cuke_linter 0.6.0 → 0.7.0

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

@@ -21,7 +21,12 @@ Feature: Example without name linter
           | value |
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                   | problem             | location         |
       | ExampleWithoutNameLinter | Example has no name | <path_to_file>:5 |
       | ExampleWithoutNameLinter | Example has no name | <path_to_file>:8 |
+
+  @wip
+  Scenario: Configuration
+
+  Ideas: Configure whether or not the linter triggers on outline with only one Example set?

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

@@ -12,6 +12,6 @@ Feature: Feature without description linter
       Feature: Features must have a description
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                          | problem                    | location         |
       | FeatureWithoutDescriptionLinter | Feature has no description | <path_to_file>:1 |

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

@@ -0,0 +1,18 @@
+Feature: Feature without name linter
+
+  As a reader of documentation
+  I want every feature to have a name
+  So that I can get an idea of  what the feature is about without having to read every use case
+
+
+  Scenario: Linting
+    Given a linter for features without a name
+    And the following feature:
+      """
+      Feature:
+        This feature does not have a name
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                   | problem                       | location         |
+      | FeatureWithoutNameLinter | Feature does not have a name. | <path_to_file>:1 |

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

@@ -12,6 +12,6 @@ Feature: Feature without scenarios linter
       Feature:
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                        | problem                  | location         |
       | FeatureWithoutScenariosLinter | Feature has no scenarios | <path_to_file>:1 |

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

@@ -18,6 +18,6 @@ Feature: Outline with single example row linter
           | value |
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                            | problem                          | location         |
       | OutlineWithSingleExampleRowLinter | Outline has only one example row | <path_to_file>:3 |

data/testing/cucumber/features/linters/{single_test_background_linter.feature → single_test_background.feature}

@@ -19,6 +19,6 @@ Feature: Single test background linter
           * a step
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                     | problem                            | location         |
       | SingleTestBackgroundLinter | Background used with only one test | <path_to_file>:3 |

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

@@ -16,13 +16,13 @@ Feature: Test step with too many characters
           * tea exists and teapots exist and so do cups and saucers and there might be milk in the milk jug together with sugar cubes
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                          | problem                                         | location         |
       | StepWithTooManyCharactersLinter | Step is too long. 121 characters found (max 80) | <path_to_file>:4 |
 
 
   Scenario: Configuration of step count threshold
-  
+
     Given a linter for test steps with too many characters has been registered
     And the following configuration file:
       """
@@ -38,6 +38,6 @@ Feature: Test step with too many characters
       """
     When the configuration file is loaded
     And the feature is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                          | problem                                        | location         |
       | StepWithTooManyCharactersLinter | Step is too long. 56 characters found (max 55) | <path_to_file>:4 |

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

@@ -16,6 +16,6 @@ Feature: Step that ends with a period linter
           * a bad step.
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                  | problem                 | location         |
       | StepWithEndPeriodLinter | Step ends with a period | <path_to_file>:5 |

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

@@ -0,0 +1,30 @@
+Feature: Test with no action step linter
+
+  As a tester
+  I want tests to have at least one action step
+  So that I know what is triggering the behavior that is being checked
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines. Also includes steps inherited from backgrounds.
+
+    Given a linter for tests with no action step
+    And the following feature:
+      """
+      Feature:
+
+        Scenario:
+          Given some setup step
+          Then that's the end of the test
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                     | problem                           | location         |
+      | TestWithNoActionStepLinter | Test does not have a 'When' step. | <path_to_file>:3 |
+
+  @wip
+  Scenario: Configuration
+
+  Ideas: Configure whether or not the linter triggers on tests with no steps at all?
+  Configure the keyword(s) that count as an action step?

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

@@ -0,0 +1,23 @@
+Feature: Test with no name linter
+
+  As a reader of documentation
+  I want every scenario to have a name
+  So that I can understand the significance of the use case
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines.
+
+    Given a linter for tests with no name
+    And the following feature:
+      """
+      Feature:
+
+        Scenario:
+          This scenario has no name
+      """
+    When it is linted
+    Then an error is reported:
+      | linter               | problem                    | location         |
+      | TestWithNoNameLinter | Test does not have a name. | <path_to_file>:3 |

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

@@ -0,0 +1,31 @@
+Feature: Test with no verification step linter
+
+  As a tester
+  I want tests to have at least one verification step
+  So that I know that something is being checked
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines. Also includes steps inherited from backgrounds.
+
+    Given a linter for tests with no verification step
+    And the following feature:
+      """
+      Feature:
+
+        Scenario:
+          Given some setup step
+          When an action is taken
+          And that's the end of the test
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                           | problem                           | location         |
+      | TestWithNoVerificationStepLinter | Test does not have a 'Then' step. | <path_to_file>:3 |
+
+  @wip
+  Scenario: Configuration
+
+  Ideas: Configure whether or not the linter triggers on tests with no steps at all?
+  Configure the keyword(s) that count as a verification step?

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

@@ -28,9 +28,9 @@ Feature: Test with too many steps linter
           * step one too many...
       """
     When it is linted
-    Then an error is reported
-      | linter                     | problem                                          | location         |
-      | TestWithTooManyStepsLinter | Test has too many steps. 11 steps found (max 10) | <path_to_file>:3 |
+    Then an error is reported:
+      | linter                     | problem                                           | location         |
+      | TestWithTooManyStepsLinter | Test has too many steps. 11 steps found (max 10). | <path_to_file>:3 |
 
   Scenario: Configuration of step count threshold
     Given a linter for tests with too many steps has been registered
@@ -51,6 +51,6 @@ Feature: Test with too many steps linter
       """
     When the configuration file is loaded
     And the feature is linted
-    Then an error is reported
-      | linter                     | problem                                        | location         |
-      | TestWithTooManyStepsLinter | Test has too many steps. 4 steps found (max 3) | <path_to_file>:3 |
+    Then an error is reported:
+      | linter                     | problem                                         | location         |
+      | TestWithTooManyStepsLinter | Test has too many steps. 4 steps found (max 3). | <path_to_file>:3 |

data/testing/cucumber/step_definitions/setup_steps.rb

@@ -57,6 +57,26 @@ Given("a linter for test steps with too many characters") do
   @linter = CukeLinter::StepWithTooManyCharactersLinter.new
 end
 
+Given(/^a linter for tests with no action step$/) do
+  @linter = CukeLinter::TestWithNoActionStepLinter.new
+end
+
+Given(/^a linter for tests with no verification step$/) do
+  @linter = CukeLinter::TestWithNoVerificationStepLinter.new
+end
+
+Given(/^a linter for features without a name$/) do
+  @linter = CukeLinter::FeatureWithoutNameLinter.new
+end
+
+Given(/^a linter for elements with too many tags$/) do
+  @linter = CukeLinter::ElementWithTooManyTagsLinter.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
+
 Given(/^a linter for tests with too many steps has been registered$/) do
   CukeLinter.register_linter(linter: CukeLinter::TestWithTooManyStepsLinter.new, name: 'TestWithTooManyStepsLinter')
 end
@@ -65,6 +85,10 @@ Given("a linter for features without a description") do
   @linter = CukeLinter::FeatureWithoutDescriptionLinter.new
 end
 
+Given(/^a linter for tests with no name$/) do
+  @linter = CukeLinter::TestWithNoNameLinter.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

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -14,7 +14,7 @@ Then(/^the resulting output will include the following:$/) do |text|
   expect(@results.chomp).to include(text)
 end
 
-Then(/^an error is reported$/) do |table|
+Then(/^an error is reported:$/) do |table|
   table.hashes.each do |error_record|
     expect(@results).to include({ linter:   error_record['linter'],
                                   problem:  error_record['problem'],
@@ -26,6 +26,10 @@ Then(/^the following linters are registered(?: by default)?$/) do |linter_names|
   expect(CukeLinter.registered_linters.keys).to match_array(linter_names.raw.flatten)
 end
 
+Then(/^an error is reported$/) do
+  expect(@results).to_not be_empty
+end
+
 Then(/^no error is reported$/) do
   expect(@results).to be_empty
 end

data/testing/model_factory.rb

@@ -5,6 +5,7 @@ module CukeLinter
   class TestModel < CukeModeler::Model
 
     include CukeModeler::Sourceable
+    include CukeModeler::Taggable
 
   end
 end

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

@@ -11,7 +11,8 @@ RSpec.describe 'the Command Line Interface' do
                                                           extension: '.feature',
                                                           text:      'Feature:
                                                                         Scenario: A scenario
-                                                                          * a step') }
+                                                                          When a step
+                                                                          Then a step') }
 
   # Stuff that is not always needed and so can be lazy instantiated
   let(:executable_directory) { "#{PROJECT_ROOT}/exe" }
@@ -61,7 +62,7 @@ RSpec.describe 'the Command Line Interface' do
         CukeLinter::FileHelper.create_file(directory: test_directory,
                                            name:      '.cuke_linter',
                                            extension: '',
-                                           text:      'FeatureWithoutDescriptionLinter:
+                                           text:      'AllLinters:
                                                          Enabled: false')
       end
 
@@ -100,15 +101,17 @@ RSpec.describe 'the Command Line Interface' do
             let(:file_1) { CukeLinter::FileHelper.create_file(directory: test_directory,
                                                               name:      'some',
                                                               extension: '.feature',
-                                                              text:      'Feature:
+                                                              text:      'Feature: Some feature
                                                                           Scenario: A scenario
-                                                                            * a step') }
+                                                                            When a step
+                                                                            Then a step') }
             let(:file_2) { CukeLinter::FileHelper.create_file(directory: test_directory,
                                                               name:      'a_directory/with_a',
                                                               extension: '.feature',
-                                                              text:      'Feature:
+                                                              text:      'Feature: Some feature
                                                                           Scenario: A scenario
-                                                                            * a step') }
+                                                                            When a step
+                                                                            Then a step') }
             let(:file_1_path) { file_1 }
             let(:file_2_directory) { File.dirname(file_2) }
             let(:command) { "bundle exec ruby #{executable_path} #{flag} #{file_1_path} #{flag} #{file_2_directory}" }
@@ -159,9 +162,10 @@ RSpec.describe 'the Command Line Interface' do
           context 'with formatter arguments' do
             let(:linted_file) { CukeLinter::FileHelper.create_file(name:      'some',
                                                                    extension: '.feature',
-                                                                   text:      'Feature:
+                                                                   text:      'Feature: Some feature
                                                                                Scenario: A scenario
-                                                                                 * a step') }
+                                                                                 When a step
+                                                                                 Then a step') }
             let(:formatter_class) { 'AFakeFormatter' }
             let(:formatter_class_in_module) { 'CukeLinter::AnotherFakeFormatter' }
             let(:formatter_class_file) { CukeLinter::FileHelper.create_file(extension: '.rb',
@@ -224,9 +228,10 @@ RSpec.describe 'the Command Line Interface' do
             let(:other_output_location) { "#{CukeLinter::FileHelper.create_directory}/other_output.txt" }
             let(:linted_file) { CukeLinter::FileHelper.create_file(name:      'some',
                                                                    extension: '.feature',
-                                                                   text:      'Feature:
+                                                                   text:      'Feature: Some feature
                                                                                Scenario: A scenario
-                                                                                 * a step') }
+                                                                                 When a step
+                                                                                 Then a step') }
             let(:formatter_class_1) { 'AFakeFormatter' }
             let(:formatter_class_2) { 'AnotherFakeFormatter' }
             let(:formatter_class_file) { CukeLinter::FileHelper.create_file(extension: '.rb',
@@ -386,7 +391,7 @@ RSpec.describe 'the Command Line Interface' do
 
             let(:config_file) { CukeLinter::FileHelper.create_file(name:      'my_config_file',
                                                                    extension: '.yml',
-                                                                   text:      'FeatureWithoutDescriptionLinter:
+                                                                   text:      'AllLinters:
                                                                                  Enabled: false') }
             let(:command) { "bundle exec ruby #{executable_path} #{flag} #{config_file}" }
 

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

@@ -176,10 +176,14 @@ RSpec.describe CukeLinter do
   it 'has a default set of registered linters' do
     expect(subject.registered_linters.keys).to include('BackgroundDoesMoreThanSetupLinter')
     expect(subject.registered_linters['BackgroundDoesMoreThanSetupLinter']).to be_a(CukeLinter::BackgroundDoesMoreThanSetupLinter)
+    expect(subject.registered_linters.keys).to include('ElementWithTooManyTagsLinter')
+    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('FeatureWithoutDescriptionLinter')
     expect(subject.registered_linters['FeatureWithoutDescriptionLinter']).to be_a(CukeLinter::FeatureWithoutDescriptionLinter)
+    expect(subject.registered_linters.keys).to include('FeatureWithoutNameLinter')
+    expect(subject.registered_linters['FeatureWithoutNameLinter']).to be_a(CukeLinter::FeatureWithoutNameLinter)
     expect(subject.registered_linters.keys).to include('FeatureWithoutScenariosLinter')
     expect(subject.registered_linters['FeatureWithoutScenariosLinter']).to be_a(CukeLinter::FeatureWithoutScenariosLinter)
     expect(subject.registered_linters.keys).to include('OutlineWithSingleExampleRowLinter')
@@ -190,6 +194,12 @@ 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('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('TestWithTooManyStepsLinter')
     expect(subject.registered_linters['TestWithTooManyStepsLinter']).to be_a(CukeLinter::TestWithTooManyStepsLinter)
   end
@@ -236,6 +246,33 @@ RSpec.describe CukeLinter do
       expect(subject.registered_linters['FakeLinter1']).to be nil
     end
 
+    it 'can apply a property to all linters' do
+      configuration = { 'AllLinters' => { 'Enabled' => false } }
+
+      # Restore the default linters
+      CukeLinter.reset_linters
+
+      # Also add some custom ones
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter, name: 'Foo')
+
+
+      subject.load_configuration(config: configuration)
+
+      expect(subject.registered_linters).to be_empty
+    end
+
+    it 'uses linter specific properties over general properties' do
+      configuration = { 'AllLinters'  => { 'Enabled' => false },
+                        'FakeLinter1' => { 'Enabled' => true } }
+
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter, name: 'FakeLinter1')
+      expect(subject.registered_linters['FakeLinter1']).to_not be nil
+
+      subject.load_configuration(config: configuration)
+
+      expect(subject.registered_linters['FakeLinter1']).to_not be nil
+    end
+
     it 'even unregisters non-configurable disabled linters' do
       config                  = { 'FakeLinter' => { 'Enabled' => false } }
       configuration_file      = CukeLinter::FileHelper.create_file(name: '.cuke_linter', extension: '', text: config.to_yaml)

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

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

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

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

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

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