terraspace 0.5.4 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e39eb604e5161adb75c3df9f81f11c29399c81a4f87909fd4197b55e730abb7
-  data.tar.gz: ba6a3053596e82c55681a12763768f19ff28405a6c4cdc4659f24fa3c00484ba
+  metadata.gz: bc9e2f5079f389bf4c52871ff21d07fd768a72c63b246d770b95c378f0d5a8ad
+  data.tar.gz: f8e957d00f64e54a789f2237161a35c8f9cfbb3af903e40c929829c4ca4d4136
 SHA512:
-  metadata.gz: 0b3104e8b07c0b55b47a175cece06c2d24c1dc92db5ccbff69e0185d2958db867e46943f335e620d04c7d694a29e9d7a097531d9b9442b4e49912e1395e9d992
-  data.tar.gz: 879fea1fd5e477eb20133696e16978f75d59ae000727f8183fafae5b2f36801a32c91a231fd63f2ec207bd4110110a3c49a69f9a4eff6c247452d3647c180c57
+  metadata.gz: 2cf81a81351b8dd8134d19ea9e5ff19644c9ef7470d64e2b54d10d9d35fd69fbc2f5da96a6c34f9e1fb547383d0721d30b49e63df6fbd5958c7b88c3d48dd47f
+  data.tar.gz: f2e202040a50b4a2123ff8e4e177fda89b9ff04d46ba6b759266ea98b75c12e7258ee3a8f424596718875b074155b01319d60107bccfbb43d75d777abda1b56e

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 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.9] - 2020-12-11
+- [#68](https://github.com/boltops-tools/terraspace/pull/68) require singleton
+- fix graphviz check for format text, improve graphviz install help message
+
+## [0.5.8] - 2020-12-04
+- [#67](https://github.com/boltops-tools/terraspace/pull/67) fix find placeholder stack so config/terraform only builds for stacks
+
+## [0.5.7] - 2020-12-02
+- [#64](https://github.com/boltops-tools/terraspace/pull/64) fix completion_script
+
+## [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
 

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/all/grapher.rb

@@ -109,13 +109,12 @@ module Terraspace::All
 
     # Check if Graphiz is installed and prints a user friendly message if it is not installed.
     def check_graphviz!
+      return if @options[:format] == 'text'
+
       installed = system("type dot > /dev/null 2>&1") # dot is a command that is part of the graphviz package
       return if installed
       logger.error "ERROR: It appears that the Graphviz is not installed.  Please install it to use the graph command.".color(:red)
-      if RUBY_PLATFORM =~ /darwin/
-        logger.error "You can install Graphviz with homebrew:"
-        logger.error "    brew install graphviz"
-      end
+      install_instructions
       logger.info <<~EOL
         Also consider:
 
@@ -125,5 +124,23 @@ module Terraspace::All
       EOL
       exit 1
     end
+
+    def install_instructions
+      installer = if RUBY_PLATFORM =~ /darwin/
+        "brew"
+      elsif system("type yum > /dev/null 2>&1")
+        "yum"
+      elsif system("type apt-get > /dev/null 2>&1")
+        "apt-get"
+      end
+
+      return unless installer
+      logger.error <<~EOL
+        You can install Graphviz with:
+
+            #{installer} install graphviz
+
+      EOL
+    end
   end
 end

data/lib/terraspace/app.rb

@@ -1,3 +1,5 @@
+require "singleton"
+
 module Terraspace
   class App
     include Singleton
@@ -18,6 +20,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/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/cli/build/placeholder.rb

@@ -18,17 +18,17 @@ module Terraspace::CLI::Build
       mod = @options[:mod]
       if !mod or %w[placeholder].include?(mod)
         logger.info "Building one of the modules to get backend.tf info"
-        mod = find_mod
+        mod = find_stack
       end
       Terraspace::Builder.new(@options.merge(mod: mod, init: false)).run # generate and init
       Terraspace::Mod.new(mod, @options) # mod metadata
     end
 
     # Used by: terraspace build placeholder
-    def find_mod
-      mod_path = Dir.glob("{app,vendor}/{modules,stacks}/*").last
+    def find_stack
+      mod_path = Dir.glob("{app,vendor}/stacks/*").last
       unless mod_path
-        logger.info "No modules or stacks found."
+        logger.info "No stacks found."
         exit 0
       end
       File.basename(mod_path) # mod name

data/lib/terraspace/cli/check_setup.rb

@@ -41,7 +41,7 @@ class Terraspace::CLI
     def terraform_is_not_installed
       <<~EOL
         Terraform not installed. Unable to detect a terraform command. Please double check that terraform is installed.
-        See: https://terraform.cloud/docs/install/terraform/
+        See: https://terraspace.cloud/docs/install/terraform/
       EOL
     end
 

data/lib/terraspace/{completer.rb → cli/completer.rb}

@@ -1,74 +1,69 @@
-=begin
-Code Explanation:
-
-There are 3 types of things to auto-complete:
-
-  1. command: the command itself
-  2. parameters: command parameters.
-  3. options: command options
-
-Here's an example:
-
-  mycli hello name --from me
-
-  * command: hello
-  * parameters: name
-  * option: --from
-
-When command parameters are done processing, the remaining completion words will be options.  We can tell that the command params are completed based on the method arity.
-
-## Arity
-
-For example, say you had a method for a CLI command with the following form:
-
-  ufo scale service count --cluster dev
-
-It's equivalent ruby method:
-
-  scale(service, count) = has an arity of 2
-
-So typing:
-
-  ufo scale service count [TAB] # there are 3 parameters including the "scale" command according to Thor's CLI processing.
-
-So the completion should only show options, something like this:
-
-  --noop --verbose --cluster
-
-## Splat Arguments
-
-When the ruby method has a splat argument, it's arity is negative.  Here are some example methods and their arities.
-
-   ship(service) = 1
-   scale(service, count) = 2
-   ships(*services) = -1
-   foo(example, *rest) = -2
-
-Fortunately, negative and positive arity values are processed the same way. So we take simply take the absolute value of the arity and process it the same.
-
-Here are some test cases, hit TAB after typing the command:
-
-  terraspace completion
-  terraspace completion hello
-  terraspace completion hello name
-  terraspace completion hello name --
-  terraspace completion hello name --noop
-
-  terraspace completion
-  terraspace completion sub:goodbye
-  terraspace completion sub:goodbye name
-
-## Subcommands and Thor::Group Registered Commands
-
-Sometimes the commands are not simple thor commands but are subcommands or Thor::Group commands. A good specific example is the ufo tool.
-
-  * regular command: ufo ship
-  * subcommand: ufo docker
-  * Thor::Group command: ufo init
-
-Auto-completion accounts for each of these type of commands.
-=end
-module Terraspace
+# begin
+# Code Explanation:
+#
+# There are 3 types of things to auto-complete:
+#
+#   1. command: the command itself
+#   2. parameters: command parameters.
+#   3. options: command options
+#
+# Here's an example:
+#
+#   mycli hello name --from me
+#
+#   * command: hello
+#   * parameters: name
+#   * option: --from
+#
+# When command parameters are done processing, the remaining completion words will be options.  We can tell that the command params are completed based on the method arity.
+#
+# ## Arity
+#
+# For example, say you had a method for a CLI command with the following form:
+#
+#   terraspace up STACK
+#
+# It's equivalent ruby method:
+#
+#   up(mod) = has an arity of 1
+#
+# So typing:
+#
+#   terraspace up [TAB] # there is parameter including the "scale" command according to Thor's CLI processing.
+#
+# So the completion should only show options, something like this:
+#
+#   --noop --verbose --cluster
+#
+# ## Splat Arguments
+#
+# When the ruby method has a splat argument, it's arity is negative.  Here are some example methods and their arities.
+#
+#   up(mod) = 1
+#   scale(service, count) = 2
+#   bundle(*args) = -1
+#   foo(example, *rest) = -2
+#
+# Fortunately, negative and positive arity values are processed the same way. So we take simply take the absolute value of the arity and process it the same.
+#
+# Here are some test cases, hit TAB after typing the command:
+#
+#   terraspace completion
+#   terraspace completion up
+#   terraspace completion up name
+#   terraspace completion up name --
+#   terraspace completion up name --noop
+#
+# ## Subcommands and Thor::Group Registered Commands
+#
+# Sometimes the commands are not simple thor commands but are subcommands or Thor::Group commands. A good specific example is the terraspace tool.
+#
+#   * regular command: terraspace up
+#   * subcommand: terraspace all
+#   * Thor::Group command: terraspace new project
+
+# Auto-completion accounts for each of these type of commands.
+class Terraspace::CLI
   class Completer
     def initialize(command_class, *params)
       @params = params
@@ -132,7 +127,6 @@ module Terraspace
 
     def params_completion
       offset = @params.size - 1
-      offset_params = command_params[offset..-1]
       command_params[offset..-1].first
     end
 

data/lib/terraspace/{completer → cli/completer}/script.rb

@@ -1,6 +1,6 @@
-class Terraspace::Completer::Script
+class Terraspace::CLI::Completer::Script
   def self.generate
     bash_script = File.expand_path("script.sh", File.dirname(__FILE__))
-    logger.info "source #{bash_script}"
+    puts "source #{bash_script}"
   end
 end

data/lib/terraspace/mod.rb

@@ -19,7 +19,7 @@ module Terraspace
 
     def placeholder(name)
       if name == "placeholder"
-        Terraspace::CLI::Build::Placeholder.new(@options).find_mod
+        Terraspace::CLI::Build::Placeholder.new(@options).find_stack
       else
         name
       end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.5.4"
+  VERSION = "0.5.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.9
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2020-12-11 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
@@ -480,6 +481,9 @@ files:
 - lib/terraspace/cli/cloud.rb
 - lib/terraspace/cli/cloud/runs.rb
 - lib/terraspace/cli/commander.rb
+- lib/terraspace/cli/completer.rb
+- lib/terraspace/cli/completer/script.rb
+- lib/terraspace/cli/completer/script.sh
 - lib/terraspace/cli/down.rb
 - lib/terraspace/cli/help.rb
 - lib/terraspace/cli/help/all/down.md
@@ -607,9 +611,6 @@ files:
 - lib/terraspace/compiler/strategy/tfvar/rb.rb
 - lib/terraspace/compiler/strategy/tfvar/tfvars.rb
 - lib/terraspace/compiler/writer.rb
-- lib/terraspace/completer.rb
-- lib/terraspace/completer/script.rb
-- lib/terraspace/completer/script.sh
 - lib/terraspace/core.rb
 - lib/terraspace/dependency/graph.rb
 - lib/terraspace/dependency/helper/base.rb