ndr_dev_support 4.2.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07b63ea8d81ee459134b9050fe9de402b50f79b0ad32139d73d90e6e26b7053c
-  data.tar.gz: 3479a5ccbd481bae7528036b8ba0cf20aba3676c99ca0f4c4b68f20920df35d0
+  metadata.gz: 26e129c80b20dc919836108bc0b10b78c58021743f79bba269a31482fc6e88d8
+  data.tar.gz: 1ce0eb57048afe75868e24f77813d569dc09a4283cbc65703ad042e4bc3ec6c0
 SHA512:
-  metadata.gz: feee00d50b38a0e07f7f2817b580d9236b177a85ff949f18662e5dcd90488b8a85b8d3851655a922356f35f8e78f0fcab0aeea0a9d9a8c99c9cc89c7d2b71e51
-  data.tar.gz: 1f12d9c909139011e27e6c185289d97189d63c7bf8949e09b49767aeee3edef302f33385528a8a301775361799308fcc73d7d7b0193015d493b5b2eae2dde40c
+  metadata.gz: da84e06b1a78ef2c281d51a95f087efbd13dea1509f66203d54afa6009fb5cc20bc650d878b6c860d491666263d66f80801c25cc5623900e5f19e1d38c7a039b
+  data.tar.gz: 9ee2faf347c3d4a475b0ba0cce515b4477d4f9fd3043454c8e51466c9e69a6b4905ef0db9e3157ab42c4c2e2eb4ff0a348ee34bce7be32c5f01848e33dc59e7f

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 ## [Unreleased]
 *no unreleased changes*
 
+## 5.0.0 / 2019-01-31
+### Changed
+* Setting the Capybara save path and prune strategy. Resolves #45 (#46)
+
+### Added
+* Added an additional cop to check commits for missing associated test files.
+
+### Fixed
+* capistrano: address filesystem issue with using NDR-model in mixed-mode project
+* support Ruby 2.6. Minimum version is now 2.4
+* ci_server: don't crash out if the prometheus gateway is unreachable
+
 ## 4.2.1 / 2018-12-18
 ### Fixed
 * ci_server: improve logging and error handling (#44)

data/code_safety.yml

@@ -15,11 +15,11 @@ file safety:
   ".travis.yml":
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 8faa3e5e7ba5ef29daa1a857c8c15702f57c5a3f
+    safe_revision: 1cce5269b61341c5ec06e91b819df84ac6140165
   CHANGELOG.md:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: a73717bdeb9f48c257aec4fa41a19735e99555c8
+    safe_revision: a225ce0f0bd125b8dce9b31f9766dd8703fb495e
   CODE_OF_CONDUCT.md:
     comments: 
     reviewed_by: timgentry
@@ -67,7 +67,7 @@ file safety:
   lib/ndr_dev_support/capistrano/ndr_model.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: eec7079a777c84f61b05c236df60195d4ddcf488
+    safe_revision: 809acebc212beaaf23e6d73ae4d9b87382c2d087
   lib/ndr_dev_support/capistrano/restart.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -95,7 +95,7 @@ file safety:
   lib/ndr_dev_support/daemon/ci_server.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 0677afc93b0a64d56383e80fa1247e5be64bfb24
+    safe_revision: fe8682a3300a322c5f6b9a17dce471f11fa5e307
   lib/ndr_dev_support/daemon/stoppable.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -103,7 +103,7 @@ file safety:
   lib/ndr_dev_support/integration_testing.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: e0b3871607c649565330d6e62740ffd860930338
+    safe_revision: 0bca06801c072832f32b7abd8559888b91e9b337
   lib/ndr_dev_support/integration_testing/drivers/chrome.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -135,7 +135,7 @@ file safety:
   lib/ndr_dev_support/rake_ci/commit_cop.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+    safe_revision: '01682912c2fc526b0bc29e2836de0aea31c65b12'
   lib/ndr_dev_support/rake_ci/commit_cop/concerns/deputisable.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -144,6 +144,10 @@ file safety:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  lib/ndr_dev_support/rake_ci/commit_cop/missing_associated_test_file.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: '01682912c2fc526b0bc29e2836de0aea31c65b12'
   lib/ndr_dev_support/rake_ci/commit_cop/modified_migration.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -191,7 +195,7 @@ file safety:
   lib/ndr_dev_support/version.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: a73717bdeb9f48c257aec4fa41a19735e99555c8
+    safe_revision: a225ce0f0bd125b8dce9b31f9766dd8703fb495e
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support
@@ -232,7 +236,7 @@ file safety:
   lib/tasks/ci/prometheus.rake:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 6cb22447594ebf450fc60deb90fd223c8067ff18
+    safe_revision: fe8682a3300a322c5f6b9a17dce471f11fa5e307
   lib/tasks/ci/redmine.rake:
     comments: 
     reviewed_by: josh.pencheon
@@ -244,7 +248,7 @@ file safety:
   lib/tasks/ci/server.rake:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: d8e52aab569d9efac3e27485b5721c9608a84b6c
+    safe_revision: fe8682a3300a322c5f6b9a17dce471f11fa5e307
   lib/tasks/ci/simplecov.rake:
     comments: 
     reviewed_by: josh.pencheon
@@ -264,7 +268,7 @@ file safety:
   ndr_dev_support.gemspec:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 3e1fbd0a5931f7598a2dd3f929a7cd8366dc0e96
+    safe_revision: 1cce5269b61341c5ec06e91b819df84ac6140165
   test/daemon/ci_server_test.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -277,6 +281,10 @@ file safety:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: a3f5b7d3709f7e340f2f7e81dab026a63b21e3ff
+  test/rake_ci/commit_cop/missing_associated_test_file_test.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: '01682912c2fc526b0bc29e2836de0aea31c65b12'
   test/rake_ci/commit_cop/modified_migration_test.rb:
     comments: 
     reviewed_by: josh.pencheon

data/lib/ndr_dev_support/capistrano/ndr_model.rb

@@ -122,6 +122,9 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     desc 'Symlink to the release any :shared_paths, ensure private/ is writeable'
     task :filesystem_tweaks do
+      # This task binds after a standard capistrano step, so we need to be careful:
+      next unless ndr_model_deployment
+
       fetch(:shared_paths, []).each do |path|
         # Symlink `path` from the shared space to the release being prepared, replacing anything
         # already there:

data/lib/ndr_dev_support/daemon/ci_server.rb

@@ -56,7 +56,7 @@ module NdrDevSupport
           WithCleanRbenv.with_clean_rbenv do
             # TODO: rbenv_install
             bundle_install
-            system('rbenv exec bundle exec rake ci:all')
+            system('rbenv exec bundle exec rake ci:all --trace')
             git_discard_changes
           end
         end

data/lib/ndr_dev_support/integration_testing.rb

@@ -3,6 +3,10 @@ require 'capybara/rails'
 ActionDispatch::IntegrationTest.include(Capybara::DSL)
 
 # Set up basic screenshotting capability:
+#
+# TODO: Once Rails 5.1 is the minimum version we support, we should be able to
+#       use the built-in behaviour that Rails adds to after_teardown.
+#
 require 'capybara-screenshot'
 if defined?(MiniTest)
   require 'capybara-screenshot/minitest'
@@ -23,3 +27,6 @@ require 'ndr_dev_support/integration_testing/drivers/switchable'
 
 Capybara.default_driver    = :switchable
 Capybara.javascript_driver = :switchable
+
+Capybara.save_path = Rails.root.join('tmp', 'screenshots')
+Capybara::Screenshot.prune_strategy = { keep: 20 }

data/lib/ndr_dev_support/rake_ci/commit_cop.rb

@@ -2,6 +2,7 @@ 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'
+require_relative 'commit_cop/missing_associated_test_file'
 
 module NdrDevSupport
   module RakeCI
@@ -16,12 +17,26 @@ module NdrDevSupport
           []
         end
 
+      # This defines the regular expression that identifies the path to application files
+      # that you would expect to have associated test files.
+      mattr_accessor :tested_paths
+      self.tested_paths =
+        if defined?(Rails)
+          Rails.application.config.paths.values_at('app/controllers',
+                                                   'app/helpers',
+                                                   'app/models',
+                                                   'app/mailers').flat_map { |obj| obj.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,
+        MissingAssociatedTestFile,
         ModifiedMigration,
         RenamedMigration
       ].freeze

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

@@ -0,0 +1,33 @@
+require_relative 'concerns/deputisable'
+
+module NdrDevSupport
+  module RakeCI
+    module CommitCop
+      # This cop checks for new controllers, helpers,
+      # mailers and models without a new, associated test file
+      class MissingAssociatedTestFile
+        include Deputisable
+
+        def check(changes)
+          added = changes[:added]
+          return unless added.any?
+
+          tested_paths = CommitCop.tested_paths.join('|')
+          monitored_files = added.select { |file| file =~ %r{((#{tested_paths})\/.*\.rb)} }
+
+          files_without_tests = monitored_files.reduce([]) do |missing_tests, monitored_file|
+            test_file = monitored_file.gsub(%r{\A\w+\/(.*)\.rb\z}, 'test/\1_test.rb')
+            added.include?(test_file) ? missing_tests : missing_tests << monitored_file
+          end
+
+          return if files_without_tests.empty?
+
+          attachment :danger,
+                     'No associated test file committed',
+                     "File(s) submitted without an associated test file:\n" \
+                     "#{files_without_tests.join("\n")}"
+        end
+      end
+    end
+  end
+end

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.2.1'.freeze
+  VERSION = '5.0.0'.freeze
 end

data/lib/tasks/ci/prometheus.rake

@@ -43,9 +43,22 @@ namespace :ci do
         end
       end
 
-      Prometheus::Client::Push.new(
-        'rake-ci-job', nil, ENV['PROMETHEUS_PUSHGATEWAY']
-      ).add(prometheus)
+      client = Prometheus::Client::Push.new('rake-ci-job', nil, ENV['PROMETHEUS_PUSHGATEWAY'])
+
+      begin
+        client.add(prometheus)
+      rescue Errno::ECONNREFUSED => exception
+        warn "Failed to push metrics to Prometheus: #{exception.message}"
+
+        @attachments ||= []
+        @attachments << {
+          color: 'danger',
+          title: 'Publishing Error',
+          text: 'Build metrics could not be pushed - the Prometheus gateway was uncontactable',
+          footer: 'bundle exec rake ci:prometheus:publish',
+          mrkdwn_in: ['text']
+        }
+      end
     end
   end
 end

data/lib/tasks/ci/server.rake

@@ -4,8 +4,8 @@ namespace :ci do
 
   desc 'publish'
   task publish: [
-    'ci:slack:publish',
-    'ci:prometheus:publish'
+    'ci:prometheus:publish',
+    'ci:slack:publish'
   ]
 
   desc 'Runs the Rake CI server'

data/ndr_dev_support.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.2'
+  spec.required_ruby_version = '>= 2.4'
 
   spec.add_dependency 'pry'
 
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'parser'
   spec.add_dependency 'rainbow'
   spec.add_dependency 'rubocop', '0.52.1'
+  spec.add_dependency 'unicode-display_width', '>= 1.3.3'
 
   # Integration test dependencies:
   spec.add_dependency 'capybara'
@@ -43,7 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'brakeman', '>= 4.2.0'
   spec.add_dependency 'bundler-audit'
   spec.add_dependency 'github-linguist'
-  spec.add_dependency 'prometheus-client'
+  spec.add_dependency 'prometheus-client', '>= 0.9.0'
   spec.add_dependency 'rugged'
   spec.add_dependency 'simplecov'
   spec.add_dependency 'with_clean_rbenv'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 5.0.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -80,6 +80,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +226,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -374,6 +388,7 @@ files:
 - 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/missing_associated_test_file.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
@@ -416,15 +431,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: NDR Developer Support library