cuke_linter 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a53b185027cee980dfa4801a9e2cb3ca7efdbd2cc0db2119a04636e494ef87
-  data.tar.gz: f71c950b3132a8141e401f2ec385c0f3ed895385ca8309be636960a34d51c2ec
+  metadata.gz: ef55f6c2d957526d16d14a9f9624fe5ea7638ba0f1b7ea2ea52244fe9805e60b
+  data.tar.gz: df6e881179035f9edb0f3c7b50a2826ff302049c2926399cee1e1570c0bcfad2
 SHA512:
-  metadata.gz: 16060efd013a6f783514efedd830db6a9ce431f786a630ed5a521c99863202ad500a72aaae8c08870d38ef22cc4b7edcba21a2f36e01512e79b7d6f6bad8b597
-  data.tar.gz: cdb8c1250a9e5bf5b6406ed05c74c4cdf97b46d3927e6bb0b4640ef966961afab29eb712667e8110aa92c610336c3a0edb9c134805c0e2beb2eb5c60a7c600b7
+  metadata.gz: a62718d8b395cddf100152b9a6c6b63cc0c4349c2715fc0261ef985000047853753835ff7d341894ad0ce6eef37b032885c75a3a569b2afaf62a2b33809b9a99
+  data.tar.gz: 9b239647d5f4f45c7454f0cfbe9c31777b8fe56064c7f99b3cab9ac237551dccc71404afa1cc4e462c10295220f1c3bfd6de7cc60d88e71da7961a13fced62c9

data/CHANGELOG.md

@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+## [0.8.0] - 2019-09-07
+
+### Changed
+ - The exit codes used by the CLI have been changed in order to better facilitate taking additional actions based on them. 
+   - 0 - No linting problems found
+   - 1 - Linting problems found
+   - 2 - Some other problem (e.g. incorrect CLI usage)
 
 ## [0.7.0] - 2019-07-12
 
@@ -78,8 +85,9 @@ Nothing yet...
 - Custom linters, formatters, and command line usability
 
 
-[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v0.7.0...HEAD
-[0.6.0]: https://github.com/enkessler/cuke_linter/compare/v0.6.0...v0.7.0
+[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/enkessler/cuke_linter/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/enkessler/cuke_linter/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/enkessler/cuke_linter/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/enkessler/cuke_linter/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/enkessler/cuke_linter/compare/v0.3.1...v0.4.0

data/environments/common_env.rb

@@ -1,6 +1,7 @@
 require 'require_all'
 
 require 'cuke_linter'
+require 'open3'
 
 
 require_relative '../testing/model_factory'

data/exe/cuke_linter

@@ -51,7 +51,7 @@ parser = OptionParser.new do |options|
 
     if params[:config]
       puts 'Cannot specify more than one configuration file!'
-      exit(1)
+      exit(2)
     end
 
     params[:config] = file_path
@@ -75,7 +75,7 @@ rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
   puts e.message
   puts parser.help
 
-  exit(1)
+  exit(2)
 end
 
 
@@ -105,4 +105,6 @@ elsif File.exist?("#{Dir.pwd}/.cuke_linter")
   CukeLinter.load_configuration
 end
 
-CukeLinter.lint(options)
+results = CukeLinter.lint(options)
+
+exit(1) unless results.empty?

data/lib/cuke_linter/version.rb

@@ -1,4 +1,4 @@
 module CukeLinter
   # The release version of this gem
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/testing/cucumber/features/command_line.feature

@@ -189,3 +189,11 @@ Feature: Using cuke_linter on the command line
       """
       0 issues found
       """
+
+  Scenario: Interpreting exit codes
+    When the executable finds no linting problems
+    Then the exit code is "0"
+    When the executable finds linting problems
+    Then the exit code is "1"
+    When the executable has a problem
+    Then the exit code is "2"

data/testing/cucumber/step_definitions/action_steps.rb

@@ -37,3 +37,48 @@ end
 When(/^"([^"]*)" is the current directory$/) do |directory|
   @working_directory = "#{@root_test_directory}/#{directory}"
 end
+
+When(/^the executable finds no linting problems$/) do
+  # Linting an empty directory doesn't (currently) find and problems
+  command = "bundle exec ruby #{PROJECT_ROOT}/exe/cuke_linter"
+
+  std_out, std_err, status = [nil, nil, nil]
+
+  Dir.chdir(@root_test_directory) do
+    std_out, std_err, status = Open3.capture3(command)
+  end
+
+  @results = { std_out: std_out, std_err: std_err, status: status }
+end
+
+When(/^the executable finds linting problems$/) do
+  # This should be a problematic feature file
+  CukeLinter::FileHelper.create_file(directory: @root_test_directory,
+                                     name:      'pretty_empty',
+                                     extension: '.feature',
+                                     text:      'Feature: ')
+
+
+  command = "bundle exec ruby #{PROJECT_ROOT}/exe/cuke_linter"
+
+  std_out, std_err, status = [nil, nil, nil]
+
+  Dir.chdir(@root_test_directory) do
+    std_out, std_err, status = Open3.capture3(command)
+  end
+
+  @results = { std_out: std_out, std_err: std_err, status: status }
+end
+
+When(/^the executable has a problem$/) do
+  # Missing a required argument for a flag should be a problem
+  command = "bundle exec ruby #{PROJECT_ROOT}/exe/cuke_linter -r"
+
+  std_out, std_err, status = [nil, nil, nil]
+
+  Dir.chdir(@root_test_directory) do
+    std_out, std_err, status = Open3.capture3(command)
+  end
+
+  @results = { std_out: std_out, std_err: std_err, status: status }
+end

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -62,3 +62,7 @@ And(/^the file "([^"]*)" contains:$/) do |file_path, text|
 
   expect(File.read(file_path)).to eq(text)
 end
+
+Then(/^the exit code is "([^"]*)"$/) do |exit_code|
+  expect(@results[:status].exitstatus).to eq(exit_code.to_i)
+end

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

@@ -4,6 +4,9 @@ require 'open3'
 
 RSpec.describe 'the Command Line Interface' do
 
+  # Exit codes that are expected during normal use of the CLI
+  let(:normal_exit_codes) { [0, 1] }
+
   # A minimal fake test suite that should be available for every spec
   let!(:test_directory) { CukeLinter::FileHelper.create_directory }
   let!(:linted_file) { CukeLinter::FileHelper.create_file(directory: test_directory,
@@ -18,6 +21,7 @@ RSpec.describe 'the Command Line Interface' do
   let(:executable_directory) { "#{PROJECT_ROOT}/exe" }
   let(:executable_name) { 'cuke_linter' }
   let(:executable_path) { "#{executable_directory}/#{executable_name}" }
+  let(:command) { "bundle exec ruby #{executable_path}" }
   let(:results) { std_out, std_err, status = [nil, nil, nil]
 
                   Dir.chdir(test_directory) do
@@ -53,7 +57,7 @@ RSpec.describe 'the Command Line Interface' do
     let(:command) { "bundle exec ruby #{executable_path}" }
 
     it 'can run cleanly by default' do
-      expect(results[:status].exitstatus).to eq(0)
+      expect(normal_exit_codes).to include(results[:status].exitstatus)
     end
 
     context 'when the default configuration file exists' do
@@ -81,13 +85,58 @@ RSpec.describe 'the Command Line Interface' do
       end
 
       it 'can still run cleanly' do
+        expect(normal_exit_codes).to include(results[:status].exitstatus)
+      end
+
+    end
+
+  end
+
+  describe 'exit codes' do
+
+    context 'when no problems are found' do
+      # This file does not have any problems with the current linter set
+      let!(:linted_file) { CukeLinter::FileHelper.create_file(directory: test_directory,
+                                                              name:      'nothing_wrong',
+                                                              extension: '.feature',
+                                                              text:      'Feature: A name
+                                                                            A description
+                                                                            Scenario: A scenario
+                                                                              When a step
+                                                                              Then a step') }
+
+      it 'returns a zero exit code' do
         expect(results[:status].exitstatus).to eq(0)
       end
 
     end
 
+    context 'when linting problems are found' do
+      # This should be a problematic feature file
+      let!(:linted_file) { CukeLinter::FileHelper.create_file(directory: test_directory,
+                                                              name:      'pretty_empty',
+                                                              extension: '.feature',
+                                                              text:      'Feature: ') }
+
+      it 'returns a non-zero exit code' do
+        expect(results[:status].exitstatus).to eq(1)
+      end
+
+    end
+
+    context 'when something else goes wrong' do
+
+      # Bad CLI usage due to missing required flag arguments
+      let(:command) { "bundle exec ruby #{executable_path} -r" }
+
+      it 'returns a different non-zero exit code' do
+        expect(results[:status].exitstatus).to eq(2)
+      end
+
+    end
   end
 
+
   describe 'option flags' do
 
     context 'with a path flag' do
@@ -143,7 +192,7 @@ RSpec.describe 'the Command Line Interface' do
             end
 
             it 'exits with an error' do
-              expect(results[:status].exitstatus).to eq(1)
+              expect(results[:status].exitstatus).to eq(2)
             end
 
           end
@@ -207,7 +256,7 @@ RSpec.describe 'the Command Line Interface' do
             end
 
             it 'exits with an error' do
-              expect(results[:status].exitstatus).to eq(1)
+              expect(results[:status].exitstatus).to eq(2)
             end
 
           end
@@ -324,7 +373,7 @@ RSpec.describe 'the Command Line Interface' do
             end
 
             it 'exits with an error' do
-              expect(results[:status].exitstatus).to eq(1)
+              expect(results[:status].exitstatus).to eq(2)
             end
 
           end
@@ -371,7 +420,7 @@ RSpec.describe 'the Command Line Interface' do
             end
 
             it 'exits with an error' do
-              expect(results[:status].exitstatus).to eq(1)
+              expect(results[:status].exitstatus).to eq(2)
             end
 
           end
@@ -410,7 +459,7 @@ RSpec.describe 'the Command Line Interface' do
             end
 
             it 'exits with an error' do
-              expect(results[:status].exitstatus).to eq(1)
+              expect(results[:status].exitstatus).to eq(2)
             end
 
           end
@@ -429,7 +478,7 @@ RSpec.describe 'the Command Line Interface' do
             end
 
             it 'exits with an error' do
-              expect(results[:status].exitstatus).to eq(1)
+              expect(results[:status].exitstatus).to eq(2)
             end
 
           end
@@ -496,7 +545,7 @@ RSpec.describe 'the Command Line Interface' do
       end
 
       it 'exits with an error' do
-        expect(results[:status].exitstatus).to eq(1)
+        expect(results[:status].exitstatus).to eq(2)
       end
 
     end

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

@@ -0,0 +1,120 @@
+require_relative '../../../../environments/rspec_env'
+
+RSpec.describe CukeLinter do
+
+  describe 'configuration' do
+
+    let(:test_model_tree) { CukeLinter::ModelFactory.generate_lintable_model }
+    let(:test_linters) { [CukeLinter::LinterFactory.generate_fake_linter] }
+    let(:test_formatters) { [[CukeLinter::FormatterFactory.generate_fake_formatter, "#{CukeLinter::FileHelper::create_directory}/junk_output_file.txt"]] }
+    let(:linting_options) { { model_trees: [test_model_tree], linters: test_linters, formatters: test_formatters } }
+
+
+    it 'unregisters disabled linters' do
+      config             = { 'FakeLinter1' => { 'Enabled' => false } }
+      configuration_file = CukeLinter::FileHelper.create_file(name: '.cuke_linter', extension: '', text: config.to_yaml)
+
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
+      expect(subject.registered_linters['FakeLinter1']).to_not be nil
+
+      subject.load_configuration(config_file_path: configuration_file)
+
+      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)
+      non_configurable_linter = CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter')
+      non_configurable_linter.instance_eval('undef :configure')
+
+      CukeLinter.register_linter(linter: non_configurable_linter, name: 'FakeLinter')
+      expect(subject.registered_linters['FakeLinter']).to_not be nil
+
+      subject.load_configuration(config_file_path: configuration_file)
+
+      expect(subject.registered_linters['FakeLinter']).to be nil
+    end
+
+    it 'uses the default configuration file in the current directory if no configuration file is provided' do
+      config             = { 'FakeLinter1' => { 'Enabled' => false } }
+      configuration_file = CukeLinter::FileHelper.create_file(name: '.cuke_linter', extension: '', text: config.to_yaml)
+
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
+      expect(subject.registered_linters['FakeLinter1']).to_not be nil
+
+      Dir.chdir(File.dirname(configuration_file)) do
+        subject.load_configuration
+      end
+
+      expect(subject.registered_linters['FakeLinter1']).to be nil
+    end
+
+    it 'raises an exception if no default configuration file is found and no configuration or file is provided' do
+      some_empty_directory = CukeLinter::FileHelper.create_directory
+
+      Dir.chdir(File.dirname(some_empty_directory)) do
+        expect { subject.load_configuration }.to raise_error('No configuration or configuration file given and no .cuke_linter file found')
+      end
+    end
+
+    it 'configures every linter for which it has a configuration' do
+      config = { 'FakeLinter1' => { 'Problem' => 'My custom message for FakeLinter1' },
+                 'FakeLinter2' => { 'Problem' => 'My custom message for FakeLinter2' } }
+
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
+      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter2'), name: 'FakeLinter2')
+      linting_options.delete(:linters)
+
+      subject.load_configuration(config: config)
+      results = subject.lint(linting_options)
+
+      expect(results).to match_array([{ linter: 'FakeLinter1', location: 'path_to_file:1', problem: 'My custom message for FakeLinter1' },
+                                      { linter: 'FakeLinter2', location: 'path_to_file:1', problem: 'My custom message for FakeLinter2' }])
+    end
+
+    it "does not try to configure linters that don't know how to be configured" do
+      config                  = { 'FakeLinter' => { 'Problem' => 'My custom message for FakeLinter' } }
+      non_configurable_linter = CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter')
+      non_configurable_linter.instance_eval('undef :configure')
+
+      CukeLinter.clear_registered_linters
+      CukeLinter.register_linter(linter: non_configurable_linter, name: 'FakeLinter')
+      linting_options.delete(:linters)
+
+      subject.load_configuration(config: config)
+      results = subject.lint(linting_options)
+
+      expect(results).to match_array([{ linter: 'FakeLinter', location: 'path_to_file:1', problem: 'FakeLinter problem' }])
+    end
+
+  end
+
+end

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

@@ -232,113 +232,4 @@ RSpec.describe CukeLinter do
     expect { subject.lint(linting_options) }.to_not raise_error
   end
 
-  describe 'configuration' do
-
-    it 'unregisters disabled linters' do
-      config             = { 'FakeLinter1' => { 'Enabled' => false } }
-      configuration_file = CukeLinter::FileHelper.create_file(name: '.cuke_linter', extension: '', text: config.to_yaml)
-
-      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
-      expect(subject.registered_linters['FakeLinter1']).to_not be nil
-
-      subject.load_configuration(config_file_path: configuration_file)
-
-      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)
-      non_configurable_linter = CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter')
-      non_configurable_linter.instance_eval('undef :configure')
-
-      CukeLinter.register_linter(linter: non_configurable_linter, name: 'FakeLinter')
-      expect(subject.registered_linters['FakeLinter']).to_not be nil
-
-      subject.load_configuration(config_file_path: configuration_file)
-
-      expect(subject.registered_linters['FakeLinter']).to be nil
-    end
-
-    it 'uses the default configuration file in the current directory if no configuration file is provided' do
-      config             = { 'FakeLinter1' => { 'Enabled' => false } }
-      configuration_file = CukeLinter::FileHelper.create_file(name: '.cuke_linter', extension: '', text: config.to_yaml)
-
-      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
-      expect(subject.registered_linters['FakeLinter1']).to_not be nil
-
-      Dir.chdir(File.dirname(configuration_file)) do
-        subject.load_configuration
-      end
-
-      expect(subject.registered_linters['FakeLinter1']).to be nil
-    end
-
-    it 'raises an exception if no default configuration file is found and no configuration or file is provided' do
-      some_empty_directory = CukeLinter::FileHelper.create_directory
-
-      Dir.chdir(File.dirname(some_empty_directory)) do
-        expect { subject.load_configuration }.to raise_error('No configuration or configuration file given and no .cuke_linter file found')
-      end
-    end
-
-    it 'configures every linter for which it has a configuration' do
-      config = { 'FakeLinter1' => { 'Problem' => 'My custom message for FakeLinter1' },
-                 'FakeLinter2' => { 'Problem' => 'My custom message for FakeLinter2' } }
-
-      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter1'), name: 'FakeLinter1')
-      CukeLinter.register_linter(linter: CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter2'), name: 'FakeLinter2')
-      linting_options.delete(:linters)
-
-      subject.load_configuration(config: config)
-      results = subject.lint(linting_options)
-
-      expect(results).to match_array([{ linter: 'FakeLinter1', location: 'path_to_file:1', problem: 'My custom message for FakeLinter1' },
-                                      { linter: 'FakeLinter2', location: 'path_to_file:1', problem: 'My custom message for FakeLinter2' }])
-    end
-
-    it "does not try to configure linters that don't know how to be configured" do
-      config                  = { 'FakeLinter' => { 'Problem' => 'My custom message for FakeLinter' } }
-      non_configurable_linter = CukeLinter::LinterFactory.generate_fake_linter(name: 'FakeLinter')
-      non_configurable_linter.instance_eval('undef :configure')
-
-      CukeLinter.clear_registered_linters
-      CukeLinter.register_linter(linter: non_configurable_linter, name: 'FakeLinter')
-      linting_options.delete(:linters)
-
-      subject.load_configuration(config: config)
-      results = subject.lint(linting_options)
-
-      expect(results).to match_array([{ linter: 'FakeLinter', location: 'path_to_file:1', problem: 'FakeLinter problem' }])
-    end
-
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_linter
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-12 00:00:00.000000000 Z
+date: 2019-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -220,6 +220,7 @@ files:
 - testing/linter_factory.rb
 - testing/model_factory.rb
 - testing/rspec/spec/integration/cli_integration_spec.rb
+- testing/rspec/spec/integration/configuration_spec.rb
 - testing/rspec/spec/integration/cuke_linter_integration_spec.rb
 - testing/rspec/spec/integration/formatters/formatter_integration_specs.rb
 - testing/rspec/spec/integration/formatters/pretty_formatter_integration_spec.rb