ci_toolkit 1.3.17 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 883207d3f29050dad756ee30f072af4ee6e0d25a2ebb6739c2c7353f0fe3e7e0
-  data.tar.gz: 7804a7d066e5b5550d0ef373c2f55753abd62f615a69bfa47ae73607bbdda8ae
+  metadata.gz: 7c3a2dc78e17b33a1f5cec89d973abd60bc9c972ec8d5d99c7547fd1ec0591f1
+  data.tar.gz: 1ac3f0583f2e9acb470dde9ecc5154003350c444a9e86e5a113722df38cfdc50
 SHA512:
-  metadata.gz: 0a2d27d94b95f311dc675105790a19ddd81849ebad508875fe69b2a6a37326cc056fda20ebc141e29e9f54e59a099254fc0a6853b84d4d3ff869a0ef42ef3f90
-  data.tar.gz: 7217613bbd0774d92857d8db7b34e7e48f70c34c66285efc55c2bdf58a417582f599a7500f41d5ede9e1dba7e9868826b94d251343b1867cc9928cbab7a6d547
+  metadata.gz: 37dfe3cb4c7f72b0489f0dbdc792ba6f7b5cc79af67b45d8b3256c1ed83dbef1cb3eb7597304015738e33cb80ee5a1138a501d46872640a7013088c5c6c04320
+  data.tar.gz: 7e6cd2c35898d510f419c6b915d29fdf0a6fcfd252b6bd34dd3d17f74dc411241a7547a839c809b9c8d1d2a1a8c20dbbe0dbc757b3aeff85a5a75a6b8254e3be

data/.devcontainer/Dockerfile

@@ -0,0 +1,13 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this line to install additional gems.
+RUN gem install bundler
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/base.Dockerfile

@@ -0,0 +1,43 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM ruby:${VARIANT}
+
+# Copy library scripts to execute
+COPY library-scripts/*.sh library-scripts/*.env /tmp/library-scripts/
+
+# [Option] Install zsh
+ARG INSTALL_ZSH="true"
+# [Option] Upgrade OS packages to their latest versions
+ARG UPGRADE_PACKAGES="true"
+# Install needed packages and setup non-root user. Use a separate RUN statement to add your own dependencies.
+ARG USERNAME=vscode
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    # Remove imagemagick due to https://security-tracker.debian.org/tracker/CVE-2019-10131
+    && apt-get purge -y imagemagick imagemagick-6-common \
+    # Install common packages, non-root user, rvm, core build tools
+    && bash /tmp/library-scripts/common-debian.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "${UPGRADE_PACKAGES}" "true" "true" \
+    && bash /tmp/library-scripts/ruby-debian.sh "none" "${USERNAME}" "true" "true" \
+    && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+ENV NVM_DIR=/usr/local/share/nvm
+ENV NVM_SYMLINK_CURRENT=true \
+    PATH=${NVM_DIR}/current/bin:${PATH}
+RUN bash /tmp/library-scripts/node-debian.sh "${NVM_DIR}" "${NODE_VERSION}" "${USERNAME}" \
+    && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+ # Remove library scripts for final image
+RUN rm -rf /tmp/library-scripts
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,35 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.202.5/containers/ruby
+{
+	"name": "Ruby",
+	"runArgs": ["--init"],
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3-bullseye",
+			// Options
+			"NODE_VERSION": "none"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "bundle install",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+
+}

data/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "ruby.useLanguageServer": true,
+    "ruby.useBundler": true,
+    "ruby.lint": {
+        "rubocop": {
+          "useBundler": true // enable rubocop via bundler
+        }
+    },
+    "ruby.intellisense": "rubyLocate",
+    "ruby.codeCompletion": "rcodetools"
+}

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ci_toolkit (1.3.17)
+    ci_toolkit (1.4.0)
       faraday
       faraday_middleware
       jwt

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec/test/test-unit` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version in `ci_toolkit.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/ci_toolkit/github_bot.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "octokit"
+require "jwt"
+
+module CiToolkit
+  # Utility class that provides an access token that can be used with the Github API
+  class GithubBot
+    # Provides a jwt token for authentication. Sores the private key and app id for the bot
+    class Credentials
+      attr_reader :app_id
+
+      def initialize(app_id = ENV["CRVSH_BOT_GITHUB_APP_ID"], private_key = ENV["CRVSH_BOT_GITHUB_APP_PRIVATE_KEY"])
+        @app_id = app_id.to_i
+        @private_key = private_key
+      end
+
+      def jwt_token
+        JWT.encode(
+          {
+            iat: Time.now.to_i,
+            exp: Time.now.to_i + (9 * 60),
+            iss: @app_id
+          },
+          OpenSSL::PKey::RSA.new(@private_key),
+          "RS256"
+        )
+      end
+    end
+    # stack = Faraday::RackBuilder.new do |builder|
+    #   builder.response :logger
+    #   builder.use Octokit::Response::RaiseError
+    #   builder.adapter Faraday.default_adapter
+    # end
+    # Octokit.middleware = stack
+
+    def initialize(
+      credentials = CiToolkit::GithubBot::Credentials.new,
+      client = Octokit::Client.new(bearer_token: credentials.jwt_token, auto_paginate: true)
+    )
+      @app_id = credentials.app_id
+      @client = client
+    end
+
+    def create_token
+      return unless (installation_id = find_app_installation)
+
+      @client.create_app_installation_access_token(
+        installation_id,
+        { accept: Octokit::Preview::PREVIEW_TYPES[:integrations] }
+      )[:token]
+    end
+
+    private
+
+    def find_app_installation
+      @client.find_app_installations(
+        { accept: Octokit::Preview::PREVIEW_TYPES[:integrations] }
+      ).select { |installation| @app_id.equal?(installation[:app_id]) }.first[:id]
+    end
+  end
+end

data/lib/ci_toolkit/github_pr.rb

@@ -16,7 +16,7 @@ module CiToolkit
       @commit_sha = env.git_commit
       @_client = client
       @build_types = build_types
-      @access = CiToolkit::GithubAccess.new
+      @bot = CiToolkit::GithubBot.new
     end
 
     def title
@@ -110,7 +110,7 @@ module CiToolkit
 
     def client
       @_client = Octokit::Client.new if @_client.nil?
-      @_client.access_token = @access.create_token if @_client.access_token.nil?
+      @_client.access_token = @bot.create_token if @_client.access_token.nil?
 
       @_client
     end

data/lib/ci_toolkit.rb

@@ -4,7 +4,7 @@ require "ci_toolkit/bitrise_env"
 require "ci_toolkit/build"
 require "ci_toolkit/build_status"
 require "ci_toolkit/duplicate_files_finder"
-require "ci_toolkit/github_access"
+require "ci_toolkit/github_bot"
 require "ci_toolkit/github_pr"
 require "ci_toolkit/git"
 require "ci_toolkit/jira"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ci_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.3.17
+  version: 1.4.0
 platform: ruby
 authors:
 - Gero Keller
@@ -186,8 +186,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/base.Dockerfile"
+- ".devcontainer/devcontainer.json"
 - ".rspec"
 - ".rubocop.yml"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -205,7 +209,7 @@ files:
 - lib/ci_toolkit/build_status.rb
 - lib/ci_toolkit/duplicate_files_finder.rb
 - lib/ci_toolkit/git.rb
-- lib/ci_toolkit/github_access.rb
+- lib/ci_toolkit/github_bot.rb
 - lib/ci_toolkit/github_pr.rb
 - lib/ci_toolkit/jira.rb
 - lib/ci_toolkit/pr_messenger.rb

data/lib/ci_toolkit/github_access.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require "octokit"
-require "jwt"
-
-module CiToolkit
-  # Utility class that provides an access token that can be used with the Github API
-  class GithubAccess
-    # stack = Faraday::RackBuilder.new do |builder|
-    #   builder.response :logger
-    #   builder.use Octokit::Response::RaiseError
-    #   builder.adapter Faraday.default_adapter
-    # end
-    # Octokit.middleware = stack
-
-    def initialize(app_id = ENV["CRVSH_BOT_GITHUB_APP_ID"], private_key = ENV["CRVSH_BOT_GITHUB_APP_PRIVATE_KEY"])
-      @app_id = app_id.to_i
-      @private_key = private_key
-      @client = Octokit::Client.new(bearer_token: jwt_token, auto_paginate: true)
-    end
-
-    def create_token
-      return unless (installation_id = find_app_installation)
-
-      @client.create_app_installation_access_token(
-        installation_id,
-        { accept: Octokit::Preview::PREVIEW_TYPES[:integrations] }
-      )[:token]
-    end
-
-    private
-
-    def find_app_installation
-      @client.find_app_installations(
-        { accept: Octokit::Preview::PREVIEW_TYPES[:integrations] }
-      ).select { |installation| installation[:app_id] == @app_id }.first[:id]
-    end
-
-    def jwt_token
-      JWT.encode(
-        {
-          iat: Time.now.to_i,
-          exp: Time.now.to_i + (9 * 60),
-          iss: @app_id
-        },
-        OpenSSL::PKey::RSA.new(@private_key),
-        "RS256"
-      )
-    end
-  end
-end