ndr_dev_support 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a77c75ad60b45a91190083d470912db589015a7237713b510b9aa4b6cfc03284
-  data.tar.gz: 9ddefdc49d88b6d445586537284590fb656fb8a97425c77e7881660bfb8f467d
+  metadata.gz: e2b84dc423c034b919fb74cd67458fc885d4f6565f4ad5798d2fbf201d8ddfc0
+  data.tar.gz: 26689488b7846c1edaf32f45f2a60976b4b7938a7af6d12a1626dce91d1c838a
 SHA512:
-  metadata.gz: dd8c7362ccb13351c211cb068a61fe660a2f4fa36b7bc93d98b5f2c395a93cfa23e503ddb07578382d631e617a1c06593c32d53c3cbfa40fffc29103f92880ba
-  data.tar.gz: 9534b04645eae6cae4d72902773f04809f8488c6a342e07e7fbf762da02372194c21f6ce0713a66856fb3034c04e341c861b939427c3205c5e37ae8d18f170a5
+  metadata.gz: 7f58716ac63abaeb4597084393f44528fa1f7426f3dce76f71fc771a3427a3dd5edcc5ee30df7e817ed35ba553107cca2997590aab1ff11811a850fe4941263e
+  data.tar.gz: a41b7019ba639d84bb3b28f01773c6aa3e69c217fadd8995655c90ec7c0392f7692288448dd23b029ffd92c86b97a6ca5a2fc6c2c4693830326b3a009dce9e62

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+rake_ci.*.yml

data/.rubocop.yml

@@ -8,7 +8,7 @@ AllCops:
   # All cops should ignore files in the following locations:
   Exclude:
   - 'bin/*'
-  - 'db/**/*'
+  - 'db/schema.rb'
   - 'lib/generators/**/templates/*'
   - 'tmp/**/*'
   - 'vendor/**/*'
@@ -44,15 +44,13 @@ Style/FrozenStringLiteralComment:
   # We're not confident enough to make this recommendation everywhere
   Enabled: false
 
-Metrics/LineLength:
-  Max: 100
-
 Style/ModuleFunction:
   # `extend self` has fewer side effects than `module_function`.
   EnforcedStyle: extend_self
 
 Style/NumericLiterals:
   Exclude:
+  - 'db/migrate/*.rb'
   - 'test/**/*.rb'
 
 Style/YodaCondition:
@@ -75,6 +73,9 @@ Performance/Casecmp:
 
 Metrics/AbcSize:
   Max: 23
+  Exclude:
+  - 'db/migrate/*.rb'
+  - 'test/**/*.rb'
 
 Metrics/BlockLength:
   # We're already limiting method size, blocks outside of methods
@@ -84,6 +85,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 150
   Exclude:
+  - 'db/migrate/*.rb'
   - 'test/**/*.rb'
 
 Metrics/ModuleLength:
@@ -97,11 +99,13 @@ Metrics/CyclomaticComplexity:
 Metrics/LineLength:
   Max: 100
   Exclude:
+  - 'db/migrate/*.rb'
   - 'test/**/*.rb'
 
 Metrics/MethodLength:
   Max: 15
   Exclude:
+  - 'db/migrate/*.rb'
   - 'test/**/*.rb'
 
 Metrics/PerceivedComplexity:

data/code_safety.yml

@@ -2,8 +2,8 @@
 file safety:
   ".gitignore":
     comments: 
-    reviewed_by: timgentry
-    safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
+    reviewed_by: josh.pencheon
+    safe_revision: 3e1fbd0a5931f7598a2dd3f929a7cd8366dc0e96
   ".hound.yml":
     comments: 
     reviewed_by: timgentry
@@ -11,7 +11,7 @@ file safety:
   ".rubocop.yml":
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 949a0ff086946426531a34d48f646b32c761c272
+    safe_revision: 33ecea8453c2b82c3e360819831bee5f1b8d3d4d
   ".travis.yml":
     comments: 
     reviewed_by: josh.pencheon
@@ -44,6 +44,10 @@ file safety:
     comments: 
     reviewed_by: timgentry
     safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
+  lib/minitest/rake_ci_reporter.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 3e1fbd0a5931f7598a2dd3f929a7cd8366dc0e96
   lib/ndr_dev_support.rb:
     comments: 
     reviewed_by: timgentry
@@ -83,7 +87,7 @@ file safety:
   lib/ndr_dev_support/daemon/ci_server.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: ec3d1f3fa1d1f1f3d039587a2f31bda28062f731
+    safe_revision: 66ce36e2646d392e3a67e19fcb9322ed8c5a6c16
   lib/ndr_dev_support/daemon/stoppable.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -120,10 +124,34 @@ file safety:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: 49caa4ef8ad9926843354d36f4610d40603ec632
+  lib/ndr_dev_support/rake_ci/commit_cop.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  lib/ndr_dev_support/rake_ci/commit_cop/concerns/deputisable.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  lib/ndr_dev_support/rake_ci/commit_cop/migration_without_structure_dump.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  lib/ndr_dev_support/rake_ci/commit_cop/modified_migration.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  lib/ndr_dev_support/rake_ci/commit_cop/renamed_migration.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
   lib/ndr_dev_support/rake_ci/concerns/commit_metadata_persistable.rb:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: 49caa4ef8ad9926843354d36f4610d40603ec632
+  lib/ndr_dev_support/rake_ci/redmine/ticket_resolver.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 2154aa7f32e731933ff6091b8f42b2b014028a6a
   lib/ndr_dev_support/rake_ci/simple_cov_helper.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -151,11 +179,11 @@ file safety:
   lib/ndr_dev_support/tasks.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: ec3d1f3fa1d1f1f3d039587a2f31bda28062f731
+    safe_revision: 2154aa7f32e731933ff6091b8f42b2b014028a6a
   lib/ndr_dev_support/version.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 3efca19afad2f7dedc1d470cd8dd51e95ec77545
+    safe_revision: e3f427496995516245e0de5c371b6867cf0a04df
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support
@@ -169,6 +197,10 @@ file safety:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: ddcf7de0bf1f5fb17cc28e2460009e162ff8917c
+  lib/tasks/ci/commit_cop.rake:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
   lib/tasks/ci/dependencies.rake:
     comments: 
     reviewed_by: josh.pencheon
@@ -181,6 +213,10 @@ file safety:
     comments: 
     reviewed_by: timgentry
     safe_revision: 00cd6c2f71612a467ee88ad53c21e08f073871d5
+  lib/tasks/ci/minitest.rake:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 3e1fbd0a5931f7598a2dd3f929a7cd8366dc0e96
   lib/tasks/ci/notes.rake:
     comments: 
     reviewed_by: timgentry
@@ -188,23 +224,27 @@ file safety:
   lib/tasks/ci/prometheus.rake:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: a10b6f3f5c9261135fae534e5785e2342430dde2
+    safe_revision: 6cb22447594ebf450fc60deb90fd223c8067ff18
+  lib/tasks/ci/redmine.rake:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 2154aa7f32e731933ff6091b8f42b2b014028a6a
   lib/tasks/ci/rugged.rake:
     comments: 
     reviewed_by: timgentry
     safe_revision: 7ab7061b257f916eb43bc8d184aa425f1f08b739
   lib/tasks/ci/server.rake:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: e581239a77666500a3108bcb3d480e370a82adb8
+    reviewed_by: josh.pencheon
+    safe_revision: d8e52aab569d9efac3e27485b5721c9608a84b6c
   lib/tasks/ci/simplecov.rake:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: 6240a84dc859af0623328f8667b93299c8eae257
   lib/tasks/ci/slack.rake:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: ad38e92c6e56b9d81fdab10681d8f2924eeadf5a
+    reviewed_by: josh.pencheon
+    safe_revision: 6cb22447594ebf450fc60deb90fd223c8067ff18
   lib/tasks/ci/stats.rake:
     comments: 
     reviewed_by: josh.pencheon
@@ -216,7 +256,7 @@ file safety:
   ndr_dev_support.gemspec:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: ec3d1f3fa1d1f1f3d039587a2f31bda28062f731
+    safe_revision: 3e1fbd0a5931f7598a2dd3f929a7cd8366dc0e96
   test/daemon/ci_server_test.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -225,6 +265,22 @@ file safety:
     comments: 
     reviewed_by: timgentry
     safe_revision: 26a8907a7a8a6b0d836aa12ca0335fa40be12240
+  test/rake_ci/commit_cop/migration_without_structure_dump_test.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  test/rake_ci/commit_cop/modified_migration_test.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  test/rake_ci/commit_cop/renamed_migration_test.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  test/rake_ci/redmine/ticket_resolver_test.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 2154aa7f32e731933ff6091b8f42b2b014028a6a
   test/test_helper.rb:
     comments: 
     reviewed_by: josh.pencheon

data/lib/minitest/rake_ci_reporter.rb

@@ -0,0 +1,115 @@
+require 'minitest'
+require 'rugged'
+require 'ndr_dev_support/rake_ci/concerns/commit_metadata_persistable'
+
+# The plugin needs to extend Minitest
+module Minitest
+  # RakeCI Minitest Reporter
+  class RakeCIReporter < StatisticsReporter
+    include CommitMetadataPersistable
+
+    def report
+      super
+
+      hash = {
+        statistics: current_statistics,
+        # results: results,
+        metrics: current_metrics,
+        attachments: current_attachments
+      }
+
+      save_current_commit_data(hash)
+    end
+
+    def commit
+      return @commit if @commit
+
+      repo = Rugged::Repository.new('.')
+      @commit = repo.lookup(repo.head.target_id)
+    end
+
+    def load_current_commit_hash
+      load_current_commit_data
+    end
+
+    private
+
+    def current_statistics
+      @current_statistics ||= {
+        total_time: total_time, runs: count, assertions: assertions, failures: failures,
+        errors: errors, skips: skips
+      }
+    end
+
+    def current_metrics
+      return @current_metrics if @current_metrics
+
+      @current_metrics = []
+      (current_statistics.keys - %i[total_time]).each do |name|
+        metric = {
+          name: 'ci_test_count',
+          type: :gauge,
+          label_set: { name: name },
+          value: current_statistics[name]
+        }
+        @current_metrics << metric
+        io.puts metric.inspect
+      end
+      @current_metrics
+    end
+
+    def current_attachments
+      return @current_attachments if @current_attachments
+
+      @current_attachments = []
+      @current_attachments << failures_attachment if failures.positive?
+      @current_attachments << errors_attachment if errors.positive?
+      @current_attachments << pass_attachment if newly_passing?
+      @current_attachments
+    end
+
+    def failures_attachment
+      {
+        color: 'danger',
+        text: ActionController::Base.helpers.pluralize(failures, 'test failure'),
+        footer: 'bundle exec rake ci:minitest'
+      }
+    end
+
+    def errors_attachment
+      {
+        color: 'warning',
+        text: ActionController::Base.helpers.pluralize(errors, 'test error'),
+        footer: 'bundle exec rake ci:minitest'
+      }
+    end
+
+    def pass_attachment
+      {
+        color: 'good',
+        text: 'Tests now pass',
+        footer: 'bundle exec rake ci:minitest'
+      }
+    end
+
+    def newly_passing?
+      return false if failures.positive? || errors.positive?
+
+      last_commit_hash = load_last_commit_data
+      return false if last_commit_hash.nil?
+
+      last_commit_hash[:statistics][:failures].positive? ||
+        last_commit_hash[:statistics][:errors].positive?
+    end
+
+    def name
+      'minitest'
+    end
+  end
+
+  def self.plugin_rake_ci_init(_options)
+    reporter << RakeCIReporter.new
+  end
+end
+
+Minitest.extensions << 'rake_ci'

data/lib/ndr_dev_support/daemon/ci_server.rb

@@ -1,6 +1,8 @@
 require 'English'
 require_relative 'stoppable'
+require 'open3'
 require 'rugged'
+require 'shellwords'
 require 'with_clean_rbenv'
 
 module NdrDevSupport
@@ -46,7 +48,7 @@ module NdrDevSupport
         git_checkout(MASTER_BRANCH_NAME)
 
         objectids_between_master_and_remote.each do |oid|
-          `git rebase #{oid}`
+          git_rebase(oid)
 
           WithCleanRbenv.with_clean_rbenv do
             # TODO: rbenv_install
@@ -62,7 +64,19 @@ module NdrDevSupport
       end
 
       def git_checkout(oid)
-        `git checkout #{oid}`
+        Open3.popen3('git', 'checkout', oid) do |_stdin, _stdout, stderr, wait_thr|
+          msg = stderr.read.strip
+          # TODO: Once https://github.com/PublicHealthEngland/ndr_dev_support/issues/27
+          # has been resolved, use logging instead of puts
+          puts msg unless msg == "Already on '#{oid}'"
+
+          process_status = wait_thr.value
+          raise stderr.read unless process_status.exited?
+        end
+      end
+
+      def git_rebase(oid)
+        `git rebase #{Shellwords.escape(oid)}`
       end
 
       def git_discard_changes

data/lib/ndr_dev_support/rake_ci/commit_cop.rb

@@ -0,0 +1,64 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require_relative 'commit_cop/migration_without_structure_dump'
+require_relative 'commit_cop/modified_migration'
+require_relative 'commit_cop/renamed_migration'
+
+module NdrDevSupport
+  module RakeCI
+    # This module encapsulates commit cop logic
+    module CommitCop
+      # This defines the regular expression that identifies the path to migration files.
+      mattr_accessor :migration_paths
+      self.migration_paths =
+        if defined?(Rails)
+          Rails.application.config.paths['db/migrate'].map(&:to_s)
+        else
+          []
+        end
+
+      # This defines the regular expression that identifies structure dump files.
+      mattr_accessor :structure_dump_pattern
+      self.structure_dump_pattern = %r{\Adb/(structure\.sql|schema\.rb)\z}
+
+      COMMIT_COPS = [
+        MigrationWithoutStructureDump,
+        ModifiedMigration,
+        RenamedMigration
+      ].freeze
+
+      # enumerates over each delta of the commmit
+      def self.each_delta(commit, &block)
+        diffs = commit.parents.first.diff(commit)
+        diffs.find_similar!
+        diffs.each_delta(&block)
+      end
+
+      # converts the deltas into a simpler changes hash of filename sets representation
+      def self.changes(commit)
+        changes = { added: Set.new, deleted: Set.new, modified: Set.new, renamed: Set.new }
+
+        each_delta(commit) do |delta|
+          if delta.status == :renamed
+            changes[delta.status].add([delta.old_file[:path], delta.new_file[:path]])
+          else
+            # old_file and new_file are the same
+            changes[delta.status].add(delta.old_file[:path])
+          end
+        end
+
+        changes
+      end
+
+      # Isolates migration/structure pattern changes by resetting them after yielding
+      def self.with_pattern
+        default_migration_paths = migration_paths
+        default_structure_dump_pattern = structure_dump_pattern
+
+        yield
+
+        self.migration_paths = default_migration_paths
+        self.structure_dump_pattern = default_structure_dump_pattern
+      end
+    end
+  end
+end

data/lib/ndr_dev_support/rake_ci/commit_cop/concerns/deputisable.rb

@@ -0,0 +1,42 @@
+require 'active_support/concern'
+
+module NdrDevSupport
+  module RakeCI
+    module CommitCop
+      # Deputisable cop concern
+      module Deputisable
+        extend ActiveSupport::Concern
+
+        private
+
+        def migration_file?
+          proc do |file|
+            if file.is_a?(Array)
+              file.any?(&migration_file?)
+            else
+              file.start_with?(*NdrDevSupport::RakeCI::CommitCop.migration_paths) &&
+                file =~ /\d{14}_.*\.rb\z/
+            end
+          end
+        end
+
+        def unscoped_migration_file?
+          proc do |file|
+            file.start_with?(*NdrDevSupport::RakeCI::CommitCop.migration_paths) &&
+              file =~ /\d{14}_[^\.]*\.rb\z/
+          end
+        end
+
+        def structure_dump_file?
+          proc { |file| file =~ NdrDevSupport::RakeCI::CommitCop.structure_dump_pattern }
+        end
+
+        def attachment(severity, title, text)
+          {
+            color: severity.to_s, title: title, text: text, mrkdwn_in: ['text']
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ndr_dev_support/rake_ci/commit_cop/migration_without_structure_dump.rb

@@ -0,0 +1,21 @@
+require_relative 'concerns/deputisable'
+
+module NdrDevSupport
+  module RakeCI
+    module CommitCop
+      # This cop checks for new migrations with no accompanying structure dump
+      class MigrationWithoutStructureDump
+        include Deputisable
+
+        def check(changes)
+          return unless changes[:added].any?(&unscoped_migration_file?) &&
+                        changes[:modified].none?(&structure_dump_file?)
+
+          attachment(:danger,
+                     'No structure file committed',
+                     'Migration(s) were added with no accompanying structure file(s)')
+        end
+      end
+    end
+  end
+end

data/lib/ndr_dev_support/rake_ci/commit_cop/modified_migration.rb

@@ -0,0 +1,20 @@
+require_relative 'concerns/deputisable'
+
+module NdrDevSupport
+  module RakeCI
+    module CommitCop
+      # This cop checks for modified migrations
+      class ModifiedMigration
+        include Deputisable
+
+        def check(changes)
+          return if changes[:modified].none?(&migration_file?)
+
+          attachment(:danger,
+                     'Modified Migration',
+                     'Migrations should not be modified. Create another migration.')
+        end
+      end
+    end
+  end
+end

data/lib/ndr_dev_support/rake_ci/commit_cop/renamed_migration.rb

@@ -0,0 +1,23 @@
+require_relative 'concerns/deputisable'
+
+module NdrDevSupport
+  module RakeCI
+    module CommitCop
+      # This cop checks for renamed migrations that change timestamp
+      class RenamedMigration
+        include Deputisable
+
+        def check(changes)
+          renamed_migrations = changes[:renamed].select(&migration_file?)
+          return if renamed_migrations.all? do |old_file, new_file|
+            File.basename(old_file)[0, 14] == File.basename(new_file)[0, 14]
+          end
+
+          attachment(:danger,
+                     'Renamed Migration',
+                     'Migrations should not change timestamp')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+require 'json'
+require 'net/http'
+
+module NdrDevSupport
+  module RakeCI
+    module Redmine
+      # This class encapsulates Redmine ticket logic
+      class TicketResolver
+        CLOSE_REGEX =
+          /
+            (
+                (?:close[sd]?)    # close, closes, closed
+              | (?:resolve[sd]?)  # resolve, resolves, resolved
+              | (?:fix(?:e[sd])?) # fix, fixes, fixed
+            )
+          /ix
+
+        MEGA_REGEX =
+          /
+              #{CLOSE_REGEX}
+            | (relate[sd]\sto)  # relates to, related to
+            | (?:
+               \[?             # optional square bracket
+               \#(\d+)         # ticket number with preceding hash character
+               (?:\#note-\d+)? # optional note reference, ignored
+               \]?             # optional square bracket
+               \b              # word boundary
+              )
+          /ix
+
+        def initialize(api_key, hostname)
+          @headers = {
+            'X-Redmine-API-Key' => api_key,
+            'Content-Type'      => 'application/json'
+          }
+          @hostname = hostname
+        end
+
+        def process_commit(user, revision, message)
+          resolved_tickets = []
+
+          each_ticket_from(message) do |ticket, resolved|
+            update_ticket(message, user, revision, ticket, resolved)
+
+            resolved_tickets << ticket if resolved
+          end
+
+          resolved_tickets
+        end
+
+        def each_ticket_from(message, &block)
+          return enum_for(:each_ticket_from, message) unless block
+
+          key_words     = message.scan(MEGA_REGEX).flatten.compact
+          action_groups = key_words.slice_when { |_l, r| r.to_i.to_s != r }.to_a
+
+          action_groups.each do |group|
+            resolved = group.any? { |word| word =~ CLOSE_REGEX }
+            tickets  = group.select { |word| word.to_i.to_s == word }.uniq
+
+            tickets.each { |ticket| yield(ticket, resolved) }
+          end
+        end
+
+        def update_payload(message, user, revision, ticket_closed, resolved)
+          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
+        end
+
+        private
+
+        # Connect lazily
+        def http
+          return @http if @http
+          @http = Net::HTTP.new(@hostname, 443)
+          @http.use_ssl = true
+          @http
+        end
+
+        def update_ticket(message, user, revision, ticket, resolved)
+          payload = update_payload(message, user, revision, ticket_closed?(ticket), resolved)
+
+          http.send_request('PUT',
+                            "/issues/#{ticket.to_i}.json",
+                            JSON.dump(issue: payload),
+                            @headers)
+        end
+
+        def ticket_closed?(ticket)
+          response = http.send_request('GET', "/issues/#{ticket.to_i}.json", nil, @headers)
+          JSON.parse(response.body)['issue']['status']['id'] == 5
+        end
+      end
+    end
+  end
+end

data/lib/ndr_dev_support/tasks.rb

@@ -1,11 +1,14 @@
 load 'tasks/audit_code.rake'
 load 'tasks/ci/brakeman.rake'
 load 'tasks/ci/bundle_audit.rake'
+load 'tasks/ci/commit_cop.rake'
 load 'tasks/ci/dependencies.rake'
 load 'tasks/ci/housekeep.rake'
 load 'tasks/ci/linguist.rake'
+load 'tasks/ci/minitest.rake'
 load 'tasks/ci/notes.rake'
 load 'tasks/ci/prometheus.rake'
+load 'tasks/ci/redmine.rake'
 load 'tasks/ci/rugged.rake'
 load 'tasks/ci/server.rake'
 load 'tasks/ci/simplecov.rake'

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 = '4.0.0'.freeze
+  VERSION = '4.1.0'.freeze
 end

data/lib/tasks/ci/commit_cop.rake

@@ -0,0 +1,28 @@
+namespace :ci do
+  desc 'commit_cop'
+  task commit_cop: 'ci:rugged:setup' do |t|
+    # Usage: bin/rake ci:commit_cop
+    require 'ndr_dev_support/rake_ci/commit_cop'
+
+    @attachments ||= []
+    changes = NdrDevSupport::RakeCI::CommitCop.changes(@commit)
+
+    NdrDevSupport::RakeCI::CommitCop::COMMIT_COPS.each do |klass|
+      attachment = klass.new.check(changes)
+      next if attachment.nil?
+
+      @attachments << attachment.merge(footer: "bundle exec rake #{t.name}")
+      puts attachment.to_yaml
+    end
+  end
+
+  desc 'changes'
+  task changes: 'ci:rugged:setup' do
+    # Usage: bin/rake ci:changes
+    require 'ndr_dev_support/rake_ci/commit_cop'
+
+    changes = NdrDevSupport::RakeCI::CommitCop.changes(@commit)
+
+    puts changes.inspect
+  end
+end

data/lib/tasks/ci/minitest.rake

@@ -0,0 +1,64 @@
+namespace :ci do
+  desc 'Test the system'
+  task :minitest do
+    raise 'Your test command must be the rake default' unless Rake::Task.task_defined?('default')
+
+    # Run the tests
+    test_cmd = 'bundle exec rake ci:minitest:setup ci:simplecov:setup default'
+    test_cmd += ' 2>&1 >/dev/null' if ENV['RAKECI_HEADLESS']
+    system test_cmd
+
+    Rake::Task['ci:minitest:process'].invoke
+
+    next if ENV['RAKECI_HEADLESS']
+    puts @metrics.inspect
+    puts @attachments.inspect
+  end
+
+  namespace :minitest do
+    desc 'setup'
+    task :setup do
+      # Load the RakeCI reporter:
+      require 'minitest/rake_ci_reporter'
+
+      # Ensure spawned processes do the same:
+      ENV['RUBYOPT'] += ' -rminitest/rake_ci_reporter'
+    end
+
+    desc 'process'
+    task :process do
+      require 'minitest/rake_ci_reporter'
+
+      @attachments ||= []
+      @metrics ||= []
+
+      rake_ci_reporter = Minitest::RakeCIReporter.new
+      hash = rake_ci_reporter.load_current_commit_hash
+      if hash.nil?
+        # Tests didn't run properly
+        attachment = {
+          color: 'danger',
+          title: 'Testing Error',
+          text: "Minitest didn't run properly",
+          footer: 'bundle exec rake ci:minitest',
+          mrkdwn_in: ['text']
+        }
+        @attachments << attachment
+
+        next
+      end
+
+      # 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
+      end
+
+      @attachments.concat(hash[:attachments])
+      @metrics.concat(hash[:metrics])
+    end
+  end
+end

data/lib/tasks/ci/prometheus.rake

@@ -2,6 +2,7 @@ namespace :ci do
   namespace :prometheus do
     desc 'Set up Prometheus'
     task :setup do
+      require 'highline/import'
       @metrics = []
 
       ENV['PROMETHEUS_PUSHGATEWAY'] ||= ask('Prometheus pushgateway (host:port): ')

data/lib/tasks/ci/redmine.rake

@@ -0,0 +1,41 @@
+namespace :ci do
+  namespace :redmine do
+    desc 'Set up Redmine'
+    task :setup do
+      ENV['REDMINE_HOSTNAME'] ||= ask('Redmine URL: ')
+      ENV['REDMINE_HOSTNAME'] = nil if ENV['REDMINE_HOSTNAME'] == ''
+
+      ENV['REDMINE_API_KEY'] ||= ask('Redmine API Key: ') { |q| q.echo = '*' }
+      ENV['REDMINE_API_KEY'] = nil if ENV['REDMINE_API_KEY'] == ''
+    end
+
+    desc 'Update Redmine tickets'
+    task update_tickets: ['ci:rugged:setup', 'ci:redmine:setup'] do
+      api_key = ENV['REDMINE_API_KEY']
+      hostname = ENV['REDMINE_HOSTNAME']
+      next if api_key.nil? || hostname.nil?
+
+      require 'ndr_dev_support/rake_ci/redmine/ticket_resolver'
+
+      ticket_resolver = NdrDevSupport::RakeCI::Redmine::TicketResolver.new(api_key, hostname)
+      resolved_tickets = ticket_resolver.process_commit(@commit.author[:name],
+                                                        @friendly_revision_name,
+                                                        @commit.message)
+
+      next if resolved_tickets.empty?
+      resolved_tickets.map! { |ticket_id| "https://#{hostname}/issues/#{ticket_id}" }
+
+      issue_s = resolved_tickets.count == 1 ? 'issue' : 'issues'
+      attachment = {
+        color: 'good',
+        title: "#{issue_s.capitalize} Resolved",
+        text: "Tests pass, so #{issue_s} #{resolved_tickets.join(', ')}" \
+              " #{resolved_tickets.count == 1 ? 'has' : 'have'} been resolved",
+        footer: 'bundle exec rake ci:minitest',
+        mrkdwn_in: ['text']
+      }
+      @attachments ||= []
+      @attachments << attachment
+    end
+  end
+end

data/lib/tasks/ci/server.rake

@@ -2,6 +2,12 @@ namespace :ci do
   # Stub ci:all rake task
   task :all
 
+  desc 'publish'
+  task publish: [
+    'ci:slack:publish',
+    'ci:prometheus:publish'
+  ]
+
   desc 'Runs the Rake CI server'
   task :server do
     require 'ndr_dev_support/daemon/ci_server'

data/lib/tasks/ci/slack.rake

@@ -2,6 +2,7 @@ namespace :ci do
   namespace :slack do
     desc 'Set up Slack'
     task :setup do
+      require 'highline/import'
       @attachments = []
 
       ENV['SLACK_WEBHOOK_URL'] ||= ask('Slack Webhook URL: ')

data/ndr_dev_support.gemspec

@@ -45,6 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'github-linguist'
   spec.add_dependency 'prometheus-client'
   spec.add_dependency 'rugged'
+  spec.add_dependency 'simplecov'
   spec.add_dependency 'with_clean_rbenv'
 
   # Deployment dependencies:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2018-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -234,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: with_clean_rbenv
   requirement: !ruby/object:Gem::Requirement
@@ -335,6 +349,7 @@ files:
 - bin/console
 - bin/setup
 - code_safety.yml
+- lib/minitest/rake_ci_reporter.rb
 - lib/ndr_dev_support.rb
 - lib/ndr_dev_support/capistrano/assets.rb
 - lib/ndr_dev_support/capistrano/ndr_model.rb
@@ -354,7 +369,13 @@ files:
 - lib/ndr_dev_support/integration_testing/drivers/switchable.rb
 - lib/ndr_dev_support/integration_testing/dsl.rb
 - lib/ndr_dev_support/rake_ci/brakeman_helper.rb
+- lib/ndr_dev_support/rake_ci/commit_cop.rb
+- lib/ndr_dev_support/rake_ci/commit_cop/concerns/deputisable.rb
+- lib/ndr_dev_support/rake_ci/commit_cop/migration_without_structure_dump.rb
+- lib/ndr_dev_support/rake_ci/commit_cop/modified_migration.rb
+- lib/ndr_dev_support/rake_ci/commit_cop/renamed_migration.rb
 - lib/ndr_dev_support/rake_ci/concerns/commit_metadata_persistable.rb
+- lib/ndr_dev_support/rake_ci/redmine/ticket_resolver.rb
 - lib/ndr_dev_support/rake_ci/simple_cov_helper.rb
 - lib/ndr_dev_support/rubocop/executor.rb
 - lib/ndr_dev_support/rubocop/range_augmenter.rb
@@ -366,11 +387,14 @@ files:
 - lib/tasks/audit_code.rake
 - lib/tasks/ci/brakeman.rake
 - lib/tasks/ci/bundle_audit.rake
+- lib/tasks/ci/commit_cop.rake
 - lib/tasks/ci/dependencies.rake
 - lib/tasks/ci/housekeep.rake
 - lib/tasks/ci/linguist.rake
+- lib/tasks/ci/minitest.rake
 - lib/tasks/ci/notes.rake
 - lib/tasks/ci/prometheus.rake
+- lib/tasks/ci/redmine.rake
 - lib/tasks/ci/rugged.rake
 - lib/tasks/ci/server.rake
 - lib/tasks/ci/simplecov.rake