terraform-wrapper 1.3.1 → 1.3.3

data/lib/terraform-wrapper/shared/runner.rb

@@ -1,32 +1,25 @@
 ###############################################################################
 
 module TerraformWrapper
-
-###############################################################################
+  #############################################################################
 
   module Shared
-
-###############################################################################
+    ###########################################################################
 
     class Runner
-
-###############################################################################
+      #########################################################################
 
       include TerraformWrapper::Shared::Logging
 
-###############################################################################
+      #########################################################################
 
-      @@lockfile_name = ".terraform.lock.hcl"
+      @@lockfile_name = '.terraform.lock.hcl'
 
-###############################################################################
+      #########################################################################
 
-      attr_reader :binary
-      attr_reader :code
-      attr_reader :config
-      attr_reader :downloaded
-      attr_reader :initialised
+      attr_reader :binary, :code, :config, :downloaded, :initialised
 
-###############################################################################
+      #########################################################################
 
       def initialize(binary:, code:)
         logger.fatal("Terraform code location: #{code.path} does not exist!") unless code.check
@@ -37,22 +30,22 @@ module TerraformWrapper
         @initialised = false
       end
 
-###############################################################################
+      #########################################################################
 
       def download
-        parameters = Array.new
-        parameters.append("-backend=false")
+        parameters = []
+        parameters.append('-backend=false')
 
-        logger.fatal("Failed to download Terraform modules.") unless run(action: "init", parameters: parameters)
+        logger.fatal('Failed to download Terraform modules.') unless run(action: 'init', parameters: parameters)
 
         @downloaded = true
       end
 
-###############################################################################
+      #########################################################################
 
       def init(config:)
-        parameters = Array.new
-        parameters.append("-reconfigure")
+        parameters = []
+        parameters.append('-reconfigure')
 
         config.backend.hash.each do |key, value|
           parameters.append("-backend-config=\"#{key}=#{value}\"")
@@ -60,13 +53,13 @@ module TerraformWrapper
 
         config.auths.map(&:auth)
 
-        logger.fatal("Failed to initialise Terraform with backend.") unless run(action: "init", parameters: parameters)
+        logger.fatal('Failed to initialise Terraform with backend.') unless run(action: 'init', parameters: parameters)
 
         @config = config
         @initialised = true
       end
 
-###############################################################################
+      #########################################################################
 
       def upgrade
         lockfile_path = File.join(@code.path, @@lockfile_name)
@@ -76,31 +69,31 @@ module TerraformWrapper
           File.delete(lockfile_path)
         end
 
-        logger.fatal("Lock file removal failed!") if File.file?(lockfile_path)
+        logger.fatal('Lock file removal failed!') if File.file?(lockfile_path)
 
-        parameters = Array.new
-        parameters.append("-update")
-        logger.fatal("Failed to upgrade Terraform modules!") unless run(action: "get", parameters: parameters)
+        parameters = []
+        parameters.append('-update')
+        logger.fatal('Failed to upgrade Terraform modules!') unless run(action: 'get', parameters: parameters)
 
-        parameters = Array.new
-        parameters.append("lock")
+        parameters = []
+        parameters.append('lock')
 
         @binary.provider.platforms.each do |platform|
           parameters.append("-platform=\"#{platform}\"")
         end
 
-        logger.fatal("Failed to upgrade Terraform providers!") unless run(action: "providers", parameters: parameters)
+        logger.fatal('Failed to upgrade Terraform providers!') unless run(action: 'providers', parameters: parameters)
       end
 
-###############################################################################
+      #########################################################################
 
       def apply(file: nil)
-        logger.fatal("Cannot Terraform apply before initialising backend!") unless initialised
+        logger.fatal('Cannot Terraform apply before initialising backend!') unless initialised
 
-        parameters = Array.new
-        parameters.append("-auto-approve")
+        parameters = []
+        parameters.append('-auto-approve')
 
-        if (not file.nil?) and file.kind_of?(String) and (not file.strip.empty?) then
+        if !file.nil? and file.is_a?(String) and !file.strip.empty?
           logger.fatal("Plan file: #{file} does not exist!") unless File.file?(file)
           parameters.append("\"#{file}\"")
         else
@@ -108,95 +101,107 @@ module TerraformWrapper
           parameters.concat(variable_strings)
         end
 
-        logger.fatal("Terraform apply failed!") unless run(action: "apply", parameters: parameters)
+        logger.fatal('Terraform apply failed!') unless run(action: 'apply', parameters: parameters)
       end
 
-###############################################################################
+      #########################################################################
 
       def plan(destroy: false, file: nil)
-        logger.fatal("Cannot Terraform plan before initialising backend!") unless initialised
+        logger.fatal('Cannot Terraform plan before initialising backend!') unless initialised
 
-        parameters = Array.new
+        parameters = []
         parameters.concat(variable_files)
         parameters.concat(variable_strings)
 
-        if not file.nil? and file.kind_of?(String) and not file.strip.empty? then
-          logger.fatal("Failed to create plan directory: #{directory}") unless ::TerraformWrapper.create_directory(directory: File.dirname(file), purpose: "plan")
+        if !file.nil? and file.is_a?(String) and !file.strip.empty?
+          logger.fatal("Failed to create plan directory: #{directory}") unless ::TerraformWrapper.create_directory(
+            directory: File.dirname(file), purpose: 'plan'
+          )
           parameters.append("-out=\"#{file}\"")
         end
 
-        parameters.append("-destroy") if destroy
+        parameters.append('-destroy') if destroy
 
-        logger.fatal("Terraform plan failed!") unless run(action: "plan", parameters: parameters)
+        logger.fatal('Terraform plan failed!') unless run(action: 'plan', parameters: parameters)
       end
 
-###############################################################################
+      #########################################################################
 
       def destroy
-        logger.fatal("Cannot Terraform destroy before initialising backend!") unless initialised
+        logger.fatal('Cannot Terraform destroy before initialising backend!') unless initialised
 
-        parameters = Array.new
+        parameters = []
         parameters.concat(variable_files)
         parameters.concat(variable_strings)
-        parameters.append("-auto-approve")
+        parameters.append('-auto-approve')
 
-        logger.fatal("Terraform destroy failed!") unless run(action: "destroy", parameters: parameters)
+        logger.fatal('Terraform destroy failed!') unless run(action: 'destroy', parameters: parameters)
       end
 
-###############################################################################
+      #########################################################################
 
       def import(address: nil, id: nil)
-        logger.fatal("Cannot Terraform import before initialising backend!") unless initialised
+        logger.fatal('Cannot Terraform import before initialising backend!') unless initialised
 
-        logger.fatal("Terraform state address for import must be a string!") unless address.kind_of?(String)
-        logger.fatal("Terraform state address for import must not be blank!") if address.strip.empty?
+        logger.fatal('Terraform state address for import must be a string!') unless address.is_a?(String)
+        logger.fatal('Terraform state address for import must not be blank!') if address.strip.empty?
 
-        logger.fatal("Identification for infrastructure to import must be a string!") unless id.kind_of?(String)
-        logger.fatal("Identification for infrastructure to import must not be blank!") if id.strip.empty?
+        logger.fatal('Identification for infrastructure to import must be a string!') unless id.is_a?(String)
+        logger.fatal('Identification for infrastructure to import must not be blank!') if id.strip.empty?
 
-        parameters = Array.new
+        parameters = []
         parameters.concat(variable_files)
         parameters.concat(variable_strings)
 
         parameters.append("'#{address}'")
         parameters.append("'#{id}'")
 
-        logger.fatal("Terraform import failed!") unless run(action: "import", parameters: parameters)
+        logger.fatal('Terraform import failed!') unless run(action: 'import', parameters: parameters)
       end
 
-###############################################################################
+      #########################################################################
 
       def taint(address: nil)
-        logger.fatal("Cannot Terraform taint before initialising backend!") unless initialised
+        logger.fatal('Cannot Terraform taint before initialising backend!') unless initialised
 
-        logger.fatal("Terraform state address for taint must be a string!") unless address.kind_of?(String)
-        logger.fatal("Terraform state address for taint must not be blank!") if address.strip.empty?
+        logger.fatal('Terraform state address for taint must be a string!') unless address.is_a?(String)
+        logger.fatal('Terraform state address for taint must not be blank!') if address.strip.empty?
 
-        parameters = Array.new
+        parameters = []
         parameters.append("'#{address}'")
 
-        logger.fatal("Terraform taint failed!") unless run(action: "taint", parameters: parameters)
+        logger.fatal('Terraform taint failed!') unless run(action: 'taint', parameters: parameters)
       end
 
-###############################################################################
+      #########################################################################
+
+      def fmt(check: true)
+        parameters = []
+
+        parameters.append('-check') if check.to_s.downcase == 'true' && check
+
+        logger.fatal('Terraform fmt failed!') unless run(action: 'fmt', parameters: parameters)
+      end
+
+      #########################################################################
 
       def validate
-        logger.fatal("Cannot Terraform validate before downloading modules!") unless downloaded
-        logger.fatal("Terraform validation failed!") unless run(action: "validate")
+        logger.fatal('Cannot Terraform validate before downloading modules!') unless downloaded
+        logger.fatal('Terraform validation failed!') unless run(action: 'validate')
       end
 
-###############################################################################
+      #########################################################################
 
-    private
+      private
 
-###############################################################################
+      #########################################################################
 
-      def run(action:, parameters: Array.new)
+      def run(action:, parameters: [])
         result = false
 
-        parameters.reject! { |item| not item.kind_of?(String) or item.strip.empty? }
+        parameters.reject! { |item| !item.is_a?(String) or item.strip.empty? }
 
-        cmdline = [ "\"#{@binary.path}\"", action ].concat(parameters).join(" ")
+        cmdline = ["\"#{@binary.path}\"", action].concat(parameters).join(' ')
 
         logger.info("Starting Terraform, action: #{action}")
 
@@ -207,47 +212,44 @@ module TerraformWrapper
 
         puts("\n" + ('#' * 80) + "\n\n")
 
-        return result
+        result
       end
 
-###############################################################################
+      #########################################################################
 
       def variable_files
-        logger.fatal("Cannot generate variable files until Terraform has been initialised!") unless @initialised
+        logger.fatal('Cannot generate variable files until Terraform has been initialised!') unless @initialised
 
-        result = Array.new
+        result = []
 
         @config.variables.files.each do |file|
           result.append("-var-file=\"#{file}\"")
         end
 
-        return result
+        result
       end
 
-###############################################################################
+      #########################################################################
 
       def variable_strings
-        logger.fatal("Cannot generate variable strings until Terraform has been initialised!") unless @initialised
+        logger.fatal('Cannot generate variable strings until Terraform has been initialised!') unless @initialised
 
-        result = Array.new
+        result = []
 
         @config.variables.values.each do |key, value|
-          result.append("-var=\"#{key.to_s}=#{value}\"")
+          result.append("-var=\"#{key}=#{value}\"")
         end
 
-        return result
+        result
       end
 
-###############################################################################
-
+      #########################################################################
     end
 
-###############################################################################
-
+    ###########################################################################
   end
 
-###############################################################################
-
+  #############################################################################
 end
 
 ###############################################################################

data/lib/terraform-wrapper/tasks/apply.rb

@@ -1,26 +1,23 @@
 ###############################################################################
 
 module TerraformWrapper
-
-###############################################################################
+  #############################################################################
 
   module Tasks
-
-###############################################################################
+    ###########################################################################
 
     class Apply < ::Rake::TaskLib
-
-###############################################################################
+      #########################################################################
 
       include TerraformWrapper::Shared::Logging
 
-###############################################################################
+      #########################################################################
 
       @binary
       @code
       @options
 
-###############################################################################
+      #########################################################################
 
       def initialize(binary:, code:, options:)
         @binary  = binary
@@ -32,14 +29,14 @@ module TerraformWrapper
         apply_task
       end
 
-###############################################################################
+      #########################################################################
 
       def apply_task
-        desc "Applies infrastructure with Terraform for a given configuration on an infrastructure component."
-        task :apply, [:config, :plan] => :binary do |t, args|
-          options = @options.merge({"name" => args[:config]})
+        desc 'Applies infrastructure with Terraform for a given configuration on an infrastructure component.'
+        task :apply, %i[config plan] => :binary do |_t, args|
+          options = @options.merge({ 'name' => args[:config] })
 
-          logger.info("Processing configuration for Terraform apply...")
+          logger.info('Processing configuration for Terraform apply...')
 
           config = TerraformWrapper::Shared::Config.new(code: @code, options: options)
           runner = TerraformWrapper::Shared::Runner.new(binary: @binary, code: @code)
@@ -51,16 +48,13 @@ module TerraformWrapper
         end
       end
 
-###############################################################################
-
+      #########################################################################
     end
 
-###############################################################################
-
+    ###########################################################################
   end
 
-###############################################################################
-
+  #############################################################################
 end
 
 ###############################################################################

data/lib/terraform-wrapper/tasks/binary.rb

@@ -9,24 +9,21 @@ require 'zip'
 ###############################################################################
 
 module TerraformWrapper
-
-###############################################################################
+  #############################################################################
 
   module Tasks
-
-###############################################################################
+    ###########################################################################
 
     class Binary < ::Rake::TaskLib
-
-###############################################################################
+      #########################################################################
 
       include TerraformWrapper::Shared::Logging
 
-###############################################################################
+      #########################################################################
 
       @binary
 
-###############################################################################
+      #########################################################################
 
       def initialize(binary:)
         @binary = binary
@@ -36,19 +33,21 @@ module TerraformWrapper
         binary_task
       end
 
-###############################################################################
+      #########################################################################
 
       def binary_task
-        desc "Downloads and extracts the expected version of the Terraform binary if it is not already present."
-        task :binary do |t, args|
+        desc 'Downloads and extracts the expected version of the Terraform binary if it is not already present.'
+        task :binary do |_t, _args|
           logger.info("Checking Terraform binary for platform: #{@binary.platform}, version: #{@binary.version}")
 
-          if not @binary.exists then
-            logger.info("Terraform binary not found. Preparing binary...")
+          unless @binary.exists
+            logger.info('Terraform binary not found. Preparing binary...')
 
-            logger.fatal("Failed to create binary directory: #{directory}") unless ::TerraformWrapper.create_directory(directory: @binary.directory, purpose: "binaries")
+            logger.fatal("Failed to create binary directory: #{directory}") unless ::TerraformWrapper.create_directory(
+              directory: @binary.directory, purpose: 'binaries'
+            )
 
-            archive_binary = "terraform"
+            archive_binary = 'terraform'
             archive_file   = "terraform_#{@binary.version}_#{@binary.platform}_amd64.zip"
             archive_path   = File.join(@binary.directory, archive_file)
             archive_uri    = "https://releases.hashicorp.com/terraform/#{@binary.version}/#{archive_file}"
@@ -58,8 +57,8 @@ module TerraformWrapper
             sums_uri  = "https://releases.hashicorp.com/terraform/#{@binary.version}/#{sums_file}"
 
             begin
-              download(path: archive_path, uri: archive_uri) if not File.file?(archive_path)
-              download(path: sums_path, uri: sums_uri) if not File.file?(sums_path)
+              download(path: archive_path, uri: archive_uri) unless File.file?(archive_path)
+              download(path: sums_path, uri: sums_uri) unless File.file?(sums_path)
               verify(file: archive_file, path: archive_path, sums: sums_path)
               extract(archive: archive_path, binary: archive_binary, destination: @binary.path)
             ensure
@@ -67,38 +66,38 @@ module TerraformWrapper
             end
           end
 
-          if not @binary.executable then
-            logger.info("Terraform binary not executable. Setting permissions...")
+          unless @binary.executable
+            logger.info('Terraform binary not executable. Setting permissions...')
             executable(path: @binary.path)
           end
 
-          logger.fatal("Problem with checking the Terraform binary!") unless @binary.check
+          logger.fatal('Problem with checking the Terraform binary!') unless @binary.check
         end
       end
 
-###############################################################################
+      #########################################################################
 
       private
 
-###############################################################################
+      #########################################################################
 
       def download(path:, uri:)
         logger.info("Downloading: #{uri}")
 
         response = Net::HTTP.get_response(URI(uri))
 
-        logger.fatal("Download request did not return HTTP status 200!") if response.code != "200"
-        logger.fatal("Download response body is not permitted!")         unless response.class.body_permitted?
-        logger.fatal("Download response body is empty!")                 if response.body.nil?
+        logger.fatal('Download request did not return HTTP status 200!') if response.code != '200'
+        logger.fatal('Download response body is not permitted!')         unless response.class.body_permitted?
+        logger.fatal('Download response body is empty!')                 if response.body.nil?
 
-        open(path, "wb") { |file|
+        open(path, 'wb') do |file|
           file.write(response.body)
-        }
+        end
 
-        logger.fatal("Download failed!") unless File.file?(path)
+        logger.fatal('Download failed!') unless File.file?(path)
       end
 
-###############################################################################
+      #########################################################################
 
       def verify(file:, path:, sums:)
         logger.info("Checking SHA256 for: #{file}")
@@ -109,26 +108,26 @@ module TerraformWrapper
 
         File.readlines(sums).each do |line|
           begin
-            fields     = line.match /^(?<sum>\S+)\s+(?<file>\S+)$/
-            sum_file   = fields["file"]
-            sum_sha256 = fields["sum"]
-          rescue
+            fields     = line.match(/^(?<sum>\S+)\s+(?<file>\S+)$/)
+            sum_file   = fields['file']
+            sum_sha256 = fields['sum']
+          rescue StandardError
             logger.warn("Unexpected data in sums file: #{sums}")
             next
           end
 
-          if sum_file == file then
-            logger.info("Expected SHA256 sum: #{sum_sha256}")
-            logger.info("Actual SHA256 sum: #{sha256}")
-            result = (sum_sha256 == sha256)
-            break
-          end
+          next unless sum_file == file
+
+          logger.info("Expected SHA256 sum: #{sum_sha256}")
+          logger.info("Actual SHA256 sum: #{sha256}")
+          result = (sum_sha256 == sha256)
+          break
         end
 
-        logger.fatal("Error whilst verifying the SHA256 sum of the downloaded Terraform archive!") unless result
+        logger.fatal('Error whilst verifying the SHA256 sum of the downloaded Terraform archive!') unless result
       end
 
-###############################################################################
+      #########################################################################
 
       def extract(archive:, binary:, destination:)
         logger.info("Extracting: #{archive}")
@@ -139,43 +138,42 @@ module TerraformWrapper
           end
         end
 
-        logger.fatal("Extraction of Terraform binary: #{binary}, from archive: #{archive} has failed!") unless File.file?(destination)
+        return if File.file?(destination)
+
+        logger.fatal("Extraction of Terraform binary: #{binary}, from archive: #{archive} has failed!")
       end
 
-###############################################################################
+      #########################################################################
 
       def executable(path:)
         logger.info("Making executable: #{path}")
-        FileUtils.chmod("+x", path)
+        FileUtils.chmod('+x', path)
         logger.fatal("Setting executable bit on file: #{path} has failed!") unless File.executable?(path)
       end
 
-###############################################################################
+      #########################################################################
 
       def clean(archive:, sums:)
         [archive, sums].each do |file|
-          if File.file?(file)
-            logger.info("Removing file: #{file}")
+          next unless File.file?(file)
 
-            begin
-              File.delete(file)
-            rescue
-              logger.error("Failed to delete: #{file}, please remove manually.")
-            end
+          logger.info("Removing file: #{file}")
+
+          begin
+            File.delete(file)
+          rescue StandardError
+            logger.error("Failed to delete: #{file}, please remove manually.")
           end
         end
       end
 
-###############################################################################
-
+      #########################################################################
     end
 
-###############################################################################
-
+    ###########################################################################
   end
 
-###############################################################################
-
+  #############################################################################
 end
 
 ###############################################################################