Skip to content

Commit

Permalink
Update V4 branch with doc changes from master and sync history (#251)
Browse files Browse the repository at this point in the history
* Fixes #156 (#157)

* Fixes #158

* Update README.md

* Fixes #160 (#162)

* Committing support version for Kentico-11 (#165)

* Committing support version for Kentico-11

* Updated passwordpolicymoduletests to support V11

* Fix #161 (#168)

* Fixes #161

* updated test to testing Fix#161

* Security settings #161

* Fixes 167 (#169)

* Fixes #167

* Adds missing line from last commit

* Added logic to check for empty string within the IN() query. (#175)

* Added logic to check for empty string in the IN() query.

* Updated to include an actual record count being returned from the dataset so the tables without a class representation would display properly.

* TYPO - Resolve Typo "DON NOT RUN" (#176)

* Update README.md

* Add/update issue templates

DC-399

* Add/update issue/PR templates

DC-399

* Add/update issue, PR templates, code of conduct, contributing guide

DC-399

* Replace http with https

DC-399

* Add a check for CMSEnableCsrfProtection (#181)

* Add a check for CMSEnableCsrfProtection

* Fix syntax error

* Update result set string for CSRF protection and module Comment

* Workflow XML parsed using ClassName instead of TableName and covers special cases (#183)

* Module refactoring #73 (#184)

* Delete Cache items module and related probe files

* Delete CMSFile usage check (CMSFileModule.cs) and related sql query file

* Remove Newsletters not using email queue (OMNewslettersWithoutQueue.cs)

* Remove Old Web Farm Tasks (OldWebFarmTasks.cs)

* Delete Site map (SiteMapModule.cs)

* Delete Add license key for (LicenseSetupModule.cs)

* Merge Click jacking protection check with module Security settings in web.config; Partial Refactor

* Merge Flood Protection into Security settings

* Merge SSL used for Administrative Interface (SslInAdministrationModule.cs) into Security settings

* Delete Password policy settings module; refactor and prune related tests

* Remove Event log size module

* Validate GlobalAdminSetupModule for K12. Refactor. Add app restart code.

* Validate SettingsModule for K12

* Validate and refactor RobotsTxtModule

* Validate SiteDomainAliasesSetup for K12

* Validate SitesSetupModule for K12

* Validate Disable enabled SMTP servers for K12

* Validate StagingServersSetupModule for K12

* Validate WebFarmServersSetupModule for K12

* Validate WebPartAnalyzerModule for K12

* Validate User password modules for K12

* Adds event log size and password format checks back in (#185)

* Create CODEOWNERS

* Rename LICENSE.txt to LICENSE.md

* Add/update issue, PR templates, code of conduct, contributing guide

DCN-34 - adjusted expectations

* Add/update issue, PR templates, code of conduct, contributing guide

DCN-34 - adjusted expectations

* Page not founds module revisions (#192)

* Return DataSet method and SimpleBaseInfo support for other modules

* Add Event Last Date column

* Attachments by size module revisions (#190)

* Return DataSet method and SimpleBaseInfo support for other modules

* Extend to list results by site and also take into account attachment variants

* Tree node children module revisions (#193)

* Return DataSet method and SimpleBaseInfo support for other modules

* Altered to show a list of all children - useful if results are close to max

* Duplicate page aliases module revisions (#191)

* Return DataSet method and SimpleBaseInfo support for other modules

* Extended to include CMS_Tree as source of aliases and make it overall easier to read

* Column/Field validation module (#194)

* New ColumnFieldValidation module to check class fields have a matching database representation and vice-versa

Signed-off-by: Pete <peter.cranston@distinction.co.uk>

* ColumnFieldValidation: make table names case-insensitive to prevent false negatives

* Update README.md

* Recommended settings module (#189)

* Return DataSet method and SimpleBaseInfo support for other modules

* Recommended settings for current site with SQL and helper class/method

* Update Kentico.KInspector.Modules.csproj

System.Windows.Forms is required for ResXResourceSet (confusingly enough)

* Use string comparison for bool check to cover empty values

* Normalize ResX path in case of project not in CMS folder

* Create migration_template.md

* Update migration_template.md

* Updates package-lock after npm i
  • Loading branch information
ChristopherJennings authored Apr 29, 2019
1 parent f99ec05 commit 44f4c68
Show file tree
Hide file tree
Showing 12 changed files with 112 additions and 57 deletions.
4 changes: 4 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Users referenced in this file will automatically be requested as reviewers for PRs that modify the given paths.
# See https://help.github.com/articles/about-code-owners/

* @ChristopherJennings
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Why is this feature required? What problems does it solve?

### Proposed solution

An ideal solution of the above problems.
An ideal solution for the above problems.

### Additional context

Expand Down
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/migration_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: V3->V4 Report Migration
about: Request a V3 module be migrated to V4

---

### Overview
We should migrate the [MODULE_NAME](LINK_TO_MODULE_CODE_FILE) module to the new V4 report format.

### Definition of done
- [ ] Code and Scripts are ported to `KenticoInspector.Reports` project in a dedicated folder for the report.
- [ ] Scripts are referenced via constants in a static class.
- [ ] Scripts are refactored to return simple results that are mappable to simple classes.
- [ ] Report logic is covered by unit test for a clean result
- [ ] Report logic is covered by unit tests for all known dirty results
- [ ] Useful, non-specific logic is abstracted to services or helpers.

_Note: The [Class/Table Validation report](https://github.com/Kentico/KInspector/tree/v4-dev/KenticoInspector.Reports/ClassTableValidation) (and it's [tests](https://github.com/Kentico/KInspector/blob/v4-dev/KenticoInspector.Reports.Tests/ClassTableValidationTests.cs)) is a good, simple example of the main concepts._

### Additional Details
- New name: __NAME__
- Tags: __tag 1, tag 2__
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ If no issue exists, what is the fix or new feature? Were there any reasons to fi
- [ ] Code follows coding conventions held in this repo
- [ ] Automated tests have been added
- [ ] Tests are passing
- [ ] Docu has been updated (if applicable)
- [ ] Temporary settings (e.g. project ID used during development and testing) have been reverted to defaults
- [ ] Docs have been updated (if applicable)
- [ ] Temporary settings (e.g. variables used during development and testing) have been reverted to defaults

### How to test

If manual testing is required, what are the steps?
If manual testing is required, what are the steps?
86 changes: 41 additions & 45 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,72 @@
# Contributing guidelines
# Ways to contribute
<img align="right" width="100" height="100" src="https://i.imgur.com/PYTV0jP.png">

There are many different ways in which you can contribute. One of them is simply by using our software and providing us with your feedback or you can actively participate by coding some new features.
There are many different ways in which you can contribute. One of the easiest ways is simply to use our software and provide us with your feedback through the right channel. You can also help us improve the open-source projects by submitting pull requests with code and documentation changes.

This guide describes general guidelines that most of the repositories refer to. We don't want to make things complicated so we try to follow the same rules in every repository. But sometimes there are some rules specific for that particular repository. Always check the contributing guideline and readme in that repository as well.
## Where to get support
Please note that **level of provided support is always determined by the [LICENSE](LICENSE.md)** of a given open-source project. Also, always make sure you use the **[latest version](../../releases)** of any given OS project. We can't provide any help for older versions. We don't want to make things complicated so we try to take the same approach in all our repositories.

### I found a bug in a Kentico's open-source project
<img align="right" width="100" height="100" src="https://i.imgur.com/TYIQdpv.png">

## I have an idea for a new feature
Sorry to hear that. Just log a new [GitHub issue](../../issues) and someone will take a look at it. Remember, the more information you provide, the easier it will be to fix the issue. If you feel like it, you can also fix the bug on your own and submit a new pull request.

Everybody loves new features! You can submit a new feature request or you can code it on your own and send us a pull request. In either case, don't forget to mention what's the use case and what's the expected output.
### I need help with using the projects and/or coding
<img align="right" width="100" height="100" src="https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-icon.svg">

It's always a good idea to discuss the feature before you start the implementation. You can check with us whether the feature fits the vision of a given project. We may also give you some useful hints before you start coding. To start chatting, either create a new GitHub issue or contact us via the [repository's default communication channel](https://github.com/Kentico/Home#questions--answers).
To get help with coding and structuring your projects, use [StackOverflow](https://stackoverflow.com/) to ask questions with one of the following tags:
- [`kentico-cloud`](https://stackoverflow.com/questions/tagged/kentico-cloud)
- [`kentico`](https://stackoverflow.com/questions/tagged/kentico)

Our team members and the community monitor these channels on a regular basis.

## I found a bug
### I want to report a security bug
<img align="right" width="100" height="100" src="https://i.imgur.com/z82nnJB.png">

Sorry to hear that. Just create new GitHub issue and someone will take a look at that. Please, don't forget to provide us with all the important information like
Security issues and bugs should be reported privately, via email, to the Kentico Developer Community Team developerscommunity@kentico.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.

- Steps to reproduce the issue
- Environment and software version used
- Screenshot
- Error message
- What is the expected behavior

The more information you provide, the easier would it be to fix the issue. You can also fix the bug on your own and submit a new pull request.
### I have an idea for a new feature (or feedback on existing functionality)
<img align="right" width="100" height="100" src="https://i.imgur.com/rUFkyPy.png">

Everybody loves new features! You can submit a new [feature request](../../issues) or you can code it on your own and [send us a pull request](#submitting-pull-requests). In either case, don't forget to mention what's the use case and what's the expected output.


## Submitting pull requests
<img align="right" width="100" height="100" src="https://i.imgur.com/aSeiliy.png">

If not stated otherwise, we use [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). To start with coding, fork the repository you want to contribute to, create a new branch and start coding.
Unless you're fixing a typo, it's usually a good idea to discuss the feature before you submit a pull request with code changes, so let's start with submitting a new [GitHub issue](../../issues) and discussing the whether it fits the vision of a given project.
You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik. Note that all code submissions will be rigorously reviewed and tested by the Kentico Maintainers teams, and only those that meet an high bar for both quality and design/roadmap appropriateness will be merged into the source.


### Example - process of contribution
If not stated otherwise, we use [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow).

1. ```Tom``` forks this repository
2. Creates a new branch for his ```cool``` feature
3. Hacks his code
4. Writes some tests
5. Once he's happy with the changes, he submits a pull request from his ```cool``` branch to ```master``` branch
6. We discuss the pull request with ```Tom``` and maybe suggest some adjustments
7. Once the code is ready, someone from maintainers will merge it into the ```master``` branch

To start with coding, fork the repository you want to contribute to, create a new branch, and start coding. Once the functionality is [done](#Definition-of-Done), you can submit a [pull request](https://help.github.com/articles/about-pull-requests/).

### Definition of Done
<img align="right" width="100" height="100" src="https://i.imgur.com/g82Ohdv.png">

- Code requirements:
- Code is buildable
- All tests are green
- Code design follows the .NET [Framework Design Guidelines](https://msdn.microsoft.com/en-us/library/ms229042.aspx)
- If you're not sure about some rules, follow the style of the existing code.
- Use "Format the whole document" button in Visual Studio to fix indentation ![format](https://cloud.githubusercontent.com/assets/9810625/12391368/a14d7726-bde7-11e5-9a0f-3310c833f5ca.png)
- Documentation is updated

- New/fixed code is covered with tests
- CI can build the code
- All tests are pass
- New version number follows [semantic versioning](https://semver.org/)
- Coding style (spaces, indentation) is in line with the rest of the code in a given repository
- Documentation is updated (e.g. code examples in README, Wiki pages, etc.)
- All `public` members are documented (using XML doc, phpdoc, etc.)
- Code doesn't contain any secrets (private keys, etc.)
- Commit messages are clear. Please read these articles: [Writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), [On commit messages](https://who-t.blogspot.com/2009/12/on-commit-messages.html)


### Learn how to write good commit messages
### Feedback
<img align="right" width="100" height="100" src="https://i.imgur.com/ZQfNzJJ.png">

We hate sloppy commit messages. No more ```Performance tuning``` or ```Changed a few files```. Please read the following articles to understand what a good commit message is.
Your pull request will now go through extensive checks by the subject matter experts on our team. Please be patient. Update your pull request according to feedback until it is approved by one of the Kentico maintainers. After that, one of our team members may adjust the branch you merge into based on the expected release schedule.

- [Writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages)
- [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
- [On commit messages](https://who-t.blogspot.com/2009/12/on-commit-messages.html)

## Code of Conduct
<img align="right" width="100" height="100" src="https://i.imgur.com/cObdKQy.png">

The Kentico team is committed to fostering a welcoming community.

**Our Code of Conduct can be found here**:

https://github.com/Kentico/Home/blob/master/CODE_OF_CONDUCT.md

For a history of updates, see the page history here:

https://github.com/Kentico/Home/commits/master/CODE_OF_CONDUCT.md
The Kentico team is committed to fostering a welcoming community, therefore this project has adopted the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). If you have any additional questions or comments, you can contact us directly at developerscommunity@kentico.com.

![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/Home/master/CONTRIBUTING.md?pixel)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
-- Classes with their xml schema
SELECT ClassTableName, ClassXmlSchema FROM CMS_Class
where ClassTableName IS NOT NULL
and ClassTableName != ''
ORDER BY ClassTableName
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
-- List of tables and columns
SELECT TABLE_NAME, COLUMN_NAME FROM INFORMATION_SCHEMA.COLUMNS
11 changes: 11 additions & 0 deletions KenticoInspector.Reports/ClassTableValidation/PasswordFormat.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
-- In the case of "CSMUsePasswordPolicy", the setting is given per site name. For that reason
-- the data has to be retrieved for each site so that the PasswordPolicy module can evaluate
-- said value at the 'site' level.
SELECT
ISNULL(CMS_Site.SiteDisplayName,'N/A') as SiteDisplayName,
CMS_SettingsKey.KeyName,
CMS_SettingsKey.KeyValue
FROM CMS_SettingsKey
LEFT OUTER JOIN CMS_Site ON CMS_SettingsKey.SiteID = CMS_Site.SiteID
WHERE
(CMS_SettingsKey.KeyName IN ('CMSPasswordFormat'))
Binary file not shown.
28 changes: 21 additions & 7 deletions KenticoInspector.WebApplication/ClientApp/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion LICENSE.txt → LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
THE SOFTWARE.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# KInspector

[![Join the chat at https://kentico-community.slack.com](https://img.shields.io/badge/join-slack-E6186D.svg)](https://kentico-community.slack.com)
[![Stack Overflow](https://img.shields.io/badge/Stack%20Overflow-ASK%20NOW-FE7A16.svg?logo=stackoverflow&logoColor=white)](https://stackoverflow.com/tags/kentico-cloud)
[![Build status](https://ci.appveyor.com/api/projects/status/udykjx510v83w9y6?svg=true)](https://ci.appveyor.com/project/kentico/kinspector)
[![first-timers-only](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](http://www.firsttimersonly.com/)
[![Github All Releases](https://img.shields.io/github/downloads/kentico/kinspector/total.svg)](https://github.com/Kentico/KInspector/releases)
Expand Down

0 comments on commit 44f4c68

Please sign in to comment.