terraform-wrapper 0.0.2 → 0.1.0

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
 
 ###############################################################################

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

@@ -14,6 +14,10 @@ module TerraformWrapper
 
     class Config
 
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
       @@config_exts = [ "", ".yaml", ".yml" ]
@@ -25,53 +29,79 @@ module TerraformWrapper
 
 ###############################################################################
 
+      attr_reader :auths
       attr_reader :backend
       attr_reader :base
       attr_reader :code
       attr_reader :name
       attr_reader :path
-      attr_reader :overrides
       attr_reader :service
       attr_reader :variable_files
+      attr_reader :variables
 
 ###############################################################################
 
-      def initialize(backend:, base:, code:, name:, overrides:, service:)
-        if not name.nil? and name.kind_of?(String) and not name.strip.empty? then
-          @name = name
-        else
-          raise("Configuration name not provided!")
-        end
+      def initialize(code:, options:)
+        logger.fatal("Configuration base path must be a String!") unless options["base"].kind_of?(String)
+        logger.fatal("Configuration base path must not be blank!") if options["base"].strip.empty?
+
+        @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 authenticator for Azure enabled must be a Boolean!") unless [ true, false ].include?(options["auth-azure"])
 
-        @base      = base
-        @code      = code
-        @name      = name
-        @overrides = overrides
-        @service   = service
+        auth_azure = options["auth-azure"]
 
+        logger.fatal("Configuration authenticator for Azure options must be a Hash!") unless options["auth-azure-options"].kind_of?(Hash)
+
+        auth_azure_options = options["auth-azure-options"]
+
+        logger.fatal("Configuration backend name must be a String!") unless options["backend"].kind_of?(String)
+        logger.fatal("Configuration backend name must not be blank!") if options["backend"].strip.empty?
+
+        backend = options["backend"]
+
+        logger.fatal("Configuration backend options must be a Hash!") unless options["backend-options"].kind_of?(Hash)
+
+        backend_options = options["backend-options"]
+
+        @code = code
         @path = find
 
         yaml = YAML.load(File.read(@path))
 
-        raise "Invalid YAML in configuration file: #{@path}" unless yaml.kind_of?(Hash)
+        logger.fatal("Invalid YAML in configuration file: #{@path}") unless yaml.kind_of?(Hash)
 
-        raise "Mandatory key 'identifiers' missing from configuration file: #{@path}" unless yaml.key?("identifiers")
-        raise "Mandatory key 'identifiers' is not a hash in configuration file: #{@path}" unless yaml["identifiers"].kind_of?(Hash)
-        raise "Mandatory key 'identifiers' is empty in provided configuration file: #{@path}" if yaml["identifiers"].empty?
+        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()
+        end
 
-        identifiers = TerraformWrapper::Shared::Identifiers.new(identifiers: yaml["identifiers"])
+        @variable_files = yaml.key?("terraform") ? validate(variable_files: yaml["terraform"]) : Array.new
+
+        @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
 
         if backend == "local" then
-          @backend = TerraformWrapper::Shared::Backends::Local.new(service: @service, code: @code, identifiers: identifiers, overrides: @overrides)
+          @backend = TerraformWrapper::Shared::Backends::Local.new(code: @code, config: @name, options: backend_options, service: @service, variables: @variables)
         elsif backend == "aws" then
-          @backend = TerraformWrapper::Shared::Backends::AWS.new(service: @service, code: @code, identifiers: identifiers, overrides: @overrides)
+          @backend = TerraformWrapper::Shared::Backends::AWS.new(code: @code, config: @name, options: backend_options, service: @service, variables: @variables)
         elsif backend == "azure" then
-          @backend = TerraformWrapper::Shared::Backends::Azure.new(service: @service, code: @code, identifiers: identifiers, overrides: @overrides)
+          @backend = TerraformWrapper::Shared::Backends::Azure.new(code: @code, config: @name, options: backend_options, service: @service, variables: @variables)
         else
-          raise "Backend: #{backend} is not valid!"
+          logger.fatal("Backend: #{backend} is not valid!")
         end
-
-        @variable_files = yaml.key?("tfvars") ? tfvars(tfvars: yaml["tfvars"]) : Array.new
       end
 
 ###############################################################################
@@ -86,24 +116,24 @@ module TerraformWrapper
           return path if File.file?(path)
         end
 
-        raise "Terraform configuration name: #{@name} not found in location: #{@base}!"
+        logger.fatal("Terraform configuration name: #{@name} not found in location: #{@base}!")
       end
 
 ###############################################################################
 
-      def tfvars(tfvars:)
-        raise("Optional key 'tfvars' must be a list of strings!") unless tfvars.kind_of?(Array)
+      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
 
-        tfvars.each do |tfvar|
-          raise("All elements of 'tfvars' must be strings!") unless tfvar.kind_of?(String)
-          raise("All elements of 'tfvars' must not be blank!") if tfvar.strip.empty?
-          path = File.join(@base, @@variable_files_name, tfvar.strip + @@variable_files_ext)
+        variable_files.each do |variable_file|
+          logger.fatal("All elements of 'variable_files' must be strings!") unless variable_file.kind_of?(String)
+          logger.fatal("All elements of 'variable_files' must not be blank!") if variable_file.strip.empty?
+          path = File.join(@base, @@variable_files_name, variable_file.strip + @@variable_files_ext)
           if File.file?(path) then
             result.append(path)
           else
-            raise("Terraform variables file: #{tfvar}, path: #{path} does not exist!")
+            logger.fatal("Terraform variables file: #{variable_file}, path: #{path} does not exist!")
           end
         end