terraform-wrapper 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ada2b6b6e65d6daedfc646d9f983894ada4061b649902252468bccaae76b4fee
+  data.tar.gz: 4698b8bc21d9ab1ab2866a263645a2aa07955aeb03b2f10d15aed732da1d4553
+SHA512:
+  metadata.gz: '095bd5f00cda0d8fa2e6e636bfaf4bf31e6dea0a03cbc49b3149c85b15c75e4928e5754dd56b9a71d9d0b33f5b8a7e033739e45e7746fe2fd97d28bb0139f62e'
+  data.tar.gz: 36f56ccf800f33dba662e41f377688e753c409076417269a2b638a6a28b60980aea437736236ca1083602f2a1cf8d935c0cc7aaaa35b297ba11bde06e935efd2

data/.gitignore

@@ -0,0 +1,28 @@
+###############################################################################
+
+**/*.DS_Store
+**/*.swp
+**/*.tmp
+**/*~
+
+###############################################################################
+
+.idea
+
+###############################################################################
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+###############################################################################
+
+/archlinux/
+!/archlinux/PKGBUILD
+
+###############################################################################

data/.gitlab-ci.yml

@@ -0,0 +1,35 @@
+###############################################################################
+
+image: ruby
+
+###############################################################################
+
+stages:
+  - test
+  - publish
+
+###############################################################################
+
+test:
+  stage : test
+  script:
+    - echo "-- Beginning Test --"
+    - echo "-- Tests not implemented yet --"
+
+###############################################################################
+
+deploy:
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'
+  stage: publish
+  script:
+    - echo "-- Beginning Publish --"
+    - test -n "${GEM_HOST_API_KEY}"
+    - echo "RubyGems API key found!"
+    - hash rake
+    - hash ruby
+    - hash gem
+    - echo "-- Publishing Gem --"
+    - rake release
+
+###############################################################################

data/Gemfile

@@ -0,0 +1,17 @@
+###############################################################################
+
+# frozen_string_literal: true
+
+###############################################################################
+
+source "https://rubygems.org"
+
+###############################################################################
+
+gemspec
+
+###############################################################################
+
+gem "rake", "~> 13.0"
+
+###############################################################################

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Richard Lees, BITServices Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+###############################################################################
+
+# frozen_string_literal: true
+
+###############################################################################
+
+require "bundler/gem_tasks"
+
+###############################################################################
+
+task default: %i[]
+
+###############################################################################

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+###############################################################################
+
+# frozen_string_literal: true
+
+###############################################################################
+
+require "bundler/setup"
+require "irb"
+require "terraform-wrapper"
+
+###############################################################################
+
+IRB.start(__FILE__)
+
+###############################################################################

data/bin/setup

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+###############################################################################
+
+set -euo pipefail
+
+###############################################################################
+
+IFS=$'\n\t'
+
+###############################################################################
+
+set -vx
+
+###############################################################################
+
+bundle install
+
+###############################################################################

data/lib/terraform-wrapper.rb

@@ -0,0 +1,47 @@
+###############################################################################
+
+require_relative 'terraform-wrapper/shared'
+require_relative 'terraform-wrapper/tasks'
+require_relative 'terraform-wrapper/version'
+
+###############################################################################
+
+require_relative 'terraform-wrapper/common'
+
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  def self.define_tasks(backend: "local",
+                        binaries: File.join(Dir.pwd, "vendor", "terraform"),
+                        component:,
+                        configs: File.join(Dir.pwd, "config"),
+                        overrides: Hash.new,
+                        service:,
+                        terraform: File.join(Dir.pwd, "terraform"),
+                        version: TerraformWrapper::Shared::Latest.instance.version)
+
+    $logger.info("Building tasks for service: #{service}, component: #{component}...")
+
+    binary = TerraformWrapper::Shared::Binary.new(base: binaries, version: version)
+    code   = TerraformWrapper::Shared::Code.new(base: terraform, name: component)
+
+    tasks = Array.new
+    tasks << TerraformWrapper::Tasks::Apply.new(backend: backend, binary: binary, code: code, configs: configs, overrides: overrides, service: service)
+    tasks << TerraformWrapper::Tasks::Binary.new(binary: binary)
+    tasks << TerraformWrapper::Tasks::Clean.new(code: code)
+    tasks << TerraformWrapper::Tasks::Destroy.new(backend: backend, binary: binary, code: code, configs: configs, overrides: overrides, service: service)
+    tasks << TerraformWrapper::Tasks::Init.new(backend: backend, binary: binary, code: code, configs: configs, overrides: overrides, service: service)
+    tasks << TerraformWrapper::Tasks::Plan.new(backend: backend, binary: binary, code: code, configs: configs, overrides: overrides, service: service)
+    tasks << TerraformWrapper::Tasks::PlanDestroy.new(backend: backend, binary: binary, code: code, configs: configs, overrides: overrides, service: service)
+    tasks << TerraformWrapper::Tasks::Validate.new(binary: binary, code: code)
+    return tasks
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/terraform-wrapper/common.rb

@@ -0,0 +1,38 @@
+###############################################################################
+
+require 'logger'
+
+###############################################################################
+
+$logger = Logger.new(STDOUT,
+                     level: "INFO",
+                     progname: "TerraformWrapper")
+
+$logger.formatter = proc do |severity, datetime, progname, msg|
+  sevId = severity.chars.first.upcase
+  "#{progname} [#{sevId}] #{msg}\n"
+end
+
+###############################################################################
+
+$logger.info("Terraform Wrapper for Ruby - version: #{TerraformWrapper::VERSION}")
+
+###############################################################################
+
+def create_directory(directory:, purpose: nil, exists: true)
+  return exists if File.directory?(directory)
+
+  result = false
+
+  if not purpose.nil? and purpose.kind_of?(String) and not purpose.strip.empty? then
+    $logger.info("Creating directory for: #{purpose}, path: #{directory}")
+  else
+    $logger.info("Creating directory: #{directory}")
+  end
+
+  FileUtils.mkdir_p(directory)
+
+  result = File.directory?(directory)
+end
+
+###############################################################################

data/lib/terraform-wrapper/shared.rb

@@ -0,0 +1,11 @@
+###############################################################################
+
+require_relative 'shared/backends'
+require_relative 'shared/binary'
+require_relative 'shared/code'
+require_relative 'shared/config'
+require_relative 'shared/identifiers'
+require_relative 'shared/latest'
+require_relative 'shared/runner'
+
+###############################################################################

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

@@ -0,0 +1,11 @@
+###############################################################################
+
+require_relative 'backends/common'
+
+###############################################################################
+
+require_relative 'backends/aws'
+require_relative 'backends/azure'
+require_relative 'backends/local'
+
+###############################################################################

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

@@ -0,0 +1,106 @@
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    module Backends
+
+###############################################################################
+
+      class AWS < Common
+
+###############################################################################
+
+        @@default_class = "terraform-state"
+
+###############################################################################
+
+        @@type = "aws"
+
+###############################################################################
+
+        attr_reader :bucket
+        attr_reader :class
+        attr_reader :key
+        attr_reader :region
+
+###############################################################################
+
+        def initialize(service:, code:, identifiers:, overrides: Hash.new)
+          construct(service: service, code: code, identifiers: identifiers, overrides: overrides)
+        end
+
+###############################################################################
+
+        def hash()
+          return {
+            "bucket" => @bucket,
+            "key"    => @key,
+            "region" => @region
+          }
+        end
+
+###############################################################################
+
+        private
+
+###############################################################################
+
+        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
+
+          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?
+
+            @region = @identifiers["account"].strip.downcase
+          end
+
+          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?
+
+            @bucket = @class + "-" + @region + "-" + @identifiers["account"].strip.downcase
+          end
+
+          key = File.join(@identifiers.path, @service, @component + @@ext)
+
+          if key.length > 1024 then
+            raise "Key: #{key} is too long for backend of type: #{@@type}"
+          else
+            @key = key
+          end
+        end
+
+###############################################################################
+
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

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

@@ -0,0 +1,120 @@
+###############################################################################
+
+module TerraformWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    module Backends
+
+###############################################################################
+
+      class Azure < Common
+
+###############################################################################
+
+        @@default_class     = "state"
+        @@default_container = "default"
+        @@default_suffix    = "tf"
+
+###############################################################################
+
+        @@type = "azure"
+
+###############################################################################
+
+        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)
+        end
+
+###############################################################################
+
+        def hash()
+          return {
+            "container_name"       => @container,
+            "key"                  => @key,
+            "resource_group_name"  => @group,
+            "storage_account_name" => @account
+          }
+        end
+
+###############################################################################
+
+        private
+
+###############################################################################
+
+        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
+
+          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
+
+          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
+
+          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?
+
+            @group = @identifiers["subscription"].strip.downcase + @suffix
+          end
+
+          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
+
+          key = File.join(@identifiers.path, @service, @component + @@ext)
+
+          if key.length > 1024 then
+            raise "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
+          end
+        end
+
+###############################################################################
+
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################