terraspace_ci_gitlab 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b032f2c6bc8b2194f5b9947c9d136179575cb2b5a7569091170002c44e4fb32c
+  data.tar.gz: dab7b140333f75176c0518bcf84931df6fdaf30f927b0c8a2c95153fc3d6d836
+SHA512:
+  metadata.gz: 5a294e4c11db5579841607da16062e48ea69540e7890e898b9a84b1b1a823d041236bd40d9c711b26271c7edefeab26fe58feb0c2138e176d8e91b348f226909
+  data.tar.gz: f6e5294f8d16af5d9097a30183fe9fda4a39e93937df89bcb10e9d92e0587d7a2d976079243813e223024dd5eb56a480a63fdd922dae9bfbb2a2478ad5dd5080

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 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) <%= Time.now.year %>
+
+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_gitlab
+
+[![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 Terraspace CI support for GitLab.
+
+## Installation
+
+Add gem to your Terraspace project
+
+Gemfile
+
+    gem terraspace_ci_gitlab
+
+Then to install run
+
+    bundle
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boltops-tools/terraspace_ci_gitlab/

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/.gitlab-ci.yml

@@ -0,0 +1,54 @@
+image: ruby:latest
+
+stages:
+  - plan dev
+  - up dev
+  - plan prod
+  - up prod
+
+before_script: |
+  # install terraform
+  git clone https://github.com/tfutils/tfenv.git ~/.tfenv
+  echo 'export PATH="$HOME/.tfenv/bin:$PATH"' >> ~/.bash_profile
+  export PATH="$HOME/.tfenv/bin:$PATH"
+  tfenv install latest
+  tfenv use latest
+  terraform --version
+  # install terraspace
+  bundle
+  bundle exec terraspace new shim
+  echo 'export PATH="/usr/local/bin:$PATH' >> ~/.bash_profile
+  export PATH="/usr/local/bin:$PATH"
+
+# Runs on Merge Request Only
+plan_dev:
+  stage: plan dev
+  only:
+  - merge_requests
+  script:
+    - terraspace plan demo
+
+# Runs on Push Only
+up_dev:
+  stage: up dev
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "main"'
+  script:
+    - terraspace up demo -y
+
+# Runs Manually Only (part 1 of 2)
+plan_prod:
+  stage: plan prod
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "web"'
+  script:
+    - TS_ENV=prod terraspace plan demo
+
+# Runs Manually Only (part 2 of 2)
+up_prod:
+  stage: up prod
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "web"'
+      when: manual # manual approval
+  script:
+    - TS_ENV=prod terraspace up demo -y

data/lib/terraspace_ci_gitlab/autoloader.rb

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

data/lib/terraspace_ci_gitlab/interface.rb

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

data/lib/terraspace_ci_gitlab/pr.rb

@@ -0,0 +1,55 @@
+require "gitlab"
+
+module TerraspaceCiGitlab
+  class Pr
+    extend Memoist
+
+    def comment(url)
+      return unless ENV['CI_PIPELINE_SOURCE'] == 'merge_request_event'
+      return unless gitlab_token?
+
+      repo = ENV['CI_PROJECT_PATH'] # org/repo
+      number = ENV['CI_MERGE_REQUEST_IID']
+      marker = "<!-- terraspace marker -->"
+      body = marker + "\n"
+      body << "Terraspace Cloud Url #{url}"
+
+      puts "Adding comment to repo #{repo} number #{number}"
+
+      project = client.project(ENV['CI_PROJECT_PATH'])
+      merge_request = ENV['CI_MERGE_REQUEST_IID']
+
+      # https://www.rubydoc.info/gems/gitlab/Gitlab/Client/Notes
+      # TODO: handle pagination
+      notes = client.merge_request_notes(project.id, number)
+      # TODO: handle not found. Examples:
+      # token is not valid
+      # token is not right repo
+      # todo are we allow to post comment on public repo without need the permission?
+      found_note = notes.find do |note|
+        note.body.starts_with?(marker)
+      end
+
+      if found_note
+        client.edit_merge_request_note(project.id, merge_request, found_note.id, body) unless found_note.body == body
+      else
+        client.create_merge_request_note(project.id, merge_request, body)
+      end
+    rescue Gitlab::Error::Unauthorized => e
+      puts "WARN: #{e.message}. Unable to create merge request comment. Please double check your gitlab token"
+    end
+
+    def client
+      Gitlab.configure do |config|
+        config.endpoint       = 'https://gitlab.com/api/v4'
+        config.private_token  = ENV['GITLAB_TOKEN']
+      end
+      Gitlab.client
+    end
+    memoize :client
+
+    def gitlab_token?
+      ENV['GITLAB_TOKEN']
+    end
+  end
+end

data/lib/terraspace_ci_gitlab/vars.rb

@@ -0,0 +1,48 @@
+module TerraspaceCiGitlab
+  class Vars
+    # Interface method. Hash of properties to be stored
+    def data
+      {
+        build_system: "gitlab",   # required
+        host: host,
+        full_repo: full_repo,
+        branch_name: branch_name,
+        # urls
+        pr_url: pr_url,
+        build_url: ENV['CI_PIPELINE_URL'],
+        # additional properties
+        build_type: ENV['CI_PIPELINE_SOURCE'], # IE: merge_request_event
+        pr_number: pr_number,  # set when build_type=pull_request
+        sha: sha,
+        # additional properties
+        commit_message: ENV['CI_COMMIT_MESSAGE'],
+        build_id: ENV['CI_PIPELINE_ID'],
+        build_number: ENV['CI_PIPELINE_IID'],
+      }
+    end
+
+    def host
+      ENV['CI_SERVER_URL'] || 'https://gitlab.com'
+    end
+
+    def pr_url
+      "#{host}/#{full_repo}/-/merge_requests/#{pr_number}" if pr_number
+    end
+
+    def pr_number
+      ENV['CI_MERGE_REQUEST_IID']
+    end
+
+    def branch_name
+      ENV['CI_COMMIT_REF_NAME']
+    end
+
+    def sha
+      ENV['CI_COMMIT_SHA']
+    end
+
+    def full_repo
+      ENV['CI_PROJECT_PATH']
+    end
+  end
+end

data/lib/terraspace_ci_gitlab/version.rb

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

data/lib/terraspace_ci_gitlab.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "terraspace_ci_gitlab/autoloader"
+TerraspaceCiGitlab::Autoloader.setup
+
+require "json"
+require "memoist"
+
+module TerraspaceCiGitlab
+  class Error < StandardError; end
+end
+
+require "terraspace"
+Terraspace::Cloud::Ci.register(
+  name: "gitlab",
+  env_key: "GITLAB_CI", # NOTE: probably have to change. Env var used for CI detection
+  root: __dir__,
+)

data/terraspace_ci_gitlab.gemspec

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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: terraspace_ci_gitlab
+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: gitlab
+  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: 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: 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/.gitlab-ci.yml
+- lib/terraspace_ci_gitlab.rb
+- lib/terraspace_ci_gitlab/autoloader.rb
+- lib/terraspace_ci_gitlab/interface.rb
+- lib/terraspace_ci_gitlab/pr.rb
+- lib/terraspace_ci_gitlab/vars.rb
+- lib/terraspace_ci_gitlab/version.rb
+- terraspace_ci_gitlab.gemspec
+homepage: https://github.com/boltops-tools/terraspace_ci_gitlab
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boltops-tools/terraspace_ci_gitlab
+  source_code_uri: https://github.com/boltops-tools/terraspace_ci_gitlab
+  changelog_uri: https://github.com/boltops-tools/terraspace_ci_gitlab/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 GitLab support
+test_files: []