terraspace 0.2.4 → 0.3.4

data/lib/terraspace/cli/help/new/project.md

@@ -0,0 +1,40 @@
+## Example
+
+    $ terraspace new project infra --plugin aws --examples
+    => Creating new project called infra.
+          create  infra
+          create  infra/.gitignore
+          create  infra/Gemfile
+          create  infra/README.md
+          create  infra/Terrafile
+          create  infra/config/app.rb
+           exist  infra
+          create  infra/config/terraform/backend.tf
+          create  infra/config/terraform/provider.tf
+    => Creating test for new module: example
+          create  infra/app/modules/example
+          create  infra/app/modules/example/main.tf
+          create  infra/app/modules/example/outputs.tf
+          create  infra/app/modules/example/variables.tf
+    => Creating new stack called demo.
+          create  infra/app/stacks/demo
+          create  infra/app/stacks/demo/main.tf
+          create  infra/app/stacks/demo/outputs.tf
+          create  infra/app/stacks/demo/variables.tf
+    => Creating test bootstrap structure
+           exist  infra
+          create  infra/.rspec
+          create  infra/spec/spec_helper.rb
+    => Installing dependencies with: bundle install
+    Bundle complete! 3 Gemfile dependencies, 88 gems now installed.
+    Use `bundle info [gemname]` to see where a bundled gem is installed.
+    ================================================================
+    Congrats! You have successfully created a terraspace project.
+    Check out the created files. Adjust to the examples and then deploy with:
+
+        cd infra
+        terraspace up demo -y   # to deploy
+        terraspace down demo -y # to destroy
+
+    More info: https://terraspace.cloud/
+    $

data/lib/terraspace/cli/help/new/project_test.md

@@ -0,0 +1,8 @@
+## Example
+
+    $ terraspace new project_test demo
+    => Creating project test: demo
+           exist
+          create  spec/fixtures/tfvars/demo.tfvars
+          create  spec/stacks/demo/main_spec.rb
+    $

data/lib/terraspace/cli/help/new/shim.md

@@ -0,0 +1,21 @@
+## Example
+
+    $ terraspace new shim
+    A terraspace shim as been generated at /usr/local/bin/terraspace
+    Please make sure that it is found in the $PATH.
+
+    You can double check with:
+
+        which terraspace
+
+    You should see
+
+        $ which terraspace
+        /usr/local/bin/terraspace
+
+    If you do not, please add /usr/local/bin to your PATH.
+    You can usually do so by adding this line to ~/.bash_profile and opening a new terminal to check.
+
+        export PATH=/usr/local/bin:/$PATH
+
+    $

data/lib/terraspace/cli/help/new/stack.md

@@ -0,0 +1,9 @@
+## Example
+
+    $ terraspace new stack demo
+    => Creating new stack called demo.
+          create  app/stacks/demo
+          create  app/stacks/demo/main.tf
+          create  app/stacks/demo/outputs.tf
+          create  app/stacks/demo/variables.tf
+    $

data/lib/terraspace/cli/help/output.md

@@ -0,0 +1,6 @@
+## Example
+
+    $ terraspace output demo
+    => terraform output
+    bucket_name = bucket-fond-sheep
+    $

data/lib/terraspace/cli/help/plan.md

@@ -0,0 +1,29 @@
+## Example
+
+    $ terraspace plan demo
+    => terraform plan
+    Refreshing Terraform state in-memory prior to plan...
+    The refreshed state will be used to calculate this plan, but will not be
+    persisted to local or remote state storage.
+
+    random_pet.this: Refreshing state... [id=fond-sheep]
+    module.bucket.aws_s3_bucket.this: Refreshing state... [id=bucket-fond-sheep]
+
+    ------------------------------------------------------------------------
+
+    An execution plan has been generated and is shown below.
+    Resource actions are indicated with the following symbols:
+    -/+ destroy and then create replacement
+    ...
+    Plan: 2 to add, 0 to change, 2 to destroy.
+
+    Changes to Outputs:
+      ~ bucket_name = "bucket-fond-sheep" -> (known after apply)
+
+    ------------------------------------------------------------------------
+
+    Note: You didn't specify an "-out" parameter to save this plan, so Terraform
+    can't guarantee that exactly these actions will be performed if
+    "terraform apply" is subsequently run.
+
+    $

data/lib/terraspace/cli/help/providers.md

@@ -0,0 +1,18 @@
+## Example
+
+    $ terraspace providers demo
+    => terraform providers
+
+    Providers required by configuration:
+    .
+    ├── provider[registry.terraform.io/hashicorp/random]
+    └── module.bucket
+        └── provider[registry.terraform.io/hashicorp/aws]
+
+    Providers required by state:
+
+        provider[registry.terraform.io/hashicorp/aws]
+
+        provider[registry.terraform.io/hashicorp/random]
+
+    $

data/lib/terraspace/cli/help/refresh.md

@@ -0,0 +1,11 @@
+## Example
+
+    $ terraspace refresh demo
+    => terraform refresh
+    random_pet.this: Refreshing state... [id=fond-sheep]
+    module.bucket.aws_s3_bucket.this: Refreshing state... [id=bucket-fond-sheep]
+
+    Outputs:
+
+    bucket_name = bucket-fond-sheep
+    $

data/lib/terraspace/cli/help/seed.md

@@ -0,0 +1,7 @@
+## Example
+
+    $ terraspace seed demo
+    Seeding tfvar files for demo
+    Reading: .terraspace-cache/us-west-2/dev/stacks/demo/variables.tf
+          create  app/stacks/demo/tfvars/dev.tfvars
+    $

data/lib/terraspace/cli/help/show.md

@@ -0,0 +1,36 @@
+## Example
+
+    $ terraspace show demo
+    => terraform show
+    # random_pet.this:
+    resource "random_pet" "this" {
+        id        = "fond-sheep"
+        length    = 2
+        separator = "-"
+    }
+
+    # module.bucket.aws_s3_bucket.this:
+    resource "aws_s3_bucket" "this" {
+        acl                         = "private"
+        arn                         = "arn:aws:s3:::bucket-fond-sheep"
+        bucket                      = "bucket-fond-sheep"
+        bucket_domain_name          = "bucket-fond-sheep.s3.amazonaws.com"
+        bucket_regional_domain_name = "bucket-fond-sheep.s3.us-west-2.amazonaws.com"
+        force_destroy               = false
+        hosted_zone_id              = "Z3BJ6K6RIION7M"
+        id                          = "bucket-fond-sheep"
+        region                      = "us-west-2"
+        request_payer               = "BucketOwner"
+        tags                        = {}
+
+        versioning {
+            enabled    = false
+            mfa_delete = false
+        }
+    }
+
+
+    Outputs:
+
+    bucket_name = "bucket-fond-sheep"
+    $

data/lib/terraspace/cli/help/summary.md

@@ -0,0 +1,11 @@
+## Example
+
+    $ terraspace summary
+    Summary of resources based on backend storage statefiles
+    Downloading statefiles to /tmp/terraspace/statefiles/terraform-state-111111111111-us-west-2-dev/us-west-2/dev/
+    stacks/demo/terraform.tfstate
+        random_pet this: sunny-chicken
+        aws_s3_bucket this: bucket-sunny-chicken
+    $
+
+Also, check out `terraspace all show`.

data/lib/terraspace/cli/help/test.md

@@ -0,0 +1,35 @@
+## Example
+
+Terraspace test just calls the configured test framework, by default, rspec.
+Here's an example with output cleaned up to reduce noise:
+
+    $ terraspace test
+    => rspec
+
+    main
+    Building test harness...
+    ...
+    Test harness built: /tmp/terraspace/test-harnesses/demo-harness
+    => terraspace up demo -y
+    Building .terraspace-cache/us-west-2/test/stacks/demo
+    Built in .terraspace-cache/us-west-2/test/stacks/demo
+    Current directory: .terraspace-cache/us-west-2/test/stacks/demo
+    => terraform init -get >> /tmp/terraspace/log/init/demo.log
+    => terraform plan -out /tmp/terraspace/plans/demo-20200920160313.plan
+    ...
+    => terraform apply -auto-approve  /tmp/terraspace/plans/demo-20200920160313.plan
+    ...
+    => terraform destroy -auto-approve
+    random_pet.this: Refreshing state... [id=hopelessly-outgoing-serval]
+    module.bucket.aws_s3_bucket.this: Refreshing state... [id=bucket-hopelessly-outgoing-serval]
+    module.bucket.aws_s3_bucket.this: Destroying... [id=bucket-hopelessly-outgoing-serval]
+    module.bucket.aws_s3_bucket.this: Destruction complete after 0s
+    random_pet.this: Destroying... [id=hopelessly-outgoing-serval]
+    random_pet.this: Destruction complete after 0s
+
+    Destroy complete! Resources: 2 destroyed.
+    Time took: 5s
+
+    Finished in 22.08 seconds (files took 0.48602 seconds to load)
+    1 example, 0 failures
+    $

data/lib/terraspace/cli/help/up.md

@@ -0,0 +1,30 @@
+## Example
+
+    $ terraspace up demo
+    Building .terraspace-cache/us-west-2/dev/stacks/demo
+    Built in .terraspace-cache/us-west-2/dev/stacks/demo
+    Current directory: .terraspace-cache/us-west-2/dev/stacks/demo
+    => terraform apply
+    ...
+    Plan: 2 to add, 0 to change, 0 to destroy.
+
+    Changes to Outputs:
+      + bucket_name = (known after apply)
+
+    Do you want to perform these actions?
+      Terraform will perform the actions described above.
+      Only 'yes' will be accepted to approve.
+      Enter a value: yes
+
+    random_pet.this: Creating...
+    random_pet.this: Creation complete after 0s [id=trusty-marmoset]
+    module.bucket.aws_s3_bucket.this: Creating...
+    module.bucket.aws_s3_bucket.this: Creation complete after 2s [id=bucket-trusty-marmoset]
+
+    Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
+
+    Outputs:
+
+    bucket_name = bucket-trusty-marmoset
+    Time took: 39s
+    $

data/lib/terraspace/cli/help/validate.md

@@ -0,0 +1,9 @@
+## Example
+
+    $ terraspace validate demo
+    Building .terraspace-cache/us-west-2/dev/stacks/demo
+    Built in .terraspace-cache/us-west-2/dev/stacks/demo
+    Current directory: .terraspace-cache/us-west-2/dev/stacks/demo
+    => terraform validate
+    Success! The configuration is valid.
+    $

data/lib/terraspace/cli/info.rb

@@ -3,26 +3,14 @@ class Terraspace::CLI
     extend Memoist
 
     def run
-      format = @options[:format] || "text"
-      send("#{format}_output")
-    end
-
-    def json_output
-      puts JSON.pretty_generate(info)
-    end
-
-    def text_output
+      presenter = CliFormat::Presenter.new(@options)
+      presenter.header = %w[Name Value]
       info.each do |k,v|
-        k = "%-#{rpad}s" % k
-        puts "#{k} #{v}"
+        presenter.rows << [k, v]
       end
+      presenter.show
     end
 
-    def rpad
-      info.keys.map(&:size).max
-    end
-    memoize :rpad
-
     def info
       @mod.to_info
     end

data/lib/terraspace/cli/init.rb

@@ -10,13 +10,14 @@ class Terraspace::CLI
     end
 
     def run
-      init if init?
-      build_remote_dependencies # runs after terraform init, which downloads remote modules
+      init
+      # build_remote_dependencies # runs after terraform init, which downloads remote modules
       sync_cloud
     end
 
     # Note the init will always create the Terraform Cloud Workspace
     def init
+      return unless run_init? # check here because RemoteState::Fetcher#pull calls init directly
       # default init timeout is pretty generous in case of slow internet to download the provider plugins
       init_timeout = Integer(ENV['TS_INIT_TIMEOUT'] || 600)
       Timeout::timeout(init_timeout) do
@@ -28,7 +29,7 @@ class Terraspace::CLI
     end
 
     def sync_cloud
-      Terraspace::Terraform::Cloud.new(@options).run if %w[apply plan destroy cloud-setup].include?(@calling_command)
+      Terraspace::Terraform::Cloud::Sync.new(@options).run if %w[apply plan destroy cloud-setup].include?(@calling_command)
     end
 
     # Currently only handles remote modules only one-level deep.
@@ -47,8 +48,8 @@ class Terraspace::CLI
       return if local_source?(meta["Source"])
       return if meta['Dir'] == '.' # root is already built
 
-      remote_mod = Mod::Remote.new(meta, @mod)
-      Compiler::Builder.new(remote_mod).build
+      remote_mod = Terraspace::Mod::Remote.new(meta, @mod)
+      Terraspace::Compiler::Builder.new(remote_mod).build
     end
 
     def auto?
@@ -60,8 +61,35 @@ class Terraspace::CLI
        s =~ %r{^\.} || s =~ %r{^/}
     end
 
-    def init?
-      %w[apply console destroy output plan providers refresh show validate cloud-setup].include?(@calling_command)
+    def run_init?
+      commands = %w[apply console destroy output plan providers refresh show validate cloud-setup]
+      return false unless commands.include?(@calling_command)
+      mode = ENV['TS_INIT_MODE'] || Terraspace.config.init.mode
+      case mode.to_sym
+      when :auto
+        !already_initialized?
+      when :always
+        true
+      when :never
+        false
+      end
+    end
+
+    # Would like to improve this detection
+    #
+    # Traverse symlink dirs also: linux_amd64 is a symlink
+    #   plugins/registry.terraform.io/hashicorp/google/3.39.0/linux_amd64/terraform-provider-google_v3.39.0_x5
+    #
+    # Check modules/modules.json also because during the tfvars dependency pass main.tf modules are not built.
+    # So init happens again during the second pass.
+    #
+    def already_initialized?
+      terraform = "#{@mod.cache_dir}/.terraform"
+      provider = Dir.glob("#{terraform}/**{,/*/**}/*").find do |path|
+        path.include?("terraform-provider-")
+      end
+      modules = File.exist?("#{terraform}/modules/modules.json")
+      !!(provider && modules)
     end
   end
 end

data/lib/terraspace/cli/list.rb

@@ -2,11 +2,24 @@ class Terraspace::CLI
   class List
     def initialize(options={})
       @options = options
+      @type_dir = normalized_type
     end
 
     def run
       Dir.glob("{app,vendor}/{modules,stacks}/*").sort.each do |path|
-        puts path
+        if @type_dir
+          puts path if path.include?("/#{@type_dir}/")
+        else
+          puts path
+        end
+      end
+    end
+
+  private
+    def normalized_type
+      type = @options[:type]
+      if %w[stack module].include?(type)
+        type.pluralize
       end
     end
   end

data/lib/terraspace/cli/log.rb

@@ -0,0 +1,112 @@
+require "eventmachine"
+require "eventmachine-tail"
+
+class Terraspace::CLI
+  class Log < Base
+    include Log::Concern
+
+    def initialize(options={})
+      super
+      @action, @stack = options[:action], options[:stack]
+      @action ||= '**'
+      @stack  ||= '*'
+    end
+
+    def run
+      check_logs!
+      if @options[:follow]
+        follow_logs
+      else
+        all_log_paths.each { |path| show_log(path) }
+      end
+    end
+
+    def follow_logs
+      glob_path = "#{Terraspace.log_root}/#{@action}/#{@stack}.log"
+      Dir.glob(glob_path).each do |path|
+        puts "Following #{pretty(path)}".color(:purple)
+      end
+      EventMachine.run do
+        interval = Integer(ENV['TS_LOG_GLOB_INTERNAL'] || 1)
+        EventMachine::FileGlobWatchTail.new(glob_path, nil, interval) do |filetail, line|
+          puts line # always show timestamp in follow mode
+        end
+      end
+    end
+
+    def show_log(path)
+      report_log(path)
+      lines = readlines(path)
+      lines = apply_limit(lines)
+      lines.each do |line|
+        puts format(line)
+      end
+    end
+
+    def report_log(path)
+      pretty_path = pretty(path)
+      if File.exist?(path)
+        puts "Showing: #{pretty_path}".color(:purple)
+      end
+    end
+
+    def format(line)
+      if timestamps
+        line
+      else
+        line.sub(/.*\]: /,'')
+      end
+    end
+
+    def all_log_paths
+      Dir.glob("#{Terraspace.log_root}/#{@action}/#{@stack}.log")
+    end
+
+    def check_logs!
+      return unless all_log_paths.empty?
+      puts "WARN: No logs found".color(:yellow)
+    end
+
+    # Only need to check if both action and stack are provided. Otherwise the Dir.globs are used to discover the files
+    def check_log!
+      return unless single_log?
+      path = "#{Terraspace.log_root}/#{@action}/#{@stack}.log"
+      return if File.exist?(path)
+      puts "ERROR: Log file was not found: #{pretty(path)}".color(:red)
+      exit 1
+    end
+
+    def single_log?
+      @action != '**' && @stack != '*'
+    end
+
+    def apply_limit(lines)
+      return lines if all
+      left = limit * -1
+      lines[left..-1] || []
+    end
+
+    def all
+      if single_log?
+        @options[:all].nil? ? true : @options[:all]
+      else # multiple
+        @options[:all].nil? ? false : @options[:all]
+      end
+    end
+
+    def limit
+      @options[:limit].nil? ? 10 : @options[:limit]
+    end
+
+    def timestamps
+      if single_log?
+        @options[:timestamps].nil? ? false : @options[:timestamps]
+      else
+        @options[:timestamps].nil? ? true : @options[:timestamps]
+      end
+    end
+    def pretty(path)
+      Terraspace::Util.pretty_path(path)
+    end
+  end
+end