terraspace_ci_github 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d88b062ab17176d868d4f0b6f11a8a4b614c1e1396922186e4356264be0e069
+  data.tar.gz: 58b57b162da756f2e3aa63c055c8980ab58aa846489ac6378263fa72bfc1101c
+SHA512:
+  metadata.gz: ccae205902e9717ca80ee2335238052217e9e4e553ebbe2c1afec8274c7aeda317ed73a04eeb611f9406af4964af5f12074a6da69f77614add44697613d34134
+  data.tar.gz: 2f24c1dd359f4856e4f67b5681777417647dc6f60d514d4b82400d631d34611a9b30f505ccb2b65dbb319800121c58a1920a8336e0c56b680aea27a84c5be3e1

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,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+This project *tries* to adhere to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - 2022-06-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in terraspace_ci_github.gemspec
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "rubocop"
+
+group :development, :test do
+  gem "terraspace"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 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_github
+
+[![Gem Version](https://badge.fury.io/rb/terraspace.png)](http://badge.fury.io/rb/terraspace)
+
+[![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 GitHub Actions CI support.
+
+## Installation
+
+Add gem to your Terraspace project
+
+Gemfile
+
+    gem terraspace_ci_github
+
+Then to install run
+
+    bundle
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boltops-tools/terraspace_ci_github.

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/.github/bin/install

@@ -0,0 +1,8 @@
+#!/bin/bash
+brew install tfenv
+tfenv install latest
+tfenv use latest
+terraform --version
+bundle install
+bundle exec terraspace new shim
+terraspace --version

data/lib/template/.github/workflows/pull_request.yml.tt

@@ -0,0 +1,21 @@
+name: Pull Request Plan
+
+on:
+  - pull_request
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+
+    env:
+<%= plugin_env_vars(indent: 6) -%>
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      TS_ENV: dev
+      TS_TOKEN: ${{ secrets.TS_TOKEN }}
+
+    steps:
+<%= partial "init_steps.yml" -%>
+
+    - name: Terraspace Command
+      run: |
+        terraspace plan demo

data/lib/template/.github/workflows/push.yml.tt

@@ -0,0 +1,23 @@
+name: Push Up
+on:
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+
+    env:
+<%= plugin_env_vars(indent: 6) -%>
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      TS_ENV: dev
+      TS_TOKEN: ${{ secrets.TS_TOKEN }}
+
+    steps:
+<%= partial "init_steps.yml" -%>
+
+    - name: Terraspace Command
+      run: |
+        terraspace up demo -y

data/lib/template/.github/workflows/workflow_dispatch.yml.tt

@@ -0,0 +1,30 @@
+name: Dispatch Terraspace
+on:
+  workflow_dispatch:
+    inputs:
+      env:
+        description: "TS_ENV"
+        type: choice
+        default: prod
+        options: # Add more environment if needed
+          - dev
+          - prod
+      command:
+        description: "Terraspace command to run"
+        default: "plan demo"
+jobs:
+  run:
+    runs-on: ubuntu-latest
+
+    env:
+<%= plugin_env_vars(indent: 6) -%>
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      TS_ENV: ${{ github.event.inputs.env }}
+      TS_TOKEN: ${{ secrets.TS_TOKEN }}
+
+    steps:
+<%= partial "init_steps.yml" -%>
+
+    - name: Terraspace Command
+      run: |
+        terraspace ${{ github.event.inputs.command }} -y

data/lib/template/partials/init_steps.yml

@@ -0,0 +1,12 @@
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Install Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Install
+      run:
+        .github/bin/install

data/lib/terraspace_ci_github/autoloader.rb

@@ -0,0 +1,23 @@
+require "zeitwerk"
+
+module TerraspaceCiGithub
+  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_GITHUB_AUTOLOAD_LOG"]
+        loader.setup
+      end
+    end
+  end
+end
+

data/lib/terraspace_ci_github/base.rb

@@ -0,0 +1,21 @@
+require "octokit"
+
+module TerraspaceCiGithub
+  class Base
+    extend Memoist
+
+    def client
+      Octokit::Client.new(access_token: ENV['GH_TOKEN'])
+    end
+    memoize :client
+
+    def github_token?
+      if ENV['GH_TOKEN']
+        true
+      else
+        puts "WARN: The env var GH_TOKEN is not configured. Will not post PR comment"
+        false
+      end
+    end
+  end
+end

data/lib/terraspace_ci_github/interface.rb

@@ -0,0 +1,13 @@
+module TerraspaceCiGithub
+  class Interface
+    # required interface
+    def vars
+      Vars.new.data
+    end
+
+    # optional interface
+    def comment(url)
+      Pr.new.comment(url)
+    end
+  end
+end

data/lib/terraspace_ci_github/pr.rb

@@ -0,0 +1,29 @@
+module TerraspaceCiGithub
+  class Pr < Base
+    def comment(url)
+      return unless ENV['GITHUB_EVENT_NAME'] == 'pull_request'
+      return unless github_token?
+
+      repo = ENV['GITHUB_REPOSITORY'] # org/repo
+      number = ENV['GITHUB_REF_NAME'].split('/').first # IE: 2/merge
+      marker = "<!-- terraspace marker -->"
+      body = marker + "\n"
+      body << "Terraspace Cloud Url #{url}"
+
+      puts "Adding comment to repo #{repo} number #{number}"
+
+      comments = client.issue_comments(repo, number)
+      found_comment = comments.find do |comment|
+        comment.body.starts_with?(marker)
+      end
+
+      if found_comment
+        client.update_comment(repo, found_comment.id, body) unless found_comment.body == body
+      else
+        client.add_comment(repo, number, body)
+      end
+    rescue Octokit::Unauthorized => e
+      puts "WARN: #{e.message}. Unable to create pull request comment. Please double check your github token"
+    end
+  end
+end

data/lib/terraspace_ci_github/vars.rb

@@ -0,0 +1,80 @@
+module TerraspaceCiGithub
+  class Vars < Base
+    # Hash of properties to store
+    def data
+      {
+        build_system: "github",   # required
+        host: host,
+        full_repo: full_repo,
+        branch_name: branch_name,
+        # urls
+        pr_url: pr_url,
+        build_url: build_url,
+        # additional properties
+        build_type: build_type,   # required IE: pull_request or push
+        pr_number: pr['number'],  # set when build_type=pull_request
+        sha: sha,
+        # additional properties
+        commit_message: commit_message,
+        build_id: build_id,
+        build_number: ENV['GITHUB_RUN_NUMBER'],
+      }
+    end
+
+    def host
+      ENV['GITHUB_SERVER_URL'] || 'https://github.com'
+    end
+
+    def pr_url
+      "#{host}/#{full_repo}/pull/#{pr['number']}" if pr['number']
+    end
+
+    def build_url
+      "#{host}/#{full_repo}/actions/runs/#{build_id}"
+    end
+
+    def build_id
+      ENV['GITHUB_RUN_ID']
+    end
+
+    # https://github.com/octokit/octokit.rb/blob/4-stable/lib/octokit/client/commits.rb#L150
+    # https://docs.github.com/en/rest/commits/commits#get-a-commit
+    def commit_message
+      return unless github_token?
+      resp = client.commit(full_repo, sha)
+      resp['commit']['message']
+    rescue Octokit::Unauthorized => e
+      puts "WARN: #{e.message}. Error getting commit message. Please double check your github token"
+    end
+
+    def full_repo
+      ENV['GITHUB_REPOSITORY']
+    end
+
+    def sha
+      if build_type == "pull_request"
+        pr.dig('pull_request','head','sha')
+      else # push
+        ENV['GITHUB_SHA']
+      end
+    end
+
+    def build_type
+      ENV['GITHUB_EVENT_NAME']
+    end
+
+    def branch_name
+      if build_type == "pull_request"
+        pr.dig('pull_request','head','ref')
+      else # push
+        ENV['GITHUB_REF']
+      end
+    end
+
+    # GitHub webhook JSON payload in file and path is set in GITHUB_EVENT_PATH
+    def pr
+      return {} unless ENV['GITHUB_EVENT_PATH']
+      JSON.load(IO.read(ENV['GITHUB_EVENT_PATH']))
+    end
+  end
+end

data/lib/terraspace_ci_github/version.rb

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

data/lib/terraspace_ci_github.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "terraspace_ci_github/autoloader"
+TerraspaceCiGithub::Autoloader.setup
+
+require "json"
+require "memoist"
+
+module TerraspaceCiGithub
+  class Error < StandardError; end
+end
+
+require "terraspace"
+Terraspace::Cloud::Ci.register(
+  name: "github",
+  env_key: "GITHUB_ACTIONS",
+  root: __dir__,
+  exe: ".github/bin",
+)

data/terraspace_ci_github.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/terraspace_ci_github/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "terraspace_ci_github"
+  spec.version = TerraspaceCiGithub::VERSION
+  spec.authors = ["Tung Nguyen"]
+  spec.email = ["tung@boltops.com"]
+
+  spec.summary = "Terraspace CI GitHub support"
+  spec.homepage = "https://github.com/boltops-tools/terraspace_ci_github"
+  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_github"
+  spec.metadata["changelog_uri"] = "https://github.com/boltops-tools/terraspace_ci_github/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 "memoist"
+  spec.add_dependency "octokit"
+  spec.add_dependency "zeitwerk"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: terraspace_ci_github
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: memoist
+  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'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  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'
+- !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/.github/bin/install
+- lib/template/.github/workflows/pull_request.yml.tt
+- lib/template/.github/workflows/push.yml.tt
+- lib/template/.github/workflows/workflow_dispatch.yml.tt
+- lib/template/partials/init_steps.yml
+- lib/terraspace_ci_github.rb
+- lib/terraspace_ci_github/autoloader.rb
+- lib/terraspace_ci_github/base.rb
+- lib/terraspace_ci_github/interface.rb
+- lib/terraspace_ci_github/pr.rb
+- lib/terraspace_ci_github/vars.rb
+- lib/terraspace_ci_github/version.rb
+- terraspace_ci_github.gemspec
+homepage: https://github.com/boltops-tools/terraspace_ci_github
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boltops-tools/terraspace_ci_github
+  source_code_uri: https://github.com/boltops-tools/terraspace_ci_github
+  changelog_uri: https://github.com/boltops-tools/terraspace_ci_github/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 GitHub support
+test_files: []