terraform-wrapper 0.0.2 → 0.2.0

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

@@ -14,6 +14,10 @@ module TerraformWrapper
 
       class AWS < Common
 
+###############################################################################
+
+        include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
         @@default_class = "terraform-state"
@@ -25,24 +29,30 @@ module TerraformWrapper
 ###############################################################################
 
         attr_reader :bucket
-        attr_reader :class
+        attr_reader :encrypt
         attr_reader :key
         attr_reader :region
 
 ###############################################################################
 
-        def initialize(service:, code:, identifiers:, overrides: Hash.new)
-          construct(service: service, code: code, identifiers: identifiers, overrides: overrides)
+        def initialize(code:, config:, options:, service:, variables:)
+          construct(code: code, config: config, options: options, service: service, variables: variables)
         end
 
 ###############################################################################
 
         def hash()
-          return {
-            "bucket" => @bucket,
-            "key"    => @key,
-            "region" => @region
-          }
+          result = Hash.new
+
+          result["bucket"]  = @bucket
+          result["region"]  = @region
+          result["key"]     = @key
+          result["encrypt"] = @encrypt.to_s
+
+          result["kms_key_id"] = @kms  unless @kms.nil?
+          result["role_arn"]   = @role unless @role.nil?
+
+          return result
         end
 
 ###############################################################################
@@ -52,39 +62,67 @@ module TerraformWrapper
 ###############################################################################
 
         def specific()
-          if @overrides.key?("class") and @overrides["class"].kind_of?(String) and not @overrides["class"].strip.empty? then
-            @class = @overrides["class"]
-          else
-            @class = @@default_class
-          end
+          kms  = nil
+          role = nil
 
-          if @overrides.key?("region") and @overrides["region"].kind_of?(String) and not @overrides["region"].strip.empty? then
-            @region = @overrides["region"]
-          else
-            raise "Mandatory identifier 'region' or override 'region' must be set in provided configuration to backend of type: #{@@type}" unless @identifier.key?("region")
-            raise "Mandatory identifier 'region' is not a string in provided configuration to backend of type: #{@@type}" unless @identifier["region"].kind_of?(String)
-            raise "Mandatory identifier 'region' is empty in provided configuration to backend of type: #{@@type}" if @identifier["region"].strip.empty?
+          logger.fatal("AWS backend mandatory option 'bucket' has not been set!") unless @options.key?("bucket")
+          logger.fatal("AWS backend mandatory option 'region' has not been set!") unless @options.key?("region")
 
-            @region = @identifiers["account"].strip.downcase
-          end
+          bucket = @options["bucket"]
+
+          logger.fatal("AWS backend S3 bucket name must be a String!") unless bucket.kind_of?(String)
+          logger.fatal("AWS backend S3 bucket name must not be blank!") if bucket.strip.empty?
+
+          region = @options["region"]
 
-          if @overrides.key?("bucket") and @overrides["bucket"].kind_of?(String) and not @overrides["bucket"].strip.empty? then
-            @bucket = @overrides["bucket"]
-          else
-            raise "Mandatory identifier 'account' or override 'bucket' must be set in provided configuration to backend of type: #{@@type}" unless @identifier.key?("account")
-            raise "Mandatory identifier 'account' is not a string in provided configuration to backend of type: #{@@type}" unless @identifier["account"].kind_of?(String)
-            raise "Mandatory identifier 'account' is empty in provided configuration to backend of type: #{@@type}" if @identifier["account"].strip.empty?
+          logger.fatal("AWS backend S3 bucket region must be a String!") unless region.kind_of?(String)
+          logger.fatal("AWS backend S3 bucket region must not be blank!") if region.strip.empty?
 
-            @bucket = @class + "-" + @region + "-" + @identifiers["account"].strip.downcase
+          key = @options.key?("key") ? @options["key"] : File.join("%{service}", "%{config}", "%{component}" + @@ext)
+
+          logger.fatal("AWS backend S3 bucket key must be a String!") unless key.kind_of?(String)
+          logger.fatal("AWS backend S3 bucket key must not be blank!") if key.strip.empty?
+
+          encrypt = @options.key?("encrypt") ? @options["encrypt"] : true
+
+          logger.fatal("AWS backend S3 bucket encryption enabled must be a Boolean!") unless [ true, false ].include?(encrypt)
+
+          if @options.key?("kms") then
+            kms = @options["kms"]
+
+            logger.fatal("AWS backend S3 bucket encryption KMS key ARN must be a String if specified!") unless kms.kind_of?(String)
+            logger.fatal("AWS backend S3 bucket encryption KMS key ARN must not be blank if specified!") if kms.strip.empty?
           end
 
-          key = File.join(@identifiers.path, @service, @component + @@ext)
+          if @options.key?("role") then
+            role = @options["role"]
 
-          if key.length > 1024 then
-            raise "Key: #{key} is too long for backend of type: #{@@type}"
-          else
-            @key = key
+            logger.fatal("AWS backend role to assume ARN must be a String if specified!") unless role.kind_of?(String)
+            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}"))
+
+          begin
+            bucket = bucket % @variables
+            region = region % @variables
+            key    = key    % @variables
+            kms    = kms    % @variables unless kms.nil?
+            role   = role   % @variables unless role.nil?
+          rescue
+            logger.fatal("AWS backend options contain variables 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
+
+          @bucket  = bucket
+          @region  = region
+          @key     = key
+          @encrypt = encrypt
+          @kms     = kms
+          @role    = role
         end
 
 ###############################################################################

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

@@ -16,9 +16,7 @@ module TerraformWrapper
 
 ###############################################################################
 
-        @@default_class     = "state"
-        @@default_container = "default"
-        @@default_suffix    = "tf"
+        include TerraformWrapper::Shared::Logging
 
 ###############################################################################
 
@@ -27,16 +25,14 @@ module TerraformWrapper
 ###############################################################################
 
         attr_reader :account
-        attr_reader :class
         attr_reader :container
         attr_reader :group
         attr_reader :key
-        attr_reader :suffix
 
 ###############################################################################
 
-        def initialize(service:, code:, identifiers:, overrides: Hash.new)
-          construct(service: service, code: code, identifiers: identifiers, overrides: overrides)
+        def initialize(code:, config:, options:, service:, variables:)
+          construct(code: code, config: config, options: options, service: service, variables: variables)
         end
 
 ###############################################################################
@@ -57,48 +53,51 @@ module TerraformWrapper
 ###############################################################################
 
         def specific()
-          if @overrides.key?("class") and @overrides["class"].kind_of?(String) and not @overrides["class"].strip.empty? then
-            @class = @overrides["class"]
-          else
-            @class = @@default_class
-          end
+          logger.fatal("Azure backend mandatory option 'group' has not been set!") unless @options.key?("group")
 
-          if @overrides.key?("container") and @overrides["container"].kind_of?(String) and not @overrides["container"].strip.empty? then
-            @container = @overrides["container"]
-          else
-            @container = @@default_container
-          end
+          group = @options["group"]
 
-          if @overrides.key?("suffix") and @overrides["suffix"].kind_of?(String) and not @overrides["suffix"].strip.empty? then
-            @suffix = @overrides["suffix"]
-          else
-            @suffix = @@default_suffix
-          end
+          logger.fatal("Azure backend group must be a String!") unless group.kind_of?(String)
+          logger.fatal("Azure backend group must not be blank!") if group.strip.empty?
 
-          if @overrides.key?("group") and @overrides["group"].kind_of?(String) and not @overrides["group"].strip.empty? then
-            @group = @overrides["group"]
-          else
-            raise "Mandatory identifier 'account' or override 'group' must be set in provided configuration to backend of type: #{@@type}" unless @identifier.key?("account")
-            raise "Mandatory identifier 'account' is not a string in provided configuration to backend of type: #{@@type}" unless @identifier["account"].kind_of?(String)
-            raise "Mandatory identifier 'account' is empty in provided configuration to backend of type: #{@@type}" if @identifier["account"].strip.empty?
+          account = @options.key?("account") ? @options["account"] : group + "tf"
 
-            @group = @identifiers["subscription"].strip.downcase + @suffix
-          end
+          logger.fatal("Azure backend storage account must be a String!") unless account.kind_of?(String)
+          logger.fatal("Azure backend storage account must not be blank!") if account.strip.empty?
 
-          if @overrides.key?("account") and @overrides["account"].kind_of?(String) and not @overrides["account"].strip.empty? then
-            @account = @overrides["account"]
-          else
-            @account = @group + "-" + @class
-          end
+          container = @options.key?("container") ? @options["container"] : "default"
+
+          logger.fatal("Azure backend storage account container must be a String!") unless container.kind_of?(String)
+          logger.fatal("Azure backend storage account container must not be blank!") if container.strip.empty?
+
+          key = @options.key?("key") ? @options["key"] : File.join("%{service}", "%{config}", "%{component}" + @@ext)
 
-          key = File.join(@identifiers.path, @service, @component + @@ext)
+          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}"))
+
+          begin
+            group     = group     % @variables
+            account   = account   % @variables
+            container = container % @variables
+            key       = key       % @variables
+          rescue
+            logger.fatal("Azure backend options contain variables that are not included in the configuration file!")
+          end
 
           if key.length > 1024 then
-            raise "Key: #{key} is too long for backend of type: #{@@type}"
+            logger.fatal("Key: #{key} is too long for backend of type: #{@@type}")
           else
-            $logger.warning("Key for backend of type: #{@@type} exceeds 256 characters. This will not work with the Azure Storage Emulator. If key is not being overriden, consider using less identifiers.") if key.length > 256
-            @key = key
+            logger.warn("Key for backend of type: #{@@type} exceeds 256 characters. This will not work with the Azure Storage Emulator. If key is not being overriden, consider using less identifiers.") if key.length > 256
           end
+
+          @group     = group
+          @account   = account
+          @container = container
+          @key       = key
         end
 
 ###############################################################################

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

@@ -14,6 +14,10 @@ module TerraformWrapper
 
       class Common
 
+###############################################################################
+
+        include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
         @@ext = ".tfstate"
@@ -21,27 +25,25 @@ module TerraformWrapper
 
 ###############################################################################
 
-        @component
-        @identifiers
-        @overrides
-        @service
+        @options
+        @variables
 
 ###############################################################################
 
-        def initialize(service:, code:, identifiers:, overrides: Hash.new)
-          raise("This class should not be used directly! Please create a backend-specific class instead!")
+        def initialize(code:, config:, options:, service:, variables:)
+          logger.fatal("This class should not be used directly! Please create a backend-specific class instead!")
         end
 
 ###############################################################################
 
         def hash()
-          raise("The backend specific class should override the 'hash' method to return a hash of parameters for Terraform to set!")
+          logger.fatal("The backend specific class should override the 'hash' method to return a hash of parameters for Terraform to set!")
         end
 
 ###############################################################################
 
         def type()
-          raise("The backend specific class should set the 'type' class variable to a string!") unless @@type.kind_of?(String)
+          logger.fatal("The backend specific class should set the 'type' class variable to a string!") unless @@type.kind_of?(String)
 
           return @@type
         end
@@ -52,11 +54,13 @@ module TerraformWrapper
 
 ###############################################################################
 
-        def construct(service:, code:, identifiers:, overrides:)
-          @component   = code.name
-          @identifiers = identifiers
-          @overrides   = overrides
-          @service     = service
+        def construct(code:, config:, options:, service:, variables:)
+          @options   = options
+          @variables = variables.values.merge({
+            component: code.name,
+            config: config,
+            service: service
+            })
 
           specific
         end
@@ -64,7 +68,7 @@ module TerraformWrapper
 ###############################################################################
 
         def specific()
-          raise("The backend specific class should override the 'specific' method to include backend specific validation and setup, or simply return 'true' if it is not required.")
+          logger.fatal("The backend specific class should override the 'specific' method to include backend specific validation and setup, or simply return 'true' if it is not required.")
         end
 
 ###############################################################################

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

@@ -16,7 +16,7 @@ module TerraformWrapper
 
 ###############################################################################
 
-        @@default_base = File.join(Dir.pwd, "state", "terraform")
+        include TerraformWrapper::Shared::Logging
 
 ###############################################################################
 
@@ -24,23 +24,19 @@ module TerraformWrapper
 
 ###############################################################################
 
-        attr_reader :base
-        attr_reader :directory
-        attr_reader :key
-        attr_reader :name
         attr_reader :path
 
 ###############################################################################
 
-        def initialize(service:, code:, identifiers:, overrides: Hash.new)
-          construct(service: service, code: code, identifiers: identifiers, overrides: overrides)
+        def initialize(code:, config:, options:, service:, variables:)
+          construct(code: code, config: config, options: options, service: service, variables: variables)
         end
 
 ###############################################################################
 
         def hash()
           return {
-            "path" => @path,
+            "path" => @path
           }
         end
 
@@ -51,20 +47,26 @@ module TerraformWrapper
 ###############################################################################
 
         def specific()
-          if @overrides.key?("base") and @overrides["base"].kind_of?(String) and not @overrides["base"].strip.empty? then
-            @base = @overrides["base"]
-          else
-            @base = @@default_base
+          path = @options.key?("path") ? @options["path"] : File.join(Dir.pwd, "state", "terraform", "%{config}", "%{component}" + @@ext)
+
+          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}")
+
+          begin
+            path = path % @variables
+          rescue
+            logger.fatal("Local backend options contain variables that are not included in the configuration file!")
           end
 
-          @name = @component + @@ext
+          directory = File.dirname(path)
 
-          directory = File.join(@base, @identifiers.path)
-          raise "Failed to create state directory: #{directory}" unless create_directory(directory: directory, purpose: "state")
+          logger.fatal("Failed to create state directory: #{directory}") unless ::TerraformWrapper.create_directory(directory: directory, purpose: "state")
 
-          @directory = directory
-          @key       = File.join(@identifiers.path, @name)
-          @path      = File.join(@directory, @name)
+          @path = path
         end
 
 ###############################################################################

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

@@ -10,6 +10,10 @@ module TerraformWrapper
 
     class Binary
 
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
       attr_accessor :name
@@ -23,11 +27,18 @@ module TerraformWrapper
 
 ###############################################################################
 
-      def initialize(base:, version:)
-        @platform = platform_detect
+      def initialize(options:)
+        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?
 
-        @base = base
-        @version = version
+        @base = options["base"]
+
+        logger.fatal("Binary version must be a String!") unless options["version"].kind_of?(String)
+        logger.fatal("Binary version must not be blank!") if options["version"].strip.empty?
+
+        @version = options["version"]
+
+        @platform = platform_detect
 
         @directory = File.join(@base, @version, @platform)
         @name = "terraform"
@@ -72,7 +83,7 @@ module TerraformWrapper
       def platform_detect
         return "darwin" if platform_is_mac
         return "linux"  if platform_is_linux
-        raise "Platform is NOT supported: #{RUBY_PLATFORM}"
+        logger.fatal("Platform is NOT supported: #{RUBY_PLATFORM}")
       end
 
 ###############################################################################

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

@@ -10,6 +10,10 @@ module TerraformWrapper
 
     class Code
 
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
       attr_reader :base
@@ -18,13 +22,20 @@ module TerraformWrapper
 
 ###############################################################################
 
-      def initialize(base:, name:)
-        @base = base
-        @name = name
+      def initialize(options:)
+        logger.fatal("Code base path must be a String!") unless options["base"].kind_of?(String)
+        logger.fatal("Code base path must not be blank!") if options["base"].strip.empty?
+
+        @base = options["base"]
+
+        logger.fatal("Code component name must be a String!") unless options["name"].kind_of?(String)
+        logger.fatal("Code component name must not be blank!") if options["name"].strip.empty?
+
+        @name = options["name"]
 
         @path = File.join(@base, @name)
 
-        raise "Terraform code location: #{@path} does not exist!" unless exists
+        logger.fatal("Terraform code location: #{@path} does not exist!") unless exists
       end
 
 ###############################################################################