cuke_linter 0.9.0 → 0.10.0

data/testing/cucumber/features/linters/feature_with_too_many_different_tags.feature

@@ -0,0 +1,56 @@
+Feature: Feature with too many different tags linter
+
+  As a writer of documentation
+  I want features to not contain too many different tags
+  So that readers do not need to know too many different contexts
+
+
+  Scenario: Linting
+    Given a linter for features with too many different tags
+    And the following feature:
+      """
+      # Total tag count doesn't matter. The count of unique tags is what matters.
+      @tag_A @tag_A @tag_A @tag_A
+      Feature:
+
+        @tag_B @tag_C
+        Scenario:
+          * a step
+
+        @tag_D @tag_E @tag_F @tag_G
+        Scenario:
+          * a step
+
+        @tag_H @tag_I @tag_J
+        Scenario:
+          * a step
+
+        @K
+        Scenario:
+          * a step
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                                | problem                                                           | location         |
+      | FeatureWithTooManyDifferentTagsLinter | Feature contains too many different tags. 11 tags found (max 10). | <path_to_file>:3 |
+
+  Scenario: Configuration of tag count threshold
+    Given a linter for features with too many different tags has been registered
+    And the following configuration file:
+      """
+      FeatureWithTooManyDifferentTagsLinter:
+        TagCountThreshold: 2
+      """
+    And the following feature:
+      """
+      @tag_A @tag_B @tag_C
+      Feature:
+
+        Scenario:
+          * a step
+      """
+    When the configuration file is loaded
+    And it is linted
+    Then an error is reported:
+      | linter                                | problem                                                         | location         |
+      | FeatureWithTooManyDifferentTagsLinter | Feature contains too many different tags. 3 tags found (max 2). | <path_to_file>:2 |

data/testing/cucumber/features/linters/step_with_end_period.feature

@@ -2,7 +2,7 @@ Feature: Step that ends with a period linter
 
   As a writer of documentation
   I want to avoid periods at the end of steps
-  So that readability is not impacted when they are used elsewhere
+  So that readability is not impacted when the steps are used in other contexts
 
 
   Scenario: Linting

data/testing/cucumber/features/linters/test_should_use_background.feature

@@ -0,0 +1,29 @@
+Feature: Test should use background linter
+
+  As a writer of documentation
+  I want to know if I am including the same steps in every use case
+  So that I can use a background to make it clear that a common context exists
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines.
+
+    Given a linter for tests that should use a background
+    And the following feature:
+      """
+      Feature:
+
+        Scenario:
+          * a common step
+          * a different step
+
+        Scenario:
+          * a common step
+          * a more different step
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                        | problem                                                              | location         |
+      | TestShouldUseBackgroundLinter | Test shares steps with all other tests in feature. Use a background. | <path_to_file>:3 |
+      | TestShouldUseBackgroundLinter | Test shares steps with all other tests in feature. Use a background. | <path_to_file>:7 |

data/testing/cucumber/features/linters/test_with_action_as_final_step.feature

@@ -0,0 +1,28 @@
+Feature: Test with action step as final step linter
+
+  As a tester
+  I want to be warned about abnormal step flows
+  So that the tests make sense
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines.
+
+    Given a linter for tests with an action step as the final step
+    And the following feature:
+      """
+      Feature:
+
+        Scenario: Action as final step
+          When the last step
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                              | problem                            | location         |
+      | TestWithActionStepAsFinalStepLinter | Test has 'When' as the final step. | <path_to_file>:3 |
+
+  @wip
+  Scenario: Configuration
+
+  Configure the keyword(s) that count as action steps?

data/testing/cucumber/features/linters/test_with_setup_step_after_action_step.feature

@@ -0,0 +1,30 @@
+Feature: Test with setup step after action step linter
+
+  As a tester
+  I want to be warned about abnormal step flows
+  So that the tests make sense
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines. Does not include steps inherited from backgrounds.
+
+    Given a linter for tests with a setup step after an action step
+    And the following feature:
+      """
+      Feature:
+
+        Scenario:
+          When action step
+          Given an out of place setup step
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                                 | problem                                  | location         |
+      | TestWithSetupStepAfterActionStepLinter | Test has 'Given' step after 'When' step. | <path_to_file>:3 |
+
+  @wip
+  Scenario: Configuration
+
+  Configure the keyword(s) that count as setup/action/verification steps?
+  Configure whether or not to include background steps?

data/testing/cucumber/features/linters/test_with_setup_step_after_verification_step.feature

@@ -0,0 +1,30 @@
+Feature: Test with setup step after verification step linter
+
+  As a tester
+  I want to be warned about abnormal step flows
+  So that the tests make sense
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines. Does not include steps inherited from backgrounds.
+
+    Given a linter for tests with a setup step after a verification step
+    And the following feature:
+      """
+      Feature:
+
+        Scenario:
+          Then verification step
+          Given an out of place setup step
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                                       | problem                                  | location         |
+      | TestWithSetupStepAfterVerificationStepLinter | Test has 'Given' step after 'Then' step. | <path_to_file>:3 |
+
+  @wip
+  Scenario: Configuration
+
+  Configure the keyword(s) that count as verification steps?
+  Configure whether or not to include background steps?

data/testing/cucumber/features/linters/test_with_setup_step_as_final_step.feature

@@ -0,0 +1,28 @@
+Feature: Test with setup step as final step linter
+
+  As a tester
+  I want to be warned about abnormal step flows
+  So that the tests make sense
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines.
+
+    Given a linter for tests with a setup step as the final step
+    And the following feature:
+      """
+      Feature:
+
+        Scenario:
+          Given the last step
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                             | problem                             | location         |
+      | TestWithSetupStepAsFinalStepLinter | Test has 'Given' as the final step. | <path_to_file>:3 |
+
+  @wip
+  Scenario: Configuration
+
+  Configure the keyword(s) that count as setup steps?

data/testing/cucumber/features/linters/test_with_too_many_steps.feature

@@ -54,3 +54,8 @@ Feature: Test with too many steps linter
     Then an error is reported:
       | linter                     | problem                                         | location         |
       | TestWithTooManyStepsLinter | Test has too many steps. 4 steps found (max 3). | <path_to_file>:3 |
+
+  @wip
+  Scenario: Configuration
+
+  Ideas: Configure whether or not the linter includes steps from backgrounds

data/testing/cucumber/step_definitions/setup_steps.rb

@@ -73,6 +73,10 @@ Given(/^a linter for elements with too many tags$/) do
   @linter = CukeLinter::ElementWithTooManyTagsLinter.new
 end
 
+Given(/^a linter for features with too many different tags$/) do
+  @linter = CukeLinter::FeatureWithTooManyDifferentTagsLinter.new
+end
+
 Given(/^a linter for elements with too many tags has been registered$/) do
   CukeLinter.register_linter(linter: CukeLinter::ElementWithTooManyTagsLinter.new, name: 'ElementWithTooManyTagsLinter')
 end
@@ -89,10 +93,34 @@ Given(/^a linter for tests with no name$/) do
   @linter = CukeLinter::TestWithNoNameLinter.new
 end
 
+Given(/^a linter for tests that should use a background$/) do
+  @linter = CukeLinter::TestShouldUseBackgroundLinter.new
+end
+
+Given(/^a linter for tests with a setup step after an action step$/) do
+  @linter = CukeLinter::TestWithSetupStepAfterActionStepLinter.new
+end
+
+Given(/^a linter for tests with a setup step after a verification step$/) do
+  @linter = CukeLinter::TestWithSetupStepAfterVerificationStepLinter.new
+end
+
+Given(/^a linter for tests with a setup step as the final step$/) do
+  @linter = CukeLinter::TestWithSetupStepAsFinalStepLinter.new
+end
+
+Given(/^a linter for tests with an action step as the final step$/) do
+  @linter = CukeLinter::TestWithActionStepAsFinalStepLinter.new
+end
+
 Given(/^a linter for test steps with too many characters has been registered$/) do
   CukeLinter.register_linter(linter: CukeLinter::StepWithTooManyCharactersLinter.new, name: 'StepWithTooManyCharactersLinter')
 end
 
+Given(/^a linter for features with too many different tags has been registered$/) do
+  CukeLinter.register_linter(linter: CukeLinter::FeatureWithTooManyDifferentTagsLinter.new, name: 'FeatureWithTooManyDifferentTagsLinter')
+end
+
 Given(/^the following configuration file(?: "([^"]*)")?:$/) do |file_name, text|
   file_name ||= '.cuke_linter'
 

data/testing/model_factory.rb

@@ -72,7 +72,7 @@ module CukeLinter
       model
     end
 
-    def self.generate_lintable_model(parent_file_path: 'path_to_file', source_line: '1', children: [])
+    def self.generate_lintable_model(parent_file_path: 'path_to_file', source_line: 1, children: [])
       fake_file_model      = CukeModeler::FeatureFile.new
       fake_file_model.path = parent_file_path
 

data/testing/rspec/spec/integration/cuke_linter_integration_spec.rb

@@ -180,6 +180,8 @@ RSpec.describe CukeLinter do
     expect(subject.registered_linters['ElementWithTooManyTagsLinter']).to be_a(CukeLinter::ElementWithTooManyTagsLinter)
     expect(subject.registered_linters.keys).to include('ExampleWithoutNameLinter')
     expect(subject.registered_linters['ExampleWithoutNameLinter']).to be_a(CukeLinter::ExampleWithoutNameLinter)
+    expect(subject.registered_linters.keys).to include('FeatureWithTooManyDifferentTagsLinter')
+    expect(subject.registered_linters['FeatureWithTooManyDifferentTagsLinter']).to be_a(CukeLinter::FeatureWithTooManyDifferentTagsLinter)
     expect(subject.registered_linters.keys).to include('FeatureWithoutDescriptionLinter')
     expect(subject.registered_linters['FeatureWithoutDescriptionLinter']).to be_a(CukeLinter::FeatureWithoutDescriptionLinter)
     expect(subject.registered_linters.keys).to include('FeatureWithoutNameLinter')
@@ -194,12 +196,22 @@ RSpec.describe CukeLinter do
     expect(subject.registered_linters['StepWithEndPeriodLinter']).to be_a(CukeLinter::StepWithEndPeriodLinter)
     expect(subject.registered_linters.keys).to include('StepWithTooManyCharactersLinter')
     expect(subject.registered_linters['StepWithTooManyCharactersLinter']).to be_a(CukeLinter::StepWithTooManyCharactersLinter)
+    expect(subject.registered_linters.keys).to include('TestShouldUseBackgroundLinter')
+    expect(subject.registered_linters['TestShouldUseBackgroundLinter']).to be_a(CukeLinter::TestShouldUseBackgroundLinter)
+    expect(subject.registered_linters.keys).to include('TestWithActionStepAsFinalStepLinter')
+    expect(subject.registered_linters['TestWithActionStepAsFinalStepLinter']).to be_a(CukeLinter::TestWithActionStepAsFinalStepLinter)
     expect(subject.registered_linters.keys).to include('TestWithNoActionStepLinter')
     expect(subject.registered_linters['TestWithNoActionStepLinter']).to be_a(CukeLinter::TestWithNoActionStepLinter)
     expect(subject.registered_linters.keys).to include('TestWithNoNameLinter')
     expect(subject.registered_linters['TestWithNoNameLinter']).to be_a(CukeLinter::TestWithNoNameLinter)
     expect(subject.registered_linters.keys).to include('TestWithNoVerificationStepLinter')
     expect(subject.registered_linters['TestWithNoVerificationStepLinter']).to be_a(CukeLinter::TestWithNoVerificationStepLinter)
+    expect(subject.registered_linters.keys).to include('TestWithSetupStepAfterActionStepLinter')
+    expect(subject.registered_linters['TestWithSetupStepAfterActionStepLinter']).to be_a(CukeLinter::TestWithSetupStepAfterActionStepLinter)
+    expect(subject.registered_linters.keys).to include('TestWithSetupStepAfterVerificationStepLinter')
+    expect(subject.registered_linters['TestWithSetupStepAfterVerificationStepLinter']).to be_a(CukeLinter::TestWithSetupStepAfterVerificationStepLinter)
+    expect(subject.registered_linters.keys).to include('TestWithSetupStepAsFinalStepLinter')
+    expect(subject.registered_linters['TestWithSetupStepAsFinalStepLinter']).to be_a(CukeLinter::TestWithSetupStepAsFinalStepLinter)
     expect(subject.registered_linters.keys).to include('TestWithTooManyStepsLinter')
     expect(subject.registered_linters['TestWithTooManyStepsLinter']).to be_a(CukeLinter::TestWithTooManyStepsLinter)
   end

data/testing/rspec/spec/integration/linters/feature_with_too_many_different_tags_linter_integration_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../../../../../environments/rspec_env'
+
+
+RSpec.describe CukeLinter::FeatureWithTooManyDifferentTagsLinter do
+
+  it_should_behave_like 'a linter at the integration level'
+
+end

data/testing/rspec/spec/integration/linters/test_should_use_background_linter_integration_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../../../../../environments/rspec_env'
+
+
+RSpec.describe CukeLinter::TestShouldUseBackgroundLinter do
+
+  it_should_behave_like 'a linter at the integration level'
+
+end

data/testing/rspec/spec/integration/linters/test_with_action_step_as_final_step_linter_integration_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../../../../../environments/rspec_env'
+
+
+RSpec.describe CukeLinter::TestWithActionStepAsFinalStepLinter do
+
+  it_should_behave_like 'a linter at the integration level'
+
+end

data/testing/rspec/spec/integration/linters/test_with_setup_step_after_action_step_linter_integration_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../../../../../environments/rspec_env'
+
+
+RSpec.describe CukeLinter::TestWithSetupStepAfterActionStepLinter do
+
+  it_should_behave_like 'a linter at the integration level'
+
+end

data/testing/rspec/spec/integration/linters/test_with_setup_step_after_verification_step_linter_integration_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../../../../../environments/rspec_env'
+
+
+RSpec.describe CukeLinter::TestWithSetupStepAfterVerificationStepLinter do
+
+  it_should_behave_like 'a linter at the integration level'
+
+end

data/testing/rspec/spec/integration/linters/test_with_setup_step_as_final_step_linter_integration_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../../../../../environments/rspec_env'
+
+
+RSpec.describe CukeLinter::TestWithSetupStepAsFinalStepLinter do
+
+  it_should_behave_like 'a linter at the integration level'
+
+end

data/testing/rspec/spec/unit/linters/background_does_more_than_setup_linter_unit_spec.rb

@@ -3,16 +3,7 @@ require_relative '../../../../../environments/rspec_env'
 
 RSpec.describe CukeLinter::BackgroundDoesMoreThanSetupLinter do
 
-  let(:good_data) do
-    CukeLinter::ModelFactory.generate_background_model(source_text: 'Background:
-                                                                       Given something')
-  end
-
-  let(:bad_data) do
-    CukeLinter::ModelFactory.generate_background_model(source_text: 'Background:
-                                                                       When something')
-  end
-
+  let(:model_file_path) { 'some_file_path' }
 
   it_should_behave_like 'a linter at the unit level'
 
@@ -26,88 +17,60 @@ RSpec.describe CukeLinter::BackgroundDoesMoreThanSetupLinter do
     context 'a background with action steps' do
 
       let(:test_model) do
-        CukeLinter::ModelFactory.generate_background_model(source_text: 'Background:
-                                                                           When something')
+        CukeLinter::ModelFactory.generate_background_model(parent_file_path: model_file_path,
+                                                           source_text:      'Background:
+                                                                                When something')
       end
 
+      it_should_behave_like 'a linter linting a bad model'
+
+
       it 'records a problem' do
         result = subject.lint(test_model)
 
         expect(result[:problem]).to eq('Background has non-setup steps')
       end
 
-      it 'records the location of the problem' do
-        model = CukeLinter::ModelFactory.generate_background_model(parent_file_path: 'path_to_file',
-                                                                   source_text:      'Background:
-                                                                                        When something')
-
-        model.source_line = 1
-        result            = subject.lint(model)
-        expect(result[:location]).to eq('path_to_file:1')
-
-        model.source_line = 3
-        result            = subject.lint(model)
-        expect(result[:location]).to eq('path_to_file:3')
-      end
-
     end
 
     context 'a background with verification steps' do
 
       let(:test_model) do
-        CukeLinter::ModelFactory.generate_background_model(source_text: 'Background:
-                                                                           Then something')
+        CukeLinter::ModelFactory.generate_background_model(parent_file_path: model_file_path,
+                                                           source_text:      'Background:
+                                                                                Then something')
       end
 
+      it_should_behave_like 'a linter linting a bad model'
+
+
       it 'records a problem' do
         result = subject.lint(test_model)
 
         expect(result[:problem]).to eq('Background has non-setup steps')
       end
 
-      it 'records the location of the problem' do
-        model = CukeLinter::ModelFactory.generate_background_model(parent_file_path: 'path_to_file',
-                                                                   source_text:      'Background:
-                                                                                        Then something')
-
-        model.source_line = 1
-        result            = subject.lint(model)
-        expect(result[:location]).to eq('path_to_file:1')
-
-        model.source_line = 3
-        result            = subject.lint(model)
-        expect(result[:location]).to eq('path_to_file:3')
-      end
-
     end
 
     context 'a background with only setup steps' do
 
-      context 'with a scenario' do
-
-        let(:test_model) do
-          gherkin = 'Background:
+      let(:test_model) do
+        gherkin = 'Background:
                        Given something
                        * (plus something)'
 
-          CukeLinter::ModelFactory.generate_background_model(source_text: gherkin)
-        end
-
-        it 'does not record a problem' do
-          expect(subject.lint(test_model)).to eq(nil)
-        end
-
+        CukeLinter::ModelFactory.generate_background_model(source_text: gherkin)
       end
 
+      it_should_behave_like 'a linter linting a good model'
+
     end
 
     context 'a non-background model' do
 
-      it 'returns no result' do
-        result = subject.lint(CukeModeler::Model.new)
+      let(:test_model) { CukeModeler::Model.new }
 
-        expect(result).to eq(nil)
-      end
+      it_should_behave_like 'a linter linting a good model'
 
     end
   end