domed-city 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a479bd76c9371672e2c98195ff3f7fb586729754
-  data.tar.gz: f01115ee5623edc4d6c49ed8a71b10f36c51697c
+  metadata.gz: dc30be20e47da94a3dba7850dcbeace2d40dcd7f
+  data.tar.gz: 8e9255071a4b955afefdfc7af8dd833b7bb88778
 SHA512:
-  metadata.gz: 000d202545551fe348eae862c7efd1f18098e161cfe8a347ff259ab3ed414b6bd1db37482648e27c4189a6c4476d03dec4a575582406d7e33fe9bdab7c582d85
-  data.tar.gz: 8f6ef5a805ecbf245b9d11abe0ec9b36484b51f5adfc9776d798127518a5d0b6ace3fd4d3815490664ac587688d9f4297de3a2f35dd5b911e6fa389991a48eb2
+  metadata.gz: f692ed025597cbda665c7f42dc4442abc71be05d7288fdc3c30b43a5eeb20dfe08e466f0351ae473fa001584a347d45d44249059edca15cfc6189111ab5ff0ab
+  data.tar.gz: 0ca6e96eb0c50e23663c45d971ab341d2712748ba7cf982e47974a8c239fb6c5b94b9f133ca6dda4d2684c02498a0e25f1269a73bbc609b741b593577a5f7f21

data/bin/dome

@@ -19,22 +19,23 @@ EOS
   opt :state, 'Synchronises the Terraform state'
 end
 
+# TODO: hopefully we can flip this logic to DRY it up
 if opts[:plan]
-  @dome = Dome::Environment.new
+  @dome = Dome::Terraform.new
   @dome.validate_environment
   @dome.plan
 elsif opts[:apply]
-  @dome = Dome::Environment.new
+  @dome = Dome::Terraform.new
   @dome.validate_environment
   @dome.apply
 elsif opts[:plan_destroy]
-  @dome = Dome::Environment.new
+  @dome = Dome::Terraform.new
   @dome.validate_environment
   @dome.plan_destroy
 elsif opts[:state]
-  @dome = Dome::Environment.new
+  @dome = Dome::Terraform.new
   @dome.validate_environment
-  @dome.bootstrap_s3_state
+  @dome.state.s3_state
 else
   Trollop.educate
 end

data/lib/dome.rb

@@ -5,4 +5,7 @@ require 'aws/profile_parser'
 require 'fileutils'
 
 require 'dome/version'
+require 'dome/helpers/shell'
 require 'dome/environment'
+require 'dome/state'
+require 'dome/terraform'

data/lib/dome/environment.rb

@@ -1,225 +1,74 @@
 module Dome
   class Environment
+    attr_reader :environment, :account, :team
+
     def initialize
-      @environment    = Dir.pwd.split('/')[-1]
-      @account        = Dir.pwd.split('/')[-2]
-      @team           = 'deirdre'
-      @tfstate_bucket = "#{@team}-tfstate-#{@environment}"
-      @tfstate_s3_obj = "#{@environment}-terraform.tfstate"
-      @varfile        = 'params/env.tfvars'
-      @plan           = "plans/#{@account}-#{@environment}-plan.tf"
-      @state_file     = "state-files/#{@environment}-terraform.tfstate"
+      @environment = Dir.pwd.split('/')[-1]
+      @account     = Dir.pwd.split('/')[-2]
+      @team        = @account.match(/(\w+)-\w+\z/)[1]
     end
 
-    # --------------------------------------------------------------
-    # Environment stuff
-    # --------------------------------------------------------------
-
-    def valid_accounts
+    def accounts
       %w(deirdre-dev deirdre-prd)
     end
 
-    def valid_env_nonprod
+    def non_production_environments
       %w(infradev sit qa stg)
     end
 
-    def valid_env_prod
+    def production_environments
       %w(infraprd prd)
     end
 
-    def validate_environment
-      puts "Environment: #{@environment}"
-      puts "Account: #{@account}"
-
-      invalid_account_message(account) unless valid_account? @account
-      invalid_environment_message(account, environment) unless valid_environment?(@account, @environment)
-
-      set_aws_credentials(@account)
-    end
-
-    def set_aws_credentials(account)
+    def aws_credentials
       begin
-        @aws_creds = AWS::ProfileParser.new.get(account)
+        @aws_credentials ||= AWS::ProfileParser.new.get(@account)
       rescue RuntimeError
-        raise "No credentials found for account: '#{account}'."
+        raise "No credentials found for account: '#{@account}'."
       end
-      ENV['AWS_ACCESS_KEY_ID']     = @aws_creds[:access_key_id]
-      ENV['AWS_SECRET_ACCESS_KEY'] = @aws_creds[:secret_access_key]
-      ENV['AWS_DEFAULT_REGION']    = @aws_creds[:region]
+    end
+
+    def populate_aws_access_keys
+      ENV['AWS_ACCESS_KEY_ID']     = aws_credentials[:access_key_id]
+      ENV['AWS_SECRET_ACCESS_KEY'] = aws_credentials[:secret_access_key]
+      ENV['AWS_DEFAULT_REGION']    = aws_credentials[:region]
     end
 
     def valid_account?(account)
-      valid_accounts.include? account
+      puts "Account: #{account.colorize(:green)}"
+      accounts.include? account
     end
 
     def valid_environment?(account, environment)
-      if valid_accounts[valid_accounts.index(account)] == 'deirdre-dev'
-        valid_env_nonprod.include? environment
-      elsif valid_accounts[valid_accounts.index(account)] == 'deirdre-prd'
-        valid_env_prod.include? environment
+      puts "Environment: #{environment.colorize(:green)}"
+      if account[-4..-1] == '-dev'
+        non_production_environments.include? environment
+      else
+        production_environments.include? environment
       end
     end
 
-    def invalid_account_message(account)
-      puts "\n'#{account}' is not a valid account.\n".colorize(:red)
-      puts "Valid accounts are: #{valid_accounts}."
+    def invalid_account_message
+      puts "\n'#{@account}' is not a valid account.\n".colorize(:red)
+      puts "The 'account' and 'environment' values are calculated based on your current directory.\n".colorize(:red)
+      puts "Valid accounts are: #{accounts}."
       puts "\nEither:"
       puts '1. Set your .aws/config to one of the valid accounts above.'
       puts '2. Ensure you are running this from the correct directory.'
       exit 1
     end
 
-    def invalid_environment_message(account, environment)
-      puts "\n'#{environment}' is not a valid environment for the account: '#{account}'.\n".colorize(:red)
-      (account == 'deirdre-dev') ? env = valid_env_nonprod : env = valid_env_prod
-      puts "Valid environments are: #{env}"
-      exit 1
-    end
-
-    # --------------------------------------------------------------
-    # Terraform commands
-    # --------------------------------------------------------------
-
-    def plan
-      puts "current dir: #{Dir.pwd}"
-      delete_terraform_directory
-      delete_plan_file
-      install_terraform_modules
-      fetch_s3_state
-      create_plan
-    end
-
-    def apply
-      command         = "terraform apply #{@plan}"
-      failure_message = 'something went wrong when applying the TF plan'
-      execute_command(command, failure_message)
-    end
-
-    def create_plan
-      command         = "terraform plan -module-depth=1 -refresh=true -out=#{@plan} -var-file=#{@varfile}"
-      failure_message = 'something went wrong when creating the TF plan'
-      execute_command(command, failure_message)
-    end
-
-    def delete_terraform_directory
-      puts 'Deleting older terraform module cache dir ...'.colorize(:green)
-      terraform_directory = '.terraform'
-      puts "About to delete directory: #{terraform_directory}"
-      FileUtils.rm_rf '.terraform/'
-    end
-
-    def delete_plan_file
-      puts 'Deleting older terraform plan ...'.colorize(:green)
-      puts "About to delete: #{@plan}"
-      FileUtils.rm_f @plan
-    end
-
-    def plan_destroy
-      delete_terraform_directory
-      delete_plan_file
-      install_terraform_modules
-      create_destroy_plan
-    end
-
-    def create_destroy_plan
-      command         = "terraform plan -destroy -module-depth=1 -out=#{@plan} -var-file=#{@varfile}"
-      failure_message = 'something went wrong when creating the TF plan'
-      execute_command(command, failure_message)
-    end
-
-    def install_terraform_modules
-      command         = 'terraform get -update=true'
-      failure_message = 'something went wrong when pulling remote TF modules'
-      execute_command(command, failure_message)
-    end
+    def invalid_environment_message
+      puts "\n'#{@environment}' is not a valid environment for the account: '#{@account}'.\n".colorize(:red)
+      puts "The 'account' and 'environment' values are calculated based on your current directory.\n".colorize(:red)
 
-    # S3 stuff
-
-    def s3_client
-      @s3_client ||= Aws::S3::Client.new(@aws_creds)
-    end
-
-    def s3_bucket_exists?(tfstate_bucket)
-      resp = s3_client.list_buckets
-      resp.buckets.each { |bucket| return true if bucket.name == tfstate_bucket }
-      false
-    end
-
-    def create_bucket(name)
-      begin
-        s3_client.create_bucket(bucket: name, acl: 'private')
-      rescue Aws::S3::Errors::BucketAlreadyExists
-        raise 'The S3 bucket must be globally unique. See https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html'.colorize(:red)
-      end
-    end
-
-    def enable_bucket_versioning(bucket_name)
-      puts 'Enabling versioning on the S3 bucket - http://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html'.colorize(:green)
-      s3_client.put_bucket_versioning(bucket:                   bucket_name,
-                                      versioning_configuration: {
-                                        mfa_delete: 'Disabled',
-                                        status:     'Enabled'
-                                      })
-    end
-
-    def put_empty_object_in_bucket(bucket_name, key_name)
-      puts "Putting an empty object with key: #{key_name} into bucket: #{bucket_name}".colorize(:green)
-      s3_client.put_object(
-        bucket: bucket_name,
-        key:    key_name,
-        body:   ''
-      )
-    end
-
-    def create_remote_state_bucket(tfstate_bucket, tfstate_s3_obj)
-      create_bucket tfstate_bucket
-      enable_bucket_versioning tfstate_bucket
-      put_empty_object_in_bucket(tfstate_bucket, tfstate_s3_obj)
-    end
-
-    def bootstrap_s3_state
-      if s3_bucket_exists?(@tfstate_bucket)
-        synchronise_s3_state
-      else
-        create_remote_state_bucket(@tfstate_bucket, @tfstate_s3_obj)
-      end
-    end
-
-    def synchronise_s3_state
-      puts 'Synchronising the remote S3 state...'
-      # not clear for me if the -state in the below command matters
-      command         = 'terraform remote config'\
-            ' -backend=S3'\
-            " -backend-config='bucket=#{@tfstate_bucket}' -backend-config='key=#{@tfstate_s3_obj}'"\
-            " -state=#{@state_file}"
-      failure_message = 'something went wrong when creating the S3 state'
-      execute_command(command, failure_message)
-    end
-
-    def synchronise_s3_state_setup
-      puts "Setting up the initial terraform S3 state in the S3 bucket: #{@tfstate_bucket.colorize(:green)} for account: #{@account.colorize(:green)} and environment: #{@environment.colorize(:green)} ..."
-      command         = 'terraform remote config'\
-          ' -backend=S3'\
-          " -backend-config='bucket=#{@tfstate_bucket}' -backend-config='key=#{@tfstate_s3_obj}'"
-      failure_message = 'something went wrong when creating the S3 state'
-      execute_command(command, failure_message)
-    end
-
-    def fetch_s3_state
-      command         = 'terraform remote config -backend=S3'\
-      " -backend-config='bucket=#{@tfstate_bucket}' -backend-config='key=#{@tfstate_s3_obj}'"
-      failure_message = 'something went wrong when fetching the S3 state'
-      execute_command(command, failure_message)
-    end
-
-    # --------------------------------------------------------------
-    # Misc.
-    # --------------------------------------------------------------
-
-    def execute_command(command, failure_message)
-      puts "About to execute command: #{command}"
-      success = system command
-      puts failure_message unless success
+      env = if account[-4..-1] == '-dev'
+              non_production_environments
+            else
+              production_environments
+            end
+      puts "Valid environments are: #{env}."
+      exit 1
     end
   end
 end

data/lib/dome/helpers/shell.rb

@@ -0,0 +1,9 @@
+module Dome
+  module Shell
+    def execute_command(command, failure_message)
+      puts "About to execute command: #{command}"
+      success = system command
+      puts failure_message unless success
+    end
+  end
+end

data/lib/dome/state.rb

@@ -0,0 +1,69 @@
+module Dome
+  class State
+    include Dome::Shell
+
+    def initialize(environment)
+      @environment  = environment
+      @state_bucket = "#{@environment.team}-tfstate-#{@environment.environment}"
+      @state_file   = "#{@environment.environment}-terraform.tfstate"
+    end
+
+    def s3_client
+      @s3_client ||= Aws::S3::Client.new(@environment.aws_credentials)
+    end
+
+    def s3_bucket_exists?(bucket_name)
+      resp = s3_client.list_buckets
+      resp.buckets.each { |bucket| return true if bucket.name == bucket_name }
+      false
+    end
+
+    def create_bucket(name)
+      begin
+        s3_client.create_bucket(bucket: name, acl: 'private')
+      rescue Aws::S3::Errors::BucketAlreadyExists
+        raise 'The S3 bucket must be globally unique. See https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html'.colorize(:red)
+      end
+    end
+
+    def enable_bucket_versioning(bucket_name)
+      puts 'Enabling versioning on the S3 bucket - http://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html'.colorize(:green)
+      s3_client.put_bucket_versioning(bucket:                   bucket_name,
+                                      versioning_configuration: {
+                                        mfa_delete: 'Disabled',
+                                        status:     'Enabled'
+                                      })
+    end
+
+    def put_empty_object_in_bucket(bucket_name, key_name)
+      puts "Putting an empty object with key: #{key_name} into bucket: #{bucket_name}".colorize(:green)
+      s3_client.put_object(
+        bucket: bucket_name,
+        key:    key_name,
+        body:   ''
+      )
+    end
+
+    def create_remote_state_bucket(state_bucket, state_file)
+      create_bucket state_bucket
+      enable_bucket_versioning state_bucket
+      put_empty_object_in_bucket(state_bucket, state_file)
+    end
+
+    def s3_state
+      if s3_bucket_exists?(@state_bucket)
+        synchronise_s3_state
+      else
+        create_remote_state_bucket(@state_bucket, @state_file)
+      end
+    end
+
+    def synchronise_s3_state
+      puts 'Synchronising the remote S3 state...'
+      command         = 'terraform remote config -backend=S3'\
+            " -backend-config='bucket=#{@state_bucket}' -backend-config='key=#{@state_file}'"
+      failure_message = 'Something went wrong when synchronising the S3 state.'
+      execute_command(command, failure_message)
+    end
+  end
+end

data/lib/dome/terraform.rb

@@ -0,0 +1,74 @@
+module Dome
+  class Terraform
+    include Dome::Shell
+
+    attr_reader :state
+
+    def initialize
+      @environment = Dome::Environment.new
+      @state       = Dome::State.new(@environment)
+      @plan_file   = "plans/#{@environment.account}-#{@environment.environment}-plan.tf"
+    end
+
+    def validate_environment
+      environment_name = @environment.environment
+      account_name     = @environment.account
+      @environment.invalid_account_message unless @environment.valid_account? account_name
+      @environment.invalid_environment_message unless @environment.valid_environment?(account_name, environment_name)
+      @environment.populate_aws_access_keys
+    end
+
+    def plan
+      delete_terraform_directory
+      delete_plan_file
+      install_terraform_modules
+      @state.synchronise_s3_state
+      create_plan
+    end
+
+    def plan_destroy
+      delete_terraform_directory
+      delete_plan_file
+      install_terraform_modules
+      @state.synchronise_s3_state
+      create_destroy_plan
+    end
+
+    def apply
+      command         = "terraform apply #{@plan_file}"
+      failure_message = 'something went wrong when applying the TF plan'
+      execute_command(command, failure_message)
+    end
+
+    def create_plan
+      command         = "terraform plan -module-depth=1 -refresh=true -out=#{@plan_file} -var-file=params/env.tfvars"
+      failure_message = 'something went wrong when creating the TF plan'
+      execute_command(command, failure_message)
+    end
+
+    def delete_terraform_directory
+      puts 'Deleting older terraform module cache dir ...'.colorize(:green)
+      terraform_directory = '.terraform'
+      puts "About to delete directory: #{terraform_directory}"
+      FileUtils.rm_rf '.terraform/'
+    end
+
+    def delete_plan_file
+      puts 'Deleting older terraform plan ...'.colorize(:green)
+      puts "About to delete: #{@plan_file}"
+      FileUtils.rm_f @plan_file
+    end
+
+    def create_destroy_plan
+      command         = "terraform plan -destroy -module-depth=1 -out=#{@plan_file} -var-file=params/env.tfvars"
+      failure_message = 'something went wrong when creating the TF plan'
+      execute_command(command, failure_message)
+    end
+
+    def install_terraform_modules
+      command         = 'terraform get -update=true'
+      failure_message = 'something went wrong when pulling remote TF modules'
+      execute_command(command, failure_message)
+    end
+  end
+end

data/lib/dome/version.rb

@@ -1,3 +1,3 @@
 module Dome
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: domed-city
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Ben Snape
@@ -141,6 +141,9 @@ files:
 - dome.gemspec
 - lib/dome.rb
 - lib/dome/environment.rb
+- lib/dome/helpers/shell.rb
+- lib/dome/state.rb
+- lib/dome/terraform.rb
 - lib/dome/version.rb
 homepage: https://github.com/ITV/dome
 licenses: []