terrafile 0.1.1

data/spec/unit/installer_spec.rb

@@ -0,0 +1,157 @@
+require_relative '../spec_helper'
+
+module Terrafile
+  RSpec.describe Installer do
+    let(:yml) { '' }
+
+    before { allow(Kernel).to    receive(:puts)                 }
+    before { allow(YAML).to      receive(:safe_load)            }
+    before { allow(File).to      receive(:read).and_return(yml) }
+    before { allow(FileUtils).to receive(:makedirs)             }
+
+    describe 'initialisation' do
+      before { allow(Kernel).to receive(:exit) }
+
+      context 'when the expected Terrafile is found' do
+        before do
+          allow(File).to receive(:exist?)
+            .with(TERRAFILE_PATH).and_return(true)
+        end
+
+        it 'reads the file from the conventional location' do
+          Installer.new
+          expect(File).to have_received(:read).with(TERRAFILE_PATH)
+        end
+
+        it 'loads the read yml safely' do
+          Installer.new
+          expect(YAML).to have_received(:safe_load).with(yml)
+        end
+      end
+
+      context 'when the expected Terrafile is not found' do
+        before do
+          allow(Helper).to receive(:file_exists?)
+            .with(TERRAFILE_PATH).and_return(false)
+        end
+
+        it 'tells us that the file is missing' do
+          Installer.new
+          expect(Kernel).to have_received(:puts).with(/Terrafile does not exist/)
+        end
+
+        it 'does not attempt to read the file' do
+          Installer.new
+          expect(File).not_to have_received(:read)
+        end
+
+        it 'does not attempt to load the yml' do
+          Installer.new
+          expect(YAML).not_to have_received(:safe_load)
+        end
+      end
+    end
+
+    describe '#call' do
+      before do
+        allow(Helper).to receive(:file_exists?).with(TERRAFILE_PATH).and_return(true)
+        allow(Dir).to receive(:chdir).and_yield
+      end
+
+      describe 'creating the modules directory' do
+        before { allow(FileUtils).to receive(:makedirs) }
+        before { allow(YAML).to receive(:safe_load).and_return([]) }
+
+        context 'when the directory already exists' do
+          before do
+            allow(Helper).to receive(:dir_exists?)
+              .with(Installer::MODULES_PATH).and_return(true)
+          end
+
+          it 'does not attempt to make the directory' do
+            Installer.new.call
+            expect(FileUtils).not_to have_received(:makedirs)
+          end
+        end
+
+        context 'when the directory does NOT exist' do
+          before do
+            allow(Helper).to receive(:dir_exists?)
+              .with(Installer::MODULES_PATH).and_return(false)
+          end
+
+          it 'notifies us of its intention to make the directory' do
+            Installer.new.call
+            expect(Kernel).to have_received(:puts).with(/Creating .+ modules directory/)
+          end
+
+          it 'makes the directory' do
+            Installer.new.call
+            expect(FileUtils).to have_received(:makedirs).with(Installer::MODULES_PATH)
+          end
+        end
+      end
+
+      describe 'fetching the listed modules' do
+        let(:dependencies) do
+          [
+            instance_double(
+              Dependency,
+              name:     'terraform-aws-name1',
+              source:   'git@github.com:org1/repo1',
+              version:  '0.8.0',
+              fetch:    true,
+              checkout: true
+            ),
+            instance_double(
+              Dependency,
+              name:     'terraform-aws-name2',
+              source:   'git@github.com:org2/repo2',
+              version:  '004e5791',
+              fetch:    true,
+              checkout: true
+            ),
+          ]
+        end
+
+        before do
+          allow(Dependency).to receive(:build_from_terrafile).and_return(dependencies)
+        end
+        before { allow(Dir).to receive(:chdir).and_yield }
+        before { allow(Helper).to receive(:fetch) }
+        before { allow(Helper).to receive(:checkout) }
+
+        it 'notifies its intention to checkout the dependency' do
+          msg1 = 'Checking out 0.8.0 from git@github.com:org1/repo1'
+          msg2 = 'Checking out 004e5791 from git@github.com:org2/repo2'
+
+          Installer.new.call
+
+          expect(Kernel).to have_received(:puts).with(/#{msg1}/)
+          expect(Kernel).to have_received(:puts).with(/#{msg2}/)
+        end
+
+        it 'changes to the module installation directory' do
+          Installer.new.call
+          expect(Dir).to have_received(:chdir).with(Installer::MODULES_PATH)
+        end
+
+        describe 'for each dependency' do
+          it 'fetches the latest version of the dependency\'s code' do
+            Installer.new.call
+
+            expect(dependencies.first).to have_received(:fetch)
+            expect(dependencies.last).to  have_received(:fetch)
+          end
+
+          it 'checks out the latest version of the dependency\'s code' do
+            Installer.new.call
+
+            expect(dependencies.first).to have_received(:checkout)
+            expect(dependencies.last).to  have_received(:checkout)
+          end
+        end
+      end
+    end
+  end
+end

data/terrafile.gemspec

@@ -0,0 +1,48 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'terrafile/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'terrafile'
+  spec.version               = Terrafile::VERSION
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.5.1'
+  spec.authors               = ['dxw']
+  spec.email                 = ['systems@dxw.com']
+  spec.summary               = 'Installs the modules listed in Terrafile'
+  spec.description           = 'Terraform modules listed in Terrafile are installed in ' \
+                                 'vendor/terraform_modules'
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license               = 'MIT'
+  spec.post_install_message  = 'Thanks for installing terrafile.'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  spec.metadata['credit'] = 'Original code and rationale found at: ' \
+    'http://bensnape.com/2016/01/14/terraform-design-patterns-the-terrafile/'
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- spec/*`.split("\n")
+  spec.bindir        = 'bin'
+  spec.require_paths = ['lib']
+  spec.executables   = ['terrafile']
+
+  spec.add_development_dependency 'aruba',      '~> 0.14'
+  spec.add_development_dependency 'bundler',    '~> 1.17'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rake',       '~> 10.5'
+  spec.add_development_dependency 'rspec',      '~> 3.8'
+  spec.add_development_dependency 'rubocop',    '~> 0.58'
+  spec.add_development_dependency 'simplecov',  '~> 0.16'
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: terrafile
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- dxw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Terraform modules listed in Terrafile are installed in vendor/terraform_modules
+email:
+- systems@dxw.com
+executables:
+- terrafile
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- bin/terrafile
+- lib/terrafile.rb
+- lib/terrafile/dependency.rb
+- lib/terrafile/errors.rb
+- lib/terrafile/helper.rb
+- lib/terrafile/installer.rb
+- lib/terrafile/version.rb
+- spec/integration/runs_terrafile_executable_spec.rb
+- spec/spec_helper.rb
+- spec/terrafile_spec.rb
+- spec/unit/dependency_spec.rb
+- spec/unit/helper_spec.rb
+- spec/unit/installer_spec.rb
+- terrafile.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  credit: 'Original code and rationale found at: http://bensnape.com/2016/01/14/terraform-design-patterns-the-terrafile/'
+post_install_message: Thanks for installing terrafile.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Installs the modules listed in Terrafile
+test_files:
+- spec/integration/runs_terrafile_executable_spec.rb
+- spec/spec_helper.rb
+- spec/terrafile_spec.rb
+- spec/unit/dependency_spec.rb
+- spec/unit/helper_spec.rb
+- spec/unit/installer_spec.rb