rspec-terraspace 0.0.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbabbd26046c3eaf54725c3aa8f4855d937c37069be0dc128df91639ef096f77
-  data.tar.gz: 139e4c4245bf1263613345a44b74f97a652f75ad04a761dcac9a235225522b13
+  metadata.gz: 42c4017e3ddd5cd3cfd9cdf4d6e59582ecaadbe6f1cf34df7d2c56c8180a9e8f
+  data.tar.gz: f9fba8a8ffa4d70071a04f487fadf519d174dff1665572d6dbf86652048d7eca
 SHA512:
-  metadata.gz: 90a4b91ba86c9fadaa11f50a2a00f3c287c59092560afcae8a4e4e7b543ecacabeccbdcfaf1c145284e4408ac951eb070b4059a39741239afdaca5ee2996c3c9
-  data.tar.gz: d64afaf6fe488205f6e1dcc9ac72541af75af33140db8164e85f1ee42e326563c55f8015b58f86c55a703eefa6601f45a6c35679fcc15551344cbaead77b61ae
+  metadata.gz: e8296689a8b23250cd37e2e9823b761a3529063adddffc45d7a76f685769702eafbb4d38d6df1911565c2c6a4a457b297bc8417d1de273afa67382a321df6c7d
+  data.tar.gz: 1e835b72584ba6a459555645b5791f8f3f63782c48d01639caf3487c31129da149463ae69f3c3f352bafe27f054c0c5e2795126390e5bbd3dc92f05ee9c89da7

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+This project *tries* to adhere to [Semantic Versioning](http://semver.org/).
+
+## [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
+
+## [0.2.0] - 2020-11-15
+- [#2](https://github.com/boltops-tools/rspec-terraspace/pull/2) stack test like module test template, reconfigure logger
+- stack test like module test template, reconfigure logger
+
+## [0.1.0]
+- Initial release

data/Gemfile

@@ -5,3 +5,7 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+
+group :development, :test do
+  gem "terraspace"
+end

data/lib/rspec/terraspace.rb

@@ -12,6 +12,11 @@ RSpec::Terraspace::Autoloader.setup
 module Rspec
   module Terraspace
     class Error < StandardError; end
-    # Your code goes here...
   end
 end
+
+require "terraspace"
+
+Terraspace::Tester.register("rspec",
+  root: File.expand_path("../..", __dir__)
+)

data/lib/rspec/terraspace/helpers.rb

@@ -2,6 +2,13 @@ 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

@@ -5,41 +5,105 @@ module RSpec::Terraspace
   class Project
     def initialize(options={})
       @options = options
-      @name    = options[:name] || "demo"
+      @name    = options[:name]
+      @config  = options[:config]
       @modules = options[:modules]
       @stacks  = options[:stacks]
+      @tfvars  = options[:tfvars]
+      @folders = options[:folders]
 
       @remove_test_folder = options[:remove_test_folder].nil? ? true : options[:remove_test_folder]
     end
 
     def create
+      puts "Building test harness at: #{build_dir}"
       clean
       build_project
+      build_config
       build_modules
       build_stacks
-      puts "Test harness built: #{build_dir}"
+      build_tfvars
+      build_folders
+      puts "Test harness built."
       build_dir
     end
 
+    # folders at any-level, including top-level can be copied with the folders option
+    def build_folders
+      return unless @folders
+
+      @folders.each do |folder|
+        dest = "#{build_dir}/#{folder}"
+        FileUtils.mkdir_p(File.dirname(dest))
+        FileUtils.cp_r(folder, dest)
+      end
+    end
+
     def build_project
       parent_dir = File.dirname(build_dir)
       FileUtils.mkdir_p(parent_dir)
       Dir.chdir(parent_dir) do
         project_name = File.basename(build_dir)
-        ::Terraspace::CLI::New::Project.start([project_name])
+        ::Terraspace::CLI::New::Project.start([project_name, "--no-config", "--quiet"])
       end
+    end
 
-      # TODO: terraspace new project --no-config option instead
-      FileUtils.rm_f("#{build_dir}/config/backend.tf")
-      FileUtils.rm_f("#{build_dir}/config/provider.tf")
+    def build_config
+      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)
     end
 
     def build_modules
-      build_app_subfolder(@modules, "modules")
+      return unless @modules
+      build_type_folder("modules", @modules)
     end
 
     def build_stacks
-      build_app_subfolder(@stacks, "stacks")
+      return unless @stacks
+      build_type_folder("stacks", @stacks)
+    end
+
+    # If a file has been supplied, then it gets copied over.
+    #
+    #     # File
+    #     terraspace.build_test_harness(
+    #       tfvars: {demo: "spec/fixtures/tfvars/demo.tfvars"},
+    #     end
+    #
+    #     # Results in:
+    #     app/stacks/#{stack}/tfvars/test.tfvars
+    #
+    # If a directory has been supplied, then the folder fully gets copied over.
+    #
+    #     # Directory
+    #     terraspace.build_test_harness(
+    #       tfvars: {demo: "spec/fixtures/tfvars/demo"},
+    #     end
+    #
+    #     # Results in (whatever is in the folder):
+    #     app/stacks/#{stack}/tfvars/base.tfvars
+    #     app/stacks/#{stack}/tfvars/test.tfvars
+    #
+    def build_tfvars
+      return unless @tfvars
+      @tfvars.each do |stack, src|
+        tfvars_folder = "#{build_dir}/app/stacks/#{stack}/tfvars"
+        FileUtils.rm_rf(tfvars_folder) # wipe current tfvars folder. dont use any of the live values
+
+        if File.directory?(src)
+          FileUtils.mkdir_p(File.dirname(tfvars_folder))
+          FileUtils.cp_r(src, tfvars_folder)
+        else # if only a single file, then generate a test.tfvars since this runs under TS_ENV=test
+          dest = "#{tfvars_folder}/test.tfvars"
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.cp(src, dest)
+        end
+      end
     end
 
     # Inputs:
@@ -58,7 +122,7 @@ module RSpec::Terraspace
     # If provide a String, it should be a path to folder containing all modules or stacks.
     # This provides less fine-grain control but is easier to use and shorter.
     #
-    def build_app_subfolder(list, type_dir)
+    def build_type_folder(type_dir, list)
       case list
       when Hash
         list.each do |name, src|
@@ -89,11 +153,15 @@ module RSpec::Terraspace
     end
 
     def build_dir
-      "#{build_root}/#{@name}"
+      "#{tmp_root}/#{@name}"
+    end
+
+    def tmp_root
+      self.class.tmp_root
     end
 
-    def build_root
-      ENV['TS_RSPEC_BUILD_ROOT'] || "/tmp/terraspace/test-harnesses"
+    def self.tmp_root
+      "#{Terraspace.tmp_root}/test-harnesses"
     end
   end
 end

data/lib/rspec/terraspace/ts.rb

@@ -7,14 +7,16 @@ module RSpec::Terraspace
     CLI = ::Terraspace::CLI
 
     def build_test_harness(options={})
-      puts "Building test harness..."
       project = Project.new(options)
-      @ts_root = project.create
-      ENV['TS_ROOT'] = @ts_root # switch root to the generated test harness
+      root = project.create
+      Terraspace.root = root # switch root to the generated test harness
     end
 
     def up(args)
       run("up #{args} -y")
+      mod = args.split(' ').first
+      @mod = ::Terraspace::Mod.new(mod)
+      save_output
     end
 
     def down(args)
@@ -22,23 +24,27 @@ module RSpec::Terraspace
     end
 
     def run(command)
+      puts "=> terraspace #{command}".color(:green)
       args = command.split(' ')
       CLI.start(args)
     end
 
-    def save_output(mod)
-      run("output #{mod} --json --save-to #{saved_output_path}")
+    # 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 output(mod, name)
-      save_output(mod)
-      data = JSON.load(IO.read(saved_output_path))
-      data.dig(name, "value")
+      outputs.dig(name, "value")
     end
 
-    def saved_output_path
-      "#{@ts_root}/output.json"
+    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.0.0"
+    VERSION = "0.2.3"
   end
 end

data/lib/templates/bootstrap/.rspec

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

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

@@ -0,0 +1,13 @@
+ENV["TS_ENV"] = "test"
+
+require "terraspace"
+require "rspec/terraspace"
+
+module Helper
+  # Add your helpers here
+end
+
+RSpec.configure do |c|
+  c.include RSpec::Terraspace::Helpers
+  c.include Helper
+end

data/lib/templates/module/test/.rspec

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

data/lib/templates/module/test/Gemfile.tt

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+<%=
+build_gemfile(
+  "terraspace",
+  "rspec-terraspace",
+  plugin_gem_name,
+)
+%>

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

@@ -0,0 +1,25 @@
+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},
+    )
+    terraspace.up("<%= name %>")
+  end
+  after(:all) do
+    terraspace.down("<%= name %>")
+  end
+
+  it "successful deploy" do
+    # Replace with your own test
+    expect(true).to be true
+    # Example
+    # pp terraspace.outputs
+    # output_value = terraspace.output("<%= name %>", "some-output")
+    # expect(output_value).to include("some-value")
+  end
+end

data/lib/templates/module/test/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+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.include Helper
+  c.include RSpec::Terraspace::Helpers
+end

data/lib/templates/project/spec/%test_name%_spec.rb.tt

@@ -0,0 +1,5 @@
+describe "<%= test_name %>" do
+  it "the truth" do
+    expect(true).to be true
+  end
+end

data/lib/templates/stack/test/.rspec

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

data/lib/templates/stack/test/Gemfile.tt

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+<%=
+build_gemfile(
+  "terraspace",
+  "rspec-terraspace",
+  plugin_gem_name,
+)
+%>

data/lib/templates/stack/test/spec/fixtures/config/app.rb

@@ -0,0 +1,4 @@
+Terraspace.configure do |config|
+  config.logger.level = :info
+  config.test_framework = "rspec"
+end

data/lib/templates/stack/test/spec/fixtures/config/terraform/provider.tf.tt

@@ -0,0 +1,5 @@
+<% if autodetect_provider == "azurerm" -%>
+provider "azurerm" {
+  features {} # required
+}
+<% end -%>

data/lib/templates/stack/test/spec/fixtures/tfvars/%name%.tfvars

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

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

@@ -0,0 +1,30 @@
+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
+    # Will be located at: /tmp/terraspace/test-harnesses/<%= name %>-harness
+    terraspace.build_test_harness(
+      name:    "<%= name %>-harness",
+      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",
+    )
+    terraspace.up("<%= name %>")
+  end
+  after(:all) do
+    terraspace.down("<%= name %>")
+  end
+
+  it "successful deploy" do
+    # Replace with your own test
+    expect(true).to be true
+    # Example
+    # pp terraspace.outputs
+    # output_value = terraspace.output("<%= name %>", "some-output")
+    # expect(output_value).to include("some-value")
+  end
+end

data/lib/templates/stack/test/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+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.include Helper
+  c.include RSpec::Terraspace::Helpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-terraspace
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,8 +89,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -102,6 +102,20 @@ files:
 - lib/rspec/terraspace/project.rb
 - lib/rspec/terraspace/ts.rb
 - lib/rspec/terraspace/version.rb
+- lib/templates/bootstrap/.rspec
+- lib/templates/bootstrap/spec/spec_helper.rb
+- lib/templates/module/test/.rspec
+- 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/spec/%test_name%_spec.rb.tt
+- 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/main_spec.rb.tt
+- lib/templates/stack/test/spec/spec_helper.rb
 - rspec-terraspace.gemspec
 homepage: https://github.com/boltops-tools/rspec-terraspace
 licenses:
@@ -122,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Terraspace RSpec support

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rspec-terraspace (0.1.0)
-      activesupport
-      memoist
-      rainbow
-      zeitwerk
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    memoist (0.16.2)
-    minitest (5.14.1)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  rspec-terraspace!
-
-BUNDLED WITH
-   2.1.4