ndr_dev_support 5.8.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9b878ad48df8dc40c659917f099ea1c3da1b500cfb691bfae12e6c96bcc99d6
-  data.tar.gz: 3a698ad806791e2f6396655de2bfdcd3b004154a27ca29af5bb44b887774179e
+  metadata.gz: 5d2619e04b75d121a98f4b49e15bcb35152b7bae2ff03586ac2eb9609c9a2008
+  data.tar.gz: c6cfff26810411f1744c40ee9496c4dc3ced957521a5b983a43d294748bdddd3
 SHA512:
-  metadata.gz: b0386fd7910a6bd53ecf101a7a365f1decfab0dab3900518482755f2fb6de3f9c0a6d5a5e277eedc6974462aa9a8d6ea5fee0dfe7d301fb365dfd0dc919967a6
-  data.tar.gz: e2fc2e48785bee63f870f0a84c70354986974172a3b65c21f3b46db323b88423ec2975879a6f6dba5b60bd2283d37ddd9fbfccfe800b2508b39612fae6c65e84
+  metadata.gz: 8fa1e81dcdebb916400971a58eae24f940a91962c571fbebfbf37d0ec7e8caaf9f66f8052d58b73ece5302b80c36c4b1037daeee48f645bf44d39241d3b07cf0
+  data.tar.gz: 7d5ebe7e388660c72e1cde750b0e44be824cb26b2261d885de258f663c1b86fefd475263bc5580aee7498f460374d6053595080ecddfc611b3292ea5c42d0c0d

data/CHANGELOG.md

@@ -1,6 +1,38 @@
 ## [Unreleased]
 *no unreleased changes*
 
+## 6.0.0 / 2021-02-25
+### Changed
+* Linting: return a zero exit status when there are no lintable changes (#97)
+
+## 5.10.2 / 2021-02-15
+### Fixed
+* Fixed an issue using `flakey_test` with `minitest` v5.11 onwards
+* Allow use with Rails 6.1
+
+## 5.10.1 / 2021-02-01
+### Fixed
+* Fixed an issue with binary files breaking certain code audit modes (#94)
+
+## 5.10.0 / 2021-01-29
+### Added
+* Added `test_repeatedly` for integration test debugging (#85)
+* Added `outfile` and `filter` options to code auditing (#93)
+
+### Fixed
+* Fixed excessive `parser/current` warnings (#91)
+* Improved performance of interactive code auditing (#93)
+
+## 5.9.0 / 2021-01-12
+### Added
+* Move to keep up with Rubocop releases
+* Add `rubocop-rake`, for additional rake-specific Rubocop checks
+* Disable browser animations in the test environment by default
+
+### Fixed
+* Fix unnecessary 'parser/current' warnings when not using rubocop
+* Test against Ruby 3.0
+
 ## 5.8.2 / 2020-07-22
 ### Fixed
 * Tweak integration testing driver config, for capybara 3.33.0 deprecations

data/README.md

@@ -1,4 +1,4 @@
-## NdrDevSupport [![Maintainability](https://api.codeclimate.com/v1/badges/2b2a644964f2aa930f81/maintainability)](https://codeclimate.com/github/PublicHealthEngland/ndr_dev_support/maintainability) [![Build Status](https://travis-ci.org/PublicHealthEngland/ndr_dev_support.svg?branch=master)](https://travis-ci.org/PublicHealthEngland/ndr_dev_support) [![Gem Version](https://badge.fury.io/rb/ndr_dev_support.svg)](https://badge.fury.io/rb/ndr_dev_support)
+## NdrDevSupport [![Maintainability](https://api.codeclimate.com/v1/badges/2b2a644964f2aa930f81/maintainability)](https://codeclimate.com/github/PublicHealthEngland/ndr_dev_support/maintainability) [![Build Status](https://github.com/publichealthengland/ndr_dev_support/workflows/Test/badge.svg)](https://github.com/publichealthengland/ndr_dev_support/actions?query=workflow%3Atest) [![Gem Version](https://badge.fury.io/rb/ndr_dev_support.svg)](https://badge.fury.io/rb/ndr_dev_support)
 
 This is the Public Health England (PHE) National Disease Registers (NDR) Developer Support ruby gem,
 providing:
@@ -156,6 +156,22 @@ end
 
 If tests still fail, they'll fail as normal. If tests pass after flakey failure, they'll be flagged to the RakeCI server, and rendered in purple on Slack.
 
+#### Repeating Flakey Tests
+
+To aid with investigations into potentially-flakey tests, `ndr_dev_support` also provides the ability to run an integration test repeatedly (by default, 100 times):
+
+```ruby
+test_repeatedly 'thing that we think might fail' do
+  # something flakey
+end
+
+test_repeatedly 'thing that we think might fail very occassionally', times: 1000 do
+  # something slightly flakey
+end
+```
+
+This may be faster to work with than repeatedly executing the entire test runner in a bash loop, for example.
+
 ### Deployment support
 
 There are various capistrano plugins in the `ndr_dev_support/capistrano` directory - see each one for details.

data/code_safety.yml

@@ -1,5 +1,17 @@
 ---
 file safety:
+  ".github/CODEOWNERS":
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: ae4a81930ad3ab1b858474bc73b714aeed0f83a8
+  ".github/workflows/lint.yml":
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 0ce43640c417e174054f903fd82043948ebe8ccb
+  ".github/workflows/test.yml":
+    comments: 
+    reviewed_by: joshpencheon
+    safe_revision: 366ef1122fa4502c25cba9e508c565989545ef25
   ".gitignore":
     comments: 
     reviewed_by: josh.pencheon
@@ -12,14 +24,10 @@ file safety:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: 6211cff0ce44645ed3752723b5b0ee65f24c66aa
-  ".travis.yml":
-    comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 1f2197bd4ea2f4330dae266eec6983e86482b613
   CHANGELOG.md:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 49a8831328fb7d24f8f6f91c5295e8f8348a383d
+    reviewed_by: joshpencheon
+    safe_revision: 0edd51580039e7ebf99ce629d26c8d61656dfc5f
   CODE_OF_CONDUCT.md:
     comments: 
     reviewed_by: timgentry
@@ -35,7 +43,7 @@ file safety:
   README.md:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: e389930b98976f20e3fc94c771e5c456b729f8cb
+    safe_revision: a18f35895baebb1b0971043b3b3f666bb4eb9b5c
   Rakefile:
     comments: 
     reviewed_by: josh.pencheon
@@ -51,15 +59,19 @@ file safety:
   config/rubocop/ndr.yml:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 6211cff0ce44645ed3752723b5b0ee65f24c66aa
+    safe_revision: 05476acacadfa0ad7404f3c37cf3c17c4e0ba11b
   gemfiles/Gemfile.rails52:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: a844e9e392a38b456b21789a8f05b9038903865a
+    reviewed_by: joshpencheon
+    safe_revision: f25001ef74c44ab727eef5cb29cef9a54525d36f
   gemfiles/Gemfile.rails60:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 38266fd047417ecb4d5e6de71746f40495fc9de9
+    reviewed_by: joshpencheon
+    safe_revision: f25001ef74c44ab727eef5cb29cef9a54525d36f
+  gemfiles/Gemfile.rails61:
+    comments: 
+    reviewed_by: joshpencheon
+    safe_revision: f25001ef74c44ab727eef5cb29cef9a54525d36f
   lib/minitest/rake_ci.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -115,7 +127,7 @@ file safety:
   lib/ndr_dev_support/integration_testing.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: a2f178853da640112cf3063ca1d640157c9edb9f
+    safe_revision: 5b427cb12907bc87e5e0cb754dcaa524fdbfb1b9
   lib/ndr_dev_support/integration_testing/drivers/chrome.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -142,8 +154,8 @@ file safety:
     safe_revision: f1a32b1f2d1851b87a883dbf8620aa0e921e436c
   lib/ndr_dev_support/integration_testing/flakey_tests.rb:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: a2f178853da640112cf3063ca1d640157c9edb9f
+    reviewed_by: joshpencheon
+    safe_revision: 9fc4527cbc132218533cec8d696bd2aadd4a2291
   lib/ndr_dev_support/rake_ci/brakeman_helper.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -187,23 +199,23 @@ file safety:
   lib/ndr_dev_support/rubocop/executor.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: e56876f46536ba006a9b68029306f41a188bf9c6
+    safe_revision: 1d8a97dc5dd2e58bfd689d5e2c94e077a4ca0649
   lib/ndr_dev_support/rubocop/inject.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 6211cff0ce44645ed3752723b5b0ee65f24c66aa
+    safe_revision: 1d8a97dc5dd2e58bfd689d5e2c94e077a4ca0649
   lib/ndr_dev_support/rubocop/range_augmenter.rb:
     comments: 
-    reviewed_by: joshpencheon
-    safe_revision: fe5f0a693b77eeecaa39ff6fcf87ad59c4fb46e1
+    reviewed_by: josh.pencheon
+    safe_revision: 136936265a5b79f0eca1bc7e58c607a2492e57a5
   lib/ndr_dev_support/rubocop/range_finder.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 41cf1558f567928faaa1e670a36d941c03c78044
+    safe_revision: 1d8a97dc5dd2e58bfd689d5e2c94e077a4ca0649
   lib/ndr_dev_support/rubocop/reporter.rb:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 41cf1558f567928faaa1e670a36d941c03c78044
+    reviewed_by: joshpencheon
+    safe_revision: 0c1489e51848d8e7a0903128ea934064c0ab254e
   lib/ndr_dev_support/slack_message_publisher.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -214,13 +226,13 @@ file safety:
     safe_revision: 2154aa7f32e731933ff6091b8f42b2b014028a6a
   lib/ndr_dev_support/version.rb:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 49a8831328fb7d24f8f6f91c5295e8f8348a383d
+    reviewed_by: joshpencheon
+    safe_revision: 0edd51580039e7ebf99ce629d26c8d61656dfc5f
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support
     reviewed_by: josh.pencheon
-    safe_revision: 810858eb1acb297625708de6ddf8179c528c48f4
+    safe_revision: cc586e0bcb9b636a4aab19198dfc99171ef49f50
   lib/tasks/ci/brakeman.rake:
     comments: 
     reviewed_by: josh.pencheon
@@ -287,12 +299,16 @@ file safety:
     safe_revision: 9f33cc3f6fed0c24cb215befa1beaa4bc03e81ef
   ndr_dev_support.gemspec:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: f4c1ea57d3eb817783fdc47a16169d215f9788a6
+    reviewed_by: joshpencheon
+    safe_revision: 9fc4527cbc132218533cec8d696bd2aadd4a2291
   test/daemon/ci_server_test.rb:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: cdd176f2e90284e11899c5c6eea1032f9b785b74
+  test/integration_testing/flakey_tests_test.rb:
+    comments: 
+    reviewed_by: joshpencheon
+    safe_revision: 9fc4527cbc132218533cec8d696bd2aadd4a2291
   test/ndr_dev_support_test.rb:
     comments: 
     reviewed_by: timgentry

data/config/rubocop/ndr.yml

@@ -6,8 +6,13 @@
 
 require:
   - rubocop-rails
+  - rubocop-rake
 
 AllCops:
+  # Given we take a "follow the herd" approach, with this file
+  # containing just deviations, enable new cops by default.
+  NewCops: enable
+
   # All cops should ignore files in the following locations:
   Exclude:
   - 'bin/*'
@@ -127,6 +132,11 @@ Rails/DynamicFindBy:
   Exclude:
   - 'test/integration/**/*.rb'
 
+Rails/RakeEnvironment:
+  # Particularly without spring, this can make things that should be quick
+  # slower than desirable.
+  Enabled: false
+
 Rails/RefuteMethods:
   Enabled: false
 

data/gemfiles/Gemfile.rails52

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
-
 gemspec path: '..'
 
 gem 'activesupport', '~> 5.2.0'

data/gemfiles/Gemfile.rails60

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 gemspec path: '..'
 
-gem 'activesupport', '~> 6.0.0rc1'
-
+gem 'activesupport', '~> 6.0.0'

data/gemfiles/Gemfile.rails61

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec path: '..'
+
+gem 'activesupport', '~> 6.1.0'

data/lib/ndr_dev_support/integration_testing.rb

@@ -35,5 +35,8 @@ require 'ndr_dev_support/integration_testing/drivers/switchable'
 Capybara.default_driver    = :switchable
 Capybara.javascript_driver = :switchable
 
+# Inject middleware to disable jQuery fx, CSS transitions/animations
+Capybara.disable_animation = true
+
 Capybara.save_path = Rails.root.join('tmp', 'screenshots')
 Capybara::Screenshot.prune_strategy = { keep: 20 }

data/lib/ndr_dev_support/integration_testing/flakey_tests.rb

@@ -15,6 +15,12 @@ module NdrDevSupport
             self.attempts_per_test = attempts_per_test.merge(test_name.to_s => attempts)
           end
         end
+
+        def test_repeatedly(description, times: 100, &block)
+          (1..times).map do |n|
+            test("#{description} - #{n}/#{times}", &block)
+          end
+        end
       end
 
       def flakes
@@ -27,11 +33,12 @@ module NdrDevSupport
 
         previous_failure = failures.last
         failed_attempts = []
+        result = nil
 
         loop do
           break if attempts_remaining < 1
 
-          super
+          result = super
 
           # No failure was added; we passed!
           break if failures.last == previous_failure
@@ -46,10 +53,12 @@ module NdrDevSupport
         # Attempts were only flakey if we eventually passed:
         flakes.concat(failed_attempts) if failures.last == previous_failure
 
-        self
+        result
       end
     end
   end
 end
 
-ActionDispatch::IntegrationTest.include(NdrDevSupport::IntegrationTesting::FlakeyTests)
+if defined?(ActionDispatch)
+  ActionDispatch::IntegrationTest.include(NdrDevSupport::IntegrationTesting::FlakeyTests)
+end

data/lib/ndr_dev_support/rubocop/executor.rb

@@ -10,7 +10,7 @@ module NdrDevSupport
       class << self
         # Use RuboCop to produce a list of all files that should be scanned.
         def target_files
-          @target_files ||= `rubocop -L`.each_line.map(&:strip)
+          @target_files ||= `rubocop -L 2>/dev/null`.each_line.map(&:strip)
         end
       end
 
@@ -23,7 +23,7 @@ module NdrDevSupport
       def offenses_by_file
         return [] if @filenames.empty?
 
-        output = JSON.parse(`rubocop --format json #{escaped_paths.join(' ')}`)
+        output = JSON.parse(`rubocop --format json #{escaped_paths.join(' ')} 2>/dev/null`)
 
         output['files'].each_with_object({}) do |file_output, result|
           result[file_output['path']] = file_output['offenses']

data/lib/ndr_dev_support/rubocop/inject.rb

@@ -1,4 +1,12 @@
-require 'rubocop'
+require 'stringio'
+
+begin
+  # Go nuclear on "warning: parser/current ..."
+  $stderr = StringIO.new
+  require 'rubocop'
+ensure
+  $stderr = STDERR
+end
 
 module NdrDevSupport
   module Rubocop

data/lib/ndr_dev_support/rubocop/range_augmenter.rb

@@ -4,8 +4,6 @@ module NdrDevSupport
     # all lines covered, expanding the ranges to include full method
     # defintions, and class/module headers.
     class RangeAugmenter
-      require 'parser/current'
-
       MODULE_TYPES = [:module, :class].freeze
       METHOD_TYPES = [:def, :defs].freeze
 
@@ -27,6 +25,7 @@ module NdrDevSupport
       end
 
       def augmented_lines
+        require 'parser/current'
         root  = Parser::CurrentRuby.parse IO.read(filename)
         nodes = extract_augmenting_nodes(root)
 

data/lib/ndr_dev_support/rubocop/range_finder.rb

@@ -1,6 +1,5 @@
 require 'English'
 require 'open3'
-require 'rubocop'
 require 'shellwords'
 
 module NdrDevSupport

data/lib/ndr_dev_support/rubocop/reporter.rb

@@ -22,15 +22,16 @@ module NdrDevSupport
       # Prints out a report, and returns an appriopriate
       # exit status for the rake task to terminate with.
       def report
-        if @offenses.any?
-          print_summary
-          puts
-          print_offenses
-          return @offenses.values.all?(&:empty?)
-        else
-          puts Rainbow('No relevant changes found.').yellow
-          return false
+        if @offenses.none?
+          warn Rainbow('No relevant changes found.').yellow
+          return true
         end
+
+        print_summary
+        puts
+        print_offenses
+
+        @offenses.values.all?(&:empty?)
       end
 
       private

data/lib/ndr_dev_support/version.rb

@@ -2,5 +2,5 @@
 # This defines the NdrDevSupport version. If you change it, rebuild and commit the gem.
 # Use "rake build" to build the gem, see rake -T for all bundler rake tasks (and our own).
 module NdrDevSupport
-  VERSION = '5.8.2'.freeze
+  VERSION = '6.0.0'.freeze
 end

data/lib/tasks/audit_code.rake

@@ -1,3 +1,4 @@
+require 'csv'
 require 'pathname'
 require 'yaml'
 
@@ -10,9 +11,6 @@ SAFETY_FILE =
     Pathname.new('code_safety.yml').expand_path
   end
 
-# Temporary overrides to only audit external access files
-SAFETY_REPOS = [['/svn/era', '/svn/extra/era/external-access']]
-
 # Returns the (Bundler aware) rake command
 def rake_cmd
   ENV['BUNDLE_BIN_PATH'] ? 'bundle exec rake' : 'rake'
@@ -48,12 +46,11 @@ end
 
 # Parameter max_print is number of entries to print before truncating output
 # (negative value => print all)
-def audit_code_safety(max_print = 20, ignore_new = false, show_diffs = false, show_in_priority = false, usr = 'usr', interactive = false)
-  puts 'Running source code safety audit script.'
-  puts
-
+def audit_code_safety(max_print = 20, ignore_new = false, show_diffs = false, usr = 'usr', interactive = false, outfile = nil, filter = nil)
   max_print = 1_000_000 if max_print.negative?
   show_diffs = true if interactive
+  ignore_new = true if filter
+
   file_safety = load_file_safety
   file_safety.each_value do |v|
     rev = v['safe_revision']
@@ -63,76 +60,143 @@ def audit_code_safety(max_print = 20, ignore_new = false, show_diffs = false, sh
 
   safety_repo = trunk_repo = get_trunk_repo
 
-  # TODO: below is broken for git-svn
-  # Is it needed?
-
-  SAFETY_REPOS.each do |suffix, alt|
-    # Temporarily override to only audit a different file list
-    if safety_repo.end_with?(suffix)
-      safety_repo = safety_repo[0...-suffix.length] + alt
-      break
-    end
-  end
-
   if ignore_new
     puts "Not checking for new files in #{safety_repo}"
   else
     puts "Checking for new files in #{safety_repo}"
-    new_files = get_new_files(safety_repo)
-    # Ignore subdirectories, and exclude code_safety.yml by default.
-    new_files.delete_if { |f| f =~ /[\/\\]$/ || Pathname.new(f).expand_path == SAFETY_FILE }
-    new_files.each { |f| add_new_file_to_file_safety(file_safety, f) }
-    update_safety_file(file_safety) # Save changes before checking latest revisions
+    add_new_files(safety_repo, file_safety)
   end
-  puts "Updating latest revisions for #{file_safety.size} files"
-  set_last_changed_revision(trunk_repo, file_safety, file_safety.keys)
-  puts "\nSummary:"
-  puts "Number of files originally in #{SAFETY_FILE}: #{orig_count}"
-  puts "Number of new files added: #{file_safety.size - orig_count}"
 
   missing_files = file_safety.keys.reject { |path| File.file?(path) }
+  abort(<<~MESSAGE) if missing_files.any?
 
-  unless missing_files.empty?
-    puts "Number of files no longer in repository but in code_safety.yml: #{missing_files.length}"
-    puts "  Please run #{rake_cmd} audit:tidy_code_safety_file to remove redundant files"
-    missing_files.each { |path| puts '  ' + path }
+    The following file(s) no longer exist in the repository:
+      #{missing_files.join("\n  ")}
+
+    Please run `#{rake_cmd} audit:tidy_code_safety_file` to remove them.
+  MESSAGE
+
+  if filter
+    filter_file_safety(file_safety, filter)
+    puts "Applying provided file filter: #{file_safety.size} file(s) remain"
   end
 
-  # Now generate statistics:
-  unknown = file_safety.values.select { |x| x['safe_revision'].nil? }
-  unsafe = file_safety.values.select do |x|
-    !x['safe_revision'].nil? && x['safe_revision'] != -1 &&
-      x['last_changed_rev'] != x['safe_revision'] &&
-      !(x['last_changed_rev'] =~ /^[0-9]+$/ && x['safe_revision'] =~ /^[0-9]+$/ &&
-      x['last_changed_rev'].to_i < x['safe_revision'].to_i)
+  if interactive
+    run_review_wizard(trunk_repo, file_safety, usr)
+
+    # Post-wizard, reload the results and continue to print a summary:
+    file_safety = load_file_safety
+    filter_file_safety(file_safety, filter) if filter
+
+    max_print = 0
+    show_diffs = false
+  else
+    # Get updates for all files in one go:
+    puts "Updating latest revisions for #{file_safety.size} files"
+    set_last_changed_revisions(trunk_repo, file_safety)
   end
-  puts "Number of files with no safe version: #{unknown.size}"
-  puts "Number of files which are no longer safe: #{unsafe.size}"
+
+  print_summary(file_safety, usr, trunk_repo, max_print, show_diffs, orig_count, ignore_new, outfile, filter)
+end
+
+def filter_file_safety(file_safety, filter)
+  filtered_paths = CSV.read(filter, headers: true).map { |row| row.to_h.fetch('path') }
+  file_safety.select! { |fname, _entry| filtered_paths.include?(fname) }
+end
+
+def run_review_wizard(trunk_repo, file_safety, usr)
+  puts <<~INTRO
+
+    In interactive mode, you'll be presented with one diff at a time for review.
+
+    For each diff, you can enter a decision (if you can make one) along with
+    any comments you may have, before being taken to the next diff.
+
+  INTRO
+
+  file_safety.each_key do |fname|
+    set_last_changed_revision(trunk_repo, file_safety, fname)
+    next unless print_file_safety(file_safety, fname, false, true)
+
+    print_file_diffs(file_safety, trunk_repo, fname, usr, true)
+  end
+end
+
+def print_summary(file_safety, usr, trunk_repo, max_print, show_diffs, orig_count, ignore_new, outfile, filter)
+  puts "\nSummary:"
+  puts "Number of files originally in #{SAFETY_FILE}: #{orig_count}"
+  puts "Number of new files added: #{file_safety.size - orig_count}" unless ignore_new
+
+  # Now generate statistics:
+  unknown = file_safety.values.select { |x| unreviewed?(x) }
+  unsafe = file_safety.values.select { |x| stale_review?(x) }
+  puts "Number of#{' filtered' if filter} files with no safe version: #{unknown.size}"
+  puts "Number of#{' filtered' if filter} files which are no longer safe: #{unsafe.size}"
   puts
   printed = []
-  # We also print a third category: ones which are no longer in the repository
+
   file_list =
-    if show_in_priority
-      file_safety.sort_by { |_k, v| v.nil? ? -100 : v['last_changed_rev'].to_i }.map(&:first)
-    else
-      file_safety.keys.sort
-    end
+      file_safety.
+      sort_by { |_k, v| v.nil? ? -100 : v['last_changed_rev'].to_i }.
+      map(&:first)
 
   file_list.each do |f|
     printed << f if print_file_safety(file_safety, f, false, printed.size >= max_print)
   end
-  puts "... and #{printed.size - max_print} others" if printed.size > max_print
+  puts "... and #{printed.size - max_print} others" if printed.size > max_print && max_print > 0
   if show_diffs
     puts
     printed.each do |f|
-      print_file_diffs(file_safety, trunk_repo, f, usr, interactive)
+      print_file_diffs(file_safety, trunk_repo, f, usr, false)
     end
   end
 
+  export_csv(trunk_repo, file_safety, printed, outfile) if outfile
+
   # Returns `true` unless there are pending reviews:
   unsafe.length.zero? && unknown.length.zero?
 end
 
+def export_csv(repo, file_safety, printed, outfile)
+  CSV.open(outfile, 'w') do |csv|
+    csv << %w[path last_changed_revision safe_revision diff_lines]
+
+    file_safety.each do |fname, entry|
+      # Only emit files needing review:
+      next unless printed.include?(fname)
+
+      last_changed_revision = entry['last_changed_rev']
+      safe_revision = entry['safe_revision']
+
+      _cmd, diffs = capture_file_diffs(repo, fname, safe_revision, last_changed_revision)
+      diff_lines = diffs.force_encoding('BINARY').split("\n").length
+
+      csv << [fname, last_changed_revision, safe_revision, diff_lines]
+    end
+  end
+
+  puts <<~MESSAGE
+
+    CSV output exported to: #{outfile}
+
+  MESSAGE
+end
+
+def stale_review?(entry)
+  return false if unreviewed?(entry)
+
+  # Could be comparing Git SHAs, or SVN revisions:
+  entry['last_changed_rev'] != entry['safe_revision']
+end
+
+def unreviewed?(entry)
+  entry['safe_revision'].nil?
+end
+
+def needs_review?(entry)
+  unreviewed?(entry) || stale_review?(entry)
+end
+
 # Print summary details of a file's known safety
 # If not verbose, only prints details for unsafe files
 # Returns true if anything printed (or would have been printed if silent),
@@ -210,14 +274,11 @@ def get_trunk_repo
   case repository_type
   when 'svn'
     repo_info = %x[svn info]
-    puts 'svn case'
     repo_info.split("\n").select { |x| x =~ /^URL: / }.collect { |x| x[5..-1] }.first
   when 'git-svn'
-    puts 'git-svn case'
     repo_info = %x[git svn info]
     repo_info.split("\n").select { |x| x =~ /^URL: / }.collect { |x| x[5..-1] }.first
   when 'git'
-    puts 'git case'
     repo_info = %x[git remote -v]
     repo_info.split("\n").first[7..-9]
   else
@@ -225,69 +286,45 @@ def get_trunk_repo
   end
 end
 
-def get_new_files(safety_repo)
-  case repository_type
-  when 'svn', 'git-svn'
-    %x[svn ls -R "#{safety_repo}"].split("\n")
-  when 'git'
-    #%x[git ls-files --modified].split("\n")
-    %x[git ls-files].split("\n")
+def add_new_files(safety_repo, file_safety)
+  new_files =
+    case repository_type
+    when 'svn', 'git-svn'
+      %x[svn ls -R "#{safety_repo}"].split("\n")
+    when 'git'
+      %x[git ls-files].split("\n")
+    else
+      []
+    end
 
-    # TODO: Below is for remote repository - for testing use local files
-    #new_files = %x[git ls-files --modified #{safety_repo}].split("\n")
-    # TODO: Do we need the --modified option?
-    #new_files = %x[git ls-files --modified].split("\n")
-  else
-    []
-  end
+  # Ignore subdirectories, and exclude code_safety.yml by default.
+  new_files.delete_if { |f| f =~ /[\/\\]$/ || Pathname.new(f).expand_path == SAFETY_FILE }
+
+  # Save changes before checking latest revisions
+  new_files.each { |f| add_new_file_to_file_safety(file_safety, f) }
+  update_safety_file(file_safety)
 end
 
 # Fill in the latest changed revisions in a file safety map.
 # (Don't write this data to the YAML file, as it is intrinsic to the SVN
 # repository.)
-def set_last_changed_revision(repo, file_safety, fnames)
-  dot_freq = (file_safety.size / 40.0).ceil # Print up to 40 progress dots
-  case repository_type
-  when 'git'
-    fnames = file_safety.keys if fnames.nil?
-
-    fnames.each_with_index do |f, i|
-      info = %x[git log -n 1 -- #{f}].split("\n").first[7..-1]
-      if info.nil? || info.empty?
-        file_safety[f]['last_changed_rev'] = -1
-      else
-        file_safety[f]['last_changed_rev'] = info
-      end
-      # Show progress
-      print '.' if (i % dot_freq) == 0
-    end
-    puts
-  when 'git-svn', 'svn'
-    fnames = file_safety.keys if fnames.nil?
-
-    fnames.each_with_index do |f, i|
-      last_revision = get_last_changed_revision(repo, f)
-      if last_revision.nil? || last_revision.empty?
-        file_safety[f]['last_changed_rev'] = -1
-      else
-        file_safety[f]['last_changed_rev'] = last_revision
-      end
-      # Show progress
-      print '.' if (i % dot_freq) == 0
-    end
-    puts
-    # NOTE: Do we need the following for retries?
-#     if retries && result.size != fnames.size && fnames.size > 1
-#        # At least one invalid (deleted file --> subsequent arguments ignored)
-#        # Try each file individually
-#        # (It would probably be safe to continue from the extra_info.size argument)
-#        puts "Retrying (got #{result.size}, expected #{fnames.size})" if debug >= 2
-#        result = []
-#        fnames.each{ |f|
-#           result += svn_info_entries([f], repo, false, debug)
-#        }
-#      end
+def set_last_changed_revisions(repo, file_safety)
+  fnames = file_safety.keys
+  dot_freq = (fnames.size / 40.0).ceil # Print up to 40 progress dots
+
+  fnames.each_with_index do |f, i|
+    set_last_changed_revision(repo, file_safety, f)
+    print '.' if (i % dot_freq) == 0
   end
+  puts
+end
+
+# Fill in the latest changed revision for the given file in a file safety map.
+def set_last_changed_revision(repo, file_safety, fname)
+  last_revision = get_last_changed_revision(repo, fname)
+  last_revision = -1 if last_revision.blank?
+
+  file_safety[fname]['last_changed_rev'] = last_revision
 end
 
 # Return the last changed revision
@@ -331,31 +368,44 @@ def root_revision
   end
 end
 
+def capture_file_diffs(repo, fname, safe_revision, repolatest)
+  cmd =
+    case repository_type
+    when 'git'
+      cmd = ['git', '--no-pager', 'diff', '--color', '-b', "#{safe_revision}..#{repolatest}", fname]
+    when 'git-svn', 'svn'
+      cmd = ['svn', 'diff', '-r', "#{safe_revision.to_i}:#{repolatest.to_i}", '-x', '-b', "#{repo}/#{fname}"]
+    end
+
+  stdout_and_err_str, _status = Open3.capture2e(*cmd)
+
+  if stdout_and_err_str.start_with?('fatal: Invalid revision range ')
+    abort <<~ERROR
+      Error running:
+        #{cmd}
+
+      Invalid commit ID in code_safety.yml for #{fname}? (#{safe_revision})
+    ERROR
+  end
+
+  [cmd.join(' '), stdout_and_err_str]
+end
+
 def print_repo_file_diffs(repolatest, repo, fname, usr, safe_revision, interactive)
   require 'open3'
   require 'highline/import'
 
   if interactive
-    ask("\n<%= color('Press Enter to continue ...', :yellow) %>")
+    ask("<%= color('Press Enter to continue ...', :yellow) %>")
     system('clear')
     system("printf '\033[3J'") # clear the scrollback
   end
 
-  cmd = nil
-  case repository_type
-  when 'git'
-    cmd = ['git', '--no-pager', 'diff', '--color', '-b', "#{safe_revision}..#{repolatest}", fname]
-  when 'git-svn', 'svn'
-    cmd = ['svn', 'diff', '-r', "#{safe_revision.to_i}:#{repolatest.to_i}", '-x', '-b', "#{repo}/#{fname}"]
-  end
-  if cmd
-    puts(cmd.join(' '))
-    stdout_and_err_str, _status = Open3.capture2e(*cmd)
-    puts 'Invalid commit ID in code_safety.yml ' + safe_revision if stdout_and_err_str.start_with?('fatal: Invalid revision range ')
-    puts(stdout_and_err_str)
-  else
-    puts 'Unknown repo'
-  end
+  cmd, diffs = capture_file_diffs(repo, fname, safe_revision, repolatest)
+  puts cmd
+  puts
+  puts diffs
+  puts
 
   if interactive
     response = ask("Flag #{fname} changes safe? [Yes|No|Abort]: ") { |q| q.case = :down }
@@ -363,18 +413,19 @@ def print_repo_file_diffs(repolatest, repo, fname, usr, safe_revision, interacti
       puts 'Flagging as safe...'
       release = get_release(repolatest)
       if usr.to_s.strip.empty?
-        usr = ask('File reviewed by:') do |q|
+        usr = ask('File reviewed by: ') do |q|
           q.whitespace = :strip_and_collapse
-          q.validate = /\A[\w \-.]+\Z/
+          q.validate = /\A[\w \-.]+\z/
         end
       end
-      comment = ask('Please write your comments (optional):')
+      comment = ask('Please write your comments (optional): ')
       # use to_s to convert response from !ruby/string:HighLine::String to String
       flag_file_as_safe(release, usr.to_s, comment.to_s, fname)
-    elsif %w[abort a].include?(response)
-      abort('Rake abort: user interrupt detected')
+    elsif response =~ /\Aa/i
+      say("\n<%= color('Aborted by user.', :red) %>")
+      abort
     else
-      say("\n<%= color('Safey review for #{fname} skipped by user.', :magenta) %>")
+      say("\n<%= color('Skipping review of #{fname}.', :magenta) %>")
     end
   else
     puts 'To flag the changes to this file as safe, run:'
@@ -436,17 +487,35 @@ File #{SAFETY_FILE} lists the safety and revision information
 of the era source code. This task updates the list, and [TODO] warns about
 files which have changed since they were last verified as safe."
   task(:code) do
-    puts 'Usage: audit:code [max_print=n] [ignore_new=false|true] [show_diffs=false|true] [show_in_priority=false|true] [reviewed_by=usr] [interactive=false|true]'
-    puts "This is a #{repository_type} repository"
+    puts <<~USAGE
+
+      NDR's code auditing tool.
+
+      Usage:
+
+        #{rake_cmd} audit:code
+          [interactive=false|true]      # use an interactive wizard to perform code review
+          [max_print=n]                 # limit the number of summary rows to n
+          [ignore_new=false|true]       # don't add new files to code_safety.yml
+          [show_diffs=false|true]       # display the full diff for each file
+          [reviewed_by=usr]             # your name, to author to any reviews added
+          [filter=path/to/input.csv]    # filter reviewing to only files specified in the filter file
+          [outfile=path/to/output.csv]  # dump a summary of outstanding review to CSV
+
+    USAGE
+
+    puts "This is a #{repository_type} repository."
+    puts
 
     ignore_new = (ENV['ignore_new'].to_s =~ /\Atrue\Z/i)
     show_diffs = (ENV['show_diffs'].to_s =~ /\Atrue\Z/i)
-    show_in_priority = (ENV['show_in_priority'].to_s =~ /\Atrue\Z/i)
     max_print = ENV['max_print'] =~ /\A-?[0-9][0-9]*\Z/ ? ENV['max_print'].to_i : 20
     reviewer  = ENV['reviewed_by']
     interactive = (ENV['interactive'].to_s =~ /\Atrue\Z/i)
+    filter = ENV['filter']
+    outfile = ENV['outfile']
 
-    all_safe = audit_code_safety(max_print, ignore_new, show_diffs, show_in_priority, reviewer, interactive)
+    all_safe = audit_code_safety(max_print, ignore_new, show_diffs, reviewer, interactive, outfile, filter)
 
     unless show_diffs || interactive
       puts "To show file diffs, run:  #{rake_cmd} audit:code max_print=-1 show_diffs=true"

data/ndr_dev_support.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ndr_dev_support/version'
 
@@ -12,14 +12,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/PublicHealthEngland/ndr_dev_support'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  # SECURE BNS 2018-08-06: Minimise sharing of (public-key encrypted) slack secrets in .travis.yml
-  spec.files         -= %w[.travis.yml] # Not needed in the gem
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.github|test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.add_dependency 'pry'
 
@@ -29,21 +27,22 @@ Gem::Specification.new do |spec|
   # Rubocop dependencies:
   spec.add_dependency 'parser'
   spec.add_dependency 'rainbow'
-  spec.add_dependency 'rubocop', '0.79.0'
-  spec.add_dependency 'rubocop-rails', '2.4.1'
+  spec.add_dependency 'rubocop', '~> 1.7'
+  spec.add_dependency 'rubocop-rake', '~> 0.5'
+  spec.add_dependency 'rubocop-rails', '~> 2.9'
   spec.add_dependency 'unicode-display_width', '>= 1.3.3'
 
   # Integration test dependencies:
-  spec.add_dependency 'capybara', '>= 3.20'
+  spec.add_dependency 'capybara', '>= 3.34'
   spec.add_dependency 'capybara-screenshot'
-  spec.add_dependency 'minitest', '~> 5.0'
+  spec.add_dependency 'minitest', '~> 5.11'
   spec.add_dependency 'poltergeist', '>= 1.8.0'
   spec.add_dependency 'selenium-webdriver'
   spec.add_dependency 'show_me_the_cookies'
   spec.add_dependency 'webdrivers', '>= 3.9'
 
   # CI server dependencies:
-  spec.add_dependency 'activesupport', '< 6.1'
+  spec.add_dependency 'activesupport', '< 7'
   spec.add_dependency 'brakeman', '>= 4.7.1'
   spec.add_dependency 'bundler-audit'
   spec.add_dependency 'github-linguist'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 5.8.2
+  version: 6.0.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -70,30 +70,44 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.20'
+        version: '3.34'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.20'
+        version: '3.34'
 - !ruby/object:Gem::Dependency
   name: capybara-screenshot
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +226,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: brakeman
   requirement: !ruby/object:Gem::Requirement
@@ -401,6 +415,7 @@ files:
 - config/rubocop/ndr.yml
 - gemfiles/Gemfile.rails52
 - gemfiles/Gemfile.rails60
+- gemfiles/Gemfile.rails61
 - lib/minitest/rake_ci.rb
 - lib/minitest/rake_ci_plugin.rb
 - lib/ndr_dev_support.rb
@@ -470,7 +485,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="