terragov 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8eeeed1f01e2992de5ea9148713142c55d55a4ed
-  data.tar.gz: 7f226cfef4d9be1f52c84395a80dbcf30ebf4038
+  metadata.gz: 852f92a97a49b1ed2bab8f9636c6633df8622915
+  data.tar.gz: 15f60c7f8b84f9c3983c01acf67ee27cfa1e85f0
 SHA512:
-  metadata.gz: 52f00a1308725247148750c67bab42f4daef588c7e0d6e8716420403734d56deb8cd0eff66166162cb5fd874fe60458f02780953e65a9f10d0edb69ea5abaa09
-  data.tar.gz: 9dc2c6a7cf98f0bb0b15c5f8a53f7900bd3541bfbbc85a04ea727ca650cb712b57f5de65412a835c0f2e4b1868d61f55e27ca438f5b162ed0ad1cfe97e01adcf
+  metadata.gz: 3e13c77232c52712968e1d39a972f0c7f85459cf9aa0ccf2460604b51968c08fc889643d2de6ff79ede4b5571ca997f8527d6d30f0ac615d04aa68e5ee443278
+  data.tar.gz: 586525da558af934a8f455dce68cce8032e84293abacd21382757674aa61e24261c46bf1c38a57573e588add6ac5ab2c0d4407e0f2f496f78686e38e176c1b61

data/README.md

@@ -1,6 +1,8 @@
 # Terragov
 
-![Cockney deployments](https://github.com/surminus/terragov/blob/master/bricktop.jpg "Cockney deployments")
+[![Build Status](https://travis-ci.org/surminus/terragov.svg?branch=master)](https://travis-ci.org/surminus/terragov) [![Gem Version](https://badge.fury.io/rb/terragov.svg)](https://badge.fury.io/rb/terragov) [![Coverage Status](https://coveralls.io/repos/github/surminus/terragov/badge.svg?branch=master)](https://coveralls.io/github/surminus/terragov?branch=master)
+
+![Terragov](https://github.com/surminus/terragov/blob/master/bricktop.jpg "Terrible pun, guv")
 
 GOV.UK use [Terraform](https://terraform.io) to deploy infrastructure. Originally a lightweight bash script was built to support our opinionated Terraform project structure, but it quickly added further functionality and I decided it would be nicer to use a tool written in a more complete language.
 
@@ -18,7 +20,7 @@ This tool is only meant to be used specifically against the project structure [d
 
 Run `--help` for details.
 
-There are several arguments to pass when running `apply`, `plan` or `destroy`:
+There are several **required** arguments to pass when running `apply`, `plan` or `destroy`:
 
 Argument | Description
 --- | ---
@@ -38,7 +40,7 @@ Use command line flags to pass the relevant argument. This has **highest** prece
 
 ### Environment variables
 
-Every command has an environment variable which can also be set. This has second **highest** precedence. The value is the name, in upper case, and prefixed with `TERRAGOV`. For example, to set `environment`:
+Every command has an environment variable which can also be set. This has **second highest** precedence. The value is the name, in upper case, and prefixed with `TERRAGOV`. For example, to set `environment`:
 
 `export TERRAGOV_ENVIRONMENT=integration`
 
@@ -58,6 +60,16 @@ repo_dir: '~/govuk/govuk-aws'
 data_dir: '~/govuk/govuk-aws-data/data'
 ```
 
+## Optional global arguments
+
+These may be set in the same way as described above, with the same precedence, but they are not required.
+
+Argument | Description
+--- | ---
+`verbose` | Be more noisy
+`dryrun` | CLI option is `--dry-run`, but config file and env var is `dryrun` and `TERRAGOV_DRYRUN` respectively
+`skip_git_check` | Do not compare branches between the repo and data directories
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/terragov/cli.rb

@@ -1,9 +1,11 @@
 require 'commander'
 require 'yaml'
+require 'highline'
 require_relative 'buildpaths'
 require_relative 'terraform'
 require_relative 'cleaner'
 require_relative 'version'
+require_relative 'git'
 
 module Terragov
   class Cli
@@ -14,11 +16,11 @@ module Terragov
       program :version, Terragov::VERSION
       program :description, 'Wrapper for GOV.UK Terraform deployments.'
 
-      global_option('-c', "--config-file FILE", 'Specify a config file. Has less precedence than environment variables, which in turn have left precedence than CLI options') do |config_file|
+      global_option('-c', "--config-file FILE", 'Specify a config file. Has less precedence than environment variables, which in turn have less precedence than CLI options') do |config_file|
         $config_file = config_file
       end
 
-      global_option('-d', "--data-dir DIRECTORY", 'Location of the data directory') do |data_dir|
+      global_option('-d', "--data-dir DIRECTORY", String, 'Location of the data directory') do |data_dir|
         $data_dir = data_dir
       end
 
@@ -42,14 +44,17 @@ module Terragov
         $extra = extra
       end
 
-      global_option('--verbose', String, 'Verbose mode') do |verbose|
+      global_option('--verbose', 'Verbose mode') do |verbose|
         $verbose = verbose
       end
 
-      global_option('--dry-run', String, 'Verbose mode', 'Output the commands to run, but do not run them') do |dryrun|
+      global_option('--dry-run', 'Dry run mode', 'Output the commands to run, but do not run them') do |dryrun|
         $dryrun = dryrun
       end
 
+      global_option('--skip-git-check', 'Skip git check', 'Do not check the status of git repositories') do |skip_git_check|
+        $skip_git_check = skip_git_check
+      end
     end
 
     def data_dir
@@ -76,6 +81,18 @@ module Terragov
       return $extra if $extra
     end
 
+    def verbose
+      return true ? $verbose : false
+    end
+
+    def dryrun
+      return true ? $dryrun : false
+    end
+
+    def skip_git_check
+      return true ? $skip_git_check : false
+    end
+
     def load_config_file
       if $config_file || ENV['TERRAGOV_CONFIG_FILE']
         file = $config_file || ENV['TERRAGOV_CONFIG_FILE']
@@ -84,10 +101,9 @@ module Terragov
       end
     end
 
-    def config(option, file=false)
+    def config(option, file=false, required=true)
       env_var = "TERRAGOV_#{option.upcase}"
       error_message = "Must set #{option}. Use --help for details."
-      #require 'pry'; binding.pry
       if public_send(option)
         if file
           return File.expand_path(public_send(option))
@@ -108,10 +124,18 @@ module Terragov
             return load_config_file[option]
           end
         else
-          abort(error_message)
+          if required
+            abort(error_message)
+          else
+            return false
+          end
         end
       else
-        abort(error_message)
+        if required
+          abort(error_message)
+        else
+          return false
+        end
       end
     end
 
@@ -127,15 +151,56 @@ module Terragov
       return cmd_options_hash
     end
 
+    def git_compare_repo_and_data(skip=false)
+      git_helper = Terragov::Git.new
+      # FIXME this is confusing as we want to check the repository git status from
+      # the root, but the "data" directory is one level down in the repository
+      repo_dir_root = cmd_options['repo_dir']
+      data_dir_root = File.expand_path(File.join(cmd_options['data_dir'], '../'))
+
+      repo_dir_branch = git_helper.branch_name(repo_dir_root)
+      data_dir_branch = git_helper.branch_name(data_dir_root)
+
+      branches = {
+        "repo_dir" => repo_dir_branch,
+        "data_dir" => data_dir_branch,
+      }
+
+      unless skip
+        branches.each do |name, branch|
+          unless branch =~ /^master$/
+            exit unless HighLine.agree("#{name} not on 'master' branch, continue on branch '#{branch}'?")
+          end
+        end
+
+        unless git_helper.compare_branch(repo_dir_root, data_dir_root)
+          puts "Warning: repo_dir(#{repo_dir_branch}) and data_dir(#{data_dir_branch}) on different branches"
+          exit unless HighLine.agree("Do you wish to continue?")
+        end
+      end
+    end
+
     def run_terraform_cmd(cmd, opt = nil)
       paths = Terragov::BuildPaths.new.base(cmd_options)
       varfiles = Terragov::BuildPaths.new.build_command(cmd_options)
       backend  = paths[:backend_file]
       project_dir = paths[:project_dir]
+
+      be_verbose = config('verbose', false, false)
+
+      do_dryrun = config('dryrun', false, false)
+
+      skip_check =  config('skip_git_check', false, false)
+      git_compare_repo_and_data(skip_check)
+
+      if be_verbose
+        puts cmd_options.to_yaml
+      end
+
       if opt
         cmd = "#{cmd} #{opt}"
       end
-      Terragov::Terraform.new.execute(cmd, varfiles, backend, project_dir)
+      Terragov::Terraform.new.execute(cmd, varfiles, backend, project_dir, do_dryrun, be_verbose)
     end
 
     def run
@@ -143,15 +208,6 @@ module Terragov
         c.syntax = 'terragov plan'
         c.description = 'Runs a plan of your code'
         c.action do |args, options|
-          if options.verbose
-            ENV['TERRAGOV_VERBOSE'] = "true"
-            puts "Planning..."
-            puts cmd_options.to_yaml
-          end
-
-          if options.dry_run
-            ENV['TERRAGOV_DRYRUN'] = "true"
-          end
 
           run_terraform_cmd(c.name)
         end
@@ -161,15 +217,6 @@ module Terragov
         c.syntax = 'terragov apply'
         c.description = 'Apply your code'
         c.action do |args, options|
-          if options.verbose
-            ENV['TERRAGOV_VERBOSE'] = "true"
-            puts "Applying..."
-            puts cmd_options.to_yaml
-          end
-
-          if options.dry_run
-            ENV['TERRAGOV_DRYRUN'] = "true"
-          end
 
           run_terraform_cmd(c.name)
         end
@@ -180,16 +227,6 @@ module Terragov
         c.description = 'Destroy your selected project'
         c.option '--force', 'Force destroy'
         c.action do |args, options|
-          if options.verbose
-            ENV['TERRAGOV_VERBOSE'] = "true"
-            puts "Destroying..."
-            puts cmd_options.to_yaml
-          end
-
-          if options.dry_run
-            ENV['TERRAGOV_DRYRUN'] = "true"
-          end
-
           if options.force
             run_terraform_cmd("#{c.name} -force")
           else
@@ -203,7 +240,7 @@ module Terragov
         c.description = 'Clean your directory of any files terraform may have left lying around'
         c.option '--force', 'Force removal of files'
         c.action do |args, options|
-          if options.verbose
+          if config('verbose', false, false)
             puts "Selecting directory #{repo_dir}"
           end
 

data/lib/terragov/git.rb

@@ -0,0 +1,25 @@
+require 'git'
+require 'highline'
+
+module Terragov
+  class Git
+    def branch_name(directory)
+      unless File.exist?(File.join(directory, '.git'))
+        exit unless HighLine.agree("#{directory} not a git repository, do you wish to continue?")
+      end
+
+      branch =  ::Git.open(directory).current_branch
+
+      return branch
+    end
+
+    def compare_branch(dir_a, dir_b)
+      if branch_name(dir_a) == branch_name(dir_b)
+        return true
+      else
+        return false
+      end
+    end
+
+  end
+end

data/lib/terragov/terraform.rb

@@ -11,7 +11,7 @@ module Terragov
       end
     end
 
-    def execute(command, vars, backend, directory)
+    def execute(command, vars, backend, directory, dryrun=false, verbose=false)
       package_check
 
       if command == 'init'
@@ -20,24 +20,24 @@ module Terragov
       end
 
       Dir.chdir directory
-      init(backend)
+      init(backend, dryrun, verbose)
 
       full_command = "bash -c 'terraform #{command} #{vars}'"
 
-      if ENV['TERRAGOV_DRYRUN']
+      if dryrun
         puts full_command
       else
-        puts "#{command} command: #{full_command}" if ENV['TERRAGOV_VERBOSE']
+        puts "#{command} command: #{full_command}" if verbose
         abort("There was an issue running the command") unless system(full_command)
       end
     end
 
-    def init(backend_file)
+    def init(backend_file, dryrun=false, verbose=false)
       init_cmd = "terraform init -backend-config #{backend_file}"
-      if ENV['TERRAGOV_DRYRUN']
+      if dryrun
         puts init_cmd
       else
-        puts "init command: #{init_cmd}" if ENV['TERRAGOV_VERBOSE']
+        puts "init command: #{init_cmd}" if verbose
         abort("Issue running: terraform init -backend-config #{backend_file}") unless system(init_cmd)
       end
     end

data/lib/terragov/version.rb

@@ -1,3 +1,3 @@
 module Terragov
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/terragov.gemspec

@@ -23,9 +23,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "commander"
+  spec.add_runtime_dependency "git"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov", ">= 0.8.2"
+  spec.add_development_dependency 'coveralls', '>= 0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terragov
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Laura Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,8 +52,36 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +95,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: GOV.UK deploy infrastructure using Terraform. This is a wrapper to help
   deployments.
 email:
@@ -106,6 +148,7 @@ files:
 - lib/terragov/buildpaths.rb
 - lib/terragov/cleaner.rb
 - lib/terragov/cli.rb
+- lib/terragov/git.rb
 - lib/terragov/terraform.rb
 - lib/terragov/version.rb
 - terragov.gemspec
@@ -129,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Wrapper for GOV.UK Terraform deployments.