domed-city 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed66b624e303da572cb9b8373540c31f87025733
-  data.tar.gz: 3c4439e4ede3d703dc60b0098e5cfabd0a6e5a4b
+  metadata.gz: 6cc7ecbabc62d32ad05359b3c283be1e67407ef8
+  data.tar.gz: 4468f74c45e4817503a079992fc27b69e019e88a
 SHA512:
-  metadata.gz: 90f0c2c2db637fd0946a507a8434990e37d44b6e6e103aa7eec7d89cd006a5647b4da252da6279eefab99132323b9b54fa1a5210ebe6416c37ac58f79649ab33
-  data.tar.gz: e9e87383b69a2e7bf938fb6ee3cac144e3219b8ab429e3b02e7625dd2295f06206dc482099e35e7fde51b377b3e4ef0cda76fdda072001f7342e2f6e1c2fe5d5
+  metadata.gz: b86362790fb01c9523938cbee392e3760a44498c58bdce70c0107566bdcf204ed033478dc89ebbce2e338a01e5322f9ece813c7617b1c8aaa7f56725066668c5
+  data.tar.gz: 5109c87e9fe98d85dfd30e08c5f3a016676d8ce6955162d6908316b78224735a211ea7fbc01327cdec436f8e086f4a001efb688247fe15913a9580c21b17f099

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 3.0.0
+
+Thanks to [@Russell-IO](https://github.com/Russell-IO) for helping with these changes.
+
+- Internal refactoring.
+- More tests added (but lots more needed).
+- Improved debug output and explained up front how variables are set.
+- Removed `aws_profile_parser` and used environment variables instead to unify
+the AWS CLI and terraform calls.
+
+ROADMAP:
+- Merge [@mhlias](https://github.com/mhlias) changes that implements assumed-role support.

data/CONTRIBUTORS.md

@@ -0,0 +1,6 @@
+- [Andrew Stangl](https://github.com/madandroid)
+- [Ben Snape](https://github.com/bsnape)
+- [Cameron Adams](https://github.com/cam-itv)
+- [Efstathios Xagoraris](https://github.com/xiii)
+- [Ilias Bertsimas](https://github.com/mhlias)
+- [Russell Clare](https://github.com/Russell-IO)

data/LICENSE

@@ -1,22 +1,7 @@
-The MIT License (MIT)
+Copyright 2016 ITV PLC, licensed under the ITV Open Source Software Licence, Version 1.0 (the “Licence"). You may not use any of the files in this repository except in compliance with the Licence”.
 
-Copyright (c) 2015 ITV
-
-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.
+You may not use this file except in compliance with the Licence. You may obtain a copy of the Licence at http://itv.com/itv-oss-licence-v1.0.
 
+Unless required by applicable law or as otherwise agreed in writing, software distributed under the Licence is distributed on an “as is” basis, without warranties or conditions of any kind, either express or implied, including without limitation,
+any warranties or conditions as to title, non-infringement, merchantability or fitness for a particular purpose.
+Please see the Licence for the specific language governing permissions and limitations under the Licence.

data/README.md

@@ -53,6 +53,3 @@ where [commands] are:
 ### NOTICE
 
 When used for the first time in an environment you need to run `dome -s` for domed-city to create the S3 bucket and and enable file versioning on it. If you run it after the bucket has been created, it will just sync the remote state, something planning already does by default.
-
-## Acknowledgment
-The initial release of `domed-city` is based on the original, and unpublished work, done by @stefancocora and @madAndroid for an internal project at itv.

data/dome.gemspec

@@ -6,8 +6,8 @@ require 'dome/version'
 Gem::Specification.new do |spec|
   spec.name          = 'domed-city'
   spec.version       = Dome::VERSION
-  spec.authors       = ['Ben Snape']
-  spec.email         = ['ben.snape@itv.com']
+  spec.authors       = ['ITV'] # see CONTRIBUTORS.md
+  spec.email         = ['common-platform-team-group@itv.com']
 
   spec.summary       = 'A simple Terraform API wrapper and helpers for ITV.'
   spec.homepage      = 'https://github.com/ITV/dome'
@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.37'
 
   spec.add_dependency 'trollop', '~> 2.1'
-  spec.add_dependency 'aws-profile_parser', '~> 0.0'
   spec.add_dependency 'aws-sdk', '~> 2.1'
   spec.add_dependency 'colorize', '~> 0.7'
 end

data/lib/dome.rb

@@ -1,7 +1,6 @@
 require 'trollop'
 require 'aws-sdk'
 require 'colorize'
-require 'aws/profile_parser'
 require 'fileutils'
 require 'yaml'
 

data/lib/dome/environment.rb

@@ -8,12 +8,12 @@ module Dome
       @settings    = Dome::Settings.new
     end
 
-    def team
+    def project
       @settings.parse['project']
     end
 
     def accounts
-      %W(#{team}-dev #{team}-prd)
+      %W(#{project}-dev #{project}-prd)
     end
 
     def environments
@@ -21,15 +21,12 @@ module Dome
     end
 
     def aws_credentials
-      @aws_credentials ||= AWS::ProfileParser.new.get(@account)
-    rescue RuntimeError
-      raise "No credentials found for account: '#{@account}'."
-    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]
+      puts "Setting environment variable #{'AWS_PROFILE'.colorize(:green)} to your "\
+        "'account' name: #{@account.colorize(:green)}"
+      ENV['AWS_PROFILE'] = @account
+      puts "Setting environment variable #{'AWS_DEFAULT_REGION'.colorize(:green)} "\
+        "to #{'eu-west-1'.colorize(:green)}"
+      ENV['AWS_DEFAULT_REGION'] = 'eu-west-1' # should we let people override this? doubtful
     end
 
     def valid_account?(account_name)
@@ -60,7 +57,7 @@ module Dome
     # rubocop:disable Metrics/AbcSize
     def generic_error_message
       puts "The 'account' and 'environment' variables are assigned based on your current directory.\n".colorize(:red)
-      puts "The expected directory structure is '.../<account>/<environment>'\n".colorize(:red)
+      puts "The expected directory structure is 'terraform/<account>/<environment>'\n".colorize(:red)
       puts '============================================================================='
       puts "Valid environments are defined using the 'environments' key in your itv.yaml."
       puts "The environments you have defined are: #{environments}."

data/lib/dome/helpers/shell.rb

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

data/lib/dome/state.rb

@@ -6,22 +6,30 @@ module Dome
       @environment = environment
     end
 
-    def state_bucket
-      "#{@environment.team}-tfstate-#{@environment.environment}"
+    def state_bucket_name
+      "#{@environment.project}-tfstate-#{@environment.environment}"
     end
 
-    def state_file
+    def state_file_name
       "#{@environment.environment}-terraform.tfstate"
     end
 
     def s3_client
-      @s3_client ||= Aws::S3::Client.new(@environment.aws_credentials)
+      @s3_client ||= Aws::S3::Client.new
+    end
+
+    def list_buckets
+      s3_client.list_buckets
+    end
+
+    def bucket_names
+      bucket_names = list_buckets.buckets.map(&:name)
+      puts "Found the following buckets: #{bucket_names}".colorize(:yellow)
+      bucket_names
     end
 
     def s3_bucket_exists?(bucket_name)
-      resp = s3_client.list_buckets
-      resp.buckets.each { |bucket| return true if bucket.name == bucket_name }
-      false
+      bucket_names.find { |bucket| bucket == bucket_name }
     end
 
     def create_bucket(name)
@@ -48,24 +56,24 @@ module Dome
       )
     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)
+    def create_remote_state_bucket(bucket_name, state_file)
+      create_bucket bucket_name
+      enable_bucket_versioning bucket_name
+      put_empty_object_in_bucket(bucket_name, state_file)
     end
 
     def s3_state
-      if s3_bucket_exists?(state_bucket)
-        synchronise_s3_state
+      if s3_bucket_exists?(state_bucket_name)
+        synchronise_s3_state(state_bucket_name, state_file_name)
       else
-        create_remote_state_bucket(state_bucket, state_file)
+        create_remote_state_bucket(state_bucket_name, state_file_name)
       end
     end
 
-    def synchronise_s3_state
+    def synchronise_s3_state(bucket_name, state_file_name)
       puts 'Synchronising the remote S3 state...'
       command         = 'terraform remote config -backend=S3'\
-            " -backend-config='bucket=#{state_bucket}' -backend-config='key=#{state_file}'"
+            " -backend-config='bucket=#{bucket_name}' -backend-config='key=#{state_file_name}'"
       failure_message = 'Something went wrong when synchronising the S3 state.'
       execute_command(command, failure_message)
     end

data/lib/dome/terraform.rb

@@ -10,21 +10,36 @@ module Dome
       @plan_file   = "plans/#{@environment.account}-#{@environment.environment}-plan.tf"
     end
 
+    # TODO: this method is a bit of a mess and needs looking at
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def validate_environment
+      puts 'Initialising domed-city...'
+      puts "* Your 'account' and 'environment' are assigned based on your current directory. "\
+          "The expected directory structure is 'terraform/<account>/<environment>'".colorize(:yellow)
+      puts "* Your 'project' is defined using the 'project' key in your 'itv.yaml'.".colorize(:yellow)
+      puts "* Valid environments are defined using the 'environments' key in your 'itv.yaml'. "\
+        "You have defined: #{@environment.environments}".colorize(:yellow)
+      puts '* Valid accounts are of the format <project>-dev and <project>-prd and are calculated '\
+        "automatically using your 'project' variable.".colorize(:yellow)
+
+      puts "\nDebug output:\n------------"
       environment = @environment.environment
       account     = @environment.account
       @environment.invalid_account_message unless @environment.valid_account? account
       @environment.invalid_environment_message unless @environment.valid_environment? environment
-      puts "Team: #{@environment.team.colorize(:green)}"
+      puts "Project: #{@environment.project.colorize(:green)}"
+      puts "State S3 bucket name: #{@state.state_bucket_name.colorize(:green)}"
+      puts "State file name: #{@state.state_file_name.colorize(:green)}"
+      @environment.aws_credentials
       puts '----------------------------------------------------------------'
-      @environment.populate_aws_access_keys
     end
 
     def plan
       delete_terraform_directory
       delete_plan_file
       install_terraform_modules
-      @state.synchronise_s3_state
+      @state.synchronise_s3_state(@state.state_bucket_name, @state.state_file_name)
       create_plan
     end
 

data/lib/dome/version.rb

@@ -1,3 +1,3 @@
 module Dome
-  VERSION = '2.0.0'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domed-city
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
-- Ben Snape
+- ITV
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: aws-profile_parser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +110,7 @@ dependencies:
         version: '0.7'
 description: 
 email:
-- ben.snape@itv.com
+- common-platform-team-group@itv.com
 executables:
 - dome
 extensions: []
@@ -134,6 +120,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTORS.md
 - Gemfile
 - LICENSE
 - README.md
@@ -166,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: A simple Terraform API wrapper and helpers for ITV.