rake_fly 2.9.0 → 2.10.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1971205b975a243684394e431b8a4191d814c59ffa40205d1de6267bfaac4ad
-  data.tar.gz: d6dc382f4e0f9712061c5358b35ce4f51c760b16c243b9e174e0218a3e37a71c
+  metadata.gz: 18edc1730fc579ae18a1676e8655366c803392ffa70e8b9b0b7df44825cd601c
+  data.tar.gz: 7f018eb6ff6c111238da6d7cf5faccd548aa5f57cbc5d543a15750bd63074681
 SHA512:
-  metadata.gz: 3ca35fc0dd6b1721a6f2b908de521119e60655d63b4b1c0e6c4198e1c8e373c874cd93d2c01789a5c9e70a1805861a5a327cb2e832d6ba324cab226449597795
-  data.tar.gz: 0c4c5ce4529a30c10878e4ae2ade3c1edeed62c0136b9916d3b9837f82b042716eedc69b8f276a831fc492edcd5daaac0f583a8b9e95043cc28ddd07a216488a
+  metadata.gz: 3f89cdc837c90c872038a2f76b8a53f111e706ed4bdede06f1b07568da8bad9678a220f04fb047204605742ac60b9b675b3e8888dc12ac02d75a78abc07bcf75
+  data.tar.gz: 4074759a07ac784256f14772ecf6263547c008b0103f03dab5bffc0b5376ef3f8afcecd148bdc823d1716da0386a880c3c7c1da13acea23f944a986f149ba5a7

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rake_fly.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rake_fly (2.9.0)
+    rake_fly (2.10.0.pre.3)
       concourse.rb (>= 0.4)
       rake_dependencies (~> 3.1)
       rake_factory (~> 0.29)
@@ -18,6 +18,7 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     colored2 (3.1.2)
     concourse.rb (0.4.0)
       dry-schema (~> 0.5)
@@ -98,7 +99,11 @@ GEM
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     openssl (3.0.0)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
     public_suffix (4.0.6)
+    rainbow (3.1.1)
     rake (13.0.6)
     rake_circle_ci (0.9.0)
       colored2 (~> 3.1)
@@ -125,6 +130,8 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -138,6 +145,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     ruby_fly (0.37.0)
       lino (~> 3.0)
@@ -157,6 +180,7 @@ GEM
     sshkey (2.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -177,7 +201,10 @@ DEPENDENCIES
   rake_gpg
   rake_ssh
   rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   simplecov
 
 BUNDLED WITH
-   2.3.9
+   2.3.11

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Toby Clemson
+Copyright (c) 2022 InfraBlocks Maintainers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'rake_circle_ci'
 require 'rake_github'
@@ -5,17 +7,20 @@ require 'rake_ssh'
 require 'rake_gpg'
 require 'securerandom'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-task :default => :spec
-
-RSpec::Core::RakeTask.new(:spec)
+task default: %i[
+  library:fix
+  test:unit
+]
 
 namespace :encryption do
   namespace :passphrase do
+    desc 'Generate encryption passphrase for CI GPG key'
     task :generate do
-      File.open('config/secrets/ci/encryption.passphrase', 'w') do |f|
-        f.write(SecureRandom.base64(36))
-      end
+      FileUtils.mkdir_p('config/secrets/ci/')
+      File.write('config/secrets/ci/encryption.passphrase',
+                 SecureRandom.base64(36))
     end
   end
 end
@@ -23,85 +28,102 @@ end
 namespace :keys do
   namespace :deploy do
     RakeSSH.define_key_tasks(
-        path: 'config/secrets/ci/',
-        comment: 'maintainers@infrablocks.io')
+      path: 'config/secrets/ci/',
+      comment: 'maintainers@infrablocks.io'
+    )
   end
 
   namespace :gpg do
     RakeGPG.define_generate_key_task(
-        output_directory: 'config/secrets/ci',
-        name_prefix: 'gpg',
-        owner_name: 'InfraBlocks Maintainers',
-        owner_email: 'maintainers@infrablocks.io',
-        owner_comment: 'rake_fly CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'rake_fly CI Key'
+    )
   end
 end
 
+RuboCop::RakeTask.new
+
+namespace :library do
+  desc 'Run all checks of the library'
+  task check: [:rubocop]
+
+  desc 'Attempt to automatically fix issues with the library'
+  task fix: [:'rubocop:auto_correct']
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end
+
 RakeCircleCI.define_project_tasks(
-    namespace: :circle_ci,
-    project_slug: 'github/infrablocks/rake_fly'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/rake_fly'
 ) do |t|
   circle_ci_config =
-      YAML.load_file('config/secrets/circle_ci/config.yaml')
+    YAML.load_file('config/secrets/circle_ci/config.yaml')
 
-  t.api_token = circle_ci_config["circle_ci_api_token"]
+  t.api_token = circle_ci_config['circle_ci_api_token']
   t.environment_variables = {
-      ENCRYPTION_PASSPHRASE:
-          File.read('config/secrets/ci/encryption.passphrase')
-              .chomp
+    ENCRYPTION_PASSPHRASE:
+        File.read('config/secrets/ci/encryption.passphrase')
+            .chomp
   }
   t.checkout_keys = []
   t.ssh_keys = [
-      {
-          hostname: "github.com",
-          private_key: File.read('config/secrets/ci/ssh.private')
-      }
+    {
+      hostname: 'github.com',
+      private_key: File.read('config/secrets/ci/ssh.private')
+    }
   ]
 end
 
 RakeGithub.define_repository_tasks(
-    namespace: :github,
-    repository: 'infrablocks/rake_fly',
+  namespace: :github,
+  repository: 'infrablocks/rake_fly'
 ) do |t, args|
   github_config =
-      YAML.load_file('config/secrets/github/config.yaml')
+    YAML.load_file('config/secrets/github/config.yaml')
 
-  t.access_token = github_config["github_personal_access_token"]
+  t.access_token = github_config['github_personal_access_token']
   t.deploy_keys = [
-      {
-          title: 'CircleCI',
-          public_key: File.read('config/secrets/ci/ssh.public')
-      }
+    {
+      title: 'CircleCI',
+      public_key: File.read('config/secrets/ci/ssh.public')
+    }
   ]
   t.branch_name = args.branch_name
   t.commit_message = args.commit_message
 end
 
 namespace :pipeline do
-  task :prepare => [
-      :'circle_ci:project:follow',
-      :'circle_ci:env_vars:ensure',
-      :'circle_ci:checkout_keys:ensure',
-      :'circle_ci:ssh_keys:ensure',
-      :'github:deploy_keys:ensure'
+  desc 'Prepare CircleCI Pipeline'
+  task prepare: %i[
+    circle_ci:project:follow
+    circle_ci:env_vars:ensure
+    circle_ci:checkout_keys:ensure
+    circle_ci:ssh_keys:ensure
+    github:deploy_keys:ensure
   ]
 end
 
 namespace :version do
-  desc "Bump version for specified type (pre, major, minor, patch)"
+  desc 'Bump version for specified type (pre, major, minor, patch)'
   task :bump, [:type] do |_, args|
     bump_version_for(args.type)
   end
 end
 
-desc "Release gem"
+desc 'Release gem'
 task :release do
-  sh "gem release --tag --push"
+  sh 'gem release --tag --push'
 end
 
 def bump_version_for(version_type)
-  sh "gem bump --version #{version_type} " +
-      "&& bundle install " +
-      "&& export LAST_MESSAGE=\"$(git log -1 --pretty=%B)\" " +
-      "&& git commit -a --amend -m \"${LAST_MESSAGE} [ci skip]\""
+  sh "gem bump --version #{version_type} " \
+     '&& bundle install ' \
+     '&& export LAST_MESSAGE="$(git log -1 --pretty=%B)" ' \
+     '&& git commit -a --amend -m "${LAST_MESSAGE} [ci skip]"'
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rake_fly"
+require 'bundler/setup'
+require 'rake_fly'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rake_fly"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/rake_fly/kernel_extensions.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'rake_factory/kernel_extensions'

data/lib/rake_fly/task_sets/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 
 require_relative '../tasks/authentication/login'
@@ -14,12 +16,13 @@ module RakeFly
       parameter :concourse_url, required: true
       parameter :team, default: 'main'
 
-      parameter :backend, default: RakeFly::Tasks::Authentication::Login::ApiBackend
+      parameter :backend,
+                default: RakeFly::Tasks::Authentication::Login::ApiBackend
       parameter :username
       parameter :password
 
       parameter :home_directory,
-          default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
+                default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
 
       parameter :login_task_name, default: :login
       parameter :ensure_task_name, default: :ensure
@@ -27,13 +30,13 @@ module RakeFly
       parameter :fly_ensure_task_name, default: :'fly:ensure'
 
       task Tasks::Authentication::Login,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.login_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.login_task_name
+           }
       task Tasks::Authentication::Ensure,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.ensure_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.ensure_task_name
+           }
     end
   end
 end

data/lib/rake_fly/task_sets/pipeline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 
 require_relative '../tasks/pipeline/get'
@@ -22,7 +24,7 @@ module RakeFly
       parameter :non_interactive
 
       parameter :home_directory,
-          default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
+                default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
 
       parameter :get_task_name, default: :get
       parameter :set_task_name, default: :set
@@ -33,25 +35,25 @@ module RakeFly
       parameter :fly_ensure_task_name, default: :'fly:ensure'
 
       task Tasks::Pipeline::Get,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.get_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.get_task_name
+           }
       task Tasks::Pipeline::Set,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.set_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.set_task_name
+           }
       task Tasks::Pipeline::Unpause,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.unpause_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.unpause_task_name
+           }
       task Tasks::Pipeline::Push,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.push_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.push_task_name
+           }
       task Tasks::Pipeline::Destroy,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.destroy_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.destroy_task_name
+           }
     end
   end
 end

data/lib/rake_fly/task_sets/project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 
 require_relative '../tasks/authentication/login'
@@ -9,6 +11,7 @@ require_relative '../tasks/pipeline/push'
 
 module RakeFly
   module TaskSets
+    # rubocop:disable Metrics/ClassLength
     class Project < RakeFactory::TaskSet
       prepend RakeFactory::Namespaceable
 
@@ -17,7 +20,8 @@ module RakeFly
       parameter :concourse_url, required: true
       parameter :team, default: 'main'
 
-      parameter :backend, default: RakeFly::Tasks::Authentication::Login::ApiBackend
+      parameter :backend,
+                default: RakeFly::Tasks::Authentication::Login::ApiBackend
       parameter :username
       parameter :password
 
@@ -29,10 +33,10 @@ module RakeFly
       parameter :non_interactive
 
       parameter :target,
-          default: RakeFactory::DynamicValue.new { |t| t.team }
+                default: RakeFactory::DynamicValue.new { |t| t.team }
 
       parameter :home_directory,
-          default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
+                default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
 
       parameter :authentication_namespace, default: :authentication
       parameter :authentication_login_task_name, default: :login
@@ -48,89 +52,93 @@ module RakeFly
       parameter :fly_ensure_task_name, default: :'fly:ensure'
 
       task Tasks::Authentication::Login,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.authentication_login_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.authentication_login_task_name
+           }
       task Tasks::Authentication::Ensure,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.authentication_ensure_task_name
-          },
-          login_task_name: RakeFactory::DynamicValue.new { |ts|
-            ts.authentication_login_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.authentication_ensure_task_name
+           },
+           login_task_name: RakeFactory::DynamicValue.new { |ts|
+             ts.authentication_login_task_name
+           }
 
       task Tasks::Pipeline::Get,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_get_task_name
-          },
-          authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
-            (ts.authentication_namespace.to_s + ":" +
-                ts.authentication_ensure_task_name.to_s)
-                .to_sym
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_get_task_name
+           },
+           authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
+             "#{ts.authentication_namespace}:"\
+             "#{ts.authentication_ensure_task_name}"
+               .to_sym
+           }
       task Tasks::Pipeline::Set,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_set_task_name
-          },
-          authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
-            (ts.authentication_namespace.to_s + ":" +
-                ts.authentication_ensure_task_name.to_s)
-                .to_sym
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_set_task_name
+           },
+           authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
+             "#{ts.authentication_namespace}:"\
+             "#{ts.authentication_ensure_task_name}"
+               .to_sym
+           }
       task Tasks::Pipeline::Unpause,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_unpause_task_name
-          },
-          authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
-            (ts.authentication_namespace.to_s + ":" +
-                ts.authentication_ensure_task_name.to_s)
-                .to_sym
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_unpause_task_name
+           },
+           authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
+             "#{ts.authentication_namespace}:"\
+             "#{ts.authentication_ensure_task_name}"
+               .to_sym
+           }
       task Tasks::Pipeline::Push,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_push_task_name
-          },
-          get_task_name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_get_task_name
-          },
-          set_task_name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_set_task_name
-          },
-          unpause_task_name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_unpause_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_push_task_name
+           },
+           get_task_name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_get_task_name
+           },
+           set_task_name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_set_task_name
+           },
+           unpause_task_name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_unpause_task_name
+           }
       task Tasks::Pipeline::Destroy,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.pipeline_destroy_task_name
-          },
-          authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
-            (ts.authentication_namespace.to_s + ":" +
-                ts.authentication_ensure_task_name.to_s)
-                .to_sym
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.pipeline_destroy_task_name
+           },
+           authentication_ensure_task_name: RakeFactory::DynamicValue.new { |ts|
+             "#{ts.authentication_namespace}:"\
+             "#{ts.authentication_ensure_task_name}"
+               .to_sym
+           }
 
       def define_on(application)
         around_define(application) do
           self.class.tasks.each do |task_definition|
-            task_class = task_definition.klass.to_s
-            ns = case task_class
-            when /Pipeline/
-              pipeline_namespace
-            when /Authentication/
-              authentication_namespace
-            else
-              raise StandardError.new(
-                  "Unexpected task definition: #{task_class}.")
-            end
+            namespace = resolve_namespace(task_definition)
 
-            application.in_namespace(ns) do
+            application.in_namespace(namespace) do
               task_definition
-                  .for_task_set(self)
-                  .define_on(application)
+                .for_task_set(self)
+                .define_on(application)
             end
           end
         end
       end
+
+      private
+
+      def resolve_namespace(task_definition)
+        case task_definition.klass.to_s
+        when /Pipeline/ then pipeline_namespace
+        when /Authentication/ then authentication_namespace
+        else
+          raise StandardError,
+                "Unexpected task definition: #{task_definition.klass}."
+        end
+      end
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/rake_fly/task_sets.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'task_sets/authentication'
 require_relative 'task_sets/pipeline'
 require_relative 'task_sets/project'

data/lib/rake_fly/tasks/authentication/ensure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ruby_fly'
 require 'rake_factory'
 require 'concourse'
@@ -7,39 +9,40 @@ module RakeFly
     module Authentication
       class Ensure < RakeFactory::Task
         default_name :ensure
-        default_prerequisites RakeFactory::DynamicValue.new { |t|
+        default_prerequisites(RakeFactory::DynamicValue.new do |t|
           [t.fly_ensure_task_name]
-        }
-        default_description RakeFactory::DynamicValue.new { |t|
+        end)
+        default_description(RakeFactory::DynamicValue.new do |t|
           target = t.target || '<derived>'
 
           "Ensure logged in for target #{target}"
-        }
+        end)
 
         parameter :target, required: true
 
         parameter :home_directory,
-            default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
+                  default: RakeFactory::DynamicValue.new { |_| ENV['HOME'] }
 
-        parameter :login_task_name, :default => :login
+        parameter :login_task_name, default: :login
 
-        parameter :fly_ensure_task_name, :default => :'fly:ensure'
+        parameter :fly_ensure_task_name, default: :'fly:ensure'
 
         action do |t, args|
-          puts "Ensuring target #{t.target} is logged in..."
+          $stdout.puts("Ensuring target #{t.target} is logged in...")
           status = RubyFly.status(
-              target: t.target,
-              environment: {
-                  "HOME" => t.home_directory
-              })
+            target: t.target,
+            environment: {
+              'HOME' => t.home_directory
+            }
+          )
           if status == :logged_in
-            puts "Already logged in. Continuing..."
+            $stdout.puts('Already logged in. Continuing...')
           else
-            puts "Not logged in. Logging in..."
+            $stdout.puts('Not logged in. Logging in...')
             t.application[t.login_task_name, t.scope].invoke(*args)
           end
         end
       end
     end
   end
-end
+end