terradactyl 0.13.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d021330dd8abb5ec42bff25987aba0388ed7879364141a3597ad8c7df890633b
+  data.tar.gz: ec0e8a4c9d6716b43c49b96a163cefffefa7c616668f7bb4522df4b284ae3917
+SHA512:
+  metadata.gz: 010b919b8f831b6ead77629ce1a94d6afbcc8a37ee5e6ec7c543474e79da0662a7a19144cb969e2b02ebeaa569486195155f4cbdae721b333e8dd0a4e9ffa41c
+  data.tar.gz: a9863ff1d88e0bdc8e7ccb897b54206dde56d8355f85f4bf07bbaf5c7326dcee1a480dc9f0502f20413afe95917f22ff11c4e2fed0c234530d73946b34d7653b

data/.github/workflows/build-and-release.yml

@@ -0,0 +1,58 @@
+name: Build and Release
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - lib/terradactyl/version.rb
+
+# Using the Ruby teams https://github.com/ruby/setup-ruby, not the Github
+# team's https://github.com/actions/setup-ruby
+
+jobs:
+  release:
+    env:
+      GEM_NAME: terradactyl
+      VERSION_FILE: lib/terradactyl/version.rb
+      CHANGELOG: CHANGELOG.md
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      GEM_HOST_API_KEY: ${{ secrets.VCILABS_GEM_HOST_API_KEY }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Build Gem
+        id: build
+        run: |
+          RELEASE_VERSION=$(grep VERSION ${VERSION_FILE} | tr -d "VERSION= \'")
+          RELEASE_BODY_PATH=body.md
+          echo RELEASE_VERSION=${RELEASE_VERSION}     >> $GITHUB_ENV
+          echo RELEASE_BODY_PATH=${RELEASE_BODY_PATH} >> $GITHUB_ENV
+          sed -ne "/## ${RELEASE_VERSION}.*/,/#/p" ${CHANGELOG} | sed -e '$d' > $RELEASE_BODY_PATH
+          gem build
+      - name: Create Release
+        id: release
+        uses: actions/create-release@v1
+        with:
+          tag_name: v${{ env.RELEASE_VERSION }}
+          release_name: v${{ env.RELEASE_VERSION }}
+          body_path: ${{ env.RELEASE_BODY_PATH }}
+          draft: false
+          prerelease: false
+      - name: Upload Asset
+        id: asset
+        uses: actions/upload-release-asset@v1
+        with:
+          upload_url: ${{ steps.release.outputs.upload_url }}
+          asset_path: ${{ env.GEM_NAME }}-${{ env.RELEASE_VERSION}}.gem
+          asset_name: ${{ env.GEM_NAME }}-${{ env.RELEASE_VERSION}}.gem
+          asset_content_type: application/x-tar
+      - name: Publish Gem
+        id: publish
+        run: gem push ${{ env.GEM_NAME }}-${{ env.RELEASE_VERSION}}.gem

data/.github/workflows/build-status.yml

@@ -0,0 +1,26 @@
+name: Build Status
+
+on:
+  push:
+    branches:
+      - main
+
+# Using the Ruby teams https://github.com/ruby/setup-ruby, not the Github
+# team's https://github.com/actions/setup-ruby
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git clone
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Run tests
+        id: test
+        run: bundle exec rake spec

data/.github/workflows/validate-pullrequest.yml

@@ -0,0 +1,29 @@
+name: Validate Pull Request
+
+on:
+  pull_request:
+    paths:
+      - '**.rb'
+
+# Using the Ruby teams https://github.com/ruby/setup-ruby, not the Github
+# team's https://github.com/actions/setup-ruby
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git clone
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Run lint
+        id: lint
+        run: bundle exec rake lint
+      - name: Run tests
+        id: test
+        run: bundle exec rake spec

data/.gitignore

@@ -0,0 +1,18 @@
+Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor
+
+# rspec failure tracking
+.rspec_status
+
+# terraform/terradactyl specific
+.terraform
+*.tfstate*
+*.audit.json

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.5
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100
+Metrics/MethodLength:
+  Max: 20
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/ClassLength:
+  Max: 115
+Naming/UncommunicativeMethodParamName:
+  MinNameLength: 2
+Style/IfUnlessModifier:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,244 @@
+# CHANGELOG
+
+## 0.13.0 (2020-11-26)
+
+NEW FEATURES:
+
+* update Gem version string to match supported Terraform revision
+* adds support for Terraform version 0.13.x
+* adds implicit Terraform version management
+  - (i.e. pessimistic operator, ~> 0.12.1)
+* adds `defaults` sub-command
+
+BUG FIXES:
+
+* remove poor and non-critical defaults
+* add CHANGELOG, LICENSE
+* update README and provide examples
+* fix/refactor/re-org tests and
+
+## 0.11.0 (2019-09-12)
+
+NEW FEATURES:
+
+* overhaul Terradactyl::Commands
+  - create dynamic Module mix-in for Stack
+  - ensure command revision module prepends Commands
+* overhaul Stack#plan and related code to use new Terraform::PlanFile class
+
+## 0.10.0 (2019-09-06)
+
+NEW FEATURES:
+
+* update to work with `terradactyl-terraform`, `0.3.1`
+* trap SIGINT to quell stack dumps on ^C
+* hyphenate meta-subcommands, like `clean-all`
+* add CLI subcommands `validate` and `validate-all`
+* modularize Terraform subcommands by revision
+  - add Terradactyl::Commands and revision sub-modules
+  - add spec tests for both major revs
+* refactor method decoration routine
+
+## 0.9.2 (2019-09-06)
+
+BUG FIXES:
+
+* update Filter classes
+  - ensure all git-related ops are performed on relative path
+  - conform the default class by giving it a `git_cmd`
+* update Stack
+  - allow `decorate_cmds` to handle method args
+  - make `validate_stack_name` err msg more generic
+* make Stacks target filter accessible via ivar
+
+## 0.9.1 (2019-09-05)
+
+BUG FIXES:
+
+* add Stack#validation and Stack#checklist
+* update Stack filter classes with names and descriptions
+
+## 0.9.0 (2019-09-03)
+
+NEW FEATURES:
+
+* update to work with supporting gem (`terradactyl-terraform`, `0.3.0`)
+  - implement autoinstall (removed from supporting gem)
+  - fix some spec tests
+* refactor `Stack` command methods; DRY code
+* cleanup some Rubocop violations
+
+## 0.8.1 (2019-07-26)
+
+BUG FIXES:
+
+* rename method `has_plan?` to `planned?`
+* add method: `plan_file_obj`; refactor plan file related methods
+* refactor `common` and `config`
+  - factor out early config loading for `String.disable_colorization`
+  - fixes load failure when requiring the gem
+* fix & refactor `Stack` and `Stacks` validation
+  - fix bug when `td audit` is passed a stack path
+  - move the path to stack name conversion into `Stacks.validate`
+
+## 0.8.0 (2019-07-19)
+
+NEW FEATURES:
+
+* jettison code that migrated to `terradactyl-terraform` gem
+* make `terradactyl-terraform` a dependency
+
+## 0.6.1 (2019-03-12)
+
+BUG FIXES:
+
+* we can't parse "JSON-like" templates because they contain bare tokens
+* rescue `JSON::ParserError` on misidentified blobs in `TerraformPlan#normalize_line`
+
+## 0.6.0 (2019-03-04)
+
+NEW FEATURES:
+
+* re-organize terraform related code into component files
+* add Gemfile.lock to .gitignore
+
+## 0.5.9 (2019-02-05)
+
+NEW FEATURES:
+
+* add report feature to `auditall`
+
+## 0.5.8 (2019-02-04)
+
+BUG FIXES:
+
+* re-classify stacks that error as errors, not dirty
+* only abort on errors, not dirty stacks
+
+## 0.5.7 (2019-01-31)
+
+BUG FIXES:
+
+* mark stacks as `dirty` on error or changed
+* remove early exits (abort); throw `:error` as required
+* add `at_exit` handler to catch dirty/error stacks
+* new feature: support relative path to stack (tab-complete friendly), example: `td quickplan global/my-stack`
+* add validation routine to stack names; better error message
+* fix documentation
+
+## 0.5.6 (2019-01-18)
+
+BUG FIXES:
+
+* change bundler pin posture to `>=`
+
+## 0.5.5 (2018-07-09)
+
+BUG FIXES:
+
+* cosmetic: replace bold markdown with h4 header; better viz in Slack
+
+## 0.5.4 (2018-07-05)
+
+BUG FIXES:
+
+* fix erroneous audit reporting
+
+## 0.5.3 (2018-07-05)
+
+BUG FIXES:
+
+* fix CLI#auditall, rescue individual abort from CLI#audit
+* update README
+
+## 0.5.2 (2018-07-04)
+
+BUG FIXES:
+
+* fix Stack#execute, full IO buffer bug
+
+## 0.5.1 (2018-06-30)
+
+BUG FIXES:
+
+* add base_folder attribute to TerraformPlan class
+* fix JSON normalization routine in TerraformPlan class
+  - was not handling lines that contained a mix of JSON blobs and regular Strings
+  - refine the regex to add plain string handling
+
+## 0.5.0 (2018-06-24)
+
+NEW FEATURES:
+
+* abandon Rake tasks as an interface
+* replace with Thor CLI
+* add `quickplan[NAME]` meta-task, per `terraenv`
+
+## 0.4.1 (2018-06-18)
+
+BUG FIXES:
+
+* don't abort on empty Stacks for terradactyl:smartplan, just warn
+
+## 0.4.0 (2018-06-18)
+
+NEW FEATURES:
+
+* permit cub-commands to be individually configured
+* make state locking a per-operation config
+
+## 0.3.9 (2018-06-18)
+
+BUG FIXES:
+
+* do not lock state during an init operation
+
+## 0.3.8 (2018-06-18)
+
+BUG FIXES:
+
+* fix JSON unescape operation
+
+## 0.3.7 (2018-06-16)
+
+BUG FIXES:
+
+* fix condition inversion
+
+## 0.3.6 (2018-06-16)
+
+BUG FIXES:
+
+* fix Git diff filters stack_name extrapolation
+
+## 0.3.5 (2018-06-16)
+
+NEW FEATURES:
+
+* add plan filter: StackPlanFilterDiffOriginBranch
+* use new filter in PR planning operations
+
+## 0.3.4 (2018-06-16)
+
+BUG FIXES:
+
+* fix missing dependency
+* flag plan object as modified when there are changes
+
+## 0.3.3 (2018-06-15)
+
+BUG FIXES:
+
+* do not lock state during a plan operation
+
+## 0.3.2 (2018-06-14)
+
+BUG FIXES:
+
+* add JSON normalization routine to TerraformPlan class that will hopefully prevent checksum drift from plan to plan
+
+## 0.3.1 (2018-06-12)
+
+BUG FIXES:
+
+* fix missing summary condition

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in terradactyl-terraform.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2020 Alida, (Vision Critical Communications Inc.)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,325 @@
+# Terradactyl
+
+[![Gem Version](https://badge.fury.io/rb/terradactyl.svg)](https://badge.fury.io/rb/terradactyl)
+![Build Status](https://github.com/vcilabs/terradactyl/workflows/Build%20Status/badge.svg)
+
+CLI tooling for managing a Terraform monorepo.
+
+## Overview
+
+Terradactyl simplifies managing large heterogeneous Terraform monorepos by introducing hierarchical configuration and automatic management of Terraform versions on a per-stack basis.
+
+## Features
+
+* hierarchical configuration
+* automatic Terraform binary installation
+* "meta-commands" for consistent CI and development workflows
+
+## Requirements
+
+Requires Ruby 2.5 or greater.
+
+NOTE: Terraform sub-command operations are only supported between stable versions `~> 0.11.x` and `~> 0.13.x`.
+
+## Installation
+
+### Bundler
+
+Add this line to your application's Gemfile ...
+
+```ruby
+gem 'terradactyl'
+```
+
+And then execute:
+
+    $ bundle install
+
+### Manual
+
+    $ gem install terradactyl
+
+## Quick Setup
+
+Terradactyl repos rely on two simple organizational conventions:
+
+* a single project-level `terradactly.yaml`
+* a single subdirectory for your stacks
+
+```sh
+.
+├── stacks
+│   └── demo
+│       └── example.tf
+└── terradactyl.yaml
+```
+
+That's it! In fact, if you use the default subdirectory name of `stacks`, all your configuration file need contain is:
+
+```yaml
+terradactyl:
+```
+
+All other configuration, including `autoinstall` (default: `true`) are optional.
+
+When your config file and `base_folder` are setup, try executing:
+
+`terradactyl stacks` OR `td stacks`
+
+See [examples](examples) for different setups.
+
+## Quick Tutorial
+
+##### NOTE: this will require an active internet connection so that the various Terraform binaries for each individual stack may be fetched and installed in the background.
+
+#### set your working directory
+
+    $ cd examples/multi-tf-stacks
+
+#### execute terradactyl
+
+The Terradactyl CLI is installed with a symlink so it may be called by its full name or its shortened name, `td`:
+
+    $ terradactyl help
+    $ td help
+
+#### quickplan a single stack
+
+You can specify the relative path to the stack OR the just the stack name. These two commands are equivalent:
+
+    $ terradactyl quickplan tfv11
+    $ terradactyl quickplan stacks/tfv11
+
+#### apply a single stack
+
+    $ terradactyl apply stacks/tfv11
+
+#### audit and report
+
+    $ terradactyl audit-all --report
+
+When complete, you should have a JSON report that you can pass to other processes.
+
+    $ cat stacks.audit.json
+
+#### quickplan ALL stacks
+
+    $ terradactyl plan-all
+
+#### apply ANY stacks that have a plan file
+
+    $ terradactyl smartapply
+
+#### clean all the stacks
+
+    $ terradactyl clean-all
+
+NOTE: `*.tfstate*` files are not cleaned up by default for obvious reasons, so clean them up manually:
+
+`git clean -fD` OR `find . -name "*.tfstate*" --delete`
+
+See the [Configuration](#configuration) section for more info on how to control which files get removed during a `clean <stack>` or `clean-all` operation.
+
+## Operation
+
+NOTE: `terradactyl` (symlinked as `td`) ONLY operates in the root of your monorepo. In order to execute any sub-commands, your working directory must contain your project-level configuration file, otherwise you will receive this:
+
+    FATAL: Could not load project file: `terradactyl.yaml`, No such file or directory @ rb_sysopen - terradactyl.yaml
+
+### General
+
+Generally speaking, Terradactyl operates on the principle of **plan file** (`*.tfout`) generation. This can be reduced to the following tenets:
+
+1. You _MUST_ perform a `plan` operation on a stack before an `apply`
+2. You _CANNOT_ `apply` a stack that does not contain a plan file
+
+In some cases, this might seem onerous, but it pays dividends in team workflow and CI/CD contexts.
+
+### Supported sub-commands
+
+Terradactyl was created to facilitate the using Terraform in a CI environment. As such, some of the more exotic ad hoc user-focused sub-commands have not received any effort in integration. The following is a list of the supported Terraform sub-commands:
+
+* apply
+* destroy
+* fmt
+* init
+* plan
+* refresh
+* validate
+
+### Meta-commands
+
+Terradactyl provides a few useful meta-commands that can help you avoid repetitive multi-phase Terraform operations. Here are a few ...
+
+#### quickplan
+
+Clean, initialize and plan a single stack in one operation.
+
+    terradactly quickplan <stack>
+
+#### smartapply/smartrefresh
+
+Apply or Refresh _ANY_ stack containing a plan file.
+
+    terradactly smartapply <stack>
+    terradactly smartrefresh <stack>
+
+### Getting Help
+
+For a list of available sub-commands do:
+
+    $ terradactyl help
+
+For help on any individual sub-command do:
+
+    $ terradactyl help <sub-command>
+
+## Configuration
+
+As previously mentioned, configuration is hierarchical. This means you may specify:
+
+* one project-level configuration for ALL stacks
+* an overriding stack-level configuration for each independent stack
+
+See [examples](examples) for different setups.
+
+##### NOTE: all project-level configurations are valid at the stack level except `base_folder` which is ignored.
+
+You can dump the compiled configuration for your project using the `defaults` sub-command:
+
+    terradactyl defaults
+    td defaults
+
+### Descriptions
+
+```yaml
+terradactyl:              <Object, Terradactyl config>
+  base_folder:            <String, the sub-directory for all your Terraform stacks, default=stacks>
+  terraform:              <Object, configuration to Terraform sub-commands and binaries>
+    binary:               <String, path to the Terraform binary you wish to use, default=nil>
+    version:              <String, explicit or implict Terraform version, default=nil>
+    autoinstall:          <Bool, perform automatic Terraform installations, default=true>
+    install_dir:          <String, path to Terraform installations, default=$HOME/bin>
+    echo:                 <Bool, print currently executing terraform command, default=false>
+    quiet:                <Bool, suppress currently executing terraform stdout, default=true>
+    init:                 <Object, CLI options to sub-command init>
+      lock:               <Bool, lock the state file when locking is supported, default=false>
+      force_copy:         <Bool, suppress prompts about copying state data, default=true>
+    plan:                 <Object, CLI options to sub-command plan>
+      lock:               <Bool, lock the state file when locking is supported, default=false>
+      parallelism:        <Int, limit the number of concurrent operations, default=5>
+      detailed_exitcode:  <Bool, lock the state file when locking is supported, default=true>
+    apply:                <Object, CLI options to sub-command apply>
+      parallelism:        <Int, limit the number of concurrent operations, default=5>
+    refresh:              <Object, CLI options to sub-command refresh>
+      input:              <Bool, ask for input for variables if not directly set, default=false>
+    destroy:              <Object, CLI options to sub-command destroy>
+      parallelism:        <Int, limit the number of concurrent operations, default=5>
+      force:              <Bool, skip interactive approval before destroying, default=true>
+  environment:            <Object, shell environment variables>
+    TF_PLUGIN_CACHE_DIR:  <String, path to common Terraform plugin directory, default=$HOME/.terraform.d/plugins>
+  misc:                   <Object, misc Terradactyl settings>
+    utf8:                 <Bool, use utf8 in stdout, default=true>
+    disable_color:        <Bool, disable color in stdout, default=false>
+  cleanup:                <Object, Terradactyl cleanup settings>
+    empty:                <Bool, remove empty directories, default=true>
+    match:                <Array, list of shell globs to match, default=["*.tfout", "*.tflock", "*.zip", ".terraform"]>
+```
+
+### Terraform sub-command arguments
+
+Note that the config above contains config for Terraform sub-commands. for example:
+
+```yaml
+terradactyl:
+  terraform:
+    plan:
+      lock: false
+      parallelism: 5
+      detailed_exitcode: true
+```
+
+Each of the keys in the `plan` object correspond to an argument passed to the `terraform` binary. For example, the config above would equate to ...
+
+    terraform -lock=false -parallelism=5 -detailed-exitcode
+
+There are two conventions to keep in mind when configuring sub-commands:
+
+1. any sub-command option which toggles behaviour (i.e. `-detailed-exitcode`) requires a specific Boolean value of `true` OR `false`
+2. any sub-command option that is hyphenated (i.e. `-detailed-exitcode`) is set in the config using an **underscore** (i.e `detailed_exitcode`)
+
+If you need to tweak or augment any of the default arguments passed to any of the supported Terraform sub-commands, you can do so by adding them to the config.
+
+Example:
+
+```yaml
+terradactyl:
+  terraform:
+    refresh:
+      lock: false
+      backup: /tmp/tfbackup
+```
+
+In addition, you can override the `echo` and `quiet` settings for any of the Terraform sub-commands:
+
+```yaml
+terradactyl:
+  terraform:
+    echo: false
+    quiet: true
+    apply:
+      echo: true
+      quiet: false
+    destroy:
+      echo: true
+      quiet: false
+```
+
+This can assist in debugging.
+
+### Terraform version management
+
+#### Explicit versions
+
+By default, Terradactyl will always use the **latest** stable version of Terraform. If you do not specify a version, you will always get the latest stable version of Terraform available.
+
+But, as part of Terradactyl's configuration, you can specify a **project** Terraform version, making it the default for _your_ monorepo:
+
+```yaml
+terradactyl:
+  terraform:
+    version: 0.12.29
+```
+
+Still, because Terradactyl's configuration is hierarchic, in addition the default version you specify at the project level, **each stack** may also specify a different version of Terraform.
+
+See [examples/multi-tf-version](examples/multi-tf-version) for this setup.
+
+#### Implicit versions
+
+Also, there is no need to pin a project or a stack to an explicit version. Instead, you can use a pessimistic operator to ensure you always have the most up-to-date version of a minor Terraform revision.
+
+Example:
+
+```yaml
+terradactyl:
+  terraform:
+    version: ~> 0.13.5
+```
+
+That way, when the next Terraform `0.13` is released, you can begin using it immediately, but you will never have to worry about upgrading to `0.14` unsuspectingly.
+
+In fact, there are a number of ways to express implicit versions ...
+
+    ~> 0.11.14
+    ~> 0.11
+    >= 0.12
+    < 0.12
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vcilabs/terradactyl.
+
+## License
+
+This code is released under the MIT License. See [LICENSE.txt](LICENSE.txt).