terraspace 0.5.1 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f43880b8fc93060a328decf3fa5ac770253341995ec800e6d38b86f7696d5912
-  data.tar.gz: 9337cb32f020b54e5693aa2dde06960c22a8fd8755ff55bf1ebb0ebf4cd2fccf
+  metadata.gz: 0e58f700f76a198ca29730aa7f8dfa70a009dd8fefc11e49c9796d060f01d6e1
+  data.tar.gz: 81b4dfd9f3280335608feebcdace38ebc97f9dd2739272e10f7482feb95ed2f7
 SHA512:
-  metadata.gz: '09047e18b86cf30f2a013c7c20f864ef3540120f7f70c12bae854f80f60f952a84e109811ab59aa078e331c0fc34134c9f84dd85f73d7dab5c08ee2208454c17'
-  data.tar.gz: 69eb21940249f6566de22d88dd33165d4265aed490deafc81659ac59d04f7c9b1436ae4b2cbdc09e74f6279e82fdbaa620001610fd2022584dcc599e23bda10e
+  metadata.gz: 71c1f99ec511b8f846d19978ba614e18801a267badc7df6d16b54113f7b9a9aafe959b3035af06e4efd46c6d2735af597532540edd849791b9b62f51f69087af
+  data.tar.gz: afd0feb506627ce32f7bd986db7c4b41a995ddf744a1be9198a56a6928d2a1642b249925622c1de83eee65fd49307672a520aea4f446d0fadb9afb95c40c064d

data/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.5.6] - 2020-11-30
+- [#61](https://github.com/boltops-tools/terraspace/pull/61) allow envs and regions check feature
+- fix terraspace build before hook
+
+## [0.5.5] - 2020-11-27
+- fix link
+
+## [0.5.4] - 2020-11-27
+- fix check setup when terraform not found
+
+## [0.5.3] - 2020-11-27
+- [#60](https://github.com/boltops-tools/terraspace/pull/60) fix terraspace check_setup, use type and allow to run outside project
+- improve terraform is not installed message
+
+## [0.5.2] - 2020-11-27
+- [#59](https://github.com/boltops-tools/terraspace/pull/59) only run bundler/setup within terraspace project and check standalone install
+- fix terraspace help
+- fix terraspace setup check when terraform is not installed
+
 ## [0.5.1] - 2020-11-17
 - [#56](https://github.com/boltops-tools/terraspace/pull/56) fix arg and hook generators
 - fix ci build

data/README.md

@@ -12,9 +12,9 @@ The Terraform Framework.
 
 Official Docs Site: [terraspace.cloud](https://terraspace.cloud)
 
-Introduction Video:
+Quick Start Demo:
 
-[![Watch the video](https://img.boltops.com/boltops/tools/terraspace/terraspace-youtube.png)](https://www.youtube.com/watch?v=O87t5q22YNc)
+[![Watch the video](https://img.boltops.com/boltops/tools/terraspace/youtube/terraspace-quick-start.png)](https://www.youtube.com/watch?v=EZfsBJx8pxQ)
 
 ## Quick Start
 
@@ -103,7 +103,7 @@ To install modules:
 
 ## Features
 
-* [Config Structure](https://terraspace.cloud/docs/config/): A common config structure that gets materializes with the deployed module. Configs can be dynamically controlled to keep your code DRY. You can override the settings if needed, like for using existing backends. See: [Existing Backends](https://terraspace.cloud/docs/state/existing/).
+* [DRY](https://terraspace.cloud/docs/intro/how-terraspace-works/): You can keep your code DRY. Terraspace builds your Terraform project with common `app` and `config/terraform` structure that gets built each deploy. You can override the settings if needed, like for using existing backends. See: [Existing Backends](https://terraspace.cloud/docs/state/existing/).
 * [Generators](https://terraspace.cloud/docs/generators/): Built-in generators to quickly create the starter module. Focus on code instead of boilerplate structure.
 * [Multiple Environments](https://terraspace.cloud/docs/patterns/multiple-envs/): [Tfvars](https://terraspace.cloud/docs/tfvars/) & [Layering](https://terraspace.cloud/docs/tfvars/layering/) allow you to the same code with different tfvars to create multiple environments. Terraspace conventionally loads tfvars from the `tfvars` folder. Rich layering support allows you to build different environments like dev and prod with the same code.  Examples are in [Full Layering](https://terraspace.cloud/docs/tfvars/full-layering/).
 * [Deploy Multiple Stacks](https://terraspace.cloud/docs/intro/deploy-all/): The ability to deploy multiple stacks with a single command. Terraspace calculates the [dependency graph](https://terraspace.cloud/docs/dependencies/) and deploys stacks in the right order. You can also target specific stacks and deploy [subgraphs](https://terraspace.cloud/docs/dependencies/subgraphs/).

data/lib/terraspace/app.rb

@@ -18,6 +18,9 @@ module Terraspace
       config.all.exit_on_fail.down = true
       config.all.exit_on_fail.up = true
       config.all.ignore_stacks = []
+      config.allow = ActiveSupport::OrderedOptions.new
+      config.allow.envs = nil
+      config.allow.regions = nil
       config.auto_create_backend = true
       config.build = ActiveSupport::OrderedOptions.new
       config.build.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"

data/lib/terraspace/autoloader.rb

@@ -1,7 +1,5 @@
-if File.exist?("config/app.rb")
-  require "terraspace/bundle"
-  Terraspace::Bundle.setup
-end
+require "terraspace/bundle"
+Terraspace::Bundle.setup
 require "zeitwerk"
 
 module Terraspace

data/lib/terraspace/builder.rb

@@ -16,7 +16,9 @@ module Terraspace
       logger.info "Building #{build_dir}" unless @options[:quiet] # from terraspace all
 
       batches = nil
+      FileUtils.mkdir_p(@mod.cache_dir) # so terraspace before build hooks work
       run_hooks("terraspace.rb", "build") do
+        check_allow!
         build_unresolved
         auto_create_backend
         batches = build_batches
@@ -26,6 +28,10 @@ module Terraspace
       batches
     end
 
+    def check_allow!
+      Allow.new(@mod).check!
+    end
+
     # Builds dependency graph and returns the batches to run
     def build_batches
       dependencies = Terraspace::Dependency::Registry.data # populated after build_unresolved

data/lib/terraspace/builder/allow.rb

@@ -0,0 +1,43 @@
+class Terraspace::Builder
+  class Allow
+    def initialize(mod)
+      @mod = mod
+    end
+
+    def check!
+      messages = []
+      unless env_allowed?
+        messages << "This env is not allowed to be used: TS_ENV=#{Terraspace.env}"
+        messages << "Allowed envs: #{config.allow.envs.join(', ')}"
+      end
+      unless region_allowed?
+        messages << "This region is not allowed to be used: Detected current region=#{current_region}"
+        messages << "Allowed regions: #{config.allow.regions.join(', ')}"
+      end
+      unless messages.empty?
+        puts "ERROR: The configs do not allow this.".color(:red)
+        puts messages
+        exit 1
+      end
+    end
+
+    def env_allowed?
+      return true unless config.allow.envs
+      config.allow.envs.include?(Terraspace.env)
+    end
+
+    def region_allowed?
+      return true unless config.allow.regions
+      config.allow.regions.include?(current_region)
+    end
+
+    def current_region
+      expander = Terraspace::Compiler::Expander.autodetect(@mod).expander
+      expander.region
+    end
+
+    def config
+      Terraspace.config
+    end
+  end
+end

data/lib/terraspace/bundle.rb

@@ -8,6 +8,7 @@ module Terraspace
     #
     def setup
       return unless gemfile?
+      return unless terraspace_project?
       Kernel.require "bundler/setup"
       Bundler.setup # Same as Bundler.setup(:default)
     rescue LoadError => e
@@ -16,12 +17,17 @@ module Terraspace
 
     def require
       return unless gemfile?
+      return unless terraspace_project?
       Kernel.require "bundler/setup"
       Bundler.require(*bundler_groups)
     rescue LoadError => e
       handle_error(e)
     end
 
+    def terraspace_project?
+      File.exist?("config/app.rb")
+    end
+
     def handle_error(e)
       puts e.message
       return if e.message.include?("already activated")

data/lib/terraspace/cli/check_setup.rb

@@ -17,7 +17,7 @@ class Terraspace::CLI
         puts "Detected #{terraform_version_message}"
         check_required_version!
       else
-        puts "Terraform not installed. Unable to detect a terraform command. Please double check that terraform is installed."
+        puts terraform_is_not_installed
         exit 1
       end
     end
@@ -38,7 +38,19 @@ class Terraspace::CLI
       ARGV[0] == "check_setup"
     end
 
+    def terraform_is_not_installed
+      <<~EOL
+        Terraform not installed. Unable to detect a terraform command. Please double check that terraform is installed.
+        See: https://terraspace.cloud/docs/install/terraform/
+      EOL
+    end
+
     def ok?
+      unless terraform_bin
+        puts terraform_is_not_installed
+        exit 1
+      end
+
       version = terraform_version_message.sub(/.*v/,'') # => 0.12.24
       unless version.match(/\d+\.\d+\.\d+/) # just parse did not find the version number
         puts "WARN: Unable to get the terraform version".color(:yellow)
@@ -52,8 +64,10 @@ class Terraspace::CLI
     end
 
     def terraform_bin
-      bin_path = `which terraform 2>&1`.strip
-      bin_path if $?.success?
+      out = `type terraform 2>&1`.strip
+      return unless $?.success?
+      md = out.match(/is (.*)/)
+      md[1] if md
     end
     memoize :terraform_bin
 

data/lib/terraspace/command.rb

@@ -30,6 +30,7 @@ module Terraspace
       include Terraspace::Util::Logging
 
       def dispatch(m, args, options, config)
+        check_standalone_install!
         check_project!(args.first)
 
         # Allow calling for help via:
@@ -58,9 +59,42 @@ module Terraspace
         super
       end
 
+      def check_standalone_install!
+        return unless opt?
+        version_manager = "rvm" if rvm?
+        version_manager = "rbenv" if rbenv?
+        if rbenv? || rvm?
+          puts <<~EOL.color(:yellow)
+            WARN: It looks like a standalone Terraspace install and #{version_manager} is also in use.
+            Different gems from the standalone Terraspace install and #{version_manager} can cause all kinds of trouble.
+            Please install Terraspace as a gem instead and remove the standalone Terraspace /opt/terraspace installation.
+            See: https://terraspace.cloud/docs/install/gem/
+          EOL
+        end
+      end
+
+      def opt?
+        paths = ENV['PATH'].split(':')
+        opt = paths.detect { |p| p.include?('/opt/terraspace') }
+        opt && File.exist?('/opt/terraspace')
+      end
+
+      def rvm?
+        paths = ENV['PATH'].split(':')
+        rvm = paths.detect { |p| p.include?('/rvm/') || p.include?('/.rvm/') }
+        rvm && system("type rvm > /dev/null 2>&1")
+      end
+
+      def rbenv?
+        paths = ENV['PATH'].split(':')
+        rbenv = paths.detect { |p| p.include?('/rbenv/') || p.include?('/.rbenv/') }
+        rbenv && system("type rbenv > /dev/null 2>&1")
+      end
+
       def check_project!(command_name)
         return if subcommand?
-        return if %w[-h -v completion completion_script help new test version].include?(command_name)
+        return if command_name.nil?
+        return if %w[-h -v check_setup completion completion_script help new test version].include?(command_name)
         return if File.exist?("#{Terraspace.root}/config/app.rb")
         logger.error "ERROR: It doesnt look like this is a terraspace project. Are you sure you are in a terraspace project?".color(:red)
         ENV['TS_TEST'] ? raise : exit(1)

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.5.1"
+  VERSION = "0.5.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.6
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -465,6 +465,7 @@ files:
 - lib/terraspace/autoloader.rb
 - lib/terraspace/booter.rb
 - lib/terraspace/builder.rb
+- lib/terraspace/builder/allow.rb
 - lib/terraspace/bundle.rb
 - lib/terraspace/cli.rb
 - lib/terraspace/cli/all.rb