terraform-wrapper 0.0.2 → 0.2.0

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
 

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

@@ -21,6 +21,10 @@ module TerraformWrapper
 
       include Singleton
 
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
       @version
@@ -40,22 +44,22 @@ module TerraformWrapper
 ###############################################################################
 
       def refresh
-        $logger.info("Finding latest available Terraform release...")
+        logger.info("Finding latest available Terraform release...")
 
         response = Net::HTTP.get_response(URI("https://checkpoint-api.hashicorp.com/v1/check/terraform"))
 
-        raise "Hashicorp Checkpoint did not return status 200 for latest version check!" if response.code != "200"
-        raise "Response body from Hashicorp Checkpoint is not permitted!"                if not response.class.body_permitted?
-        raise "Response body from Hashicorp Checkpoint is empty!"                        if response.body.nil?
+        logger.fatal("Hashicorp Checkpoint did not return status 200 for latest version check!") if response.code != "200"
+        logger.fatal("Response body from Hashicorp Checkpoint is not permitted!")                if not response.class.body_permitted?
+        logger.fatal("Response body from Hashicorp Checkpoint is empty!")                        if response.body.nil?
 
         body = JSON.parse(response.body)
 
-        raise "Hashicorp Checkpoint JSON response did not include latest available Terraform version!" if not body.key?("current_version")
-        raise "Hashicorp Checkpoint indicated latest available version of Terraform is blank!"         if body["current_version"].empty?
+        logger.fatal("Hashicorp Checkpoint JSON response did not include latest available Terraform version!") if not body.key?("current_version")
+        logger.fatal("Hashicorp Checkpoint indicated latest available version of Terraform is blank!")         if body["current_version"].empty?
 
         version = body["current_version"]
 
-        $logger.info("Latest available Terraform release found: #{version}")
+        logger.success("Latest available Terraform release found: #{version}")
 
         return version
       end

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

@@ -0,0 +1,80 @@
+###############################################################################
+
+require 'logger'
+
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Logger < ::Logger
+
+###############################################################################
+
+      @colour = false
+
+###############################################################################
+
+      def colour()
+        @colour
+      end
+
+###############################################################################
+
+      def colour=(enabled)
+        @colour = [ true, false ].include?(enabled) ? enabled : false
+      end
+
+###############################################################################
+
+      def success(message)
+        info(format(colour: 32, message: message))
+      end
+
+###############################################################################
+
+      def warn(message)
+        super(format(colour: 33, message: message))
+      end
+
+###############################################################################
+
+      def error(message)
+        super(format(colour: 31, message: message))
+      end
+
+###############################################################################
+
+      def fatal(message)
+        super(format(colour: 31, message: message))
+        exit(1)
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def format(colour: 32, message:)
+        return @colour ? "\e[" + colour.to_s + "m" + message + "\e[0m" : message
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,77 @@
+###############################################################################
+
+require 'logger'
+
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    module Logging
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def logger
+        @logger ||= Logging.logger_for(self.class.name)
+      end
+
+###############################################################################
+
+      @loggers = {}
+
+###############################################################################
+
+      class << self
+
+###############################################################################
+
+        def logger_for(classname)
+          @loggers[classname] ||= configure_logger_for(classname)
+        end
+
+###############################################################################
+
+        def configure_logger_for(classname)
+          colour = ENV["TERRAFORM_WRAPPER_LOG_COLOUR"] || "true"
+          level  = ENV["TERRAFORM_WRAPPER_LOG_LEVEL"]  || "INFO"
+
+          logger = ::TerraformWrapper::Shared::Logger.new(STDOUT)
+
+          logger.colour   = colour.downcase == "true"
+          logger.level    = level.upcase
+          logger.progname = classname
+
+          logger.formatter = proc do |severity, datetime, progname, msg|
+            sevId = severity.chars.first.upcase
+            "[#{sevId}] [#{progname}] #{msg}\n"
+          end
+
+          logger
+        end
+
+###############################################################################
+
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -10,6 +10,10 @@ module TerraformWrapper
 
     class Runner
 
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
       attr_reader :binary
@@ -30,75 +34,111 @@ module TerraformWrapper
 
 ###############################################################################
 
-      def download
-        parameters = [ "-backend=false" ]
+      def download(upgrade: false)
+        parameters = Array.new
+        parameters.append("-backend=false")
+        parameters.append("-upgrade") if upgrade
+
         @downloaded = run(action: "init", parameters: parameters)
-        raise("Failed to download Terraform modules.") unless @downloaded
+        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("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 init(config:)
-        parameters = [ "-reconfigure" ]
+        parameters = Array.new
+        parameters.append("-reconfigure")
+
         config.backend.hash.each do |key, value|
           parameters.append("-backend-config=\"#{key}=#{value}\"")
         end
 
+        config.auths.map(&:auth)
+
         @config = config
         @initialised = run(action: "init", parameters: parameters)
-        raise("Failed to initialise Terraform with backend.") unless @initialised
+        logger.fatal("Failed to initialise Terraform with backend.") unless @initialised
       end
 
 ###############################################################################
 
       def plan(destroy: false, file: nil)
-        raise("Cannot Terraform plan before initialising backend!") unless initialised
+        logger.fatal("Cannot Terraform plan before initialising backend!") unless initialised
 
-        parameters = variable_files
+        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
-          raise "Failed to create plan directory: #{directory}" unless create_directory(directory: File.dirname(file), purpose: "plan")
+          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
 
-        raise("Terraform plan failed!") unless run(action: "plan", parameters: parameters)
+        logger.fatal("Terraform plan failed!") unless run(action: "plan", parameters: parameters)
       end
 
 ###############################################################################
 
       def apply(file: nil)
-        raise("Cannot Terraform apply before initialising backend!") unless initialised
+        logger.fatal("Cannot Terraform apply before initialising backend!") unless initialised
 
-        parameters = [ "-auto-approve" ]
+        parameters = Array.new
+        parameters.concat(variable_files)
+        parameters.concat(variable_strings)
+        parameters.append("-auto-approve")
 
         if not file.nil? and file.kind_of?(String) and not file.strip.empty? then
-          raise "Plan file: #{file} does not exist!" unless File.file?(file)
+          logger.fatal("Plan file: #{file} does not exist!") unless File.file?(file)
           parameters.append("\"#{file}\"")
         else
           parameters.concat(variable_files)
         end
 
-        raise("Terraform apply failed!") unless run(action: "apply", parameters: parameters)
+        logger.fatal("Terraform apply failed!") unless run(action: "apply", parameters: parameters)
       end
 
 ###############################################################################
 
       def destroy
-        raise("Cannot Terraform destroy before initialising backend!") unless initialised
+        logger.fatal("Cannot Terraform destroy before initialising backend!") unless initialised
 
-        parameters = [ "-auto-approve" ]
+        parameters = Array.new
         parameters.concat(variable_files)
+        parameters.concat(variable_strings)
+        parameters.append("-auto-approve")
 
-        raise("Terraform destroy failed!") unless run(action: "destroy", parameters: parameters)
+        logger.fatal("Terraform destroy failed!") unless run(action: "destroy", parameters: parameters)
       end
 
 ###############################################################################
 
       def validate
-        raise("Cannot Terraform validate before downloading modules!") unless downloaded
-        raise("Terraform validation failed!") unless run(action: "validate")
+        logger.fatal("Cannot Terraform validate before downloading modules!") unless downloaded
+        logger.fatal("Terraform validation failed!") unless run(action: "validate")
       end
 
 ###############################################################################
@@ -108,7 +148,7 @@ module TerraformWrapper
 ###############################################################################
 
       def variable_files
-        raise("Cannot generate variable files until Terraform has been initialised!") unless @initialised
+        logger.fatal("Cannot generate variable files until Terraform has been initialised!") unless @initialised
 
         result = Array.new
 
@@ -119,6 +159,24 @@ module TerraformWrapper
         return result
       end
 
+###############################################################################
+
+      def variable_strings
+        logger.fatal("Cannot generate variable strings until Terraform has been initialised!") unless @initialised
+
+        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
+
+        return result
+      end
+
 ###############################################################################
 
       def run(action:, parameters: Array.new)
@@ -128,14 +186,14 @@ module TerraformWrapper
 
         cmdline = [ "\"#{@binary.path}\"", action ].concat(parameters).join(" ")
 
-        $logger.info("Starting Terraform, action: #{action}")
+        logger.info("Starting Terraform, action: #{action}")
 
         puts("\n" + ('#' * 80) + "\n\n")
 
         Dir.chdir(@code.path)
         result = system(cmdline) || false
 
-        puts("\n")
+        puts("\n" + ('#' * 80) + "\n\n")
 
         return result
       end