rspec-terraspace 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8e1b5f17a60183d80868b81010f3afa769afa017639895276a4b1afd0ebe9cf
-  data.tar.gz: 44feb0924a0d0a02e1c8e0c6d25bffcdbcdbea47e2b0ffb4acfc34db8e0200de
+  metadata.gz: 86b718772c65d61edfd892aab57116ec4414f6302162d59c7369090a2864cd50
+  data.tar.gz: d27b219c170bd11a122d71ca07f6d06b3f10a3056524f23a4a9a55104b3c8b48
 SHA512:
-  metadata.gz: e2172c1a7f4c5655094a42fa5ce0d36489677c7b92618dcdda9b97318a2dbb1ad3173f54b0d73373edd08cb55223b1bd078b0edf0fc274bcd8128f37e097ba5b
-  data.tar.gz: 92597f1143ddcc9e4202b240ca089a2d5357665fcc66e038270f6cad0bdc47fdae85b81942e404772e877af6910f1de4fd857083f04391d4d3c003279777ba7e
+  metadata.gz: 7cf1300e159a1bd5be2c0ad59236e889b426a83f955829be294b504981290e3da22a5af83835f8bc5b6dafb780e8350835b4acda49a3aa6f349d50a92b1d8002
+  data.tar.gz: cd0486c714961d6e4d34e577e2c60b313dcae8112e59affead2a1228588eaf517d5137acbe2cbae9952ded6c9624e0c925fc4f1c221f681ea7c3a91cb5989893

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [0.3.1] - 2021-12-29
+- [#8](https://github.com/boltops-tools/rspec-terraspace/pull/8) provider autodetection
+
+## [0.3.0] - 2021-07-26
+- [#5](https://github.com/boltops-tools/rspec-terraspace/pull/5) Improvements
+- detect module or stack type so module specs can be written
+- better organize internal ts helper methods to concerns
+- improve config folder copy so it overwrites existing files instead of blowing away folder
+- improve starter boilerplate templates
+- clean up reconfigure logging and auto call it
+
+## [0.2.3] - 2021-05-31
+- [#4](https://github.com/boltops-tools/rspec-terraspace/pull/4) fix module test generator
+
+## [0.2.2] - 2020-11-17
+- fix outputs helper and templates
+
 ## [0.2.1] - 2020-11-16
 - [#3](https://github.com/boltops-tools/rspec-terraspace/pull/3) add config terraform provider template for azure test
 

data/README.md

@@ -21,7 +21,7 @@ So if you set it: `export TS_RSPEC_BUILD_ROOT=~/environment/terraspace-test-harn
 
 The test helpers support both module-level and project-level tests. See:
 
-* [Terraspace Testing](https://github.com/boltops-tools/terraspace-docs/blob/master/testing.md)
+* [Terraspace Testing](https://terraspace.cloud/docs/testing/)
 
 ## Installation
 

data/lib/rspec/terraspace/concern.rb

@@ -0,0 +1,50 @@
+module RSpec::Terraspace
+  module Concern
+    extend Memoist
+
+    def output(mod, name)
+      outputs.dig(name, "value")
+    end
+
+    def outputs
+      save_output
+      JSON.load(IO.read(out_path))
+    end
+
+    # Note: a terraspace.down will remove the output.json since it does a clean
+    def save_output
+      FileUtils.mkdir_p(File.dirname(out_path))
+      run("output #{@mod.name} --format json --out #{out_path}")
+    end
+    memoize :save_output
+
+    def out_path
+      "#{Terraspace.tmp_root}/rspec/terraform-output.json"
+    end
+
+    def state
+      save_state
+      JSON.load(IO.read(state_path))
+    end
+
+    # full_name: random_pet.this
+    def state_resource(full_name)
+      type, name = full_name.split('.')
+      state['resources'].find do |i|
+        i['type'] == type && i['name'] == name || # IE: type=random_pet name=this
+        i['module'] == full_name # IE: module.bucket
+      end
+    end
+
+    def save_state
+      FileUtils.mkdir_p(File.dirname(state_path))
+      run("state pull #{@mod.name} > #{state_path}")
+    end
+    memoize :save_state
+
+    def state_path
+      "#{Terraspace.tmp_root}/rspec/terraform-state.json"
+    end
+
+  end
+end

data/lib/rspec/terraspace/helpers.rb

@@ -2,13 +2,6 @@ module RSpec::Terraspace
   module Helpers
     extend Memoist
 
-    def reconfigure_logging(level="info")
-      path = "/tmp/terraspace/log/test.log"
-      FileUtils.mkdir_p(File.dirname(path))
-      Terraspace.logger = Terraspace::Logger.new(path)
-      puts "Terraspace.logger has been reconfigured to #{path}"
-    end
-
     def ts
       Ts.new
     end

data/lib/rspec/terraspace/project.rb

@@ -11,6 +11,7 @@ module RSpec::Terraspace
       @stacks  = options[:stacks]
       @tfvars  = options[:tfvars]
       @folders = options[:folders]
+      @plugin  = options[:plugin]
 
       @remove_test_folder = options[:remove_test_folder].nil? ? true : options[:remove_test_folder]
     end
@@ -44,7 +45,29 @@ module RSpec::Terraspace
       FileUtils.mkdir_p(parent_dir)
       Dir.chdir(parent_dir) do
         project_name = File.basename(build_dir)
-        ::Terraspace::CLI::New::Project.start([project_name, "--no-config", "--quiet"])
+        args = [project_name, "--no-config", "--quiet"] + plugin_option
+        ::Terraspace::CLI::New::Project.start(args)
+      end
+    end
+
+    def plugin_option
+      if @plugin
+        ["-p", @plugin]
+      else
+        provider = autodetect_provider || "none"
+        ["-p", provider]
+      end
+    end
+
+    def autodetect_provider
+      providers = Terraspace::Plugin.meta.keys
+      if providers.size == 1
+        providers.first
+      else
+        precedence = %w[aws azurerm google]
+        precedence.find do |p|
+          providers.include?(p)
+        end
       end
     end
 
@@ -52,10 +75,10 @@ module RSpec::Terraspace
       return unless @config
 
       config_folder = "#{build_dir}/config"
-      FileUtils.rm_rf(config_folder) # wipe current config folder
       FileUtils.mkdir_p(File.dirname(config_folder))
-      src = @config
-      FileUtils.cp_r(src, config_folder)
+      Dir.glob("#{@config}/*").each do |src|
+        FileUtils.cp_r(src, config_folder)
+      end
     end
 
     def build_modules
@@ -92,7 +115,8 @@ module RSpec::Terraspace
     def build_tfvars
       return unless @tfvars
       @tfvars.each do |stack, src|
-        tfvars_folder = "#{build_dir}/app/stacks/#{stack}/tfvars"
+        type = detected_type
+        tfvars_folder = "#{build_dir}/app/#{type}/#{stack}/tfvars"
         FileUtils.rm_rf(tfvars_folder) # wipe current tfvars folder. dont use any of the live values
 
         if File.directory?(src)
@@ -106,6 +130,13 @@ module RSpec::Terraspace
       end
     end
 
+    # Returns: modules or stacks
+    def detected_type
+      dir = Dir.pwd
+      md = dir.match(%r{app/(stacks|modules)/(.*)?/})
+      md[1]
+    end
+
     # Inputs:
     #
     #     list:     options[:modules] or options[:stacks]

data/lib/rspec/terraspace/ts.rb

@@ -3,20 +3,29 @@ require "json"
 module RSpec::Terraspace
   class Ts
     extend Memoist
+    include Concern
 
     CLI = ::Terraspace::CLI
 
     def build_test_harness(options={})
+      setup
       project = Project.new(options)
       root = project.create
       Terraspace.root = root # switch root to the generated test harness
     end
 
+    def setup
+      # Require gems in Gemfile so terraspace_plugin_* gets loaded and registered
+      # This it test Gemfile. IE: app/stacks/demo/test/Gemfile
+      Kernel.require "bundler/setup"
+      Bundler.require # Same as Bundler.require(:default)
+      Terraspace.check_project = false
+    end
+
     def up(args)
       run("up #{args} -y")
       mod = args.split(' ').first
       @mod = ::Terraspace::Mod.new(mod)
-      save_output
     end
 
     def down(args)
@@ -24,27 +33,9 @@ module RSpec::Terraspace
     end
 
     def run(command)
-      puts "=> terraspace #{command}".color(:green)
+      puts "=> TS_ENV=#{Terraspace.env} terraspace #{command}".color(:green)
       args = command.split(' ')
       CLI.start(args)
     end
-
-    # Note: a terraspace.down will remove the output.json since it does a clean
-    def save_output
-      FileUtils.mkdir_p(File.dirname(out_path))
-      run("output #{@mod.name} --format json --out #{out_path}")
-    end
-
-    def output(mod, name)
-      outputs.dig(name, "value")
-    end
-
-    def outputs(mod)
-      JSON.load(IO.read(out_path))
-    end
-
-    def out_path
-      "#{Terraspace.tmp_root}/rspec/output.json"
-    end
   end
 end

data/lib/rspec/terraspace/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module Terraspace
-    VERSION = "0.2.1"
+    VERSION = "0.3.1"
   end
 end

data/lib/rspec/terraspace.rb

@@ -1,5 +1,6 @@
 require "rspec/terraspace/version"
 
+require "active_support"
 require "active_support/core_ext/class"
 require "active_support/core_ext/hash"
 require "active_support/core_ext/string"

data/lib/templates/module/test/spec/main_spec.rb.tt

@@ -1,13 +1,14 @@
 describe "main" do
   before(:all) do
-    reconfigure_logging # reconfigure Terraspace.logger to a file
     mod_path = File.expand_path("../..", __dir__) # the source of the module to test is 2 levels up
     # Build terraspace project to use as a test harness
     # Will be located at: /tmp/terraspace/test-harnesses/<%= name %>-harness
     terraspace.build_test_harness(
       name: "<%= name %>-harness",
       modules: {<%= name %>: mod_path},
-      stacks:  {<%= name %>: "#{mod_path}/test/spec/fixtures/stack"}, # folder with the stack module files
+      # See: https://terraspace.cloud/docs/testing/test-harness/
+      # config: "spec/fixtures/config",
+      # tfvars: {example: "spec/fixtures/tfvars/test.tfvars"},
     )
     terraspace.up("<%= name %>")
   end
@@ -19,8 +20,8 @@ describe "main" do
     # Replace with your own test
     expect(true).to be true
     # Example
-    # pp terraspace.outputs("<%= name %>")
-    # output_value = terraspace.output("<%= name %>", "some-output")
+    # pp terraspace.outputs
+    # output_value = terraspace.output("<%= name %>", "name")
     # expect(output_value).to include("some-value")
   end
 end

data/lib/templates/project/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/lib/templates/project/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+ENV["TS_ENV"] = "test"
+
+require "terraspace"
+require "rspec/terraspace"
+
+module Helper
+  def execute(cmd)
+    puts "Running: #{cmd}" if ENV['SHOW_COMMAND']
+    out = `#{cmd}`
+    puts out if ENV['SHOW_COMMAND']
+    out
+  end
+end
+
+RSpec.configure do |c|
+  c.before(:all) do
+    Dir.glob("config/helpers/**/*.rb").each do |path|
+      require "./#{path}"
+      name = path.sub(%r{config/helpers/},'').sub('.rb','').camelize
+      mod = "Terraspace::Project::#{name}"
+      c.include mod.constantize
+    end
+  end
+end

data/lib/templates/stack/test/spec/main_spec.rb.tt

@@ -1,6 +1,5 @@
 describe "main" do
   before(:all) do
-    reconfigure_logging # reconfigure Terraspace.logger to a file
     stack_path = File.expand_path("../..", __dir__) # the source of the stack to test is 2 levels up
     ts_root = File.expand_path("../../..", stack_path) # original Terraspace.root
     # Build terraspace project to use as a test harness
@@ -10,8 +9,8 @@ describe "main" do
       modules: "#{ts_root}/app/modules", # include all modules in folder
       stacks:  {<%= name %>: stack_path},
       # override demo stack tfvars for testing
-      tfvars:  {demo: "#{stack_path}/test/spec/fixtures/tfvars/demo.tfvars"},
       config:  "#{stack_path}/test/spec/fixtures/config",
+      # tfvars:  {demo: "#{stack_path}/test/spec/fixtures/tfvars/test.tfvars"},
     )
     terraspace.up("<%= name %>")
   end
@@ -23,8 +22,12 @@ describe "main" do
     # Replace with your own test
     expect(true).to be true
     # Example
-    # pp terraspace.outputs("<%= name %>")
-    # output_value = terraspace.output("<%= name %>", "some-output")
-    # expect(output_value).to include("some-value")
+    # pp terraspace.outputs
+    output_value = terraspace.output("<%= name %>", "bucket_name")
+    puts "output_value #{output_value}"
+    # More useful helpers:
+    # pp terraspace.state['resources']
+    # pp terraspace.state_resource('random_pet.this')
+    # pp terraspace.state_resource('module.bucket')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-terraspace
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,6 +98,7 @@ files:
 - bin/setup
 - lib/rspec/terraspace.rb
 - lib/rspec/terraspace/autoloader.rb
+- lib/rspec/terraspace/concern.rb
 - lib/rspec/terraspace/helpers.rb
 - lib/rspec/terraspace/project.rb
 - lib/rspec/terraspace/ts.rb
@@ -106,16 +107,16 @@ files:
 - lib/templates/bootstrap/spec/spec_helper.rb
 - lib/templates/module/test/.rspec
 - lib/templates/module/test/Gemfile.tt
-- lib/templates/module/test/spec/fixtures/stack/main.tf.tt
-- lib/templates/module/test/spec/fixtures/stack/outputs.tf
 - lib/templates/module/test/spec/main_spec.rb.tt
 - lib/templates/module/test/spec/spec_helper.rb
+- lib/templates/project/.rspec
 - lib/templates/project/spec/%test_name%_spec.rb.tt
+- lib/templates/project/spec/spec_helper.rb
 - lib/templates/stack/test/.rspec
 - lib/templates/stack/test/Gemfile.tt
 - lib/templates/stack/test/spec/fixtures/config/app.rb
 - lib/templates/stack/test/spec/fixtures/config/terraform/provider.tf.tt
-- lib/templates/stack/test/spec/fixtures/tfvars/%name%.tfvars
+- lib/templates/stack/test/spec/fixtures/tfvars/test.tfvars
 - lib/templates/stack/test/spec/main_spec.rb.tt
 - lib/templates/stack/test/spec/spec_helper.rb
 - rspec-terraspace.gemspec
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Terraspace RSpec support

data/lib/templates/module/test/spec/fixtures/stack/main.tf.tt

@@ -1,6 +0,0 @@
-# This is where you call your module. Example:
-module "<%= name %>" {
-  source = "../../modules/<%= name %>"
-  # Input variables
-  # var1 = "val1"
-}

data/lib/templates/module/test/spec/fixtures/stack/outputs.tf

@@ -1 +0,0 @@
-# This is where you put your output declarations