terraform-wrapper 0.0.2 → 0.2.0

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

@@ -0,0 +1,66 @@
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Variables
+
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
+###############################################################################
+
+      @@reserved = [ "component", "config", "service" ]
+
+###############################################################################
+
+      attr_reader :values
+
+###############################################################################
+
+      def initialize(values: Hash.new, sort: true)
+        cleansed = cleanse(values: values)
+        @values = sort ? cleansed.sort.to_h : cleansed
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def cleanse(values:)
+        result = Hash.new
+
+        values.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, 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?
+
+          result[key.downcase.to_sym] = values[key].strip
+        end
+
+        return result
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/terraform-wrapper/tasks.rb

@@ -1,12 +1,18 @@
 ###############################################################################
 
+require 'rake/tasklib'
+
+###############################################################################
+
 require_relative 'tasks/apply'
 require_relative 'tasks/binary'
 require_relative 'tasks/clean'
 require_relative 'tasks/destroy'
+require_relative 'tasks/import'
 require_relative 'tasks/init'
 require_relative 'tasks/plan'
 require_relative 'tasks/plandestroy'
+require_relative 'tasks/upgrade'
 require_relative 'tasks/validate'
 
 ###############################################################################

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

@@ -1,9 +1,5 @@
 ###############################################################################
 
-require 'rake/tasklib'
-
-###############################################################################
-
 module TerraformWrapper
 
 ###############################################################################
@@ -16,22 +12,20 @@ module TerraformWrapper
 
 ###############################################################################
 
-      @backend
+      include TerraformWrapper::Shared::Logging
+
+###############################################################################
+
       @binary
       @code
-      @configs
-      @overrides
-      @service
+      @options
 
 ###############################################################################
 
-      def initialize(backend:, binary:, code:, configs:, overrides:, service:)
-        @backend   = backend
-        @binary    = binary
-        @code      = code
-        @configs   = configs
-        @overrides = overrides
-        @service   = service
+      def initialize(binary:, code:, options:)
+        @binary  = binary
+        @code    = code
+        @options = options
 
         yield self if block_given?
 
@@ -41,13 +35,17 @@ module TerraformWrapper
 ###############################################################################
 
       def apply_task
-        desc "Applies infrastructure with Terraform for a given configuration on a workspace."
+        desc "Applies infrastructure with Terraform for a given configuration on an infrastructure component."
         task :apply, [:config, :plan] => :binary do |t, args|
-          $logger.info("Running Terraform apply for service: #{@service}, component: #{@code.name}...")
+          options = @options.merge({"name" => args[:config]})
 
-          config = TerraformWrapper::Shared::Config.new(backend: @backend, base: @configs, code: @code, name: args[:config], overrides: @overrides, service: @service)
+          logger.info("Processing configuration for Terraform apply...")
+
+          config = TerraformWrapper::Shared::Config.new(code: @code, options: options)
           runner = TerraformWrapper::Shared::Runner.new(binary: @binary, code: @code)
 
+          logger.info("Running Terraform apply for service: #{config.service}, component: #{@code.name}...")
+
           runner.init(config: config)
           runner.apply(file: args[:plan])
         end

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

@@ -3,7 +3,6 @@
 require 'digest'
 require 'fileutils'
 require 'net/http'
-require 'rake/tasklib'
 require 'uri'
 require 'zip'
 
@@ -19,6 +18,10 @@ module TerraformWrapper
 
     class Binary < ::Rake::TaskLib
 
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
       @binary
@@ -38,12 +41,12 @@ module TerraformWrapper
       def binary_task
         desc "Downloads and extracts the expected version of the Terraform binary if it is not already present."
         task :binary do |t, args|
-          $logger.info("Checking Terraform binary for platform: #{@binary.platform}, version: #{@binary.version}")
+          logger.info("Checking Terraform binary for platform: #{@binary.platform}, version: #{@binary.version}")
 
           if not @binary.exists then
-            $logger.info("Terraform binary not found. Preparing binary...")
+            logger.info("Terraform binary not found. Preparing binary...")
 
-            raise "Failed to create binary directory: #{directory}" unless create_directory(directory: @binary.directory, purpose: "binaries")
+            logger.fatal("Failed to create binary directory: #{directory}") unless ::TerraformWrapper.create_directory(directory: @binary.directory, purpose: "binaries")
 
             archive_binary = "terraform"
             archive_file   = "terraform_#{@binary.version}_#{@binary.platform}_amd64.zip"
@@ -65,11 +68,11 @@ module TerraformWrapper
           end
 
           if not @binary.executable then
-            $logger.info("Terraform binary not executable. Setting permissions...")
+            logger.info("Terraform binary not executable. Setting permissions...")
             executable(path: @binary.path)
           end
 
-          raise("Problem with checking the Terraform binary!") unless @binary.check
+          logger.fatal("Problem with checking the Terraform binary!") unless @binary.check
         end
       end
 
@@ -80,25 +83,25 @@ module TerraformWrapper
 ###############################################################################
 
       def download(path:, uri:)
-        $logger.info("Downloading: #{uri}")
+        logger.info("Downloading: #{uri}")
 
         response = Net::HTTP.get_response(URI(uri))
 
-        raise "Download request did not return HTTP status 200!" if response.code != "200"
-        raise "Download response body is not permitted!"         unless response.class.body_permitted?
-        raise "Download response body is empty!"                 if response.body.nil?
+        logger.fatal("Download request did not return HTTP status 200!") if response.code != "200"
+        logger.fatal("Download response body is not permitted!")         unless response.class.body_permitted?
+        logger.fatal("Download response body is empty!")                 if response.body.nil?
 
         open(path, "wb") { |file|
           file.write(response.body)
         }
 
-        raise "Download failed!" unless File.file?(path)
+        logger.fatal("Download failed!") unless File.file?(path)
       end
 
 ###############################################################################
 
       def verify(file:, path:, sums:)
-        $logger.info("Checking SHA256 for: #{file}")
+        logger.info("Checking SHA256 for: #{file}")
 
         result = false
 
@@ -110,41 +113,41 @@ module TerraformWrapper
             sum_file   = fields["file"]
             sum_sha256 = fields["sum"]
           rescue
-            $logger.warn("Unexpected data in sums file: #{sums}")
+            logger.warn("Unexpected data in sums file: #{sums}")
             next
           end
 
           if sum_file == file then
-            $logger.info("Expected SHA256 sum: #{sum_sha256}")
-            $logger.info("Actual SHA256 sum: #{sha256}")
+            logger.info("Expected SHA256 sum: #{sum_sha256}")
+            logger.info("Actual SHA256 sum: #{sha256}")
             result = (sum_sha256 == sha256)
             break
           end
         end
 
-        raise "Error whilst verifying the SHA256 sum of the downloaded Terraform archive!" unless result
+        logger.fatal("Error whilst verifying the SHA256 sum of the downloaded Terraform archive!") unless result
       end
 
 ###############################################################################
 
       def extract(archive:, binary:, destination:)
-        $logger.info("Extracting: #{archive}")
+        logger.info("Extracting: #{archive}")
 
-        Zip::ZipFile.open(archive) do |zip|
+        Zip::File.open(archive) do |zip|
           zip.each do |file|
             zip.extract(file, destination) if file.name == binary
           end
         end
 
-        raise "Extraction of Terraform binary: #{binary}, from archive: #{archive} has failed!" unless File.file?(destination)
+        logger.fatal("Extraction of Terraform binary: #{binary}, from archive: #{archive} has failed!") unless File.file?(destination)
       end
 
 ###############################################################################
 
       def executable(path:)
-        $logger.info("Making executable: #{path}")
+        logger.info("Making executable: #{path}")
         FileUtils.chmod("+x", path)
-        raise "Setting executable bit on file: #{path} has failed!" unless File.executable?(path)
+        logger.fatal("Setting executable bit on file: #{path} has failed!") unless File.executable?(path)
       end
 
 ###############################################################################
@@ -152,12 +155,12 @@ module TerraformWrapper
       def clean(archive:, sums:)
         [archive, sums].each do |file|
           if File.file?(file)
-            $logger.info("Removing file: #{file}")
+            logger.info("Removing file: #{file}")
 
             begin
               File.delete(file)
             rescue
-              $logger.error("Failed to delete: #{file}, please remove manually.")
+              logger.error("Failed to delete: #{file}, please remove manually.")
             end
           end
         end

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

@@ -1,9 +1,5 @@
 ###############################################################################
 
-require 'rake/tasklib'
-
-###############################################################################
-
 module TerraformWrapper
 
 ###############################################################################
@@ -14,6 +10,10 @@ module TerraformWrapper
 
     class Clean < ::Rake::TaskLib
 
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
 ###############################################################################
 
       @@glob_directories = {
@@ -46,13 +46,13 @@ module TerraformWrapper
 ###############################################################################
 
       def clean_task
-        desc "Cleans the Terraform workspace of any downloaded providers and modules."
+        desc "Cleans a Terraform infrastructure component workspace of any downloaded providers and modules."
         task :clean do |t, args|
-          $logger.info("Cleaning Terraform component: #{@code.name}...")
+          logger.info("Cleaning Terraform component: #{@code.name}...")
 
           directory_counter = 0
           @@glob_directories.each do |key, value|
-            $logger.info("Cleaning directories: #{key}")
+            logger.info("Cleaning directories: #{key}")
             directory_item_counter = 0
 
             directories = Dir.glob(File.join(@code.path, value))
@@ -62,12 +62,12 @@ module TerraformWrapper
                 directory_counter      += 1
               end
             end
-            $logger.info("Cleaned: #{directory_item_counter.to_s} directories.")
+            logger.success("Cleaned: #{directory_item_counter.to_s} directories.")
           end
 
           file_counter = 0
           @@glob_files.each do |key, value|
-            $logger.info("Cleaning files: #{key}")
+            logger.info("Cleaning files: #{key}")
             file_item_counter = 0
 
             files = Dir.glob(File.join(@code.path, value))
@@ -77,10 +77,10 @@ module TerraformWrapper
                 file_counter      += 1
               end
             end
-            $logger.info("Cleaned: #{file_item_counter.to_s} files.")
+            logger.success("Cleaned: #{file_item_counter.to_s} files.")
           end
 
-          $logger.info("Cleaned total: #{directory_counter.to_s} directories and: #{file_counter.to_s} files.")
+          logger.success("Cleaned total: #{directory_counter.to_s} directories and: #{file_counter.to_s} files.")
         end
       end
 
@@ -97,10 +97,10 @@ module TerraformWrapper
         begin
           FileUtils.remove_dir(directory)
           result = true
-          $logger.info("Deleted directory: #{directory}")
+          logger.info("Deleted directory: #{directory}")
         rescue
           result = false
-          $logger.warn("Failed to delete directory: #{directory}")
+          logger.warn("Failed to delete directory: #{directory}")
         end
       end
 
@@ -116,10 +116,10 @@ module TerraformWrapper
         begin
           File.delete(file)
           result = true
-          $logger.info("Deleted file: #{file}")
+          logger.info("Deleted file: #{file}")
         rescue
           result = false
-          $logger.warn("Failed to delete file: #{file}")
+          logger.warn("Failed to delete file: #{file}")
         end
       end
 

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

@@ -1,9 +1,5 @@
 ###############################################################################
 
-require 'rake/tasklib'
-
-###############################################################################
-
 module TerraformWrapper
 
 ###############################################################################
@@ -16,22 +12,20 @@ module TerraformWrapper
 
 ###############################################################################
 
-      @backend
+      include TerraformWrapper::Shared::Logging
+
+###############################################################################
+
       @binary
       @code
-      @configs
-      @overrides
-      @service
+      @options
 
 ###############################################################################
 
-      def initialize(backend:, binary:, code:, configs:, overrides:, service:)
-        @backend   = backend
-        @binary    = binary
-        @code      = code
-        @configs   = configs
-        @overrides = overrides
-        @service   = service
+      def initialize(binary:, code:, options:)
+        @binary  = binary
+        @code    = code
+        @options = options
 
         yield self if block_given?
 
@@ -41,13 +35,17 @@ module TerraformWrapper
 ###############################################################################
 
       def destroy_task
-        desc "Destroys infrastructure with Terraform for a given configuration on a workspace."
+        desc "Destroys infrastructure with Terraform for a given configuration on an infrastructure component."
         task :destroy, [:config] => :binary do |t, args|
-          $logger.info("Running Terraform destroy for service: #{@service}, component: #{@code.name}...")
+          options = @options.merge({"name" => args[:config]})
 
-          config = TerraformWrapper::Shared::Config.new(backend: @backend, base: @configs, code: @code, name: args[:config], overrides: @overrides, service: @service)
+          logger.info("Processing configuration for Terraform destroy...")
+
+          config = TerraformWrapper::Shared::Config.new(code: @code, options: options)
           runner = TerraformWrapper::Shared::Runner.new(binary: @binary, code: @code)
 
+          logger.info("Running Terraform destroy for service: #{config.service}, component: #{@code.name}...")
+
           runner.init(config: config)
           runner.destroy
         end

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

@@ -0,0 +1,66 @@
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Import < ::Rake::TaskLib
+
+###############################################################################
+
+      include TerraformWrapper::Shared::Logging
+
+###############################################################################
+
+      @binary
+      @code
+      @options
+
+###############################################################################
+
+      def initialize(binary:, code:, options:)
+        @binary  = binary
+        @code    = code
+        @options = options
+
+        yield self if block_given?
+
+        import_task
+      end
+
+###############################################################################
+
+      def import_task
+        desc "Import a piece of existing infrastructure into Terraform state for a given configuration on an infrastructure component."
+        task :import, [:config, :address, :id] => :binary do |t, args|
+          options = @options.merge({"name" => args[:config]})
+
+          logger.info("Processing configuration for Terraform import...")
+
+          config = TerraformWrapper::Shared::Config.new(code: @code, options: options)
+          runner = TerraformWrapper::Shared::Runner.new(binary: @binary, code: @code)
+
+          logger.info("Running Terraform import for service: #{config.service}, component: #{@code.name}...")
+
+          runner.init(config: config)
+          runner.import(address: args[:address], id: args[:id])
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################