miriamtech-gocd 0.2.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d722ba99c05bc4ee1fa260006ece0b86f16293ae46962e65032b38c4af3e5f
-  data.tar.gz: 3aceb0eac5244fa478caaa7893677e33bc8368c72f690127034c14b5a82ccb5d
+  metadata.gz: e720fa3c10cb4b5bf73916fbeacaefa6175e56dbb60681d8fa5e8e9079d77679
+  data.tar.gz: fbad6afa1904d72416c60913b97767de59215b38dc82b0467bc0d4dc944cb058
 SHA512:
-  metadata.gz: df45c585d2e5629dfd6c6d6c0a0aa60fc89f3a7be0d358fd8e1cbdb20a28615824c46b831aec4ac9a2566b75f20b1c3f2ef84541455b02ba4255f9a361880e2f
-  data.tar.gz: 194f1632e39f2b5a463b48aad89f1150c7dce5b534dbf0152b2e6ed8c02d7a19e572056cf514a6d00474c1185a2a2ab6126542c497927dc5c09b4bcb01e67cf2
+  metadata.gz: f6ee1a59a81b0458c938ce3a88ec90ac9c701f7370639164474aa343898fe57f9b858a2b575b2d864f280c3ca375c19141d2f4b7ccb9c9cf5303c764427ae447
+  data.tar.gz: 6b33dd54129028edb50b6e19f1c7247e5287253dc4a512ab788cd7e3ad341dbeaa7c22259ca746e5173cdb34503f4e857a1495852aff703691bd0d7d81a3d018

data/.gitignore

@@ -6,4 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-Gemfile.lock
+/vendor/bundle

data/.rubocop.yml

@@ -0,0 +1,70 @@
+require:
+  - rubocop-minitest
+
+AllCops:
+  Exclude:
+    - '**/bin/*'
+    - '**/schema.rb'
+    - 'node_modules/**/*'
+    - 'vendor/bundle/**/*'
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/UnusedBlockArgument:
+  AutoCorrect: false
+
+Lint/UnusedMethodArgument:
+  AutoCorrect: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*
+
+Metrics/MethodLength:
+  Exclude:
+    - test/**/*
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - Rakefile
+
+Style/SymbolArray:
+  Exclude:
+    - Rakefile
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in miriamtech-gocd.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    miriamtech-gocd (0.4.0)
+      rake (>= 10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    minitest (5.11.3)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (1.13.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.11.1)
+      rubocop (>= 0.90, < 2.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  miriamtech-gocd!
+  rspec-expectations
+  rspec-mocks
+  rubocop
+  rubocop-minitest
+
+BUNDLED WITH
+   2.2.31

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task :default => :test

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby2.5
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/lib/miriamtech/gocd/artifacts.rb

@@ -1,18 +1,18 @@
+require 'securerandom'
+
 module MiriamTech
   module GoCD
     module DSL
-      def capture_artifacts(prefix = project_name, workdir:, path:, &block)
+      def capture_artifacts(prefix = project_name, workdir:, path:)
         with_artifacts_volume(prefix) do |volume_name|
-          begin
             yield "-v #{volume_name}:#{workdir}/#{path}"
-          ensure
-            copy_artifacts_from_volume(volume_name, local_path: path)
-          end
+        ensure
+          copy_artifacts_from_volume(volume_name, local_path: path)
         end
       end
 
-      def with_artifacts_volume(prefix = project_name, &block)
-        artifacts_volume = sanitized_volume_name("#{prefix}#{build_tag}")
+      def with_artifacts_volume(prefix = project_name)
+        artifacts_volume = sanitized_volume_name("#{prefix}_#{random_hex}")
         docker "volume create #{artifacts_volume}"
         yield artifacts_volume
       ensure
@@ -20,7 +20,7 @@ module MiriamTech
       end
 
       def copy_artifacts_from_volume(volume, local_path:)
-        container_id = `docker create -v #{volume}:/artifacts_volume #{WORKER_IMAGE} cp -a /artifacts_volume /artifacts_tmp`.chomp
+        container_id = `docker create -v #{volume}:/artifacts #{WORKER_IMAGE} cp -a /artifacts /artifacts_tmp`.chomp
         begin
           docker "start -i #{container_id}"
           cd root_path do
@@ -34,7 +34,11 @@ module MiriamTech
       private
 
       def sanitized_volume_name(name)
-        name.gsub(/[^-_\.A-Za-z0-9]/, '_')
+        name.gsub(/[^-_.A-Za-z0-9]/, '_')
+      end
+
+      def random_hex
+        SecureRandom.hex
       end
     end
   end

data/lib/miriamtech/gocd/docker.rb

@@ -1,18 +1,44 @@
 module MiriamTech
   module GoCD
+    FALSY_ENV_VALUES = (%w[0 f false n no] + ['']).freeze
     module DSL
       def project_name(env = ENV)
-        (env['GO_PIPELINE_NAME'] || root_path.basename.to_s).downcase
+        pipeline_name = env['GO_PIPELINE_NAME']
+        stage_name = env['GO_STAGE_NAME']
+        job_name = env['GO_JOB_NAME']
+        name = root_path.basename.to_s
+
+        if pipeline_name
+          name = pipeline_name
+          name += "-#{stage_name}" if stage_name
+          name += "-#{job_name}" if job_name
+        end
+
+        name.downcase
       end
 
       def build_tag(env = ENV)
         @build_tag ||= generate_build_tag(env)
       end
 
+      def build_counter(env = ENV)
+        @build_counter ||= generate_build_counter(env)
+      end
+
       def docker(string)
         sh "docker #{string}"
       end
 
+      def docker_build_arguments(env = ENV, build_args: {})
+        args = ['--force-rm']
+        no_cache_arg = env['DOCKER_BUILD_NO_CACHE']
+        args << '--no-cache' if no_cache_arg && !FALSY_ENV_VALUES.include?(no_cache_arg)
+        build_args.each do |key, value|
+          args << "--build-arg #{key}=#{value}"
+        end
+        args
+      end
+
       def docker_compose(string)
         cd root_path do
           sh "docker-compose -p #{project_name} -f docker-compose.yml #{string}"
@@ -22,11 +48,13 @@ module MiriamTech
       private
 
       def generate_build_tag(env)
-        if revision = env['GO_PIPELINE_COUNTER']
-          @build_tag =":#{revision}"
-        else
-          @build_tag = ""
-        end
+        revision = env['GO_REVISION_SOURCE']
+        revision ? ":#{revision}" : ''
+      end
+
+      def generate_build_counter(env)
+        counter = env['GO_PIPELINE_COUNTER']
+        counter ? ":#{counter}" : ''
       end
     end
   end

data/lib/miriamtech/gocd/dsl.rb

@@ -5,4 +5,10 @@ require_relative 'lambda'
 require_relative 'paths'
 require_relative 'tasks'
 
-self.extend MiriamTech::GoCD::DSL
+# Add our DSL methods to the top level namespace without polluting the Object inheritance tree.
+# This technique comes from `rake`, see e.g.
+# https://github.com/ruby/rake/blob/11973e8d31f29aee2e40d874206c9240956f86ed/lib/rake/dsl_definition.rb#L195
+#
+# rubocop:disable Style/MixinUsage
+extend MiriamTech::GoCD::DSL
+# rubocop:enable Style/MixinUsage

data/lib/miriamtech/gocd/images.rb

@@ -1,7 +1,7 @@
 module MiriamTech
   module GoCD
     module DSL
-      WORKER_IMAGE = 'debian:buster'
+      WORKER_IMAGE = 'debian:buster'.freeze
 
       def pull(image_name)
         docker "pull #{image_name}#{build_tag}"
@@ -17,14 +17,10 @@ module MiriamTech
       end
 
       def cleanup_old_images(image_name, number_to_keep)
-        revision_number = ENV["GO_PIPELINE_COUNTER"].to_i
-        return unless revision_number > number_to_keep
-        images = `docker images --format "{{.Repository}}:{{.Tag}}" #{image_name}`.split(/\s+/)
-        images.each do |image|
-          next unless image.match(/:(\d+)\z/)
-          if $1.to_i < revision_number - number_to_keep
-            docker "image rm #{image}"
-          end
+        images = `docker images --format '"{{.CreatedAt}}" id:{{.ID}}' #{image_name} | sort -r`.split("\n")
+        images.collect { |each| each.split(':').last }.uniq.each_with_index do |image, index|
+          next if index <= number_to_keep
+          docker "image rm --force #{image}"
         end
       end
     end

data/lib/miriamtech/gocd/paths.rb

@@ -6,10 +6,11 @@ module MiriamTech
       def root_path
         cwd = Pathname.new(File.expand_path('.'))
         path = Pathname.new(cwd)
-        begin
+        loop do
+          break if path.root?
           return path if path.join('Dockerfile').exist?
           path = path.parent
-        end until path.root?
+        end
         cwd
       end
 

data/lib/miriamtech/gocd/tasks.rb

@@ -4,28 +4,35 @@ require 'rake/clean'
 module MiriamTech
   module GoCD
     module DSL
+      # rubocop:disable Style/HashSyntax, Style/SymbolArray, Metrics/MethodLength
+
       def define_gocd_tasks(
         image_name,
-        revisions_to_keep: 10)
+        revisions_to_keep: 10,
+        build_args: {}
+      )
 
         task :default => [:test]
-        task :full => [:clobber, :build]
+        task :full => [:destroy_containers, :build]
 
         task :environment do
           ENV['BUILD_TAG'] = build_tag
         end
 
-        CLEAN.add(root_path + 'test/reports')
+        CLEAN.add("#{root_path}/test/reports")
         task :clean => [:environment]
-        task :clobber => [:environment, :cleanup_old_images]
+        task :destroy_containers => [:environment, :clean, :cleanup_old_images]
+
+        # This is here for compatibility
+        task :clobber => :destroy_containers
 
         if compose_file.exist?
           task :clean do
-            docker_compose "stop"
+            docker_compose 'stop'
           end
 
-          task :clobber do
-            docker_compose "rm -fv"
+          task :destroy_containers do
+            docker_compose 'rm -fv'
           end
         end
 
@@ -34,10 +41,23 @@ module MiriamTech
         end
 
         task :build => :environment do
-          docker "build --force-rm -t #{image_name}#{build_tag} #{root_path}"
+          docker "build #{docker_build_arguments(build_args: build_args).join(' ')} -t #{image_name}#{build_tag} -t #{image_name}#{build_counter} #{root_path}"
+        end
+
+        task :test => [:environment, :destroy_containers] do
+          at_exit { Rake::Task[:destroy_containers].execute }
         end
 
-        task :test => :environment
+        task :save, [:path] => :environment do | t, args |
+          args.with_defaults(path: File.join(root_path, '.docker', 'image.tar'))
+          FileUtils.mkdir_p File.dirname(args[:path])
+          docker "save #{image_name}#{build_tag} -o #{args[:path]}"
+        end
+
+        task :load, :path do | t, args |
+          args.with_defaults(path: File.join(root_path, '.docker', 'image.tar'))
+          docker "load -i #{args[:path]}"
+        end
 
         task :push do
           push(image_name)
@@ -53,6 +73,8 @@ module MiriamTech
           docker("run -it --rm #{image_name} bash")
         end
       end
+
+      # rubocop:enable Style/HashSyntax, Style/SymbolArray, Metrics/MethodLength
     end
   end
 end

data/lib/miriamtech/gocd/version.rb

@@ -1,5 +1,5 @@
 module MiriamTech
   module GoCD
-    VERSION = "0.2.7"
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/miriamtech/gocd.rb

@@ -1,2 +1,2 @@
-require "miriamtech/gocd/version"
-require "miriamtech/gocd/dsl"
+require 'miriamtech/gocd/version'
+require 'miriamtech/gocd/dsl'

data/miriamtech-gocd.gemspec

@@ -1,35 +1,38 @@
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "miriamtech/gocd/version"
+require 'miriamtech/gocd/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "miriamtech-gocd"
+  spec.name          = 'miriamtech-gocd'
   spec.version       = MiriamTech::GoCD::VERSION
-  spec.authors       = ["Ken Treis"]
-  spec.email         = ["ken@miriamtech.com"]
+  spec.authors       = ['Ken Treis']
+  spec.email         = ['ken@miriamtech.com']
 
-  spec.summary       = %q{Utilities for building apps in Docker containers with GoCD}
-  spec.homepage      = "https://www.miriamtech.com"
+  spec.summary       = 'Utilities for building apps in Docker containers with GoCD'
+  spec.homepage      = 'https://www.miriamtech.com'
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/miriamtech/gocd"
-  spec.metadata["changelog_uri"] = "https://github.com/miriamtech/gocd/blob/master/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/miriamtech/gocd'
+  spec.metadata['changelog_uri'] = 'https://github.com/miriamtech/gocd/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rake", ">= 10.0"
+  spec.required_ruby_version = '~> 2.5'
+  spec.add_dependency 'rake', '>= 10.0'
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rspec-expectations'
   spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-minitest'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miriamtech-gocd
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Ken Treis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2021-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - ken@miriamtech.com
@@ -88,12 +116,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
+- bin/rubocop
 - bin/run_tests.sh
 - bin/setup
 - lib/miriamtech/gocd.rb
@@ -119,17 +150,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Utilities for building apps in Docker containers with GoCD