terraform-wrapper 0.2.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66bb2630f4f5580fdf738902d4807b9584572ef131a01d685eecbe2a067f023c
-  data.tar.gz: efcd70b4c39b0870f2cce7461c03861425262347d565c80d3da90841f4eb6bf2
+  metadata.gz: 757e953e25e4899b35a17e556123581ab077a84769a144f51db286a6b56f8608
+  data.tar.gz: 25d70f9f0132157ccc738bf0c459f35d1e777f5760bae6177bc202e92bc1c95c
 SHA512:
-  metadata.gz: fede831e98a731bf9145c90bd54d51cbabd51a76337d7360cec08fe59c3bc464d526584b0ea1dbaa34a1daab63137b8c7389c8c2d043ebb297a9bc47dadb4433
-  data.tar.gz: c6852721632b1fe7384127baecabd11d32cab7966f7ab40b804761211f18902118a7f966bdbdf78d0dc24c53374fa504d0f3bd77f8a63b105242dac51f14b878
+  metadata.gz: a0399939f5522c2ffb3fcee4e0dded13c09b7731e0025de5d92bdab8afe63e9b3506eba6bf99d345323ea4f77f7a9096e18203f975127eb29729b60379036144
+  data.tar.gz: 9a8ef1ea51a121cd85a5a4334cda520f8a4246c2125510054c047f7d29e004cae8bf30a4eb200aae71321d0ccf1748b385449735d5e1bc00b65cf67b3f624c15

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)

data/lib/terraform-wrapper/common.rb

@@ -4,7 +4,7 @@ module TerraformWrapper
 
 ###############################################################################
 
-  def self.create_directory(directory:, purpose: nil, exists: true)
+  def self.create_directory(directory:, exists: true, purpose: nil)
     return exists if File.directory?(directory)
 
     result = false
@@ -20,6 +20,17 @@ module TerraformWrapper
     result = File.directory?(directory)
   end
 
+###############################################################################
+
+  def self.find(base:, name:, exts:, description: "File")
+    exts.each do |ext|
+      path = File.join(base, name + ext)
+      return path if File.file?(path)
+    end
+
+    @logger.fatal("#{description} name: #{name} not found in location: #{base}!")
+  end
+
 ###############################################################################
 
 end

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

@@ -25,27 +25,34 @@ module TerraformWrapper
 
 ###############################################################################
 
-        @password = nil
+        @keyvault        = nil
+        @secret_username = nil
+        @secret_password = nil
 
 ###############################################################################
 
-        attr_reader :subscription
-        attr_reader :tenant
-        attr_reader :username
+        @subscription
 
 ###############################################################################
 
-        def initialize(code:, config:, options:, service:, variables:)
-          construct(code: code, config: config, options: options, service: service, variables: variables)
+        def initialize(options:, variables:)
+          construct(options: options, variables: variables)
         end
 
 ###############################################################################
 
         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
-            keyvault     = keyvault     % @variables unless keyvault.nil?
-            username     = username     % @variables unless keyvault.nil?
-            password     = password     % @variables 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 variables that are not included in the configuration file!")
+            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/auths/common.rb

@@ -29,7 +29,7 @@ module TerraformWrapper
 
 ###############################################################################
 
-        def initialize(code:, config:, options:, service:, variables:)
+        def initialize(options:, variables:)
           logger.fatal("This class should not be used directly! Please create an authenticator-specific class instead!")
         end
 
@@ -59,13 +59,9 @@ module TerraformWrapper
 
 ###############################################################################
 
-        def construct(code:, config:, options:, service:, variables:)
+        def construct(options:, variables:)
           @options   = options
-          @variables = variables.values.merge({
-            component: code.name,
-            config: config,
-            service: service
-            })
+          @variables = variables
 
           specific
         end

data/lib/terraform-wrapper/shared/backends/aws.rb

@@ -35,8 +35,8 @@ module TerraformWrapper
 
 ###############################################################################
 
-        def initialize(code:, config:, options:, service:, variables:)
-          construct(code: code, config: config, options: options, service: service, variables: variables)
+        def initialize(options:, variables:)
+          construct(options: options, variables: variables)
         end
 
 ###############################################################################
@@ -101,18 +101,18 @@ module TerraformWrapper
             logger.fatal("AWS backend role to assume ARN must not be blank if specified!") if role.strip.empty?
           end
 
-          logger.fatal("AWS backend S3 bucket name or key must include %{service}.") unless (bucket.include?("%{service}") or key.include?("%{service}"))
-          logger.fatal("AWS backend S3 bucket name or key must include %{config}.") unless (bucket.include?("%{config}") or key.include?("%{config}"))
-          logger.fatal("AWS backend S3 bucket name or key must include %{component}.") unless  (bucket.include?("%{component}") or key.include?("%{component}"))
+          @variables.core.keys.map{ |sym| sym.to_s }.each do |core|
+            logger.fatal("AWS backend S3 bucket name or key must include %{#{core}}.") unless (bucket.include?("%{#{core}}") or key.include?("%{#{core}}"))
+          end
 
           begin
-            bucket = bucket % @variables
-            region = region % @variables
-            key    = key    % @variables
-            kms    = kms    % @variables unless kms.nil?
-            role   = role   % @variables unless role.nil?
+            bucket = bucket % @variables.identifiers
+            region = region % @variables.identifiers
+            key    = key    % @variables.identifiers
+            kms    = kms    % @variables.identifiers unless kms.nil?
+            role   = role   % @variables.identifiers unless role.nil?
           rescue
-            logger.fatal("AWS backend options contain variables that are not included in the configuration file!")
+            logger.fatal("AWS backend options contain identifiers that are not included in the configuration file!")
           end
 
           logger.fatal("Key: #{key} is too long for backend of type: #{@@type}") if key.length > 1024

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

@@ -31,8 +31,8 @@ module TerraformWrapper
 
 ###############################################################################
 
-        def initialize(code:, config:, options:, service:, variables:)
-          construct(code: code, config: config, options: options, service: service, variables: variables)
+        def initialize(options:, variables:)
+          construct(options: options, variables: variables)
         end
 
 ###############################################################################
@@ -75,17 +75,17 @@ module TerraformWrapper
           logger.fatal("Azure backend storage account key must be a string!") unless key.kind_of?(String)
           logger.fatal("Azure backend storage account key must not be blank!") if key.strip.empty?
 
-          logger.fatal("Azure backend container or key must include %{service}.") unless (container.include?("%{service}") or key.include?("%{service}"))
-          logger.fatal("Azure backend container or key must include %{config}.") unless (container.include?("%{config}") or key.include?("%{config}"))
-          logger.fatal("Azure backend container or key must include %{component}.") unless  (container.include?("%{component}") or key.include?("%{component}"))
+          @variables.core.keys.map{ |sym| sym.to_s }.each do |core|
+            logger.fatal("Azure backend container or key must include %{#{core}}.") unless (container.include?("%{#{core}}") or key.include?("%{#{core}}"))
+          end
 
           begin
-            group     = group     % @variables
-            account   = account   % @variables
-            container = container % @variables
-            key       = key       % @variables
+            group     = group     % @variables.identifiers
+            account   = account   % @variables.identifiers
+            container = container % @variables.identifiers
+            key       = key       % @variables.identifiers
           rescue
-            logger.fatal("Azure backend options contain variables that are not included in the configuration file!")
+            logger.fatal("Azure backend options contain identifiers that are not included in the configuration file!")
           end
 
           if key.length > 1024 then

data/lib/terraform-wrapper/shared/backends/common.rb

@@ -30,7 +30,7 @@ module TerraformWrapper
 
 ###############################################################################
 
-        def initialize(code:, config:, options:, service:, variables:)
+        def initialize(options:, variables:)
           logger.fatal("This class should not be used directly! Please create a backend-specific class instead!")
         end
 
@@ -54,13 +54,9 @@ module TerraformWrapper
 
 ###############################################################################
 
-        def construct(code:, config:, options:, service:, variables:)
+        def construct(options:, variables:)
           @options   = options
-          @variables = variables.values.merge({
-            component: code.name,
-            config: config,
-            service: service
-            })
+          @variables = variables
 
           specific
         end

data/lib/terraform-wrapper/shared/backends/local.rb

@@ -28,8 +28,8 @@ module TerraformWrapper
 
 ###############################################################################
 
-        def initialize(code:, config:, options:, service:, variables:)
-          construct(code: code, config: config, options: options, service: service, variables: variables)
+        def initialize(options:, variables:)
+          construct(options: options, variables: variables)
         end
 
 ###############################################################################
@@ -52,14 +52,15 @@ module TerraformWrapper
           logger.fatal("Local backend path must be a string!") unless path.kind_of?(String)
           logger.fatal("Local backend path must not be blank!") if path.strip.empty?
 
-          logger.fatal("Local backend path must include %{service} or the path to this repository.") unless (path.include?("%{service}") or path.include?(Dir.pwd))
-          logger.fatal("Local backend path must include %{config}") unless path.include?("%{config}")
-          logger.fatal("Local backend path must include %{component}") unless path.include?("%{component}")
+          @variables.core.keys.map{ |sym| sym.to_s }.each do |core|
+            next if (core == "service") and (path.include?(Dir.pwd))
+            logger.fatal("Local backend path must include %{#{core}}.") unless path.include?("%{#{core}}")
+          end
 
           begin
-            path = path % @variables
+            path = path % @variables.identifiers
           rescue
-            logger.fatal("Local backend options contain variables that are not included in the configuration file!")
+            logger.fatal("Local backend options contain identifiers that are not included in the configuration file!")
           end
 
           directory = File.dirname(path)

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

@@ -22,11 +22,6 @@ module TerraformWrapper
 
       @@config_exts = [ "", ".yaml", ".yml" ]
 
-###############################################################################
-
-      @@variable_files_name =   "tfvars"
-      @@variable_files_exts = [ ".tfvars" ]
-
 ###############################################################################
 
       attr_reader :auths
@@ -36,7 +31,6 @@ module TerraformWrapper
       attr_reader :name
       attr_reader :path
       attr_reader :service
-      attr_reader :variable_files
       attr_reader :variables
 
 ###############################################################################
@@ -75,65 +69,50 @@ module TerraformWrapper
         backend_options = options["backend-options"]
 
         @code = code
-        @path = find(base: @base, name: @name, exts: @@config_exts, description: "Configuration")
+        @path = ::TerraformWrapper.find(base: @base, name: @name, exts: @@config_exts, description: "Configuration")
 
         yaml = YAML.load(File.read(@path))
         logger.fatal("Invalid YAML in configuration file: #{@path}") unless yaml.kind_of?(Hash)
 
-        if yaml.key?("variables") then
-          logger.fatal("Key 'variables' is not a hash in configuration file: #{@path}") unless yaml["variables"].kind_of?(Hash)
-          @variables = TerraformWrapper::Shared::Variables.new(values: yaml["variables"])
-        else
-          @variables = TerraformWrapper::Shared::Variables.new()
+        identifiers = yaml.key?("identifiers") ? yaml["identifiers"] : Hash.new
+        @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
 
-        @variable_files = yaml.key?("terraform") ? validate(variable_files: yaml["terraform"]) : Array.new
+        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"]
+
+          [ "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
-        @auths.append(TerraformWrapper::Shared::Auths::Azure.new(code: @code, config: @name, options: auth_azure_options, service: @service, variables: @variables)) if auth_azure
+        @auths.append(TerraformWrapper::Shared::Auths::Azure.new(options: auth_azure_options, variables: @variables)) if auth_azure
 
         if backend == "local" then
-          @backend = TerraformWrapper::Shared::Backends::Local.new(code: @code, config: @name, options: backend_options, service: @service, variables: @variables)
+          @backend = TerraformWrapper::Shared::Backends::Local.new(options: backend_options, variables: @variables)
         elsif backend == "aws" then
-          @backend = TerraformWrapper::Shared::Backends::AWS.new(code: @code, config: @name, options: backend_options, service: @service, variables: @variables)
+          @backend = TerraformWrapper::Shared::Backends::AWS.new(options: backend_options, variables: @variables)
         elsif backend == "azure" then
-          @backend = TerraformWrapper::Shared::Backends::Azure.new(code: @code, config: @name, options: backend_options, service: @service, variables: @variables)
+          @backend = TerraformWrapper::Shared::Backends::Azure.new(options: backend_options, variables: @variables)
         else
           logger.fatal("Backend: #{backend} is not valid!")
         end
       end
 
-###############################################################################
-
-      private
-
-###############################################################################
-
-      def find(base:, name:, exts:, description: "File")
-        exts.each do |ext|
-          path = File.join(base, name + ext)
-          return path if File.file?(path)
-        end
-
-        logger.fatal("#{description} name: #{@name} not found in location: #{@base}!")
-      end
-
-###############################################################################
-
-      def validate(variable_files:)
-        logger.fatal("Optional key 'variable_files' must be a list of strings!") unless variable_files.kind_of?(Array)
-
-        result = Array.new
-
-        variable_files.each do |variable_file|
-          logger.fatal("All elements of 'terraform' must be strings!") unless variable_file.kind_of?(String)
-          logger.fatal("All elements of 'terraform' must not be blank!") if variable_file.strip.empty?
-          result.append(find(base: File.join(@base, @@variable_files_name), name: variable_file.strip, exts: @@variable_files_exts, description: "Terraform values file"))
-        end
-
-        return result
-      end
-
 ###############################################################################
 
     end

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

@@ -25,6 +25,8 @@ module TerraformWrapper
 ###############################################################################
 
       def initialize(binary:, code:)
+        logger.fatal("Terraform code location: #{code.path} does not exist!") unless code.check
+
         @binary = binary
         @code   = code
 
@@ -151,8 +153,8 @@ module TerraformWrapper
 
         result = Array.new
 
-        @config.variable_files.each do |variable_file|
-          result.append("-var-file=\"#{variable_file}\"")
+        @config.variables.files.each do |file|
+          result.append("-var-file=\"#{file}\"")
         end
 
         return result
@@ -165,10 +167,6 @@ module TerraformWrapper
 
         result = Array.new
 
-        result.append("-var=\"component=#{@code.name}\"")
-        result.append("-var=\"config=#{@config.name}\"")
-        result.append("-var=\"service=#{@config.service}\"")
-
         @config.variables.values.each do |key, value|
           result.append("-var=\"#{key.to_s}=#{value}\"")
         end

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

@@ -16,17 +16,80 @@ module TerraformWrapper
 
 ###############################################################################
 
-      @@reserved = [ "component", "config", "service" ]
+      @@variable_files_name =   "tfvars"
+      @@variable_files_exts = [ ".tfvars" ]
 
 ###############################################################################
 
+      attr_reader :core
+      attr_reader :files
+      attr_reader :identifiers
       attr_reader :values
 
 ###############################################################################
 
-      def initialize(values: Hash.new, sort: true)
-        cleansed = cleanse(values: values)
-        @values = sort ? cleansed.sort.to_h : cleansed
+      def initialize(component:, config:, service:, identifiers: Hash.new, sort: false)
+        logger.fatal("Identifiers provided must be a hash!") unless identifiers.kind_of?(Hash)
+
+        @core             = Hash.new()
+        @core[:component] = component
+        @core[:config]    = config
+        @core[:service]   = service
+
+        user   = cleanse(variables: identifiers, reserved: @core.keys)
+        merged = @core.merge(user)
+
+        @identifiers = sort ? merged.sort.to_h : merged
+        @values      = @identifiers
+        @files       = Array.new
+      end
+
+###############################################################################
+
+      def add_files(base:, files:)
+        logger.fatal("Variable files provided must be an array!") unless files.kind_of?(Array)
+
+        files.each do |file|
+          logger.fatal("All provided variable file names must be strings!") unless file.kind_of?(String)
+          logger.fatal("All provided variable file names must not be blank!") if file.strip.empty?
+
+          path = ::TerraformWrapper.find(base: File.join(base, @@variable_files_name), name: file.strip, exts: @@variable_files_exts, description: "Terraform values file")
+
+          if @files.include?(path) then
+            logger.warn("Terraform variables file is included more than once: #{file.strip}")
+          else
+            @files.append(path)
+          end
+        end
+      end
+
+###############################################################################
+
+      def add_variables(variables:, sort: false)
+        logger.fatal("Variables provided must be a hash!") unless variables.kind_of?(Hash)
+
+        cleansed = cleanse(variables: variables, reserved: @values.keys)
+
+        begin
+          cleansed = cleansed.map{ |key, value| [ key, value % @identifiers ] }.to_h
+        rescue
+          logger.fatal("Variables contain identifiers that are not included in the configuration file!")
+        end
+
+        merged  = @values.merge(cleansed)
+        @values = sort ? merged.sort.to_h : merged
+      end
+
+###############################################################################
+
+      def clear_files()
+        @files = Array.new
+      end
+
+###############################################################################
+
+      def clear_variables()
+        @values = @identifers
       end
 
 ###############################################################################
@@ -35,17 +98,17 @@ module TerraformWrapper
 
 ###############################################################################
 
-      def cleanse(values:)
+      def cleanse(variables:, reserved:)
         result = Hash.new
 
-        values.keys.each do |key|
+        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 and cannot be used!") if @@reserved.include?(key.downcase)
+          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 values[key].kind_of?(String)
-          logger.fatal("Could not clean variables hash, value for: #{key.downcase} is empty!") if values[key].strip.empty?
+          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] = values[key].strip
+          result[key.downcase.to_sym] = variables[key].strip
         end
 
         return result

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

@@ -34,7 +34,7 @@ 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, :clean] do |t, args|
           runner = TerraformWrapper::Shared::Runner.new(binary: @binary, code: @code)
 
           logger.info("Upgrading Terraform component: #{@code.name}...")

data/lib/terraform-wrapper/version.rb

@@ -4,7 +4,7 @@ module TerraformWrapper
 
 ###############################################################################
 
-  VERSION = "0.2.2"
+  VERSION = "1.1.0"
 
 ###############################################################################
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraform-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Lees
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake