ndr_dev_support 5.6.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e945839e116f3076fe950ec01ddeb9a9442bfc1bf2132460bf5d2a15d983d362
-  data.tar.gz: a39d1a0b73260aa8c45ccd48e6f3c1478ac1db86a18952084b0d35bfa2b7c8a3
+  metadata.gz: 597318cf10af72895cde73338ece46a13d00893ec14c240ee24b4063c68bfef9
+  data.tar.gz: af273055a5d011e8897bcdbd164cd9d31b99175ad48c862de84ed4765cff6644
 SHA512:
-  metadata.gz: 2052481ce02c0fcb3947778df3132a2ce76d2848f8748970494a490926fcb8764275e953ab1f3169710325a774087deeb901bd70c676cc0b2bd1380945fb0610
-  data.tar.gz: 0a97dd68a18fbbc247a618f9c4fe23b3d66552c8971dba5dd54380f9c019d466c5cccea02bf5b498577ea8230723d95e7f36753c19c1b42556184c79ab7bc571
+  metadata.gz: 2368ad56bd91b4f48815998b8e4ccf5ed0fde7d62c337e99222ccc77c16619eaf696d5b30fe78be9048b256787da199d9b23142c2577e8ec2fd2a05021af1a8f
+  data.tar.gz: 8ef7192f3b4f8404982bdab883e2cde34c79bbaae9f58a22ef78a409a0eda1a6b492af343e72db7fe8b8096b042fba35c6d483faf5df171f064059c3af4f06b2

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 ## [Unreleased]
 *no unreleased changes*
 
+## 5.7.0 / 2020-03-26
+### Added
+* Add `ci:brakeman:strict` alternative CI task. (#77)
+* Send `brakeman_filtered_warnings` metrics. (#78)
+* Allow redmine tickets to be updated (but not resolved) when the build fails (#73)
+
+### Fixed
+* Stop including asset compilation caches in the deployment archive.
+* Ensure brakeman alerts aren't sent to Slack if they've been reviewed and filtered out
+
 ## 5.6.0 / 2020-02-14
 ### Added
 * Add `flakey_test` to the minitest DSL, to allow sporadic failures to be retried

data/README.md

@@ -1,4 +1,4 @@
-## NdrDevSupport [![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://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)
 
 This is the Public Health England (PHE) National Disease Registers (NDR) Developer Support ruby gem,
 providing:

data/code_safety.yml

@@ -19,7 +19,7 @@ file safety:
   CHANGELOG.md:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 8995f6ed25fa308e541c3d33396b0a30c4f4db80
+    safe_revision: 1f4383e983313441ba3b118891dfb1c3ff962368
   CODE_OF_CONDUCT.md:
     comments: 
     reviewed_by: timgentry
@@ -35,7 +35,7 @@ file safety:
   README.md:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: a2f178853da640112cf3063ca1d640157c9edb9f
+    safe_revision: b405f60e921805378ba1f3beaeb10cf1a8503182
   Rakefile:
     comments: 
     reviewed_by: josh.pencheon
@@ -99,7 +99,7 @@ file safety:
   lib/ndr_dev_support/capistrano/svn_cache.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 123d0cd32bdf9e0940fac8945985aa9f467616c1
+    safe_revision: 2baa360b06290775a961a7573fe08edd18f8312e
   lib/ndr_dev_support/capistrano/sysadmin_scripts.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -147,7 +147,7 @@ file safety:
   lib/ndr_dev_support/rake_ci/brakeman_helper.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: d3d238a863c0b016d2d782b1696964fa3f40738b
+    safe_revision: 053c9834ca5d402a1f8dc8d09257dc7075a5ec06
   lib/ndr_dev_support/rake_ci/commit_cop.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -179,7 +179,7 @@ file safety:
   lib/ndr_dev_support/rake_ci/redmine/ticket_resolver.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 2154aa7f32e731933ff6091b8f42b2b014028a6a
+    safe_revision: 12aad1254186ee9ce0fde263bf8dccf46cdfebe2
   lib/ndr_dev_support/rake_ci/simple_cov_helper.rb:
     comments: 
     reviewed_by: timgentry
@@ -215,7 +215,7 @@ file safety:
   lib/ndr_dev_support/version.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 8995f6ed25fa308e541c3d33396b0a30c4f4db80
+    safe_revision: 1f4383e983313441ba3b118891dfb1c3ff962368
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support
@@ -224,7 +224,7 @@ file safety:
   lib/tasks/ci/brakeman.rake:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 908c04663ca6949259f41fe38ee705f03774cbdf
+    safe_revision: 053c9834ca5d402a1f8dc8d09257dc7075a5ec06
   lib/tasks/ci/bundle_audit.rake:
     comments: 
     reviewed_by: josh.pencheon
@@ -248,7 +248,7 @@ file safety:
   lib/tasks/ci/minitest.rake:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 29b7dc86673f4f876667db95e79a57b20766077e
+    safe_revision: 12aad1254186ee9ce0fde263bf8dccf46cdfebe2
   lib/tasks/ci/notes.rake:
     comments: 
     reviewed_by: timgentry
@@ -260,7 +260,7 @@ file safety:
   lib/tasks/ci/redmine.rake:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 958ef09c5cf50bb50348e6bff949e3e5989254f9
+    safe_revision: 12aad1254186ee9ce0fde263bf8dccf46cdfebe2
   lib/tasks/ci/rugged.rake:
     comments: 
     reviewed_by: josh.pencheon
@@ -288,7 +288,7 @@ file safety:
   ndr_dev_support.gemspec:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: a2f178853da640112cf3063ca1d640157c9edb9f
+    safe_revision: f4c1ea57d3eb817783fdc47a16169d215f9788a6
   test/daemon/ci_server_test.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -316,7 +316,7 @@ file safety:
   test/rake_ci/redmine/ticket_resolver_test.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 2154aa7f32e731933ff6091b8f42b2b014028a6a
+    safe_revision: 12aad1254186ee9ce0fde263bf8dccf46cdfebe2
   test/test_helper.rb:
     comments: 
     reviewed_by: josh.pencheon

data/lib/ndr_dev_support/capistrano/svn_cache.rb

@@ -17,7 +17,13 @@ Capistrano::Configuration.instance(:must_exist).load do
         system("rm -rf #{cache}")
       end
     end
+
+    desc 'Ensures compilation artefacts are removed from the compressed archive sent to the server'
+    task :augment_copy_exclude do
+      set :copy_exclude, (fetch(:copy_exclude) || []) + %w[node_modules tmp/*]
+    end
   end
 
+  before 'deploy:update_code', 'ndr_dev_support:augment_copy_exclude'
   before 'deploy:update_code', 'ndr_dev_support:remove_svn_cache_if_needed'
 end

data/lib/ndr_dev_support/rake_ci/brakeman_helper.rb

@@ -10,7 +10,9 @@ module NdrDevSupport
 
       attr_reader :new_fingerprints, :old_fingerprints, :tracker
 
-      def run
+      def run(strict:)
+        @strict = strict
+
         @tracker = ::Brakeman.run(app_path: '.')
 
         last_commit_fingerprints = load_last_commit_data
@@ -22,10 +24,16 @@ module NdrDevSupport
         end
       end
 
+      # All warnings (including those we've flagged as false positives)
       def warnings
         @tracker.warnings
       end
 
+      # Only the warnings we haven't flagged as false positives (i.e. the outstanding ones)
+      def filtered_warnings
+        @tracker.filtered_warnings
+      end
+
       def warning_counts_by_confidence
         return @warning_counts_by_confidence if @warning_counts_by_confidence
 
@@ -36,13 +44,90 @@ module NdrDevSupport
         @warning_counts_by_confidence
       end
 
+      def filtered_warning_counts_by_confidence
+        return @filtered_warning_counts_by_confidence if @filtered_warning_counts_by_confidence
+
+        @filtered_warning_counts_by_confidence = {}
+        filtered_warnings.group_by(&:confidence).each do |confidence, grouped_warnings|
+          @filtered_warning_counts_by_confidence[confidence] = grouped_warnings.count
+        end
+        @filtered_warning_counts_by_confidence
+      end
+
       def current_fingerprints
-        @current_fingerprints ||= warnings.map(&:fingerprint).to_set
+        @current_fingerprints ||= filtered_warnings.map(&:fingerprint).to_set
       end
 
       def save_current_fingerprints
         save_current_commit_data(current_fingerprints)
       end
+
+      def metrics
+        metrics = []
+
+        ::Brakeman::Warning::TEXT_CONFIDENCE.each do |confidence, text|
+          overall_metric = {
+            name: 'brakeman_warnings',
+            type: :gauge,
+            label_set: { confidence: text },
+            value: warning_counts_by_confidence[confidence] || 0
+          }
+          filtered_metric = {
+            name: 'brakeman_filtered_warnings',
+            type: :gauge,
+            label_set: { confidence: text },
+            value: filtered_warning_counts_by_confidence[confidence] || 0
+          }
+          metrics << overall_metric << filtered_metric
+          puts overall_metric.inspect
+          puts filtered_metric.inspect
+        end
+
+        metrics
+      end
+
+      def attachments
+        attachments = []
+
+        if @strict && current_fingerprints.any?
+          # all warnings found
+          attachment = {
+            color: 'danger',
+            title: "#{current_fingerprints.size} Brakeman warning(s) :rotating_light:",
+            text: '_Brakeman_ warning fingerprint(s):' \
+            "```#{current_fingerprints.to_a.join("\n")}```",
+            footer: 'bundle exec rake ci:brakeman:fingerprint_details FINGERPRINTS=...',
+            mrkdwn_in: ['text']
+          }
+          attachments << attachment
+          puts attachment.inspect
+        elsif new_fingerprints.any?
+          # new warnings found
+          attachment = {
+            color: 'danger',
+            title: "#{new_fingerprints.size} new Brakeman warning(s) :rotating_light:",
+            text: '_Brakeman_ warning fingerprint(s):' \
+            "```#{new_fingerprints.to_a.join("\n")}```",
+            footer: 'bundle exec rake ci:brakeman:fingerprint_details FINGERPRINTS=...',
+            mrkdwn_in: ['text']
+          }
+          attachments << attachment
+          puts attachment.inspect
+        end
+
+        unless old_fingerprints.empty?
+          # old warnings missing
+          attachment = {
+            color: 'good',
+            title: "#{old_fingerprints.size} Brakeman warning(s) resolved :+1:",
+            footer: 'bundle exec rake ci:brakeman'
+          }
+          attachments << attachment
+          puts attachment.inspect
+        end
+
+        attachments
+      end
     end
   end
 end

data/lib/ndr_dev_support/rake_ci/redmine/ticket_resolver.rb

@@ -36,13 +36,13 @@ module NdrDevSupport
           @hostname = hostname
         end
 
-        def process_commit(user, revision, message)
+        def process_commit(user, revision, message, tests_passed)
           resolved_tickets = []
 
           each_ticket_from(message) do |ticket, resolved|
-            update_ticket(message, user, revision, ticket, resolved)
+            update_ticket(message, user, revision, ticket, resolved, tests_passed)
 
-            resolved_tickets << ticket if resolved
+            resolved_tickets << ticket if resolved && tests_passed
           end
 
           resolved_tickets
@@ -62,13 +62,17 @@ module NdrDevSupport
           end
         end
 
-        def update_payload(message, user, revision, ticket_closed, resolved)
+        def update_payload(message, user, revision, ticket_closed, resolved, tests_passed)
+          if resolved && !ticket_closed && !tests_passed
+            message += "\n\n*Automated tests did not pass successfully, so ticket status left unchanged.*"
+          end
+
           payload = {
             notes: "_#{resolved ? 'Resolved' : 'Referenced'} by #{user} in #{revision}_:" \
                    "#{resolved ? message.gsub(CLOSE_REGEX, '+\1+') : message}"
           }
 
-          payload[:status_id] = 3 if resolved && !ticket_closed
+          payload[:status_id] = 3 if resolved && !ticket_closed && tests_passed
           payload
         end
 
@@ -83,7 +87,7 @@ module NdrDevSupport
         end
 
         def update_ticket(message, user, revision, ticket, resolved)
-          payload = update_payload(message, user, revision, ticket_closed?(ticket), resolved)
+          payload = update_payload(message, user, revision, ticket_closed?(ticket), resolved, tests_passed)
 
           http.send_request('PUT',
                             "/issues/#{ticket.to_i}.json",

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.6.0'.freeze
+  VERSION = '5.7.0'.freeze
 end

data/lib/tasks/ci/brakeman.rake

@@ -11,48 +11,35 @@ namespace :ci do
 
     brakeman = NdrDevSupport::RakeCI::BrakemanHelper.new
     brakeman.commit = @commit
-    brakeman.run
-
-    Brakeman::Warning::TEXT_CONFIDENCE.each do |confidence, text|
-      metric = {
-        name: 'brakeman_warnings',
-        type: :gauge,
-        label_set: { confidence: text },
-        value: brakeman.warning_counts_by_confidence[confidence] || 0
-      }
-      @metrics << metric
-      puts metric.inspect
-    end
-
-    unless brakeman.new_fingerprints.empty?
-      # new warnings found
-      attachment = {
-        color: 'danger',
-        title: "#{brakeman.new_fingerprints.size} new Brakeman warning(s) :rotating_light:",
-        text: '_Brakeman_ warning fingerprint(s):' \
-              "```#{brakeman.new_fingerprints.to_a.join("\n")}```",
-        footer: 'bundle exec rake ci:brakeman:fingerprint_details FINGERPRINTS=...',
-        mrkdwn_in: ['text']
-      }
-      @attachments << attachment
-      puts attachment.inspect
-    end
+    brakeman.run(strict: false)
 
-    unless brakeman.old_fingerprints.empty?
-      # old warnings missing
-      attachment = {
-        color: 'good',
-        title: "#{brakeman.old_fingerprints.size} Brakeman warning(s) resolved :+1:",
-        footer: 'bundle exec rake ci:brakeman'
-      }
-      @attachments << attachment
-      puts attachment.inspect
-    end
+    @metrics.concat(brakeman.metrics)
+    @attachments.concat(brakeman.attachments)
 
     brakeman.save_current_fingerprints
   end
 
   namespace :brakeman do
+    desc "Brakeman (strict mode - all issues must be reviewed by Brakeman's interactive mode)"
+    task strict: 'ci:rugged:setup' do
+      next unless defined?(Rails)
+
+      require 'ndr_dev_support/rake_ci/brakeman_helper'
+      # Usage: bundle exec rake ci:brakeman:strict
+
+      @metrics ||= []
+      @attachments ||= []
+
+      brakeman = NdrDevSupport::RakeCI::BrakemanHelper.new
+      brakeman.commit = @commit
+      brakeman.run(strict: true)
+
+      @metrics.concat(brakeman.metrics)
+      @attachments.concat(brakeman.attachments)
+
+      brakeman.save_current_fingerprints
+    end
+
     desc 'Brakeman fingerprint details'
     task fingerprint_details: 'ci:rugged:setup' do
       # Usage: bundle exec rake ci:brakeman:fingerprint_details FINGERPRINTS=fp1,fp2,...

data/lib/tasks/ci/minitest.rake

@@ -47,10 +47,9 @@ namespace :ci do
       # Test(s) ran
       Rake::Task['ci:simplecov:process'].invoke
 
-      if hash[:statistics][:failures].zero? && hash[:statistics][:errors].zero? &&
-         Rake::Task.task_defined?('ci:redmine:update_tickets')
-        # Test(s) passing
-        Rake::Task['ci:redmine:update_tickets'].invoke
+      if Rake::Task.task_defined?('ci:redmine:update_tickets')
+        tests_passed = hash[:statistics][:failures].zero? && hash[:statistics][:errors].zero?
+        Rake::Task['ci:redmine:update_tickets'].invoke(tests_passed)
       end
 
       @attachments.concat(hash[:attachments])

data/lib/tasks/ci/redmine.rake

@@ -12,7 +12,7 @@ namespace :ci do
     end
 
     desc 'Update Redmine tickets'
-    task update_tickets: ['ci:rugged:setup', 'ci:redmine:setup'] do
+    task :update_tickets, [:tests_passed] => ['ci:rugged:setup', 'ci:redmine:setup'] do |task, args|
       api_key = ENV['REDMINE_API_KEY']
       hostname = ENV['REDMINE_HOSTNAME']
       next if api_key.nil? || hostname.nil?
@@ -27,7 +27,7 @@ namespace :ci do
         ticket_resolver = NdrDevSupport::RakeCI::Redmine::TicketResolver.new(api_key, hostname)
         resolved_tickets = ticket_resolver.process_commit(@commit.author[:name],
                                                           @friendly_revision_name,
-                                                          @commit.message)
+                                                          @commit.message, args.tests_passed)
       rescue
         @attachments << {
           color: 'danger',

data/ndr_dev_support.gemspec

@@ -57,5 +57,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'mocha'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.7.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-14 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -366,14 +366,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 description: Provides support to developers of NDR projects
 email: []
 executables: []