terraspace_ci_azure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29397c0d042aab0f08259211bd43983b6716ffad53280773eb7869abf56b1c72
+  data.tar.gz: d61509334b832dd3aaf7b951a3bbd7b2e855609ee663c0630521421b5aeaaf5e
+SHA512:
+  metadata.gz: b69b7c6680f7d4f655866c9dcebbc4bc23d4c92497979fc10c85474c82a7bcb5ed8030461bb84c6beda956ff62a7021585211cf4480e4daa17131b181285b83b
+  data.tar.gz: 0c2c641ac7df2360df06a508ddc309a35c097fedc3775024d83173df1d1db5fe5f439eb577c19519870488fe701b0ce0c4809528c4a4091982ab37e99515af82

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-16
+
+- 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_azure
+
+[![Gem Version](https://badge.fury.io/rb/terraspace_ci_azure.png)](http://badge.fury.io/rb/terraspace_ci_azure)
+
+[![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 Azure.
+
+## Installation
+
+Add gem to your Terraspace project
+
+Gemfile
+
+    gem "terraspace_ci_azure"
+
+Then to install run
+
+    bundle
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boltops-tools/terraspace_ci_azure/

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

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# 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/.tfenv/bin/terraform
+# shim for terraform since it's since is not the .tfenv/bin
+# HOME = /home/vsts for azure pipeline
+# Note: export PATH causes infinite loop in azure env for some reason. IE:
+#     export PATH="~/.tfenv/bin:$PATH"
+# Instead use full path: ~/.tfenv/bin/terraform
+mkdir -p ~/.local/bin
+cat << 'EOF' > ~/.local/bin/terraform
+exec ~/.tfenv/bin/terraform "$@"
+EOF
+chmod +x ~/.local/bin/terraform
+terraform -v
+
+# install terraspace
+bundle install
+# Details of azure shell PATH: https://gist.github.com/tongueroo/db796d7facd6b2a7635a50b965e73736
+# Shim so dont have to remember bundle exec
+cat << 'EOF' > ~/.local/bin/terraspace
+#!/bin/bash
+if [ -f config/app.rb ]; then
+  exec bundle exec terraspace "$@"
+else
+  exec terraspace "$@"
+fi
+EOF
+chmod +x ~/.local/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/.azure/pipelines/dev-plan.yml

@@ -0,0 +1,42 @@
+# Trigger for branch workflow
+trigger:
+  branches:
+    exclude: [ "main" ] # plan on all branches except main
+
+pool:
+  vmImage: ubuntu-latest
+
+# Note: common-variables group must already exist.
+# Using group to reduce some duplication. Instead of:
+#
+#     variables:
+#     - name: one
+#       value: initialValue
+#
+# Docs: https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#understand-variable-syntax
+variables:
+- group: common-variables
+
+steps:
+- task: UseRubyVersion@0
+  inputs:
+    versionSpec: '>= 3.1'
+
+# Note: script must be first parameter
+# Reference Docs: https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/steps-script?view=azure-pipelines
+- script: |
+    .azure/bin/install
+  displayName: install terraspace
+
+# Secret variables must be exported to be available.
+# Plain text variables are automatically available.
+- script: |
+    export ARM_CLIENT_ID=$(ARM_CLIENT_ID)
+    export ARM_CLIENT_SECRET=$(ARM_CLIENT_SECRET)
+    export ARM_SUBSCRIPTION_ID=$(ARM_SUBSCRIPTION_ID)
+    export ARM_TENANT_ID=$(ARM_TENANT_ID)
+    export TS_TOKEN=$(TS_TOKEN)
+    # Uncomment export INFRACOST_API_KEY if using cost estimates
+    # export INFRACOST_API_KEY=$(INFRACOST_API_KEY)
+    terraspace plan demo
+  displayName: terraspace plan

data/lib/template/.azure/pipelines/dev-up.yml

@@ -0,0 +1,40 @@
+trigger:
+  - main # once merged into main `terraspace up` runs on dev env
+
+pool:
+  vmImage: ubuntu-latest
+
+# Note: common-variables group must already exist.
+# Using group to reduce some duplication. Instead of:
+#
+#     variables:
+#     - name: one
+#       value: initialValue
+#
+# Docs: https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#understand-variable-syntax
+variables:
+- group: common-variables
+
+steps:
+- task: UseRubyVersion@0
+  inputs:
+    versionSpec: '>= 3.1'
+
+# Note: script must be first parameter
+# Reference Docs: https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/steps-script?view=azure-pipelines
+- script: |
+    .azure/bin/install
+  displayName: install terraspace
+
+# Secret variables must be exported to be available.
+# Plain text variables are automatically available.
+- script: |
+    export ARM_CLIENT_ID=$(ARM_CLIENT_ID)
+    export ARM_CLIENT_SECRET=$(ARM_CLIENT_SECRET)
+    export ARM_SUBSCRIPTION_ID=$(ARM_SUBSCRIPTION_ID)
+    export ARM_TENANT_ID=$(ARM_TENANT_ID)
+    export TS_TOKEN=$(TS_TOKEN)
+    # Uncomment export INFRACOST_API_KEY if using cost estimates
+    # export INFRACOST_API_KEY=$(INFRACOST_API_KEY)
+    terraspace up demo -y
+  displayName: terraspace up

data/lib/template/.azure/pipelines/manual.yml

@@ -0,0 +1,46 @@
+trigger: none # only manual trigger
+
+parameters:
+- name: command
+  displayName: Terraspace command to run
+  type: string
+  default: plan demo
+  values:
+  - plan demo
+  - up demo
+  - down demo
+- name: TS_ENV
+  displayName: Terraspace env
+  type: string
+  default: prod
+  values:
+  - dev
+  - prod
+
+pool:
+  vmImage: ubuntu-latest
+
+variables:
+- group: common-variables
+
+steps:
+- task: UseRubyVersion@0
+  inputs:
+    versionSpec: '>= 3.1'
+
+- script: |
+    .azure/bin/install
+  displayName: install terraspace
+
+- script: |
+    export ARM_CLIENT_ID=$(ARM_CLIENT_ID)
+    export ARM_CLIENT_SECRET=$(ARM_CLIENT_SECRET)
+    export ARM_SUBSCRIPTION_ID=$(ARM_SUBSCRIPTION_ID)
+    export ARM_TENANT_ID=$(ARM_TENANT_ID)
+    export TS_TOKEN=$(TS_TOKEN)
+    export TS_ENV=${{ parameters.TS_ENV }}
+    # Uncomment export INFRACOST_API_KEY if using cost estimates
+    # export INFRACOST_API_KEY=$(INFRACOST_API_KEY)
+    # always use -y in case user forgets in parameter
+    terraspace ${{ parameters.command }} -y
+  displayName: run terraspace

data/lib/terraspace_ci_azure/autoloader.rb

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

data/lib/terraspace_ci_azure/interface.rb

@@ -0,0 +1,114 @@
+require "uri"
+
+module TerraspaceCiAzure
+  class Interface
+    # Interface method. Returns Hash of properties.
+    def vars
+      {
+        build_system: "azure",
+        host: host,
+        full_repo: full_repo,
+        branch_name: branch_name,
+        # urls
+        pr_url: pr_url,
+        build_url: build_url,
+        branch_url: branch_url,
+        commit_url: commit_url,
+        # additional properties
+        build_type: build_type,
+        pr_number: pr_number,
+        sha: sha,
+        # additional properties
+        # commit_message: ENV['REPLACE_ME'],
+        build_id: build_id,
+        build_number: ENV['BUILD_BUILDNUMBER'], # IE: BUILD_BUILDNUMBER=20220715.12
+      }
+    end
+
+    def branch_name
+      if pr_number
+        message = ENV['BUILD_SOURCEVERSIONMESSAGE']
+        md = message.match(/Merge pull request \d+ from (.*) into (.*)/)
+        if md
+          # IE: BUILD_SOURCEVERSIONMESSAGE=Merge pull request 2 from feature into main
+          # Its a bit weird but with azure repos with check policy trigger
+          md[1]
+        else # GitHub and Bitbucket PR has actual branch though
+          # IE: SYSTEM_PULLREQUEST_SOURCEBRANCH=feature
+          message
+        end
+      else # push
+        ENV['BUILD_SOURCEBRANCHNAME']
+      end
+    end
+
+    def sha
+      ENV['BUILD_SOURCEVERSION']
+    end
+
+    # IE: BUILD_REPOSITORY_URI=https://tongueroo@dev.azure.com/tongueroo/infra-project/_git/infra-ci
+    def host
+      uri = URI(ENV['BUILD_REPOSITORY_URI'])
+      "#{uri.scheme}://#{uri.host}"
+    end
+
+    # removes the user@ part
+    # IE: BUILD_REPOSITORY_URI=https://tongueroo@dev.azure.com/tongueroo/infra-project/_git/infra-ci
+    def base_project_url
+      uri = URI(ENV['BUILD_REPOSITORY_URI'])
+      base_path = uri.path.split('/')[0..2].join('/')
+      "#{uri.scheme}://#{uri.host}#{base_path}"
+    end
+
+    def base_repo_url
+      uri = URI(ENV['BUILD_REPOSITORY_URI'])
+      "#{uri.scheme}://#{uri.host}#{uri.path}"
+    end
+
+    # IE: BUILD_REPOSITORY_URI=https://tongueroo@dev.azure.com/tongueroo/infra-project/_git/infra-ci
+    def full_repo
+      uri = URI(ENV['BUILD_REPOSITORY_URI'])
+      org = uri.path.split('/')[1] # since there's a leading /
+      repo = ENV['BUILD_REPOSITORY_NAME'] # tongueroo
+      "#{org}/#{repo}"
+    end
+
+    def build_type
+      ENV['SYSTEM_PULLREQUEST_PULLREQUESTID'] ? 'pull_request' : 'push'
+    end
+
+    # IE: SYSTEM_PULLREQUEST_PULLREQUESTID=2
+    def pr_number
+      ENV['SYSTEM_PULLREQUEST_PULLREQUESTID']
+    end
+
+    def build_id
+      ENV['BUILD_BUILDID']
+    end
+
+    # https://dev.azure.com/tongueroo/infra-project/_git/infra-ci/pullrequest/2
+    # IE: BUILD_REPOSITORY_URI=https://tongueroo@dev.azure.com/tongueroo/infra-project/_git/infra-ci
+    def pr_url
+      return unless pr_number
+      uri = URI(ENV['BUILD_REPOSITORY_URI'])
+      "#{base_repo_url}/pullrequest/#{pr_number}"
+    end
+
+    # IE: BUILD_BUILDID=74
+    # https://dev.azure.com/tongueroo/infra-project/_build/results?buildId=152&view=results
+    def build_url
+      return unless build_id
+      "#{base_project_url}/_build/results?buildId=#{build_id}&view=results"
+    end
+
+    # IE: https://dev.azure.com/tongueroo/infra-project/_git/infra-ci/commit/2eac582a6c0582c426f5304619aafd1db4f12434
+    def commit_url
+      "#{base_repo_url}/commit/#{sha}"
+    end
+
+    # IE: https://dev.azure.com/tongueroo/infra-project/_git/infra-ci?version=GBfeature
+    def branch_url
+      "#{base_repo_url}?version=GB#{branch_name}"
+    end
+  end
+end

data/lib/terraspace_ci_azure/version.rb

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

data/lib/terraspace_ci_azure.rb

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

data/terraspace_ci_azure.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/terraspace_ci_azure/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "terraspace_ci_azure"
+  spec.version = TerraspaceCiAzure::VERSION
+  spec.authors = ["Tung Nguyen"]
+  spec.email = ["tung@boltops.com"]
+
+  spec.summary = "Terraspace CI Azure support"
+  spec.homepage = "https://github.com/boltops-tools/terraspace_ci_azure"
+  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_azure"
+  spec.metadata["changelog_uri"] = "https://github.com/boltops-tools/terraspace_ci_azure/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|azure)|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,76 @@
+--- !ruby/object:Gem::Specification
+name: terraspace_ci_azure
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-16 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/.azure/bin/install
+- lib/template/.azure/pipelines/dev-plan.yml
+- lib/template/.azure/pipelines/dev-up.yml
+- lib/template/.azure/pipelines/manual.yml
+- lib/terraspace_ci_azure.rb
+- lib/terraspace_ci_azure/autoloader.rb
+- lib/terraspace_ci_azure/interface.rb
+- lib/terraspace_ci_azure/version.rb
+- terraspace_ci_azure.gemspec
+homepage: https://github.com/boltops-tools/terraspace_ci_azure
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boltops-tools/terraspace_ci_azure
+  source_code_uri: https://github.com/boltops-tools/terraspace_ci_azure
+  changelog_uri: https://github.com/boltops-tools/terraspace_ci_azure/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 Azure support
+test_files: []