terragov 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d3187ea6e2507304bac2bb4d38e0efc7d012247
-  data.tar.gz: 33d452899677a07ea2f72c77d2e861327f060a87
+  metadata.gz: 707493668e500d3df9dd3676a2a34a6076d2963b
+  data.tar.gz: 9d1ab18b21d0b14338d60bcda07926c57f1cf3f8
 SHA512:
-  metadata.gz: c6298dde09d8ca0292a442d3c182b7ac48f5568be61509fa62542a67aa39e9cd1c72ed7cdf192e2309fb0e380fe112bdd61f63a668c0f24660527f45adc19bd2
-  data.tar.gz: 67365897d0ffce2f81960b61a85a6807587be42ef816cacb0d2a5b91534f59416547370567d560e60308b4e030aee03df8f03707c3ee9b711d981ab57cd05507
+  metadata.gz: cdcdc9cd6184dc833f5ea4cd3920f6d8ef50532b331aa719b12a9e3695f7be90ac3a027e1eb9b7a4227522fb900a9f53d3e895a8d6314c95133ce7bf2cd891e7
+  data.tar.gz: db62d131106c5756c7f148d8ea7a36269d61ef6e6e716bdcead3e29f25e6fe9b28c7d168526adc0a81b88e99a5b5dc9bebdd4a5a1dcbae09788439050c88a042

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.2.4 (2017-10-15)
+
+ - Updated cleaner method to check for both ".terraform" and "terraform.tfstate.backup"
+ files, and not exit if they are not found.
+

data/README.md

@@ -20,6 +20,15 @@ This tool is only meant to be used specifically against the project structure [d
 
 Run `--help` for details.
 
+You can run the following commands:
+
+Command | Description
+--- | ---
+`plan` | Plan Terraform resources
+`apply` | Apply Terraform changes
+`delete` | Delete Terraform resources
+`clean` | Delete any files that have been left by Terraform
+
 There are several **required** arguments to pass when running `apply`, `plan` or `destroy`:
 
 Argument | Description

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "terragov"
+require 'bundler/setup'
+require 'terragov'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "terragov"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/terragov.rb

@@ -1,5 +1,6 @@
-require "terragov/version"
-require "terragov/buildpaths"
-require "terragov/cli"
-require "terragov/terraform"
-require "terragov/cleaner"
+require 'terragov/buildpaths'
+require 'terragov/cleaner'
+require 'terragov/cli'
+require 'terragov/git'
+require 'terragov/terraform'
+require 'terragov/version'

data/lib/terragov/buildpaths.rb

@@ -2,9 +2,7 @@ require_relative 'cli'
 
 module Terragov
   class BuildPaths
-
-    def base(options={})
-
+    def base(options = {})
       environment = options['environment']
       data_dir = options['data_dir']
       repo_dir = options['repo_dir']
@@ -13,51 +11,51 @@ module Terragov
       extra   = options['extra']
 
       # Construct variables
-      terraform_dir              = File.join(repo_dir, "terraform")
+      terraform_dir              = File.join(repo_dir, 'terraform')
       project_dir                = File.join(terraform_dir, "projects/#{project}")
       backend_file               = File.join(project_dir, "#{environment}.#{stack}.backend")
       common_data_dir            = File.join(data_dir, "common/#{environment}")
-      common_data                = File.join(common_data_dir, "common.tfvars")
+      common_data                = File.join(common_data_dir, 'common.tfvars')
       stack_common_data          = File.join(common_data_dir, "#{stack}.tfvars")
       project_data_dir           = File.join(data_dir, "#{project}/#{environment}")
-      common_project_data        = File.join(project_data_dir, "common.tfvars")
-      secret_common_project_data = File.join(project_data_dir, "common.secret.tfvars")
+      common_project_data        = File.join(project_data_dir, 'common.tfvars')
+      secret_common_project_data = File.join(project_data_dir, 'common.secret.tfvars')
       stack_project_data         = File.join(project_data_dir, "#{stack}.tfvars")
       secret_project_data        = File.join(project_data_dir, "#{stack}.secret.tfvars")
 
       # Return hash to enable testing
       data_paths = {
-        :terraform_dir              => terraform_dir,
-        :project_dir                => project_dir,
-        :backend_file               => backend_file,
-        :common_data_dir            => common_data_dir,
-        :common_data                => common_data,
-        :stack_common_data          => stack_common_data,
-        :project_data_dir           => project_data_dir,
-        :common_project_data        => common_project_data,
-        :secret_common_project_data => secret_common_project_data,
-        :stack_project_data         => stack_project_data,
-        :secret_project_data        => secret_project_data,
+        terraform_dir: terraform_dir,
+        project_dir: project_dir,
+        backend_file: backend_file,
+        common_data_dir: common_data_dir,
+        common_data: common_data,
+        stack_common_data: stack_common_data,
+        project_data_dir: project_data_dir,
+        common_project_data: common_project_data,
+        secret_common_project_data: secret_common_project_data,
+        stack_project_data: stack_project_data,
+        secret_project_data: secret_project_data
       }
     end
 
     def data_validation(path, required = false)
       if required
         if File.exist?(path)
-          return true
+          true
         else
           abort("Invalid directory or file: #{path}")
         end
       else
         if File.exist?(path)
-          return true
+          true
         else
-          return false
+          false
         end
       end
     end
 
-    def data_paths(options={})
+    def data_paths(options = {})
       # The path order is important for passing the var files in the correct
       # order to Terraform as that creates the hierarchy for overrides
       base = self.base(options)
@@ -67,7 +65,7 @@ module Terragov
         base[:common_project_data],
         base[:secret_common_project_data],
         base[:stack_project_data],
-        base[:secret_project_data],
+        base[:secret_project_data]
       ]
     end
 
@@ -77,20 +75,20 @@ module Terragov
         $path_array << data_validation(path)
       end
 
-      unless $path_array.include? true
-        puts "Files checked: "
+      if $path_array.include? true
+        return true
+      else
+        puts 'Files checked: '
         paths.each do |path|
           puts path
         end
         return false
-      else
-        return true
       end
     end
 
-    def build_command(options={})
-      paths = self.base(options)
-      abort("Cannot find main repository") unless data_validation(paths[:terraform_dir], true)
+    def build_command(options = {})
+      paths = base(options)
+      abort('Cannot find main repository') unless data_validation(paths[:terraform_dir], true)
       var_paths = data_paths(options)
       abort("Can't find any var files") unless check_var_files(var_paths)
 
@@ -107,9 +105,9 @@ module Terragov
       end
       # If defining additional Terraform commands, they need to be passed in as one string,
       # with any hyphens escaped twice so it does not conflict with commander CLI options
-      extra = options["extra"].to_s
-      $full_vars << extra.gsub('\\', '')
-      return $full_vars.join(" ")
+      extra = options['extra'].to_s
+      $full_vars << extra.delete('\\')
+      $full_vars.join(' ')
     end
   end
 end

data/lib/terragov/cleaner.rb

@@ -3,28 +3,32 @@ require 'highline'
 
 module Terragov
   class Cleaner
-    def delete(path, pattern, force=false)
-      files = Find.find(path).grep(pattern)
+    def delete(path, patterns = [], force = false)
+      patterns.each do |pattern|
+        puts path
 
-      if files.empty?
-        puts "No files found matching #{pattern} in #{path}"
-        exit
-      end
+        files = Find.find(path).grep(pattern)
 
-      puts "Files matching #{pattern} found:"
+        if files.empty?
+          puts "No files found matching #{pattern} in #{path}"
+          next
+        end
 
-      files.each do |file|
-        puts File.expand_path(file)
-      end
+        puts "Files matching #{pattern} found:"
 
-      unless force
-        exit unless HighLine.agree('Do you wish to delete?')
-      end
+        files.each do |file|
+          puts File.expand_path(file)
+        end
+
+        unless force
+          next unless HighLine.agree('Do you wish to delete?')
+        end
 
-      files.each do |file|
-        File.delete(File.expand_path(file))
+        files.each do |file|
+          File.delete(File.expand_path(file))
+        end
+        puts 'Done'
       end
-      puts "Done"
     end
   end
 end

data/lib/terragov/cli.rb

@@ -16,27 +16,27 @@ 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 less 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", String, '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
 
-      global_option( '-e', '--environment STRING', String, 'Select environment') do |environment|
+      global_option('-e', '--environment STRING', String, 'Select environment') do |environment|
         $environment = environment
       end
 
-      global_option(  '-p', '--project STRING', String, 'Name of the project') do |project|
+      global_option('-p', '--project STRING', String, 'Name of the project') do |project|
         $project = project
       end
 
-      global_option( '-r', '--repo-dir DIRECTORY', String, 'Location of the main terraform repository') do |repo_dir|
+      global_option('-r', '--repo-dir DIRECTORY', String, 'Location of the main terraform repository') do |repo_dir|
         $repo_dir = repo_dir
       end
 
-      global_option( '-s', '--stack STRING', String, 'Name of the stack') do |stack|
+      global_option('-s', '--stack STRING', String, 'Name of the stack') do |stack|
         $stack = stack
       end
 
@@ -58,23 +58,23 @@ module Terragov
     end
 
     def data_dir
-      return $data_dir ? $data_dir : false
+      $data_dir ? $data_dir : false
     end
 
     def environment
-      return $environment ? $environment : false
+      $environment ? $environment : false
     end
 
     def project
-      return $project ? $project : false
+      $project ? $project : false
     end
 
     def repo_dir
-      return $repo_dir ? $repo_dir : false
+      $repo_dir ? $repo_dir : false
     end
 
     def stack
-      return $stack ? $stack : false
+      $stack ? $stack : false
     end
 
     def extra
@@ -82,26 +82,26 @@ module Terragov
     end
 
     def verbose
-      return true ? $verbose : false
+      true ? $verbose : false
     end
 
     def dryrun
-      return true ? $dryrun : false
+      true ? $dryrun : false
     end
 
     def skip_git_check
-      return true ? $skip_git_check : false
+      true ? $skip_git_check : false
     end
 
     def load_config_file
       if $config_file || ENV['TERRAGOV_CONFIG_FILE']
         file = $config_file || ENV['TERRAGOV_CONFIG_FILE']
         $values = YAML.load_file(File.expand_path(file))
-        return $values
+        $values
       end
     end
 
-    def config(option, file=false, required=true)
+    def config(option, file = false, required = true)
       env_var = "TERRAGOV_#{option.upcase}"
       error_message = "Must set #{option}. Use --help for details."
       if public_send(option)
@@ -117,18 +117,18 @@ module Terragov
           return ENV[env_var]
         end
       elsif !load_config_file.nil?
-        unless load_config_file[option].nil?
-          if file
-            return File.expand_path(load_config_file[option])
-          else
-            return load_config_file[option]
-          end
-        else
+        if load_config_file[option].nil?
           if required
             abort(error_message)
           else
             return false
           end
+        else
+          if file
+            return File.expand_path(load_config_file[option])
+          else
+            return load_config_file[option]
+          end
         end
       else
         if required
@@ -141,19 +141,19 @@ module Terragov
 
     def cmd_options
       cmd_options_hash = {
-        "environment" => config('environment'),
-        "data_dir"    => config('data_dir', true),
-        "project"     => config('project'),
-        "stack"       => config('stack'),
-        "repo_dir"    => config('repo_dir', true),
-        "extra"       => extra,
+        'environment' => config('environment'),
+        'data_dir'    => config('data_dir', true),
+        'project'     => config('project'),
+        'stack'       => config('stack'),
+        'repo_dir'    => config('repo_dir', true),
+        'extra'       => extra
       }
-      return cmd_options_hash
+      cmd_options_hash
     end
 
-    def git_compare_repo_and_data(skip=false)
+    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
+      # 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'], '../'))
@@ -162,8 +162,8 @@ module Terragov
       data_dir_branch = git_helper.branch_name(data_dir_root)
 
       branches = {
-        "repo_dir" => repo_dir_branch,
-        "data_dir" => data_dir_branch,
+        'repo_dir' => repo_dir_branch,
+        'data_dir' => data_dir_branch
       }
 
       unless skip
@@ -175,7 +175,7 @@ module Terragov
 
         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?")
+          exit unless HighLine.agree('Do you wish to continue?')
         end
       end
     end
@@ -190,16 +190,12 @@ module Terragov
 
       do_dryrun = config('dryrun', false, false)
 
-      skip_check =  config('skip_git_check', 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
+      puts cmd_options.to_yaml if be_verbose
 
-      if opt
-        cmd = "#{cmd} #{opt}"
-      end
+      cmd = "#{cmd} #{opt}" if opt
       Terragov::Terraform.new.execute(cmd, varfiles, backend, project_dir, do_dryrun, be_verbose)
     end
 
@@ -207,8 +203,7 @@ module Terragov
       command :plan do |c|
         c.syntax = 'terragov plan'
         c.description = 'Runs a plan of your code'
-        c.action do |args, options|
-
+        c.action do |_args, _options|
           run_terraform_cmd(c.name)
         end
       end
@@ -216,8 +211,7 @@ module Terragov
       command :apply do |c|
         c.syntax = 'terragov apply'
         c.description = 'Apply your code'
-        c.action do |args, options|
-
+        c.action do |_args, _options|
           run_terraform_cmd(c.name)
         end
       end
@@ -226,7 +220,7 @@ module Terragov
         c.syntax = 'terragov destroy'
         c.description = 'Destroy your selected project'
         c.option '--force', 'Force destroy'
-        c.action do |args, options|
+        c.action do |_args, options|
           if options.force
             run_terraform_cmd("#{c.name} -force")
           else
@@ -239,12 +233,19 @@ module Terragov
         c.syntax = 'terragov clean'
         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|
+        c.action do |_args, options|
           if config('verbose', false, false)
             puts "Selecting directory #{repo_dir}"
           end
 
-          Terragov::Cleaner.new.delete(repo_dir, /terraform\.tfstate\.backup/, options.force)
+          files_to_delete = [
+            /\.terraform/,
+            /terraform\.tfstate\.backup/,
+          ]
+
+          path = config('repo_dir', true)
+
+          Terragov::Cleaner.new.delete(path, files_to_delete, options.force)
         end
       end
 

data/lib/terragov/git.rb

@@ -8,18 +8,13 @@ module Terragov
         exit unless HighLine.agree("#{directory} not a git repository, do you wish to continue?")
       end
 
-      branch =  ::Git.open(directory).current_branch
+      branch = ::Git.open(directory).current_branch
 
-      return branch
+      branch
     end
 
     def compare_branch(dir_a, dir_b)
-      if branch_name(dir_a) == branch_name(dir_b)
-        return true
-      else
-        return false
-      end
+      branch_name(dir_a) == branch_name(dir_b)
     end
-
   end
 end

data/lib/terragov/terraform.rb

@@ -1,19 +1,18 @@
 module Terragov
   class Terraform
-
     def package_check(package)
       unless system("which #{package} >/dev/null")
         abort("Must install #{package}") unless HighLine.agree("Can't find #{package}. Install using Homebrew?")
-        if system("which brew >/dev/null")
+        if system('which brew >/dev/null')
           system("brew install #{package}")
         else
-          abort("Error: cannot find brew")
+          abort('Error: cannot find brew')
         end
       end
     end
 
-    def execute(command, vars, backend, directory, dryrun=false, verbose=false)
-      packages = [ 'terraform', 'sops' ]
+    def execute(command, vars, backend, directory, dryrun = false, verbose = false)
+      packages = %w[terraform sops]
 
       packages.each do |pkg|
         package_check(pkg)
@@ -29,23 +28,21 @@ module Terragov
 
       full_command = "bash -c 'terraform #{command} #{vars}'"
 
-      if dryrun
-        puts full_command
-      else
-        puts "#{command} command: #{full_command}" if verbose
-        abort("There was an issue running the command") unless system(full_command)
-      end
+      run(full_command, dryrun, verbose)
     end
 
-    def init(backend_file, dryrun=false, verbose=false)
+    def init(backend_file, dryrun = false, verbose = false)
       init_cmd = "terraform init -backend-config #{backend_file}"
+      run(init_cmd, dryrun, verbose)
+    end
+
+    def run(command, dryrun = false, verbose = false)
       if dryrun
-        puts init_cmd
+        puts command
       else
-        puts "init command: #{init_cmd}" if verbose
-        abort("Issue running: terraform init -backend-config #{backend_file}") unless system(init_cmd)
+        puts command if verbose
+        abort("There was an issue running the command: #{command}") unless system(full_command)
       end
     end
-
   end
 end

data/lib/terragov/version.rb

@@ -1,3 +1,3 @@
 module Terragov
-  VERSION = "0.2.3"
+  VERSION = '0.2.4'.freeze
 end

data/terragov.gemspec

@@ -1,34 +1,36 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'terragov/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "terragov"
+  spec.name          = 'terragov'
   spec.version       = Terragov::VERSION
-  spec.authors       = ["Laura Martin"]
-  spec.email         = ["surminus@gmail.com"]
+  spec.authors       = ['Laura Martin']
+  spec.email         = ['surminus@gmail.com']
 
-  spec.summary       = "Wrapper for GOV.UK Terraform deployments."
-  spec.description   = "GOV.UK deploy infrastructure using Terraform. This is a wrapper to help deployments."
-  spec.homepage      = "https://github.com/surminus/terragov"
-  spec.license       = "MIT"
+  spec.summary       = 'Wrapper for GOV.UK Terraform deployments.'
+  spec.description   = 'GOV.UK deploy infrastructure using Terraform. This is a wrapper to help deployments.'
+  spec.homepage      = 'https://github.com/surminus/terragov'
+  spec.license       = 'MIT'
 
   spec.required_ruby_version = '>= 2.2.2'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.executables   = ['terragov']
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "commander"
-  spec.add_runtime_dependency "git"
+  spec.add_runtime_dependency 'commander'
+  spec.add_runtime_dependency 'git'
 
-  spec.add_development_dependency "bundler"
-  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 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rubocop'
+  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.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Laura Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-23 00:00:00.000000000 Z
+date: 2017-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +162,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -172,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Wrapper for GOV.UK Terraform deployments.