terraform-wrapper 1.0.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d30c2203437eadddce4f57b8f845b991a2460b7c20d3fc6e223386a26707c78
-  data.tar.gz: 1b1c50e4a9beffa0b51b847505b06522bcf4849016db8ee2fc0e2c2d811266bc
+  metadata.gz: f79a8c4cca3d760d2dac3766055a31b94ce3d24785d946c37cf63c8976ef8000
+  data.tar.gz: ff9a1986b4473b7697439d3729f79dfffa18f22301436171f736ff238ee16394
 SHA512:
-  metadata.gz: c333afef9d9a4cf2fa35c0ad0d02a37a7945fe5c2d5261f3de0228a6f1d2f41a844f674faa63eb7c803db81b647e6df3e36e17f709a11ff4f1ea648c84d25cba
-  data.tar.gz: 2d4264529b09c33a18c4ea15438e43a5fad87ffe10a30ccca51abbbd011984e5b509341e17c070c88cf74e76f329ac9fa035d150149ef4d518cbcf4bb7bc1d87
+  metadata.gz: 8e7271146e058d3166c7414710a85345fb3d5d26b5a5beaecdc36b416c6b65bf4197a0a6325cdeec04996e554f06c345fcee5878d23f0efd02b431261b047491
+  data.tar.gz: a097d6d1baf0373e7ed4ba14ef34d36ecf907b022c87da6ea747d2398d46dea65c3acf52a4d6dcc435b050debbf30e8d2ba288902d55219a44b18fabd459d667

data/lib/terraform-wrapper.rb

@@ -22,7 +22,7 @@ module TerraformWrapper
 
 ###############################################################################
 
-  def self.define_tasks(component:, options: Hash.new, service:)
+  def self.deployment_tasks(component:, options: Hash.new, service:)
     @logger.info("Building tasks for service: #{service}, component: #{component}...")
 
     @logger.fatal("Options must be specified as a hash!") unless options.kind_of?(Hash)
@@ -43,8 +43,12 @@ module TerraformWrapper
     config_options["backend-options"]    = options.key?("config-backend-options")    ? options["config-backend-options"]    : Hash.new
     config_options["service"]            = service
 
-    binary = TerraformWrapper::Shared::Binary.new(options: binary_options)
-    code   = TerraformWrapper::Shared::Code.new(options: code_options)
+    provider_options = Hash.new
+    provider_options["platforms"] = options.key?("provider-platforms") ? options["provider-platforms"] : Array.new
+
+    provider = TerraformWrapper::Shared::Provider.new(options: provider_options)
+    binary   = TerraformWrapper::Shared::Binary.new(options: binary_options, provider: provider)
+    code     = TerraformWrapper::Shared::Code.new(options: code_options)
 
     tasks = Array.new
     tasks << TerraformWrapper::Tasks::Apply.new(binary: binary, code: code, options: config_options)

data/lib/terraform-wrapper/shared.rb

@@ -11,6 +11,7 @@ require_relative 'shared/binary'
 require_relative 'shared/code'
 require_relative 'shared/config'
 require_relative 'shared/latest'
+require_relative 'shared/provider'
 require_relative 'shared/runner'
 require_relative 'shared/variables'
 

data/lib/terraform-wrapper/shared/auths/azure.rb

@@ -25,13 +25,13 @@ module TerraformWrapper
 
 ###############################################################################
 
-        @password = nil
+        @keyvault        = nil
+        @secret_username = nil
+        @secret_password = nil
 
 ###############################################################################
 
-        attr_reader :subscription
-        attr_reader :tenant
-        attr_reader :username
+        @subscription
 
 ###############################################################################
 
@@ -42,10 +42,17 @@ module TerraformWrapper
 ###############################################################################
 
         def auth()
-          ENV["ARM_SUBSCRIPTION_ID"] = @subscription
-          ENV["ARM_TENANT_ID"]       = @tenant
-          ENV["ARM_CLIENT_ID"]       = @username unless @username.nil?
-          ENV["ARM_CLIENT_SECRET"]   = @password unless @password.nil?
+          details = subscription_details(subscription: @subscription)
+
+          subscription = details["id"]
+          tenant       = details["tenant"]
+          username     = @keyvault.nil? ? nil : secret(vault: @keyvault, name: @secret_username)
+          password     = @keyvault.nil? ? nil : secret(vault: @keyvault, name: @secret_password)
+
+          ENV["ARM_SUBSCRIPTION_ID"] = subscription
+          ENV["ARM_TENANT_ID"]       = tenant
+          ENV["ARM_CLIENT_ID"]       = username unless username.nil?
+          ENV["ARM_CLIENT_SECRET"]   = password unless password.nil?
           logger.success("Azure authenticator environment variables set!")
         end
 
@@ -151,20 +158,13 @@ module TerraformWrapper
           end
 
           begin
-            subscription = subscription % @variables.identifiers
-            keyvault     = keyvault     % @variables.identifiers unless keyvault.nil?
-            username     = username     % @variables.identifiers unless keyvault.nil?
-            password     = password     % @variables.identifiers unless keyvault.nil?
+            @subscription    = subscription % @variables.identifiers
+            @keyvault        = keyvault     % @variables.identifiers unless keyvault.nil?
+            @secret_username = username     % @variables.identifiers unless keyvault.nil?
+            @secret_password = password     % @variables.identifiers unless keyvault.nil?
           rescue
             logger.fatal("Azure authenticator options contain identifiers that are not included in the configuration file!")
           end
-
-          details = subscription_details(subscription: subscription)
-
-          @subscription = details["id"]
-          @tenant       = details["tenant"]
-          @username     = keyvault.nil? ? nil : secret(vault: keyvault, name: username)
-          @password     = keyvault.nil? ? nil : secret(vault: keyvault, name: password)
         end
 
 ###############################################################################

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

@@ -22,12 +22,13 @@ module TerraformWrapper
 
       attr_reader :base
       attr_reader :directory
+      attr_reader :provider
       attr_reader :platform
       attr_reader :version
 
 ###############################################################################
 
-      def initialize(options:)
+      def initialize(options:, provider:)
         logger.fatal("Binary base path must be a string!") unless options["base"].kind_of?(String)
         logger.fatal("Binary base path must not be blank!") if options["base"].strip.empty?
 
@@ -39,8 +40,8 @@ module TerraformWrapper
         @version = options["version"]
 
         @platform = platform_detect
-
         @directory = File.join(@base, @version, @platform)
+        @provider = provider
         @name = "terraform"
       end
 

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

@@ -34,8 +34,6 @@ module TerraformWrapper
         @name = options["name"]
 
         @path = File.join(@base, @name)
-
-        logger.fatal("Terraform code location: #{@path} does not exist!") unless exists
       end
 
 ###############################################################################

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

@@ -41,16 +41,16 @@ module TerraformWrapper
 
         @base = options["base"]
 
-        logger.fatal("Configuration service name must be a string!") unless options["service"].kind_of?(String)
-        logger.fatal("Configuration service name must not be blank!") if options["service"].strip.empty?
-
-        @service = options["service"]
-
         logger.fatal("Configuration name must be a string!") unless options["name"].kind_of?(String)
         logger.fatal("Configuration name must not be blank!") if options["name"].strip.empty?
 
         @name = options["name"]
 
+        logger.fatal("Configuration service name must be a string!") unless options["service"].kind_of?(String)
+        logger.fatal("Configuration service name must not be blank!") if options["service"].strip.empty?
+
+        @service = options["service"]
+
         logger.fatal("Configuration authenticator for Azure enabled must be a Boolean!") unless [ true, false ].include?(options["auth-azure"])
 
         auth_azure = options["auth-azure"]
@@ -75,15 +75,28 @@ module TerraformWrapper
         logger.fatal("Invalid YAML in configuration file: #{@path}") unless yaml.kind_of?(Hash)
 
         identifiers = yaml.key?("identifiers") ? yaml["identifiers"] : Hash.new
-        @variables = TerraformWrapper::Shared::Variables.new(config: @name, component: @code.name, service: @service, identifiers: identifiers)
-        @variables.add_variables(variables: yaml["globals"]) if yaml.key?("globals")
+        @variables  = TerraformWrapper::Shared::Variables.new(config: @name, component: @code.name, service: @service, identifiers: identifiers)
+
+        if yaml.key?("globals") then
+          logger.fatal("Key 'globals' is not a hash in configuration file: #{@path}") unless yaml["globals"].kind_of?(Hash)
+          globals = yaml["globals"]
+
+          @variables.add_variables(variables: globals["variables"]) if globals.key?("variables")
+        end
 
         if yaml.key?("terraform") then
           logger.fatal("Key 'terraform' is not a hash in configuration file: #{@path}") unless yaml["terraform"].kind_of?(Hash)
           terraform = yaml["terraform"]
 
-          @variables.add_variables(variables: terraform["variables"]) if terraform.key?("variables")
-          @variables.add_files(base: @base, files: terraform["files"]) if terraform.key?("files")
+          [ "globals", @code.name ].each do |extra|
+            if terraform.key?(extra) then
+              logger.fatal("Key '#{extra}' under 'terraform' is not a hash in configuration file: #{@path}") unless terraform[extra].kind_of?(Hash)
+              section = terraform[extra]
+
+              @variables.add_variables(variables: section["variables"]) if section.key?("variables")
+              @variables.add_files(base: @base, files: section["files"]) if section.key?("files")
+            end
+          end
         end
 
         @auths = Array.new

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

@@ -0,0 +1,41 @@
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Provider
+
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
+###############################################################################
+
+      attr_reader :platforms
+
+###############################################################################
+
+      def initialize(options:)
+        logger.fatal("Provider platforms to prefetch hashs for must be an array!") unless options["platforms"].kind_of?(Array)
+
+        @platforms = options["platforms"]
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -14,6 +14,10 @@ module TerraformWrapper
 
       include TerraformWrapper::Shared::Logging
 
+###############################################################################
+
+      @@lockfile_name = ".terraform.lock.hcl"
+
 ###############################################################################
 
       attr_reader :binary
@@ -25,6 +29,8 @@ module TerraformWrapper
 ###############################################################################
 
       def initialize(binary:, code:)
+        logger.fatal("Terraform code location: #{code.path} does not exist!") unless code.check
+
         @binary = binary
         @code   = code
 
@@ -33,35 +39,13 @@ module TerraformWrapper
 
 ###############################################################################
 
-      def download(upgrade: false)
+      def download
         parameters = Array.new
         parameters.append("-backend=false")
-        parameters.append("-upgrade") if upgrade
-
-        @downloaded = run(action: "init", parameters: parameters)
-        logger.fatal("Failed to download Terraform modules.") unless @downloaded
-      end
-
-###############################################################################
 
-      def import(address: nil, id: nil)
-        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 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("Failed to download Terraform modules.") unless run(action: "init", parameters: parameters)
 
-        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?
-
-        parameters = Array.new
-        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)
+        @downloaded = true
       end
 
 ###############################################################################
@@ -76,28 +60,31 @@ module TerraformWrapper
 
         config.auths.map(&:auth)
 
+        logger.fatal("Failed to initialise Terraform with backend.") unless run(action: "init", parameters: parameters)
+
         @config = config
-        @initialised = run(action: "init", parameters: parameters)
-        logger.fatal("Failed to initialise Terraform with backend.") unless @initialised
+        @initialised = true
       end
 
 ###############################################################################
 
-      def plan(destroy: false, file: nil)
-        logger.fatal("Cannot Terraform plan before initialising backend!") unless initialised
-
-        parameters = Array.new
-        parameters.concat(variable_files)
-        parameters.concat(variable_strings)
+      def upgrade
+        lockfile_path = File.join(@code.path, @@lockfile_name)
 
-        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")
-          parameters.append("-out=\"#{file}\"")
+        if File.file?(lockfile_path)
+          logger.info("Removing lock file: #{lockfile_path}")
+          File.delete(lockfile_path)
         end
 
-        parameters.append("-destroy") if destroy
+        logger.fatal("Lock file removal failed!") if File.file?(lockfile_path)
 
-        logger.fatal("Terraform plan failed!") unless run(action: "plan", parameters: parameters)
+        parameters = Array.new
+        parameters.append("-update")
+        logger.fatal("Failed to upgrade Terraform modules!") unless run(action: "get", parameters: parameters)
+
+        parameters = Array.new
+        parameters.append("lock")
+        logger.fatal("Failed to upgrade Terraform providers!") unless run(action: "providers", parameters: parameters)
       end
 
 ###############################################################################
@@ -120,6 +107,25 @@ module TerraformWrapper
         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
+
+        parameters = Array.new
+        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")
+          parameters.append("-out=\"#{file}\"")
+        end
+
+        parameters.append("-destroy") if destroy
+
+        logger.fatal("Terraform plan failed!") unless run(action: "plan", parameters: parameters)
+      end
+
 ###############################################################################
 
       def destroy
@@ -133,6 +139,28 @@ module TerraformWrapper
         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("Terraform state address for import must be a string!") unless address.kind_of?(String)
+        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("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?
+
+        parameters = Array.new
+        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)
+      end
+
 ###############################################################################
 
       def validate
@@ -144,6 +172,27 @@ module TerraformWrapper
 
     private
 
+###############################################################################
+
+      def run(action:, parameters: Array.new)
+        result = false
+
+        parameters.reject! { |item| not item.kind_of?(String) or item.strip.empty? }
+
+        cmdline = [ "\"#{@binary.path}\"", action ].concat(parameters).join(" ")
+
+        logger.info("Starting Terraform, action: #{action}")
+
+        puts("\n" + ('#' * 80) + "\n\n")
+
+        Dir.chdir(@code.path)
+        result = system(cmdline) || false
+
+        puts("\n" + ('#' * 80) + "\n\n")
+
+        return result
+      end
+
 ###############################################################################
 
       def variable_files
@@ -172,27 +221,6 @@ module TerraformWrapper
         return result
       end
 
-###############################################################################
-
-      def run(action:, parameters: Array.new)
-        result = false
-
-        parameters.reject! { |item| not item.kind_of?(String) or item.strip.empty? }
-
-        cmdline = [ "\"#{@binary.path}\"", action ].concat(parameters).join(" ")
-
-        logger.info("Starting Terraform, action: #{action}")
-
-        puts("\n" + ('#' * 80) + "\n\n")
-
-        Dir.chdir(@code.path)
-        result = system(cmdline) || false
-
-        puts("\n" + ('#' * 80) + "\n\n")
-
-        return result
-      end
-
 ###############################################################################
 
     end

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

@@ -36,11 +36,11 @@ module TerraformWrapper
         @core[:config]    = config
         @core[:service]   = service
 
-        user   = cleanse(variables: identifiers, reserved: @core.keys)
+        user   = cleanse(variables: identifiers, reserved: @core.keys, downcase: true)
         merged = @core.merge(user)
 
         @identifiers = sort ? merged.sort.to_h : merged
-        @values      = @identifiers
+        @values      = Hash.new
         @files       = Array.new
       end
 
@@ -89,7 +89,7 @@ module TerraformWrapper
 ###############################################################################
 
       def clear_variables()
-        @values = @identifers
+        @values = Hash.new
       end
 
 ###############################################################################
@@ -98,17 +98,20 @@ module TerraformWrapper
 
 ###############################################################################
 
-      def cleanse(variables:, reserved:)
+      def cleanse(variables:, reserved:, downcase: false)
         result = Hash.new
 
         variables.keys.each do |key|
           logger.fatal("Could not clean variables hash. All keys MUST be strings!") unless key.kind_of?(String)
-          logger.fatal("Could not clean variables hash, key: #{key.downcase} is reserved or already in use and cannot be used!") if reserved.include?(key.downcase.to_sym)
-          logger.fatal("Could not clean variables hash, duplicate key found: #{key.downcase}!") if result.key?(key.downcase.to_sym)
-          logger.fatal("Could not clean variables hash, value for: #{key.downcase} is not a string!") unless variables[key].kind_of?(String)
-          logger.fatal("Could not clean variables hash, value for: #{key.downcase} is empty!") if variables[key].strip.empty?
 
-          result[key.downcase.to_sym] = variables[key].strip
+          sym = downcase ? key.downcase.to_sym : key.to_sym
+
+          logger.fatal("Could not clean variables hash, key: #{sym.to_s} is reserved or already in use and cannot be used!") if reserved.include?(sym)
+          logger.fatal("Could not clean variables hash, duplicate key found: #{sym.to_s}!") if result.key?(sym)
+          logger.fatal("Could not clean variables hash, value for: #{sym.to_s} is not a string!") unless variables[key].kind_of?(String)
+          logger.fatal("Could not clean variables hash, value for: #{sym.to_s} is empty!") if variables[key].strip.empty?
+
+          result[sym] = variables[key].strip
         end
 
         return result

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

@@ -34,12 +34,12 @@ module TerraformWrapper
 
       def upgrade_task
         desc "Upgrades the Terraform infrastructure component modules, providers and lock file."
-        task :upgrade => :binary do |t, args|
+        task :upgrade => [:binary] do |t, args|
           runner = TerraformWrapper::Shared::Runner.new(binary: @binary, code: @code)
 
           logger.info("Upgrading Terraform component: #{@code.name}...")
 
-          runner.download(upgrade: true)
+          runner.upgrade
         end
       end
 

data/lib/terraform-wrapper/version.rb

@@ -4,7 +4,7 @@ module TerraformWrapper
 
 ###############################################################################
 
-  VERSION = "1.0.1"
+  VERSION = "1.2.3"
 
 ###############################################################################
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraform-wrapper
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Richard Lees
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,6 +71,7 @@ files:
 - lib/terraform-wrapper/shared/latest.rb
 - lib/terraform-wrapper/shared/logger.rb
 - lib/terraform-wrapper/shared/logging.rb
+- lib/terraform-wrapper/shared/provider.rb
 - lib/terraform-wrapper/shared/runner.rb
 - lib/terraform-wrapper/shared/variables.rb
 - lib/terraform-wrapper/tasks.rb
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for managing Terraform binaries and remote state.