terraspace 0.3.3 → 0.3.4

data/lib/terraspace/cli/help/logs/truncate.md

@@ -0,0 +1,5 @@
+## Example
+
+    $ terraspace logs truncate
+    Truncating log files in log/
+    $

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

@@ -0,0 +1,8 @@
+## Example
+
+    $ terraspace new bootstrap_test
+    => Creating test bootstrap structure
+           exist
+          create  .rspec
+          create  spec/spec_helper.rb
+    $

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

@@ -0,0 +1,8 @@
+## Example
+
+    => Creating test for new module: example
+          create  app/modules/example
+          create  app/modules/example/main.tf
+          create  app/modules/example/outputs.tf
+          create  app/modules/example/variables.tf
+    $

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

@@ -0,0 +1,6 @@
+## Example
+
+    $ terraspace new git_hook
+          create  .git/hooks/pre-push
+           chmod  .git/hooks/pre-push
+    $

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

@@ -0,0 +1,9 @@
+## Example
+
+    $ terraspace new module example
+    => Creating test for new module: example
+          create  app/modules/example
+          create  app/modules/example/main.tf
+          create  app/modules/example/outputs.tf
+          create  app/modules/example/variables.tf
+    $

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

@@ -0,0 +1,12 @@
+## Example
+
+    $ terraspace new module_test example
+    => Creating module test: example
+           exist  app/modules/example
+          create  app/modules/example/test/.rspec
+          create  app/modules/example/test/Gemfile
+          create  app/modules/example/test/spec/fixtures/stack/main.tf
+          create  app/modules/example/test/spec/fixtures/stack/outputs.tf
+          create  app/modules/example/test/spec/main_spec.rb
+          create  app/modules/example/test/spec/spec_helper.rb
+    $

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

@@ -0,0 +1,49 @@
+## Example
+
+    $ terraspace new plugin mycloud
+    => Creating new plugin: mycloud
+          create  terraspace_plugin_mycloud
+          create  terraspace_plugin_mycloud/.gitignore
+          create  terraspace_plugin_mycloud/.rspec
+          create  terraspace_plugin_mycloud/CHANGELOG.md
+          create  terraspace_plugin_mycloud/Gemfile
+          create  terraspace_plugin_mycloud/LICENSE.txt
+          create  terraspace_plugin_mycloud/README.md
+          create  terraspace_plugin_mycloud/Rakefile
+          create  terraspace_plugin_mycloud/bin/console
+          create  terraspace_plugin_mycloud/bin/setup
+          create  terraspace_plugin_mycloud/lib/templates/hcl/module/main.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/module/outputs.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/module/variables.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/project/config/terraform/backend.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/project/config/terraform/provider.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/stack/main.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/stack/outputs.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/stack/variables.tf
+          create  terraspace_plugin_mycloud/lib/templates/ruby/module/main.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/module/outputs.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/module/variables.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/project/config/terraform/backend.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/project/config/terraform/provider.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/stack/main.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/stack/outputs.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/stack/variables.rb
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/.rspec
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/Gemfile
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/fixtures/stack/main.tf
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/fixtures/stack/outputs.tf
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/fixtures/stack/variables.tf
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/main_spec.rb
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/spec_helper.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/autoloader.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/clients.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/interfaces/backend.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/interfaces/config.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/interfaces/expander.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/interfaces/layer.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/version.rb
+          create  terraspace_plugin_mycloud/spec/spec_helper.rb
+          create  terraspace_plugin_mycloud/spec/terraspace_provider_mycloud_spec.rb
+          create  terraspace_plugin_mycloud/terraspace_plugin_mycloud.gemspec
+    $

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/logs.rb

@@ -1,6 +1,6 @@
 class Terraspace::CLI
   class Logs < Terraspace::Command
-    desc "truncate", "Truncates logs. IE: Removes contents and zero bytes the files"
+    desc "truncate", "Truncates logs. IE: Keeps the files but removes contents and zero bytes the files."
     long_desc Help.text("logs/truncate")
     def truncate
       Tasks.new(options).truncate

data/lib/terraspace/cli/new.rb

@@ -1,40 +1,40 @@
 class Terraspace::CLI
   class New < Terraspace::Command
-    long_desc Help.text(:git_hook)
+    long_desc Help.text("new/git_hook")
     GitHook.cli_options.each { |args| option(*args) }
-    register(GitHook, "git_hook", "git_hook", "Generates new git hook")
+    register(GitHook, "git_hook", "git_hook", "Generates new git hook.")
 
-    long_desc Help.text(:shim)
+    long_desc Help.text("new/shim")
     Shim.cli_options.each { |args| option(*args) }
-    register(Shim, "shim", "shim", "Generates terraspace shim")
+    register(Shim, "shim", "shim", "Generates terraspace shim.")
 
-    long_desc Help.text(:module)
+    long_desc Help.text("new/module")
     Module.base_options.each { |args| option(*args) }
     Module.component_options.each { |args| option(*args) }
-    register(Module, "module", "module NAME", "Generates new module")
+    register(Module, "module", "module NAME", "Generates new module.")
 
-    long_desc Help.text(:stack)
+    long_desc Help.text("new/stack")
     Stack.base_options.each { |args| option(*args) }
     Stack.component_options.each { |args| option(*args) }
-    register(Stack, "stack", "stack NAME", "Generates new stack")
+    register(Stack, "stack", "stack NAME", "Generates new stack.")
 
-    long_desc Help.text(:project)
+    long_desc Help.text("new/project")
     Project.base_options.each { |args| option(*args) }
     Project.project_options.each { |args| option(*args) }
-    register(Project, "project", "project NAME", "Generates new project")
+    register(Project, "project", "project NAME", "Generates new project.")
 
-    long_desc Help.text(:project_test)
-    register(Test::Project, "project_test", "project_test NAME", "Generates new project test")
+    long_desc Help.text("new/project_test")
+    register(Test::Project, "project_test", "project_test NAME", "Generates new project test.")
 
-    long_desc Help.text(:module_test)
-    register(Test::Module, "module_test", "module_test NAME", "Generates new module test")
+    long_desc Help.text("new/module_test")
+    register(Test::Module, "module_test", "module_test NAME", "Generates new module test.")
 
-    long_desc Help.text(:bootstrap_test)
+    long_desc Help.text("new/bootstrap_test")
     Test::Bootstrap.options.each { |args| option(*args) }
-    register(Test::Bootstrap, "bootstrap_test", "bootstrap_test", "Generates bootstrap test setup")
+    register(Test::Bootstrap, "bootstrap_test", "bootstrap_test", "Generates bootstrap test setup.")
 
-    long_desc Help.text(:plugin)
+    long_desc Help.text("new/plugin")
     Plugin.options.each { |args| option(*args) }
-    register(Plugin, "plugin", "plugin", "Generates plugin")
+    register(Plugin, "plugin", "plugin", "Generates plugin.")
   end
 end