chutney 3.7.0 → 3.8.0

data/usechutney.com/docs/rules/missing-example-table/index.md

@@ -0,0 +1,34 @@
+---
+title: "Missing Example Table"
+layout: single
+permalink: /docs/rules/missing-example-table/
+---
+
+You have a scenario outline without an example table. You should add an example table to the scenario outline to show what the scenario is testing, or convert the scenario outline to a scenario if you do not need to test multiple examples.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario Outline: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario Outline: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+    Examples:
+      | username | password |
+      | user1    | pass1    |
+      | user2    | pass2    |
+```

data/usechutney.com/docs/rules/missing-feature-description/index.md

@@ -0,0 +1,25 @@
+---
+title: "Missing Feature Description"
+layout: single
+permalink: /docs/rules/missing-feature-description/
+---
+
+You should write a description for your feature in the form of a value-statements. This makes it clear to the reader what the feature is doing and why it is important.
+
+Value statements are short description that put the feature in context. They should be written in the form of "As a [role], I want [feature], so that [benefit]".
+
+## Bad
+
+```gherkin
+Feature: logging in
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  As a user,
+  I want to log in to the website,
+  so that I can access my account.
+```

data/usechutney.com/docs/rules/missing-feature-name/index.md

@@ -0,0 +1,19 @@
+---
+title: "Missing Feature Name"
+layout: single
+permalink: /docs/rules/missing-feature-name/
+---
+
+Your `Feature` should have a name that describes what the feature is doing. This makes it clear to the reader what the feature is doing and why it is important.
+
+## Bad
+
+```gherkin
+Feature:
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+```

data/usechutney.com/docs/rules/missing-scenario-name/index.md

@@ -0,0 +1,19 @@
+---
+title: "Missing Scenario Name"
+layout: single
+permalink: /docs/rules/missing-scenario-name/
+---
+
+Your `Scenario` and `Scenario Outline` should have a name that describes what the feature is doing. This makes it clear to the reader what the feature is doing and why it is important.
+
+## Bad
+
+```gherkin
+Scenario:
+```
+
+## Good
+
+```gherkin
+Scenario: logging in
+```

data/usechutney.com/docs/rules/missing-scenario-outline/index.md

@@ -0,0 +1,39 @@
+---
+title: "Missing Scenario Outline"
+layout: single
+permalink: /docs/rules/missing-scenario-outline/
+---
+
+You have a `Scenario` with an example table, but you should use a `Scenario Outline` instead. This makes it clear to the reader that the scenario is a template for multiple examples.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+    Examples:
+      | username | password |
+      | user1    | pass1    |
+      | user2    | pass2    |
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario Outline: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+    Examples:
+      | username | password |
+      | user1    | pass1    |
+      | user2    | pass2    |
+```

data/usechutney.com/docs/rules/missing-test-action/index.md

@@ -0,0 +1,28 @@
+---
+title: "Missing Test Action"
+layout: single
+permalink: /docs/rules/missing-test-action/
+---
+
+You have a `Scenario` or `Scenario Outline` without a `When` step. You should add a `When` step to show what the scenario is testing.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```

data/usechutney.com/docs/rules/missing-test-verification/index.md

@@ -0,0 +1,28 @@
+---
+title: "Missing Test Verification"
+layout: single
+permalink: /docs/rules/missing-test-verification/
+---
+
+You have a `Scenario` or `Scenario Outline` without a `Then` step. You should add a `Then` step to show what the scenario is testing.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```

data/usechutney.com/docs/rules/required-tag-starts-with/index.md

@@ -0,0 +1,31 @@
+---
+title: "Required Tags Starts With"
+layout: single
+permalink: /docs/rules/required-tags-start-with/
+---
+
+This is a rule which you can configure to enforce a naming convention for tags. This rule will check that all tags on a feature start with a specific prefix.
+
+## Configuration
+
+To configure and enable this rule, you need to change your `chutney.yml` configuration file.
+
+```yaml
+RequiredTagsStartsWith:
+    Enabled: true
+    Matcher: ['JIRA','PROJECT']
+```
+
+This will require all tags to start with either `JIRA` or `PROJECT`.
+
+## Examples
+
+```gherkin
+@JIRA-1234 @PROJECT-1
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```

data/usechutney.com/docs/rules/same-tag-different-case/index.md

@@ -0,0 +1,42 @@
+---
+title: "Same Tag Different Case"
+layout: single
+permalink: /docs/rules/same-tag-different-case/
+---
+
+Cucumber tags are case-sensitive. Be careful when using tags that are the same but have different cases, you might not get the results you expect if you use tags to select scenarios.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  @Smoke
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+  @smoke
+  Scenario: logging out
+    Given I have visited the website
+    When I log out
+    Then I will see the login page
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+  @smoke
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+  @smoke
+  Scenario: logging out
+    Given I have visited the website
+    When I log out
+    Then I will see the login page
+```

data/usechutney.com/docs/rules/same-tag-for-all-scenarios/index.md

@@ -0,0 +1,42 @@
+---
+title: "Same Tag For All Scenarios"
+layout: single
+permalink: /docs/rules/same-tag-for-all-scenarios/
+---
+
+You have the same tag for all scenarios. This is not recommended because it makes it difficult to filter scenarios by tags. Instead, set the tag at the \`Feature` level.
+
+## Bad
+
+```gherkin
+Feature: Login
+
+  @login
+  Scenario: Successful login
+    Given I am on the login page
+    When I enter my credentials
+    Then I should be logged in
+
+  @login
+  Scenario: Failed login
+    Given I am on the login page
+    When I enter invalid credentials
+    Then I should see an error message
+```
+
+## Good
+
+```gherkin
+@login
+Feature: Login
+
+  Scenario: Successful login
+    Given I am on the login page
+    When I enter my credentials
+    Then I should be logged in
+
+  Scenario: Failed login
+    Given I am on the login page
+    When I enter invalid credentials
+    Then I should see an error message
+```

data/usechutney.com/docs/rules/scenario-names-match/index.md

@@ -0,0 +1,30 @@
+---
+title: "Scenario Names Match"
+layout: single
+permalink: /docs/rules/scenario-names-match/
+---
+
+This is a rule which you can configure to enforce a naming convention for scenarios. This rule will check that all scenario names match a regular expression.
+
+## Configuration
+
+To configure and enable this rule, you need to change your `chutney.yml` configuration file.
+
+```yaml
+ScenarioNamesMatch:
+    Enabled: true
+    Matcher: ^AC.*
+```
+
+This will require all scenario names to start with `AC`.
+
+## Examples
+
+```gherkin
+Feature: logging in
+
+  Scenario: AC-1 logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```

data/usechutney.com/docs/rules/tag-used-multiple-times/index.md

@@ -0,0 +1,32 @@
+---
+title: "Tag Used Multiple Times"
+layout: single
+permalink: /docs/rules/tag-used-multiple-times/
+---
+
+Avoid using the same tag at both the feature and scenario level. If it is used at the feature level it is redundant at the scenario level. This rule will check that tags are not used multiple times in the same feature file.
+
+## Bad
+
+```gherkin
+@tag
+Feature: logging in
+
+  @tag
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+@tag
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```

data/usechutney.com/docs/rules/too-clumsy/index.md

@@ -0,0 +1,78 @@
+---
+title: "Too Clumsy"
+layout: single
+permalink: /docs/rules/too-clumsy/
+---
+
+Avoid having very long or wordy scenarios. They are difficult to read and maintain and are often a sign that the scenario is doing too much or there is scripting involved. This rule will checks the total number of character in a scenario.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in with a valid username and password
+    Given I have visited the website
+    When I log in with "validusername" and "validpassword"
+    Then I will see my account
+    And I will see the logout button
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "validusername" and "validpassword"
+    Then I will see my account details
+```

data/usechutney.com/docs/rules/too-long-step/index.md

@@ -0,0 +1,30 @@
+---
+title: "Too Long Step"
+layout: single
+permalink: /docs/rules/too-long-step/
+---
+
+Avoid having very long or wordy steps. They are difficult to read and maintain and are often a sign that the step is doing too much or there is scripting involved. This rule will check that steps are not too long. Having an 'and' inside the step is often a clue that you have a compound step that should be broken down into smaller steps.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website and  successfully logged in with a user account having the credentials "validusername" and "validpassword"
+    When I view my profile
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    And I have logged with credentials "validusername" and "validpassword"
+    When I view my profile
+    Then I will see my account
+```

data/usechutney.com/docs/rules/too-many-different-tags/index.md

@@ -0,0 +1,32 @@
+---
+title: "Too Many Different Tags"
+layout: single
+permalink: /docs/rules/too-many-different-tags/
+---
+
+Avoid a tag soup by using too many different tags in a feature file. It suggests that redundant tags have been left in the feature file and have not been cleaned up.
+
+## Bad
+
+```gherkin
+@tag1 @tag2 @tag3 @tag4 @tag5 @tag6 @tag7 @tag8 @tag9 @tag10
+Feature: logging in
+
+  @tag11 @tag12 @tag13 @tag14 @tag15 @tag16 @tag17 @tag18 @tag19 @tag20
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+@tag1 @tag2 @tag3
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```

data/usechutney.com/docs/rules/too-many-steps/index.md

@@ -0,0 +1,79 @@
+---
+title: "Too Many Steps"
+layout: single
+permalink: /docs/rules/too-many-steps/
+---
+
+Avoid having too many steps in a scenario. Scenarios should be concise and focused on a single behavior. This rule will check that scenarios do not have too many steps.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "validusername" and "validpassword"
+    Then I will see my account
+    And I will see the logout button
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+    And I will see the account phone number
+    And I will see the account email
+    And I will see the account status
+    And I will see the account type
+    And I will see the account currency
+    And I will see the account balance
+    And I will see the account number
+    And I will see the account name
+    And I will see the account address
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "validusername" and "validpassword"
+    Then I will see my account details
+```

data/usechutney.com/docs/rules/too-many-tags/index.md

@@ -0,0 +1,32 @@
+---
+title: "Too Many Tags"
+layout: single
+permalink: /docs/rules/too-many-tags/
+---
+
+Avoid a tag soup by using too many tags in a feature file. It suggests that redundant tags have been left in the feature file and have not been cleaned up.
+
+## Bad
+
+```gherkin
+@tag1 @tag2 @tag3 @tag4 @tag5 @tag6 @tag7 @tag8 @tag9 @tag10
+Feature: logging in
+
+  @tag11 @tag12 @tag13 @tag14 @tag15 @tag16 @tag17 @tag18 @tag19 @tag20
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+@tag1 @tag2 @tag3
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```

data/usechutney.com/docs/rules/unique-scenario-names/index.md

@@ -0,0 +1,39 @@
+---
+title: "Unique Scenario Names"
+layout: single
+permalink: /docs/rules/unique-scenario-names/
+---
+
+Avoid duplicating scenario names. Scenario names should be unique within a feature file so that they are meaningful and easy to identify. This rule will check that scenario names are unique within a feature file.
+
+## Bad
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+Feature: logging in
+
+  Scenario: logging in
+    Given I have visited the website
+    When I log in with "<username>" and "<password>"
+    Then I will see my account
+
+  Scenario: logging out
+    Given I have visited the website
+    When I log out
+    Then I will see the login page
+```