Add a --audit flag for finding missing/unused steps #194

pedantic-git · 2017-01-10T12:02:06Z

spinach --generate is awesome if you get your feature files right first time, but I often find that over time features change and I have to add to or edit old feature files.

This tool helps with that. Running spinach --audit will do an audit of all the feature files and their shared modules.

If steps are missing, it will generate all the pending step definitions that need adding somewhere and output them to stdout.

If steps are unused, it will print out the filename and line number of the unused step so it can be removed. [Note: In order to do this, a slight change has been made to Spinach::DSL to have it keep track of steps as they're defined. I hope this is OK/useful!]

(The audit can also be run on individual feature files, but of course it may detect shared steps as being unused when they are in fact being used by other features! It doesn't do this when run over the whole directory.)

I have tried to keep to the coding style as much as possible and I've added a lot of scenarios to defend all the possible quirks I could think of.

Please let me know if you'd like any changes making and I hope you find this useful!

mention-bot · 2017-01-10T12:02:07Z

@pedantic-git, thanks for your PR! By analyzing the history of the files in this pull request, we identified @aokolish, @ywen and @josepjaume to be potential reviewers.

houndci-bot · 2017-01-10T12:02:16Z

lib/spinach/dsl.rb

@@ -141,6 +142,11 @@ def after(&block)
      def feature(name)
        @feature_name = name
      end
+


Trailing whitespace detected.

houndci-bot · 2017-01-10T12:02:17Z

lib/spinach/config.rb

@@ -142,6 +143,16 @@ def failure_exceptions
    def fail_fast
      @fail_fast
    end
+


Trailing whitespace detected.

houndci-bot · 2017-01-10T12:02:17Z

lib/spinach/cli.rb

@@ -132,6 +134,11 @@ def parse_options
                       'Terminate the suite run on the first failure') do |class_name|
            config[:fail_fast] = true
          end
+
+          opts.on('-a', '--audit',
+                  'Audit steps instead of running them, outputting missing and obsolete steps') do


Line is too long. [98/80]

houndci-bot · 2017-01-10T12:02:17Z

lib/spinach/cli.rb

@@ -132,6 +134,11 @@ def parse_options
                       'Terminate the suite run on the first failure') do |class_name|
            config[:fail_fast] = true
          end
+


Trailing whitespace detected.

houndci-bot · 2017-01-10T12:02:17Z

lib/spinach/auditor.rb

+
+  end
+
+end


Final newline missing.

houndci-bot · 2017-01-10T12:02:18Z

lib/spinach/auditor.rb

+    end
+
+  end
+


Trailing whitespace detected.

houndci-bot · 2017-01-10T12:02:18Z

lib/spinach/auditor.rb

+        puts "\n" + "Unused step: #{location} ".colorize(:yellow) + "'#{name}'".colorize(:light_yellow)
+      end
+    end
+


Trailing whitespace detected.

houndci-bot · 2017-01-10T12:02:18Z

lib/spinach/auditor.rb

+      # Remove any unused_steps that were in common modules and used in another feature
+      used_steps.each {|location| unused_steps.delete location}
+      unused_steps.each do |location, name|
+        puts "\n" + "Unused step: #{location} ".colorize(:yellow) + "'#{name}'".colorize(:light_yellow)


Line is too long. [103/80]

houndci-bot · 2017-01-10T12:02:18Z

lib/spinach/auditor.rb

+
+    def report_unused_steps
+      # Remove any unused_steps that were in common modules and used in another feature
+      used_steps.each {|location| unused_steps.delete location}


Space between { and | missing.
Space missing inside }.

houndci-bot · 2017-01-10T12:02:19Z

lib/spinach/auditor.rb

+    end
+
+    def report_unused_steps
+      # Remove any unused_steps that were in common modules and used in another feature


Line is too long. [87/80]

houndci-bot · 2017-01-10T12:02:19Z

lib/spinach/auditor.rb

+      end
+      return true
+    end
+


Trailing whitespace detected.

houndci-bot · 2017-01-10T12:02:19Z

lib/spinach/auditor.rb

+        end
+        return false
+      end
+      return true


Redundant return detected.

houndci-bot · 2017-01-10T12:02:19Z

lib/spinach/auditor.rb

+      if missing_steps.length > 0
+        puts "\nMissing steps:".colorize(:light_cyan)
+        missing_steps.each do |step|        
+          puts Generators::StepGenerator.new(step).generate.gsub(/^/, '  ').colorize(:cyan)


Line is too long. [91/80]

houndci-bot · 2017-01-10T12:02:20Z

lib/spinach/auditor.rb

+      # And then generate a report of missing steps
+      if missing_steps.length > 0
+        puts "\nMissing steps:".colorize(:light_cyan)
+        missing_steps.each do |step|        


Trailing whitespace detected.

houndci-bot · 2017-01-10T12:02:20Z

lib/spinach/auditor.rb

+      end
+
+      # And then generate a report of missing steps
+      if missing_steps.length > 0


Use missing_steps.length.positive? instead of missing_steps.length > 0.
Use !empty? instead of length > 0.

houndci-bot · 2017-01-10T12:02:20Z

lib/spinach/auditor.rb

+        location = step_defs.step_location_for(name).join(':')
+        unused_steps[location] = name
+      end
+


Trailing whitespace detected.

pedantic-git · 2017-01-10T12:07:17Z

Looks like CI is passing but I have some Hound issues - let me take care of those.

coveralls · 2017-01-10T12:13:30Z

Coverage remained the same at 100.0% when pulling 2b0814c on fishpercolator:master into 9821a0c on codegram:master.

coveralls · 2017-01-10T12:13:30Z

Coverage remained the same at 100.0% when pulling 2b0814c on fishpercolator:master into 9821a0c on codegram:master.

coveralls · 2017-01-10T12:13:30Z

Coverage remained the same at 100.0% when pulling 2b0814c on fishpercolator:master into 9821a0c on codegram:master.

coveralls · 2017-01-10T12:13:30Z

Coverage remained the same at 100.0% when pulling 2b0814c on fishpercolator:master into 9821a0c on codegram:master.

coveralls · 2017-01-10T12:13:30Z

Coverage remained the same at 100.0% when pulling 2b0814c on fishpercolator:master into 9821a0c on codegram:master.

coveralls · 2017-01-10T12:13:30Z

Coverage remained the same at 100.0% when pulling 2b0814c on fishpercolator:master into 9821a0c on codegram:master.

houndci-bot · 2017-01-10T14:45:37Z

features/steps/step_auditing.rb

+    @stdout.scan('I should still exist').count.must_equal 1
+  end
+
+  step 'I have step files for both with common steps, but one common step is not used by either' do


Block has too many lines. [45/25]
Line is too long. [99/80]

houndci-bot · 2017-01-10T14:45:37Z

features/steps/step_auditing.rb

+    @stdout.scan('I exist').count.must_equal 1
+    @stdout.scan('I should still exist').count.must_equal 1
+  end
+


Trailing whitespace detected.

houndci-bot · 2017-01-10T14:45:38Z

features/steps/step_auditing.rb

+    pending 'step not implemented'
+  end
+end
+""")


Prefer single-quoted strings when you don't need string interpolation or special symbols.

houndci-bot · 2017-01-10T14:46:42Z

features/steps/step_auditing.rb

+  end
+end
+""")
+    write_file('features/steps/awesome_new_feature.rb', """


Combine "" and "\nclass Spinach::Features::AwesomeNewFeature < Spinach::FeatureSteps\n include Awesome\n step 'I am awesome' do\n pending 'step not implemented'\n end\n step 'people will cheer' do\n pending 'step not implemented';\n end\nend\n" into a single string literal, rather than using implicit string concatenation. Or, if they were intended to be separate method arguments, separate them with a comma.
Prefer single-quoted strings when you don't need string interpolation or special symbols.
Combine "\nclass Spinach::Features::AwesomeNewFeature < Spinach::FeatureSteps\n include Awesome\n step 'I am awesome' do\n pending 'step not implemented'\n end\n step 'people will cheer' do\n pending 'step not implemented';\n end\nend\n" and "" into a single string literal, rather than using implicit string concatenation. Or, if they were intended to be separate method arguments, separate them with a comma.

houndci-bot · 2017-01-10T14:46:42Z

features/steps/step_auditing.rb

+    pending 'step not implemented'
+  end
+end
+""")


Prefer single-quoted strings when you don't need string interpolation or special symbols.

houndci-bot · 2017-01-10T14:46:43Z

features/steps/step_auditing.rb

+  end
+
+  step 'I have created a step file without those reused steps' do
+    write_file('features/steps/exciting_feature.rb', """


Combine "" and "\nclass Spinach::Features::ExcitingFeature < Spinach::FeatureSteps\n step 'I do nothing' do\n pending 'step not implemented'\n end\nend\n" into a single string literal, rather than using implicit string concatenation. Or, if they were intended to be separate method arguments, separate them with a comma.
Prefer single-quoted strings when you don't need string interpolation or special symbols.
Combine "\nclass Spinach::Features::ExcitingFeature < Spinach::FeatureSteps\n step 'I do nothing' do\n pending 'step not implemented'\n end\nend\n" and "" into a single string literal, rather than using implicit string concatenation. Or, if they were intended to be separate method arguments, separate them with a comma.

houndci-bot · 2017-01-10T14:46:43Z

features/steps/step_auditing.rb

+    Given I exist
+    When I jump up and down
+    Then I should still exist
+""")


Prefer single-quoted strings when you don't need string interpolation or special symbols.

pedantic-git · 2017-01-10T14:49:00Z

I've taken care of the hound issues in most of the lib code, but I can't get the complexity of the audit_file method down any further without breaking the Auditor down into smaller classes. Let me know if you need me to do this.

I've ignored the issues reported on the step files because I'm assuming you don't have the same code review standards on those?

coveralls · 2017-01-10T14:56:25Z

Coverage remained the same at 100.0% when pulling 9ee1c03 on fishpercolator:master into 9821a0c on codegram:master.

coveralls · 2017-01-10T14:56:25Z

Coverage remained the same at 100.0% when pulling 9ee1c03 on fishpercolator:master into 9821a0c on codegram:master.

coveralls · 2017-01-10T14:57:14Z

Coverage remained the same at 100.0% when pulling 9ee1c03 on fishpercolator:master into 9821a0c on codegram:master.

josepjaume

Hi, thanks so much for your Pull Request! This is a really, really nice feature and you certainly put a lot of effort on it.

I'm 👍 on this - do you think you could update the Readme.md explaining how to use the feature?

We'll release a new version after merging. Thanks ❤️

josepjaume · 2017-01-15T21:29:09Z

Oh, and sorry for all Hound CI's trolling :(. It looks like we mistakenly activated it for this repo and, without further configuration, it's quite annoying - we usually don't follow some of his hints. Sorry you had to deal with it, but hopefully gave some useful advice!

pedantic-git · 2017-01-16T09:49:07Z

Hi @josepjaume - thanks for saying so! The feature has already saved me tons of time even though I only implemented it last week so I hope it will be useful for you and other users too!

I've added those instructions to the README as requested. Let me know if I can help with anything else!

coveralls · 2017-01-16T10:00:18Z

Coverage remained the same at 100.0% when pulling 5546f7c on fishpercolator:master into e75f3e9 on codegram:master.

coveralls · 2017-01-16T10:00:18Z

Coverage remained the same at 100.0% when pulling c238aa2 on fishpercolator:master into 9821a0c on codegram:master.

coveralls · 2017-01-16T10:03:55Z

Coverage remained the same at 100.0% when pulling 5546f7c on fishpercolator:master into e75f3e9 on codegram:master.

coveralls · 2017-01-16T10:03:55Z

Coverage remained the same at 100.0% when pulling 5546f7c on fishpercolator:master into e75f3e9 on codegram:master.

coveralls · 2017-01-16T10:03:55Z

Coverage remained the same at 100.0% when pulling 5546f7c on fishpercolator:master into e75f3e9 on codegram:master.

coveralls · 2017-01-16T10:03:55Z

Coverage remained the same at 100.0% when pulling 5546f7c on fishpercolator:master into e75f3e9 on codegram:master.

coveralls · 2017-01-16T10:03:55Z

Coverage remained the same at 100.0% when pulling 5546f7c on fishpercolator:master into e75f3e9 on codegram:master.

coveralls · 2017-01-16T10:03:55Z

Coverage remained the same at 100.0% when pulling 5546f7c on fishpercolator:master into e75f3e9 on codegram:master.

coveralls · 2017-01-16T10:03:55Z

Coverage remained the same at 100.0% when pulling 5546f7c on fishpercolator:master into e75f3e9 on codegram:master.

pedantic-git added 5 commits January 9, 2017 14:43

Add features for --audit

2142350

Get the most basic auditor working, prior to tidyup/refactor

5367e55

Make it nicer to look at and do a little refactoring

d8ca0db

Much progress - just a few kinks to iron out

76ec146

Last few bugs and scenarios to defend them

2b0814c