rake_terraform 1.11.0 → 1.16.0.pre.1

data/lib/rake_terraform/task_sets/terraform.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'rake'
+
+module RakeTerraform
+  module TaskSets
+    # rubocop:disable Metrics/ClassLength
+
+    class Terraform
+      def self.define(*args, &configuration_block)
+        new(*args, &configuration_block).define_on(Rake.application)
+      end
+
+      attr_reader :delegate
+
+      def initialize(*args, &configuration_block)
+        @opts = args[0]
+        @delegate =
+          RakeDependencies::TaskSets::All.define(
+            task_set_opts, &configuration_block
+          )
+      end
+
+      def define_on(application)
+        @delegate.define_on(application)
+        self
+      end
+
+      def binary
+        @binary ||= File.join(path, binary_directory, binary_name)
+      end
+
+      private
+
+      # rubocop:disable Metrics/MethodLength
+
+      def task_set_opts
+        {
+          namespace: namespace,
+          dependency: dependency,
+          version: version,
+          path: path,
+          type: type,
+
+          os_ids: os_ids,
+
+          uri_template: uri_template,
+          file_name_template: file_name_template,
+
+          binary_directory: binary_directory,
+
+          needs_fetch: needs_fetch
+        }
+      end
+
+      # rubocop:enable Metrics/MethodLength
+
+      def logger
+        @logger ||=
+          @opts[:logger] ||
+          Logger.new($stderr,
+                     level: Logger.const_get(ENV['TF_LOG'] || 'WARN'))
+      end
+
+      def namespace
+        @namespace ||= @opts[:namespace] || :terraform
+      end
+
+      def dependency
+        @dependency ||= 'terraform'
+      end
+
+      def version
+        @version ||= @opts[:version] || '0.10.3'
+      end
+
+      def path
+        @path ||= @opts[:path] ||
+                  File.join(Dir.pwd, 'vendor', 'terraform')
+      end
+
+      def binary_directory
+        @binary_directory ||= 'bin'
+      end
+
+      def binary_name
+        @binary_name ||= 'terraform'
+      end
+
+      def type
+        @type ||= :zip
+      end
+
+      def os_ids
+        @os_ids ||= { mac: 'darwin', linux: 'linux' }
+      end
+
+      def uri_template
+        @uri_template ||=
+          'https://releases.hashicorp.com/terraform/<%= @version %>/' \
+          'terraform_<%= @version %>_<%= @os_id %>_amd64<%= @ext %>'
+      end
+
+      def file_name_template
+        @file_name_template ||=
+          'terraform_<%= @version %>_<%= @os_id %>_amd64<%= @ext %>'
+      end
+
+      def needs_fetch
+        @needs_fetch ||= ->(_) { return !exists_with_correct_version?(binary) }
+      end
+
+      def exists_with_correct_version?(binary)
+        log_binary_location(binary)
+
+        exist?(binary) && correct_version?(binary)
+      end
+
+      def exist?(binary)
+        File.exist?(binary)
+      end
+
+      def correct_version?(binary)
+        result = StringIO.new
+        command = version_command(binary)
+
+        log_version_lookup(command)
+
+        command.execute(stdout: result)
+
+        log_version_information(result)
+        log_check_outcome(result)
+
+        contains_version_number?(result)
+      end
+
+      def version_command(binary)
+        Lino::CommandLineBuilder
+          .for_command(binary)
+          .with_flag('-version')
+          .build
+      end
+
+      def log_binary_location(binary)
+        logger.info("Terraform binary should be at: #{binary}")
+      end
+
+      def log_version_lookup(command)
+        logger.info(
+          'Fetching terraform version information using command: ' \
+            "#{command}"
+        )
+      end
+
+      def log_version_information(result)
+        logger.info(
+          "Terraform version information is: \n#{result}"
+        )
+      end
+
+      def log_check_outcome(result)
+        logger.debug(
+          "Version: '#{version}' is in version line: " \
+          "'#{version_line(result)}'?: #{contains_version_number?(result)}"
+        )
+      end
+
+      def version_line(result)
+        result.string.lines.first
+      end
+
+      def contains_version_number?(result)
+        version_line(result) =~ /#{version}/
+      end
+    end
+
+    # rubocop:enable Metrics/ClassLength
+  end
+end

data/lib/rake_terraform/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'tasks/validate'
 require_relative 'tasks/plan'
 require_relative 'tasks/provision'

data/lib/rake_terraform/tasks/destroy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 require 'ruby_terraform'
 require 'ostruct'
@@ -7,16 +9,16 @@ module RakeTerraform
   module Tasks
     class Destroy < RakeFactory::Task
       default_name :destroy
-      default_prerequisites RakeFactory::DynamicValue.new { |t|
+      default_prerequisites(RakeFactory::DynamicValue.new do |t|
         [t.ensure_task_name]
-      }
-      default_description RakeFactory::DynamicValue.new { |t|
+      end)
+      default_description(RakeFactory::DynamicValue.new do |t|
         "Destroy #{t.configuration_name} using terraform"
-      }
+      end)
 
-      parameter :configuration_name, :required => true
-      parameter :source_directory, :required => true
-      parameter :work_directory, :required => true
+      parameter :configuration_name, required: true
+      parameter :source_directory, required: true
+      parameter :work_directory, required: true
 
       parameter :backend_config
 
@@ -24,39 +26,42 @@ module RakeTerraform
       parameter :var_file
       parameter :state_file
 
-      parameter :debug, :default => false
-      parameter :no_color, :default => false
-      parameter :no_backup, :default => false
+      parameter :debug, default: false
+      parameter :no_color, default: false
+      parameter :no_backup, default: false
 
       parameter :backup_file
 
-      parameter :ensure_task_name, :default => :'terraform:ensure'
+      parameter :ensure_task_name, default: :'terraform:ensure'
 
       action do |t|
         Colored2.disable! if t.no_color
 
         configuration_directory =
-            File.join(t.work_directory, t.source_directory)
+          File.join(t.work_directory, t.source_directory)
 
-        puts "Destroying #{t.configuration_name}".cyan
+        Kernel.puts "Destroying #{t.configuration_name}".cyan
         RubyTerraform.clean(
-            directory: configuration_directory)
+          directory: configuration_directory
+        )
 
-        mkdir_p File.dirname(configuration_directory)
-        cp_r t.source_directory, configuration_directory
+        FileUtils.mkdir_p(File.dirname(configuration_directory))
+        FileUtils.cp_r(t.source_directory, configuration_directory)
 
         Dir.chdir(configuration_directory) do
           RubyTerraform.init(
-              backend_config: t.backend_config,
-              no_color: t.no_color)
+            backend_config: t.backend_config,
+            no_color: t.no_color
+          )
           RubyTerraform.destroy(
-              force: true,
-              no_color: t.no_color,
-              no_backup: t.no_backup,
-              backup: t.backup_file,
-              state: t.state_file,
-              vars: t.vars,
-              var_file: t.var_file)
+            force: true,
+            no_color: t.no_color,
+            no_backup: t.no_backup,
+            backup: t.backup_file,
+            state: t.state_file,
+            vars: t.vars,
+            var_file: t.var_file
+          )
         end
       end
     end

data/lib/rake_terraform/tasks/output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 require 'ruby_terraform'
 require 'ostruct'
@@ -7,50 +9,53 @@ module RakeTerraform
   module Tasks
     class Output < RakeFactory::Task
       default_name :output
-      default_prerequisites RakeFactory::DynamicValue.new { |t|
+      default_prerequisites(RakeFactory::DynamicValue.new do |t|
         [t.ensure_task_name]
-      }
-      default_description RakeFactory::DynamicValue.new { |t|
+      end)
+      default_description(RakeFactory::DynamicValue.new do |t|
         "Output #{t.configuration_name} using terraform"
-      }
+      end)
 
-      parameter :configuration_name, :required => true
-      parameter :source_directory, :required => true
-      parameter :work_directory, :required => true
+      parameter :configuration_name, required: true
+      parameter :source_directory, required: true
+      parameter :work_directory, required: true
 
       parameter :backend_config
 
       parameter :state_file
 
-      parameter :debug, :default => false
-      parameter :no_color, :default => false
-      parameter :no_print_output, :default => false
+      parameter :debug, default: false
+      parameter :no_color, default: false
+      parameter :no_print_output, default: false
 
-      parameter :ensure_task_name, :default => :'terraform:ensure'
+      parameter :ensure_task_name, default: :'terraform:ensure'
 
       action do |t|
         Colored2.disable! if t.no_color
 
         configuration_directory =
-            File.join(t.work_directory, t.source_directory)
+          File.join(t.work_directory, t.source_directory)
 
-        puts "Output of #{t.configuration_name}".cyan
+        Kernel.puts("Output of #{t.configuration_name}".cyan)
         RubyTerraform.clean(
-            directory: configuration_directory)
+          directory: configuration_directory
+        )
 
-        mkdir_p File.dirname(configuration_directory)
-        cp_r t.source_directory, configuration_directory
+        FileUtils.mkdir_p(File.dirname(configuration_directory))
+        FileUtils.cp_r(t.source_directory, configuration_directory)
 
         Dir.chdir(configuration_directory) do
           RubyTerraform.init(
-              backend_config: t.backend_config,
-              no_color: t.no_color)
+            backend_config: t.backend_config,
+            no_color: t.no_color
+          )
 
           output = RubyTerraform.output(
-              no_color: t.no_color,
-              state: t.state_file)
+            no_color: t.no_color,
+            state: t.state_file
+          )
 
-          puts output unless t.no_print_output
+          Kernel.puts(output) unless t.no_print_output
 
           output
         end

data/lib/rake_terraform/tasks/plan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 require 'ruby_terraform'
 require 'ostruct'
@@ -7,16 +9,16 @@ module RakeTerraform
   module Tasks
     class Plan < RakeFactory::Task
       default_name :plan
-      default_prerequisites RakeFactory::DynamicValue.new { |t|
+      default_prerequisites(RakeFactory::DynamicValue.new do |t|
         [t.ensure_task_name]
-      }
-      default_description RakeFactory::DynamicValue.new { |t|
+      end)
+      default_description(RakeFactory::DynamicValue.new do |t|
         "Plan #{t.configuration_name} using terraform"
-      }
+      end)
 
-      parameter :configuration_name, :required => true
-      parameter :source_directory, :required => true
-      parameter :work_directory, :required => true
+      parameter :configuration_name, required: true
+      parameter :source_directory, required: true
+      parameter :work_directory, required: true
 
       parameter :backend_config
 
@@ -24,38 +26,41 @@ module RakeTerraform
       parameter :var_file
       parameter :state_file
 
-      parameter :debug, :default => false
-      parameter :no_color, :default => false
+      parameter :debug, default: false
+      parameter :no_color, default: false
 
       parameter :plan_file
-      parameter :destroy, :default => false
+      parameter :destroy, default: false
 
-      parameter :ensure_task_name, :default => :'terraform:ensure'
+      parameter :ensure_task_name, default: :'terraform:ensure'
 
       action do |t|
         Colored2.disable! if t.no_color
 
         configuration_directory =
-            File.join(t.work_directory, t.source_directory)
+          File.join(t.work_directory, t.source_directory)
 
-        puts "Planning #{configuration_name}".cyan
+        Kernel.puts("Planning #{configuration_name}".cyan)
         RubyTerraform.clean(
-            directory: configuration_directory)
+          directory: configuration_directory
+        )
 
-        mkdir_p File.dirname(configuration_directory)
-        cp_r t.source_directory, configuration_directory
+        FileUtils.mkdir_p(File.dirname(configuration_directory))
+        FileUtils.cp_r(t.source_directory, configuration_directory)
 
         Dir.chdir(configuration_directory) do
           RubyTerraform.init(
-              backend_config: t.backend_config,
-              no_color: t.no_color)
+            backend_config: t.backend_config,
+            no_color: t.no_color
+          )
           RubyTerraform.plan(
-              no_color: t.no_color,
-              destroy: t.destroy,
-              state: t.state_file,
-              plan: t.plan_file,
-              vars: t.vars,
-              var_file: t.var_file)
+            no_color: t.no_color,
+            destroy: t.destroy,
+            state: t.state_file,
+            plan: t.plan_file,
+            vars: t.vars,
+            var_file: t.var_file
+          )
         end
       end
     end

data/lib/rake_terraform/tasks/provision.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 require 'ruby_terraform'
 require 'ostruct'
@@ -7,16 +9,16 @@ module RakeTerraform
   module Tasks
     class Provision < RakeFactory::Task
       default_name :provision
-      default_prerequisites RakeFactory::DynamicValue.new { |t|
+      default_prerequisites(RakeFactory::DynamicValue.new do |t|
         [t.ensure_task_name]
-      }
-      default_description RakeFactory::DynamicValue.new { |t|
+      end)
+      default_description(RakeFactory::DynamicValue.new do |t|
         "Provision #{t.configuration_name} using terraform"
-      }
+      end)
 
-      parameter :configuration_name, :required => true
-      parameter :source_directory, :required => true
-      parameter :work_directory, :required => true
+      parameter :configuration_name, required: true
+      parameter :source_directory, required: true
+      parameter :work_directory, required: true
 
       parameter :backend_config
 
@@ -24,40 +26,42 @@ module RakeTerraform
       parameter :var_file
       parameter :state_file
 
-      parameter :debug, :default => false
-      parameter :no_color, :default => false
-      parameter :no_backup, :default => false
+      parameter :debug, default: false
+      parameter :no_color, default: false
+      parameter :no_backup, default: false
 
       parameter :backup_file
 
-      parameter :ensure_task_name, :default => :'terraform:ensure'
+      parameter :ensure_task_name, default: :'terraform:ensure'
 
       action do |t|
         Colored2.disable! if t.no_color
 
         configuration_directory =
-            File.join(t.work_directory, t.source_directory)
+          File.join(t.work_directory, t.source_directory)
 
-        puts "Provisioning #{t.configuration_name}".cyan
+        Kernel.puts("Provisioning #{t.configuration_name}".cyan)
         RubyTerraform.clean(
-            directory: configuration_directory)
-
-        mkdir_p File.dirname(configuration_directory)
-        cp_r t.source_directory, configuration_directory
+          directory: configuration_directory
+        )
 
+        FileUtils.mkdir_p(File.dirname(configuration_directory))
+        FileUtils.cp_r(t.source_directory, configuration_directory)
 
         Dir.chdir(configuration_directory) do
           RubyTerraform.init(
-              backend_config: t.backend_config,
-              no_color: t.no_color)
+            backend_config: t.backend_config,
+            no_color: t.no_color
+          )
           RubyTerraform.apply(
-              auto_approve: true,
-              no_color: t.no_color,
-              no_backup: t.no_backup,
-              backup: t.backup_file,
-              state: t.state_file,
-              vars: t.vars,
-              var_file: t.var_file)
+            auto_approve: true,
+            no_color: t.no_color,
+            no_backup: t.no_backup,
+            backup: t.backup_file,
+            state: t.state_file,
+            vars: t.vars,
+            var_file: t.var_file
+          )
         end
       end
     end