terraspace_ci_circleci 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88aa7a619627c1ffc00c3be9eb25f1ed52aef51113d614fd2a7a25537aa78f03
+  data.tar.gz: 24d73984a44ce20c180dde3ea7c0deccd00c2ae9ade255595a8a040bc42cdaad
+SHA512:
+  metadata.gz: 748151767f81f5fe0df19ebebb01f0855cb4aebdf33922dde3e8e106188cfffabe0df241c561d1a111ff9fb17a1fb0309fc4a31b0a93344ee171b3b9aa4605ea
+  data.tar.gz: aa01e0580f0e66e274cd9f57f882aa626daf42a1b0dc503031c2ed4c3d8311979eb19789c98e78103c8d5289d8fc1efdc8f8898c00898af61a9def62f29d2276

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [0.1.0] - 2022-07-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gemspec
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "rubocop"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Tung Nguyen
+
+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,25 @@
+# terraspace_ci_circleci
+
+[![Gem Version](https://badge.fury.io/rb/terraspace_ci_circleci.png)](http://badge.fury.io/rb/terraspace_ci_circleci)
+
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
+[![BoltOps Learn Badge](https://img.boltops.com/boltops-learn/boltops-learn.png)](https://learn.boltops.com)
+
+Provides Terraspace CI support for CircleCI.
+
+## Installation
+
+Add gem to your Terraspace project
+
+Gemfile
+
+    gem terraspace_ci_circleci
+
+Then to install run
+
+    bundle
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boltops-tools/terraspace_ci_circleci/

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/template/.circleci/bin/install

@@ -0,0 +1,36 @@
+#!/bin/bash
+set -eux
+# install terraform
+git clone https://github.com/tfutils/tfenv.git ~/.tfenv
+export PATH="$HOME/.tfenv/bin:$PATH"
+tfenv install latest
+tfenv use latest
+terraform --version
+type terraform # /home/circleci/.tfenv/bin/terraform
+# shim for terraform since it's since is not the .tfenv/bin
+mkdir -p /home/circleci/.local/bin
+cat << 'EOF' > /home/circleci/.local/bin/terraform
+export PATH="$HOME/.tfenv/bin:$PATH"
+exec terraform "$@"
+EOF
+chmod +x /home/circleci/.local/bin/terraform
+
+# install terraspace
+bundle install
+# shim for circleci
+mv ~/.rubygems/bin/terraspace ~/.rubygems/bin/terraspace.rb
+cat << 'EOF' > ~/.rubygems/bin/terraspace
+#!/bin/bash
+EXE=~/.rubygems/bin/terraspace.rb
+if [ -f config/app.rb ]; then
+  exec bundle exec $EXE "$@"
+else
+  exec $EXE "$@"
+fi
+EOF
+chmod +x ~/.rubygems/bin/terraspace
+terraspace --version
+
+# install infracost
+# https://www.infracost.io/docs/
+curl -fsSL https://raw.githubusercontent.com/infracost/infracost/master/scripts/install.sh | sh

data/lib/template/.circleci/bin/terraspace-plan-or-up.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+set -ex
+
+# Looks like only able to conditionally decide with CIRCLE_PULL_REQUEST and CIRCLE_BRANCH
+# at runtime instead of circleci evaluation time for the workflow we're trying to achieve.
+# So will "cancel" workflows that don't really want to run we can see this with the status visually.
+#
+if [ -n "$CIRCLE_PULL_REQUEST" ]; then
+  exec terraspace plan "$@"
+else
+  if [ "$CIRCLE_BRANCH" == "main" ]; then
+    exec terraspace up "$@" -y
+  else
+    # cancel workflow and set status
+    if [ -n "$CIRCLE_TOKEN" ] ; then
+      # https://circleci.com/docs/api/v2/index.html#operation/cancelWorkflow
+      curl --request POST \
+        --header "Circle-Token: $CIRCLE_TOKEN" \
+        https://circleci.com/api/v2/workflow/$CIRCLE_WORKFLOW_ID/cancel
+      sleep 10 # seems to allow the curl request to cancel consistently
+    fi
+    # For correct Workflow Cancelled Status also. Correct status only if also cancel via the API
+    circleci step halt
+  fi
+fi

data/lib/template/.circleci/config.yml

@@ -0,0 +1,57 @@
+version: 2.1
+
+common_env_vars: &common_env_vars
+  AWS_REGION: us-west-2
+
+parameters:
+  manual:
+    type: boolean
+    default: false
+
+jobs:
+  # Manually triggered: TS_ENV=prod
+  prod_plan:
+    docker:
+      - image: cimg/ruby:3.1.0
+    environment: *common_env_vars
+    steps:
+      - checkout
+      - run: .circleci/bin/install
+      - run: TS_ENV=prod terraspace plan demo
+  prod_up:
+    docker:
+      - image: cimg/ruby:3.1.0
+    environment: *common_env_vars
+    steps:
+      - checkout
+      - run: .circleci/bin/install
+      - run: TS_ENV=prod terraspace up demo -y
+
+  # On PR:   TS_ENV=dev terraspace plan
+  # On push: TS_ENV=dev terraspace up - checks a specific branch only
+  dev_plan_or_up:
+    docker:
+      - image: cimg/ruby:3.1.0
+    environment: *common_env_vars
+    steps:
+      - checkout
+      - run: .circleci/bin/install
+      - run: .circleci/bin/terraspace-plan-or-up.sh demo # depends if PR
+
+workflows:
+  prod_plan_then_up_with_approval:
+    when: << pipeline.parameters.manual >>
+    jobs:
+      - prod_plan
+      - hold:
+          type: approval
+          requires:
+            - prod_plan
+      - prod_up:
+          requires:
+            - hold
+  dev_plan_or_up:
+    when:
+      not: << pipeline.parameters.manual >>
+    jobs:
+      - dev_plan_or_up

data/lib/terraspace_ci_circleci/autoloader.rb

@@ -0,0 +1,23 @@
+require "zeitwerk"
+
+module TerraspaceCiCircleci
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.log! if ENV["TERRASPACE_CI_CIRCLECI_AUTOLOAD_LOG"]
+        loader.setup
+      end
+    end
+  end
+end
+

data/lib/terraspace_ci_circleci/interface.rb

@@ -0,0 +1,53 @@
+require "uri"
+
+module TerraspaceCiCircleci
+  class Interface
+    # Interface method. Returns Hash of properties.
+    def vars
+      {
+        build_system: "circleci",
+        host: host,
+        full_repo: full_repo,
+        branch_name: ENV['CIRCLE_BRANCH'],
+        # urls
+        pr_url: ENV['CIRCLE_PULL_REQUEST'],
+        build_url: ENV['CIRCLE_BUILD_URL'],
+        # additional properties
+        build_type: build_type,
+        pr_number: pr_number,
+        sha: ENV['CIRCLE_SHA1'],
+        # additional properties
+        # commit_message: ENV['REPLACE_ME'],
+        build_id: ENV['CIRCLE_BUILD_NUM'],
+        build_number: ENV['CIRCLE_BUILD_NUM'],
+      }
+    end
+
+    # IE: CIRCLE_BUILD_URL=https://circleci.com/gh/ORG/REPO/7
+    def host
+      uri = URI(ENV['CIRCLE_BUILD_URL'])
+      "#{uri.scheme}://#{uri.host}"
+    end
+
+    # IE: CIRCLE_REPOSITORY_URL=git@github.com:ORG/REPO.git
+    def full_repo
+      url = ENV['CIRCLE_REPOSITORY_URL']
+      full_repo = if url.include?(':')
+        url.split(':').last
+      else
+        URI(url).path.sub(%r{^/},'')
+      end
+      full_repo.sub('.git','')
+    end
+
+    def build_type
+      ENV['CIRCLE_PULL_REQUEST'] ? 'pull_request' : 'push'
+    end
+
+    # CIRCLE_PULL_REQUEST=https://github.com/ORG/REPO/pull/2
+    def pr_number
+      pr = ENV['CIRCLE_PULL_REQUEST']
+      pr.split('/').last if pr
+    end
+  end
+end

data/lib/terraspace_ci_circleci/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TerraspaceCiCircleci
+  VERSION = "0.1.0"
+end

data/lib/terraspace_ci_circleci.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "terraspace_ci_circleci/autoloader"
+TerraspaceCiCircleci::Autoloader.setup
+
+require "json"
+
+module TerraspaceCiCircleci
+  class Error < StandardError; end
+end
+
+Terraspace::Cloud::Ci.register(
+  name: "circleci",
+  env_key: "CIRCLECI",
+  root: __dir__,
+  exe: ".circleci/bin", # terraspace new ci NAME generator will make files in this folder executable
+)

data/terraspace_ci_circleci.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/terraspace_ci_circleci/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "terraspace_ci_circleci"
+  spec.version = TerraspaceCiCircleci::VERSION
+  spec.authors = ["Tung Nguyen"]
+  spec.email = ["tung@boltops.com"]
+
+  spec.summary = "Terraspace CI CircleCI support"
+  spec.homepage = "https://github.com/boltops-tools/terraspace_ci_circleci"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/boltops-tools/terraspace_ci_circleci"
+  spec.metadata["changelog_uri"] = "https://github.com/boltops-tools/terraspace_ci_circleci/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "zeitwerk"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: terraspace_ci_circleci
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tung@boltops.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/template/.circleci/bin/install
+- lib/template/.circleci/bin/terraspace-plan-or-up.sh
+- lib/template/.circleci/config.yml
+- lib/terraspace_ci_circleci.rb
+- lib/terraspace_ci_circleci/autoloader.rb
+- lib/terraspace_ci_circleci/interface.rb
+- lib/terraspace_ci_circleci/version.rb
+- terraspace_ci_circleci.gemspec
+homepage: https://github.com/boltops-tools/terraspace_ci_circleci
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boltops-tools/terraspace_ci_circleci
+  source_code_uri: https://github.com/boltops-tools/terraspace_ci_circleci
+  changelog_uri: https://github.com/boltops-tools/terraspace_ci_circleci/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.12
+signing_key: 
+specification_version: 4
+summary: Terraspace CI CircleCI support
+test_files: []