rake_terraform 1.15.0 → 1.16.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d550032093e5d7de07df9b79e3381ecf28b9b952bfaec0ed5a3a74f3aa13b4f0
-  data.tar.gz: c4d7faa23016ed97162f5ee35ae0c7c028717935415302dc6a07886a6f610304
+  metadata.gz: 47f55aa9a595370ed1f405492791f178e0f2e532ac4ae132ab4a9686978ec6be
+  data.tar.gz: 31709ec776abc2f745c9361693bd0d9b3c657f8b18b7a978e95c14cbefe5d605
 SHA512:
-  metadata.gz: 11b9533ffdd188e022a83f464d132788213581aacfcd80d700d8a7343a2e44eacfcf81fb7d3ff6b66bf66ca9717cac3052a3dd33d7761c3364d5dc7374a58fff
-  data.tar.gz: 327079e6269ca3a8fba4161760ff105b85a84b191d4fd58024317f1aa62a463b712a13c13d4faaf6018a427f97b612c80b82cd6aa17f712cf8213b23950ec3c8
+  metadata.gz: f6bad9acb193c43b44422f995974010af3296d3f59759a54279eb1436c558c9199c0806480d3e120d914f3538363fa171b74832d3a2f83f943343be0b67b1949
+  data.tar.gz: f93d1ffa1051d13bb2ae28d91410577bc999d1d485593525ba663cbe583bdef3051e8ceedf20f4d2a412e91efed3f0bc325e34daddca0b7d1f75b21b2a11b58f

data/Gemfile

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

data/Gemfile.lock

@@ -1,48 +1,88 @@
 PATH
   remote: .
   specs:
-    rake_terraform (1.15.0)
+    rake_terraform (1.16.0.pre.1)
       colored2 (~> 3.1)
-      rake_dependencies (~> 2, < 3)
-      rake_factory (>= 0.23, < 1)
-      ruby-terraform (>= 0.62, < 1)
+      rake_dependencies (~> 2.9)
+      rake_factory (~> 0.23)
+      ruby-terraform (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.5)
+    activesupport (5.2.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
     colored2 (3.1.2)
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    excon (0.79.0)
+    docile (1.3.5)
+    excon (0.81.0)
     fakefs (0.20.1)
-    faraday (1.3.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    ffi (1.15.0)
+    formatador (0.2.5)
     gem-release (2.2.1)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     hamster (3.0.0)
       concurrent-ruby (~> 1.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    lino (2.5.0)
+    immutable-struct (2.4.1)
+    lino (2.7.0)
       hamster (~> 3.0)
       open4 (~> 1.3)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     minitar (0.9)
     minitest (5.14.4)
     multipart-post (2.1.1)
-    octokit (4.20.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     public_suffix (4.0.6)
+    rainbow (3.0.0)
     rake (13.0.3)
     rake_circle_ci (0.9.0)
       colored2 (~> 3.1)
@@ -69,6 +109,11 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -82,8 +127,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    ruby-terraform (0.64.0)
-      lino (>= 1.5)
+    rubocop (1.14.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.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby-terraform (1.1.0)
+      immutable-struct (~> 2.4)
+      lino (~> 2.7)
     ruby2_keywords (0.0.4)
     ruby_gpg2 (0.8.0)
       lino (>= 1.5)
@@ -91,10 +154,20 @@ GEM
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     sshkey (2.0.0)
+    thor (1.1.0)
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
@@ -103,7 +176,9 @@ DEPENDENCIES
   activesupport (~> 5.2)
   bundler (~> 2.0)
   fakefs (~> 0.18)
-  gem-release (~> 2.0)
+  gem-release (~> 2.1)
+  guard (~> 2.16)
+  guard-rspec (~> 4.7)
   rake (~> 13.0)
   rake_circle_ci (~> 0.9)
   rake_github (~> 0.5)
@@ -111,6 +186,11 @@ DEPENDENCIES
   rake_ssh (~> 0.4)
   rake_terraform!
   rspec (~> 3.9)
+  rubocop (~> 1.12)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.2)
+  simplecov (~> 0.21)
+  yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.16
+   2.2.17

data/Rakefile

@@ -1,17 +1,23 @@
+# frozen_string_literal: true
+
 require 'yaml'
+require 'yard'
 require 'rake_circle_ci'
 require 'rake_github'
 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))
@@ -23,83 +29,124 @@ 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_terraform CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'rake_terraform CI Key'
+    )
   end
 end
 
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = %w[--embed-mixins --output-dir docs]
+end
+
+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 :documentation do
+  desc 'Generate documentation'
+  task generate: [:yard]
+
+  desc 'Commit documentation'
+  task :commit, [:skip] do |_, args|
+    args.with_defaults(skip: 'true')
+
+    skip_ci = args.skip == 'true'
+
+    sh('git', 'commit',
+       '-a',
+       '-m', "Generate latest documentation#{skip_ci ? ' [ci skip]' : ''}")
+  end
+
+  desc 'Update documentation'
+  task update: %i[generate commit]
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end
+
 RakeCircleCI.define_project_tasks(
-    namespace: :circle_ci,
-    project_slug: 'github/infrablocks/rake_terraform'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/rake_terraform'
 ) 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_terraform',
+  namespace: :github,
+  repository: 'infrablocks/rake_terraform'
 ) do |t|
   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')
+    }
   ]
 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/terraform"
+require 'bundler/setup'
+require 'rake_terraform'
 
 # 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/terraform"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/rake_terraform.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'rake_dependencies'
 require 'ruby_terraform'
@@ -6,137 +8,54 @@ require 'rake_terraform/tasks'
 require 'rake_terraform/task_sets'
 
 module RakeTerraform
-  include RubyTerraform
-
   def self.define_command_tasks(opts = {}, &block)
     RakeTerraform::TaskSets::All.define(opts, &block)
   end
 
   def self.define_installation_tasks(opts = {})
-    logger = opts[:logger] ||
-        Logger.new(STDERR, level: Logger.const_get(ENV['TF_LOG'] || 'WARN'))
-
-    namespace = opts[:namespace] || :terraform
-    version = opts[:version] || '0.10.3'
-    path = opts[:path] || File.join(Dir.pwd, 'vendor', 'terraform')
-    providers = opts[:providers] || []
-
-    command_task_set_opts = {
-        namespace: namespace,
-        dependency: 'terraform',
-        version: version,
-        path: path,
-        type: :zip,
-
-        os_ids: {mac: 'darwin', linux: 'linux'},
-
-        uri_template:
-            'https://releases.hashicorp.com/terraform/<%= @version %>/' +
-                'terraform_<%= @version %>_<%= @os_id %>_amd64<%= @ext %>',
-        file_name_template:
-            'terraform_<%= @version %>_<%= @os_id %>_amd64<%= @ext %>',
-
-        needs_fetch: lambda { |params|
-          terraform_binary = File.join(
-              params.path, params.binary_directory, 'terraform')
-          version_string = StringIO.new
+    command_task_set = define_command_installation_tasks(opts)
+    provider_task_sets = define_providers_installation_tasks(opts)
 
-          logger.info("Terraform binary should be at: #{terraform_binary}")
+    configure_ruby_terraform(command_task_set.binary)
+    wire_provider_ensure_tasks(opts)
 
-          if File.exist?(terraform_binary)
-            command_line = Lino::CommandLineBuilder
-                .for_command(terraform_binary)
-                .with_flag('-version')
-                .build
-
-            logger.info(
-                'Fetching terraform version information using command: ' +
-                    "#{command_line}")
-
-            command_line.execute(stdout: version_string)
-
-            logger.info(
-                "Terraform version information is: \n#{version_string.string}")
-
-            version_line = version_string.string.lines.first
-            version_is_correct = version_line =~ /#{version}/
-
-            logger.debug(
-                "Version: '#{version}' is in version line: " +
-                    "'#{version_line}'?: #{version_is_correct}")
-
-            return !version_is_correct
-          end
+    [command_task_set.delegate, provider_task_sets.map(&:delegate)]
+  end
 
-          return true
-        }
-    }
+  class << self
+    private
 
-    RubyTerraform.configure do |c|
-      c.binary = File.join(path, 'bin', 'terraform')
+    def define_command_installation_tasks(opts = {})
+      RakeTerraform::TaskSets::Terraform.define(opts)
     end
 
-    command_task_set = RakeDependencies::TaskSets::All
-        .define(command_task_set_opts)
-
-    provider_task_sets = providers.map do |provider|
-      dependency = "terraform-provider-#{provider[:name]}"
-      provider_task_set_opts = {
-          namespace: provider[:name],
-          dependency: dependency,
-          version: provider[:version],
-          path: provider[:path] || File.join('vendor', dependency),
-          type: :tar_gz,
-
-          os_ids: {mac: 'darwin', linux: 'linux'},
-
-          uri_template:
-              "https://github.com/#{provider[:repository]}/releases/" +
-                  "download/<%= @version %>/" +
-                  "#{dependency}_v<%= @version %>_<%= @os_id %>" +
-                  "_amd64<%= @ext %>",
-          file_name_template:
-              "#{dependency}_v<%= @version %>_<%= @os_id %>_amd64<%= @ext %>",
-
-          source_binary_name_template: dependency,
-          target_binary_name_template: "#{dependency}_v<%= @version %>",
-
-          installation_directory: "#{ENV['HOME']}/.terraform.d/plugins",
-
-          needs_fetch: lambda { |params|
-            provider_binary = File.join(
-                params.path,
-                params.binary_directory,
-                "#{dependency}_v#{params.version}")
-
-            logger.info(
-                "Terraform provider binary for: #{provider.name} " +
-                    "should be at: #{provider_binary}")
-
-            binary_exists = File.exists?(provider_binary)
-
-            logger.debug("Provider file exists?: #{binary_exists}")
-
-            !binary_exists
-          }
-      }
+    def define_provider_installation_tasks(opts = {})
+      RakeTerraform::TaskSets::Provider.define(opts)
+    end
 
-      provider_task_set = RakeDependencies::TaskSets::All.new(
-          provider_task_set_opts)
+    def define_providers_installation_tasks(opts = {})
+      namespace = opts[:namespace] || :terraform
+      providers = opts[:providers] || []
 
-      Rake.application.in_namespace namespace do
-        Rake.application.in_namespace :providers do
-          provider_task_set.define_on(Rake.application)
-        end
+      providers.map do |provider_opts|
+        define_provider_installation_tasks(
+          { parent_namespace: namespace }.merge(provider_opts)
+        )
       end
+    end
 
-      provider_task_set
+    def configure_ruby_terraform(binary)
+      RubyTerraform.configure { |c| c.binary = binary }
     end
 
-    Rake::Task["#{namespace}:ensure"]
-        .enhance(providers.map { |provider|
-          "#{namespace}:providers:#{provider[:name]}:ensure" })
+    def wire_provider_ensure_tasks(opts)
+      namespace = opts[:namespace] || :terraform
+      providers = opts[:providers] || []
 
-    return command_task_set, provider_task_sets
+      Rake::Task["#{namespace}:ensure"]
+        .enhance(providers.map do |provider_opts|
+          "#{namespace}:providers:#{provider_opts[:name]}:ensure"
+        end)
+    end
   end
 end