terraform-wrapper 0.0.2

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

@@ -0,0 +1,70 @@
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Identifiers
+
+###############################################################################
+
+      attr_reader :identifiers
+
+###############################################################################
+
+      def initialize(identifiers: Hash.new, sort: true)
+        cleansed = cleanse(identifiers: identifiers)
+        @identifiers = sort ? cleansed.sort : cleansed
+      end
+
+###############################################################################
+
+      def path()
+        result = String.new
+
+        @identifiers.each do |key, value|
+          directory = key + "-" + value
+          result = result.empty? ? directory : File.join(result, directory)
+        end
+
+        return result
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def cleanse(identifiers:)
+        result = Hash.new
+
+        identifiers.keys.each do |key|
+          raise "Could not clean identifiers hash. All keys MUST be strings!" unless key.kind_of?(String)
+          raise "Could not clean identifiers hash, duplicate key found: #{key.downcase}!" if result.key?(key.downcase)
+          raise "Could not clean identifiers hash, value for: #{key.downcase} is not a string!" unless identifiers[key].kind_of?(String)
+          raise "Could not clean identifiers hash, value for: #{key.downcase} is empty!" if identifiers[key].strip.empty?
+
+          result[key.downcase] = identifiers[key].strip.downcase
+        end
+
+        return result
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,75 @@
+###############################################################################
+
+require 'json'
+require 'net/http'
+require 'singleton'
+require 'uri'
+
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Latest
+
+###############################################################################
+
+      include Singleton
+
+###############################################################################
+
+      @version
+
+###############################################################################
+
+      def version
+        @version ||= refresh
+
+        return @version
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def refresh
+        $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?
+
+        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?
+
+        version = body["current_version"]
+
+        $logger.info("Latest available Terraform release found: #{version}")
+
+        return version
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,155 @@
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Runner
+
+###############################################################################
+
+      attr_reader :binary
+      attr_reader :code
+      attr_reader :config
+      attr_reader :downloaded
+      attr_reader :initialised
+
+###############################################################################
+
+      def initialize(binary:, code:)
+        @binary = binary
+        @code   = code
+
+        @initialised = false
+        @ready       = false
+      end
+
+###############################################################################
+
+      def download
+        parameters = [ "-backend=false" ]
+        @downloaded = run(action: "init", parameters: parameters)
+        raise("Failed to download Terraform modules.") unless @downloaded
+      end
+
+###############################################################################
+
+      def init(config:)
+        parameters = [ "-reconfigure" ]
+        config.backend.hash.each do |key, value|
+          parameters.append("-backend-config=\"#{key}=#{value}\"")
+        end
+
+        @config = config
+        @initialised = run(action: "init", parameters: parameters)
+        raise("Failed to initialise Terraform with backend.") unless @initialised
+      end
+
+###############################################################################
+
+      def plan(destroy: false, file: nil)
+        raise("Cannot Terraform plan before initialising backend!") unless initialised
+
+        parameters = variable_files
+
+        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")
+          parameters.append("-out=\"#{file}\"")
+        end
+
+        parameters.append("-destroy") if destroy
+
+        raise("Terraform plan failed!") unless run(action: "plan", parameters: parameters)
+      end
+
+###############################################################################
+
+      def apply(file: nil)
+        raise("Cannot Terraform apply before initialising backend!") unless initialised
+
+        parameters = [ "-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)
+          parameters.append("\"#{file}\"")
+        else
+          parameters.concat(variable_files)
+        end
+
+        raise("Terraform apply failed!") unless run(action: "apply", parameters: parameters)
+      end
+
+###############################################################################
+
+      def destroy
+        raise("Cannot Terraform destroy before initialising backend!") unless initialised
+
+        parameters = [ "-auto-approve" ]
+        parameters.concat(variable_files)
+
+        raise("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")
+      end
+
+###############################################################################
+
+    private
+
+###############################################################################
+
+      def variable_files
+        raise("Cannot generate variable files until Terraform has been initialised!") unless @initialised
+
+        result = Array.new
+
+        @config.variable_files.each do |variable_file|
+          result.append("-var-file=\"#{variable_file}\"")
+        end
+
+        return result
+      end
+
+###############################################################################
+
+      def run(action:, parameters: Array.new)
+        result = false
+
+        parameters.reject! { |item| not item.kind_of?(String) or item.strip.empty? }
+
+        cmdline = [ "\"#{@binary.path}\"", action ].concat(parameters).join(" ")
+
+        $logger.info("Starting Terraform, action: #{action}")
+
+        puts("\n" + ('#' * 80) + "\n\n")
+
+        Dir.chdir(@code.path)
+        result = system(cmdline) || false
+
+        puts("\n")
+
+        return result
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/terraform-wrapper/tasks.rb

@@ -0,0 +1,12 @@
+###############################################################################
+
+require_relative 'tasks/apply'
+require_relative 'tasks/binary'
+require_relative 'tasks/clean'
+require_relative 'tasks/destroy'
+require_relative 'tasks/init'
+require_relative 'tasks/plan'
+require_relative 'tasks/plandestroy'
+require_relative 'tasks/validate'
+
+###############################################################################

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

@@ -0,0 +1,68 @@
+###############################################################################
+
+require 'rake/tasklib'
+
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Apply < ::Rake::TaskLib
+
+###############################################################################
+
+      @backend
+      @binary
+      @code
+      @configs
+      @overrides
+      @service
+
+###############################################################################
+
+      def initialize(backend:, binary:, code:, configs:, overrides:, service:)
+        @backend   = backend
+        @binary    = binary
+        @code      = code
+        @configs   = configs
+        @overrides = overrides
+        @service   = service
+
+        yield self if block_given?
+
+        apply_task
+      end
+
+###############################################################################
+
+      def apply_task
+        desc "Applies infrastructure with Terraform for a given configuration on a workspace."
+        task :apply, [:config, :plan] => :binary do |t, args|
+          $logger.info("Running Terraform apply for service: #{@service}, component: #{@code.name}...")
+
+          config = TerraformWrapper::Shared::Config.new(backend: @backend, base: @configs, code: @code, name: args[:config], overrides: @overrides, service: @service)
+          runner = TerraformWrapper::Shared::Runner.new(binary: @binary, code: @code)
+
+          runner.init(config: config)
+          runner.apply(file: args[:plan])
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,178 @@
+###############################################################################
+
+require 'digest'
+require 'fileutils'
+require 'net/http'
+require 'rake/tasklib'
+require 'uri'
+require 'zip'
+
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Tasks
+
+###############################################################################
+
+    class Binary < ::Rake::TaskLib
+
+###############################################################################
+
+      @binary
+
+###############################################################################
+
+      def initialize(binary:)
+        @binary = binary
+
+        yield self if block_given?
+
+        binary_task
+      end
+
+###############################################################################
+
+      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}")
+
+          if not @binary.exists then
+            $logger.info("Terraform binary not found. Preparing binary...")
+
+            raise "Failed to create binary directory: #{directory}" unless create_directory(directory: @binary.directory, purpose: "binaries")
+
+            archive_binary = "terraform"
+            archive_file   = "terraform_#{@binary.version}_#{@binary.platform}_amd64.zip"
+            archive_path   = File.join(@binary.directory, archive_file)
+            archive_uri    = "https://releases.hashicorp.com/terraform/#{@binary.version}/#{archive_file}"
+
+            sums_file = "terraform_#{@binary.version}_SHA256SUMS"
+            sums_path = File.join(@binary.directory, sums_file)
+            sums_uri  = "https://releases.hashicorp.com/terraform/#{@binary.version}/#{sums_file}"
+
+            begin
+              download(path: archive_path, uri: archive_uri) if not File.file?(archive_path)
+              download(path: sums_path, uri: sums_uri) if not File.file?(sums_path)
+              verify(file: archive_file, path: archive_path, sums: sums_path)
+              extract(archive: archive_path, binary: archive_binary, destination: @binary.path)
+            ensure
+              clean(archive: archive_path, sums: sums_path)
+            end
+          end
+
+          if not @binary.executable then
+            $logger.info("Terraform binary not executable. Setting permissions...")
+            executable(path: @binary.path)
+          end
+
+          raise("Problem with checking the Terraform binary!") unless @binary.check
+        end
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def download(path:, 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?
+
+        open(path, "wb") { |file|
+          file.write(response.body)
+        }
+
+        raise "Download failed!" unless File.file?(path)
+      end
+
+###############################################################################
+
+      def verify(file:, path:, sums:)
+        $logger.info("Checking SHA256 for: #{file}")
+
+        result = false
+
+        sha256 = Digest::SHA256.hexdigest File.read(path)
+
+        File.readlines(sums).each do |line|
+          begin
+            fields     = line.match /^(?<sum>\S+)\s+(?<file>\S+)$/
+            sum_file   = fields["file"]
+            sum_sha256 = fields["sum"]
+          rescue
+            $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}")
+            result = (sum_sha256 == sha256)
+            break
+          end
+        end
+
+        raise "Error whilst verifying the SHA256 sum of the downloaded Terraform archive!" unless result
+      end
+
+###############################################################################
+
+      def extract(archive:, binary:, destination:)
+        $logger.info("Extracting: #{archive}")
+
+        Zip::ZipFile.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)
+      end
+
+###############################################################################
+
+      def executable(path:)
+        $logger.info("Making executable: #{path}")
+        FileUtils.chmod("+x", path)
+        raise "Setting executable bit on file: #{path} has failed!" unless File.executable?(path)
+      end
+
+###############################################################################
+
+      def clean(archive:, sums:)
+        [archive, sums].each do |file|
+          if File.file?(file)
+            $logger.info("Removing file: #{file}")
+
+            begin
+              File.delete(file)
+            rescue
+              $logger.error("Failed to delete: #{file}, please remove manually.")
+            end
+          end
+        end
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################