rspec-terraspace 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42c4017e3ddd5cd3cfd9cdf4d6e59582ecaadbe6f1cf34df7d2c56c8180a9e8f
-  data.tar.gz: f9fba8a8ffa4d70071a04f487fadf519d174dff1665572d6dbf86652048d7eca
+  metadata.gz: c09973fe7ff5551af56434b0cdc5bc97194e4695fcdd061c3c7cfaebbd7d468f
+  data.tar.gz: eadb2ce4620283dfd666afff0993aee8769217c6a36848ed8ca98bf1d3db8d27
 SHA512:
-  metadata.gz: e8296689a8b23250cd37e2e9823b761a3529063adddffc45d7a76f685769702eafbb4d38d6df1911565c2c6a4a457b297bc8417d1de273afa67382a321df6c7d
-  data.tar.gz: 1e835b72584ba6a459555645b5791f8f3f63782c48d01639caf3487c31129da149463ae69f3c3f352bafe27f054c0c5e2795126390e5bbd3dc92f05ee9c89da7
+  metadata.gz: 63571680195d695c14d2bf3633f165f904cadc3145e3f802610ecc6c33386fe57f99a4acb5c9234c05d27b6870137192eb37c759612ff83e27d1dc6eb1202958
+  data.tar.gz: c524ce214a25bc5d9a54be71a74b1b30130433ed79c8b63f7d716da420c7e161a900ea8b2a18e7b96d5d50084cedcf9cc0cc4619e852cec137329a1c0ced6f07

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 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.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
 

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

@@ -52,10 +52,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 +92,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 +107,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,6 +3,7 @@ require "json"
 module RSpec::Terraspace
   class Ts
     extend Memoist
+    include Concern
 
     CLI = ::Terraspace::CLI
 
@@ -16,7 +17,6 @@ module RSpec::Terraspace
       run("up #{args} -y")
       mod = args.split(' ').first
       @mod = ::Terraspace::Mod.new(mod)
-      save_output
     end
 
     def down(args)
@@ -24,27 +24,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
-      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.3"
+    VERSION = "0.3.0"
   end
 end

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

@@ -1,12 +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},
+      # See: https://terraspace.cloud/docs/testing/test-harness/
+      # config: "spec/fixtures/config",
+      # tfvars: {example: "spec/fixtures/tfvars/test.tfvars"},
     )
     terraspace.up("<%= name %>")
   end
@@ -19,7 +21,7 @@ describe "main" do
     expect(true).to be true
     # Example
     # pp terraspace.outputs
-    # output_value = terraspace.output("<%= name %>", "some-output")
+    # 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
@@ -24,7 +23,11 @@ describe "main" do
     expect(true).to be true
     # Example
     # pp terraspace.outputs
-    # output_value = terraspace.output("<%= name %>", "some-output")
-    # expect(output_value).to include("some-value")
+    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.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-07-26 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
@@ -108,12 +109,14 @@ files:
 - lib/templates/module/test/Gemfile.tt
 - 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