terraspace 0.1.2 → 0.2.4

data/lib/terraspace/compiler/cleaner.rb

@@ -19,6 +19,7 @@ module Terraspace::Compiler
     # only remove .tf* files. leaving cache .terraform and terraform.state files
     def remove_materialized_artifacts
       Dir.glob("#{Terraspace.cache_root}/**/*").each do |path|
+        next unless within_env?(path)
         next if path.include?(".tfstate")
         FileUtils.rm_f(path) if File.file?(path)
       end
@@ -31,7 +32,7 @@ module Terraspace::Compiler
     # the file again. With verbose logging, it shows it twice so that's a little bit confusing though.
     #
     # def remove_materialized_artifacts_dot_terraform
-    #   expr = "#{@mod.cache_build_dir}/.terraform/**/*"
+    #   expr = "#{@mod.cache_dir}/.terraform/**/*"
     #
     #   Dir.glob(expr).each do |path|
     #     logger.info "path #{path}"
@@ -40,7 +41,23 @@ module Terraspace::Compiler
 
     def remove_empty_directories
       return unless File.exist?(Terraspace.cache_root)
-      Dir["#{Terraspace.cache_root}/**/"].reverse_each { |d| Dir.rmdir d if Dir.entries(d).size == 2 }
+      Dir["#{Terraspace.cache_root}/**/"].reverse_each do |d|
+        next unless within_env?(d)
+        Dir.rmdir(d) if Dir.entries(d).size == 2
+      end
+    end
+
+    # Only remove files within an env for the TFC VCS-Workflow.
+    # We dont want to run:
+    #
+    #      TS_ENV=prod terraspace up demo
+    #
+    # And that to delete the .terraspace-cache/us-west-2/dev files
+    #
+    # May need to allow further customization to this if user project has a stack named the same as the env.
+    #
+    def within_env?(path)
+      path.include?("/#{Terraspace.env}/")
     end
   end
 end

data/lib/terraspace/compiler/cleaner/backend_change.rb

@@ -27,7 +27,7 @@ class Terraspace::Compiler::Cleaner
     end
 
     def current_backend
-      materialized_path = find_src_path("#{@mod.cache_build_dir}/backend*")
+      materialized_path = find_src_path("#{@mod.cache_dir}/backend*")
       IO.read(materialized_path) if materialized_path
     end
 

data/lib/terraspace/compiler/dsl/syntax/mod.rb

@@ -1,5 +1,6 @@
 module Terraspace::Compiler::Dsl::Syntax
   module Mod
+    include Terraspace::Util::Logging
     include_dir("mod")
     include_dir("helpers")
   end

data/lib/terraspace/compiler/dsl/syntax/mod/backend.rb

@@ -3,16 +3,29 @@ module Terraspace::Compiler::Dsl::Syntax::Mod
     def backend(name, props={})
       terraform = @structure[:terraform] ||= {}
       backend = terraform[:backend] ||= {}
-      backend_expand_all!(name, props)
+      expansion_all!(name, props)
       backend[name] = props
     end
 
-    def backend_expand_all!(backend_name, props={})
+    def expansion_all!(backend_name, props={})
       Terraspace::Compiler::Expander.new(@mod, backend_name).expand(props)
     end
 
+    # Can set opts to explicitly use an specfic backend. Example:
+    #
+    #    opts = {backend: s3}
+    #
+    # Else Terraspace autodetects the backend installed.
+    #
+    def expansion(string, opts={})
+      expander = Terraspace::Compiler::Expander.autodetect(@mod, opts)
+      expander.expansion(string)
+    end
+
+    # DEPRECATED: Will be removed in future release
     def backend_expand(backend_name, string)
-      Terraspace::Compiler::Expander.new(@mod, backend_name).expand_string(string)
+      logger.info "DEPRECATED backend_expand: instead use expansion(string)"
+      Terraspace::Compiler::Expander.new(@mod, backend_name).expansion(string)
     end
   end
 end

data/lib/terraspace/compiler/expander.rb

@@ -1,6 +1,6 @@
 module Terraspace::Compiler
   class Expander
-    delegate :expand, :expand_string, to: :expander
+    delegate :expand, :expansion, to: :expander
 
     attr_reader :expander
     def initialize(mod, name)
@@ -15,5 +15,32 @@ module Terraspace::Compiler
     rescue NameError
       Terraspace::Plugin::Expander::Generic
     end
+
+    class << self
+      extend Memoist
+
+      def autodetect(mod, opts={})
+        backend = opts[:backend]
+        unless backend
+          plugin = find_plugin
+          backend = plugin[:backend]
+        end
+        new(mod, backend)
+      end
+      memoize :autodetect
+
+      def find_plugin
+        plugins = Terraspace::Plugin.meta
+        if plugins.size == 1
+          plugins.first[1]
+        else
+          precedence = %w[aws azurerm google]
+          plugin = precedence.find do |provider|
+            plugins[provider]
+          end
+          plugins[plugin]
+        end
+      end
+    end
   end
 end

data/lib/terraspace/compiler/writer.rb

@@ -19,7 +19,7 @@ module Terraspace::Compiler
       if @mod.is_a?(Terraspace::Mod::Remote)
         File.dirname(@src_path) # for Mod::Remote src is dest
       else
-        @mod.cache_build_dir
+        @mod.cache_dir
       end
     end
 

data/lib/terraspace/core.rb

@@ -18,7 +18,7 @@ module Terraspace
     end
 
     def cache_root
-      ENV['TS_CACHE_ROOT'] || "#{root}/.terraspace-cache"
+      ENV['TS_CACHE_ROOT'] || config.build.cache_root || "#{root}/.terraspace-cache"
     end
     memoize :cache_root
 
@@ -42,5 +42,11 @@ module Terraspace
       config.logger
     end
     memoize :logger
+
+    def check_project!
+      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)
+    end
   end
 end

data/lib/terraspace/mod.rb

@@ -11,18 +11,26 @@ module Terraspace
 
     attr_reader :name, :consider_stacks, :instance, :options
     def initialize(name, options={})
-      @name, @options = name, options
+      @name, @options = placeholder(name), options
       @consider_stacks = options[:consider_stacks].nil? ? true : options[:consider_stacks]
       @instance = options[:instance]
     end
 
+    def placeholder(name)
+      if name == "placeholder"
+        Terraspace::CLI::Build::Placeholder.new(@options).find_mod
+      else
+        name
+      end
+    end
+
     attr_accessor :root_module
     def root_module?
       @root_module
     end
 
     def check_exist!
-      check_terraspace_project!
+      Terraspace.check_project!
       return if root
 
       pretty_paths = paths.map { |p| Terraspace::Util.pretty_path(p) }
@@ -30,16 +38,10 @@ module Terraspace
       ENV['TS_TEST'] ? raise : exit(1)
     end
 
-    def check_terraspace_project!
-      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)
-    end
-
     def to_info
       {
         build_dir: build_dir,
-        cache_build_dir: Terraspace::Util.pretty_path(cache_build_dir),
+        cache_dir: Terraspace::Util.pretty_path(cache_dir),
         name: name,
         root: Terraspace::Util.pretty_path(root),
         type: type,
@@ -48,10 +50,30 @@ module Terraspace
     end
 
     def root
-      paths.find { |p| File.exist?(p) }
+      root = paths.find { |p| File.exist?(p) }
+      if root.nil?
+        possible_fake_root
+      else
+        root
+      end
     end
     memoize :root
 
+    # If the app/stacks/NAME has been removed in source code but stack still exist in the cloud.
+    # allow user to delete by materializing an empty stack with the backend.tf
+    # Note this does not seem to work for Terraform Cloud as terraform init doesnt seem to download the plugins
+    # required. SIt only works for s3, azurerm, and gcs backends. On TFC, you can delete the stack via the GUI though.
+    #
+    #   down - so user can delete stacks w/o needing to create an empty app/stacks/demo folder
+    #   null - for the terraspace summary command when there are zero stacks.
+    #          Also useful for terraspace cloud list_workspaces
+    #
+    def possible_fake_root
+      if @options[:command] == "down"
+        "#{Terraspace.root}/app/stacks/#{@name}" # fake stack root
+      end
+    end
+
     # Relative folder path without app or vendor. For example, the actual location can be found in a couple of places
     #
     #     app/modules/vpc
@@ -74,9 +96,12 @@ module Terraspace
     end
 
     # Full path with build_dir
-    def cache_build_dir
-      "#{Terraspace.cache_root}/#{Terraspace.env}/#{build_dir}"
+    def cache_dir
+      pattern = Terraspace.config.build.cache_dir # IE: :CACHE_ROOT/:REGION/:ENV/:BUILD_DIR
+      expander = Terraspace::Compiler::Expander.autodetect(self)
+      expander.expansion(pattern)
     end
+    memoize :cache_dir
 
     def type
       root.include?("/stacks/") ? "stack" : "module"

data/lib/terraspace/mod/remote.rb

@@ -8,7 +8,7 @@ class Terraspace::Mod
     end
 
     def root
-      "#{@parent.cache_build_dir}/#{@meta['Dir']}"
+      "#{@parent.cache_dir}/#{@meta['Dir']}"
     end
 
     def type

data/lib/terraspace/plugin/expander/interface.rb

@@ -6,34 +6,64 @@
 #
 module Terraspace::Plugin::Expander
   module Interface
-    delegate :build_dir, :type_dir, to: :mod
+    include Terraspace::Plugin::InferProvider
+
+    delegate :build_dir, :type_dir, :type, to: :mod
 
     attr_reader :mod
     def initialize(mod)
       @mod = mod
     end
 
+    # Handles list of objects. Calls expansion to handle each string expansion.
     def expand(props={})
       props.each do |key, value|
-        props[key] = expand_string(value)
+        props[key] = expansion(value)
       end
       props
     end
 
+    # Handles single string
+    #
     # Replaces variables denoted by colon in front with actual values. Example:
     #
     #     :REGION/:ENV/:BUILD_DIR/terraform.tfstate
     # =>
     #     us-west-2/dev/stacks/wordpress/terraform.tfstate
     #
-    def expand_string(string)
+    def expansion(string)
       return string unless string.is_a?(String) # in case of nil
 
+      string = string.dup
       vars = string.scan(/:\w+/) # => [":ENV", ":BUILD_DIR"]
       vars.each do |var|
         string.gsub!(var, var_value(var))
       end
-      string
+      strip(string)
+    end
+
+    # remove leading and trailing common separators.
+    #
+    # This is useful for when INSTANCE is not set.
+    # Note: BUILD_DIR includes INSTANCE
+    #
+    # Examples:
+    #
+    # cache_dir:
+    #
+    #    :CACHE_ROOT/:REGION/:ENV/:BUILD_DIR/
+    #
+    # s3 backend key:
+    #
+    #    :REGION/:ENV/:BUILD_DIR/terraform.tfstate
+    #
+    # workspace:
+    #
+    #    :MOD_NAME-:ENV-:REGION-:INSTANCE
+    #
+    def strip(string)
+      string.sub(/^-+/,'').sub(/-+$/,'') # remove leading and trailing -
+            .sub(%r{/+$},'') # only remove trailing / or else /home/ec2-user => home/ec2-user
     end
 
     def var_value(name)
@@ -48,5 +78,18 @@ module Terraspace::Plugin::Expander
     def env
       Terraspace.env
     end
+
+    def type_instance
+      [type, instance].reject { |s| s.blank? }.join('-')
+    end
+
+    def instance
+      @mod.options[:instance] || ''
+    end
+    alias_method :instance_option, :instance
+
+    def cache_root
+      Terraspace.cache_root
+    end
   end
-end
+end

data/lib/terraspace/plugin/infer_provider.rb

@@ -0,0 +1,15 @@
+module Terraspace::Plugin
+  module InferProvider
+    # Examples:
+    #    TerraspacePluginAws     => aws
+    #    TerraspacePluginAzurerm => azurerm
+    #    TerraspacePluginGoogle  => google
+    #
+    # If multiple clouds used in a single Terraspace project. The TS_PROVIDER_EXPANSION env var provides a way to
+    # change it. Can possibly use config hooks to set different values based on the module being deployed:
+    # https://terraspace.cloud/docs/config/hooks/
+    def provider
+      ENV['TS_PROVIDER'] || self.class.to_s.split('::').first.sub('TerraspacePlugin','').underscore
+    end
+  end
+end

data/lib/terraspace/plugin/layer/interface.rb

@@ -0,0 +1,5 @@
+module Terraspace::Plugin::Layer
+  module Interface
+    include Terraspace::Plugin::InferProvider
+  end
+end

data/lib/terraspace/plugin/summary/interface.rb

@@ -104,6 +104,7 @@ module Terraspace::Plugin::Summary
       index = path.index(regexp)
       unless index
         logger.error "ERROR: Unable to find the #{Terraspace.env} position in the prefix"
+        logger.error "path used: #{path}"
         exit 1
       end
       env_chars = Terraspace.env.size + 1

data/lib/terraspace/seeder.rb

@@ -21,7 +21,7 @@ module Terraspace
       elsif exist?("variables.tf.json")
         JSON.load(read("variables.tf.json"))
       else
-        logger.warn "WARN: no variables.tf or variables.tf.json found in: #{@mod.cache_build_dir}"
+        logger.warn "WARN: no variables.tf or variables.tf.json found in: #{@mod.cache_dir}"
         ENV['TS_TEST'] ? raise : exit
       end
     end
@@ -30,7 +30,7 @@ module Terraspace
     def load_hcl_variables
       HclParser.load(read("variables.tf"))
     rescue Racc::ParseError => e
-      logger.error "ERROR: Unable to parse the #{Util.pretty_path(@mod.cache_build_dir)}/variables.tf file".color(:red)
+      logger.error "ERROR: Unable to parse the #{Util.pretty_path(@mod.cache_dir)}/variables.tf file".color(:red)
       logger.error "and generate the starter tfvars file. This is probably due to a complex variable type."
       logger.error "#{e.class}: #{e.message}"
       puts
@@ -48,12 +48,12 @@ module Terraspace
     memoize :dest_path
 
     def exist?(file)
-      path = "#{@mod.cache_build_dir}/#{file}"
+      path = "#{@mod.cache_dir}/#{file}"
       File.exist?(path)
     end
 
     def read(file)
-      path = "#{@mod.cache_build_dir}/#{file}"
+      path = "#{@mod.cache_dir}/#{file}"
       logger.info "Reading: #{Util.pretty_path(path)}"
       IO.read(path)
     end

data/lib/terraspace/terraform/api.rb

@@ -0,0 +1,58 @@
+module Terraspace::Terraform
+  class Api
+    extend Memoist
+    include Client
+    include Terraspace::Util::Logging
+
+    def initialize(mod, remote)
+      @mod = mod
+      @organization = remote['organization']
+      @workspace_name = remote['workspaces']['name']
+    end
+
+    # Docs: https://www.terraform.io/docs/cloud/api/workspaces.html
+    def set_working_dir
+      return if working_directory == workspace['attributes']['working-directory']
+
+      payload = {
+        data: {
+          attributes: {
+            "working-directory": working_directory
+          },
+          type: "workspaces"
+        }
+      }
+      http.patch("organizations/#{@organization}/workspaces/#{@workspace_name}", payload)
+    end
+
+    def working_directory
+      cache_dir = @mod.cache_dir.sub("#{Terraspace.root}/", '')
+      relative_root = Terraspace.config.cloud.relative_root # prepended to TFC Working Directory
+      relative_root ? "#{relative_root}/#{cache_dir}" : cache_dir
+    end
+
+    def set_env_vars
+      Vars.new(@mod, workspace).run
+    end
+
+    def workspace(options={})
+      payload = http.get("organizations/#{@organization}/workspaces/#{@workspace_name}")
+      # Note only way to get here is to bypass init. Example:
+      #
+      #     terraspace up demo --no-init
+      #
+      unless payload || options[:exit_on_fail] == false
+        logger.error "ERROR: Unable to find the workspace. The workspace may not exist. Or the Terraform token may be invalid. Please double check your Terraform token.".color(:red)
+        exit 1
+      end
+      return unless payload
+      payload['data']
+    end
+    memoize :workspace
+
+    def destroy_workspace
+      # resp payload from delete operation is nil
+      http.delete("/organizations/#{@organization}/workspaces/#{@workspace_name}")
+    end
+  end
+end