ci_toolkit 1.4.12 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf57d831af4f6cf35645bf6badfa46e4e5c4a248b71073e913c7b00d916d9e29
-  data.tar.gz: '0178662a1ea410b9dd1b653a5da8c7afd9230825e51b3f8da3f57e857d925907'
+  metadata.gz: a76550025b344c5539c79e2002b47c2e622ce90e1f1dd4dcf9710e148a41174f
+  data.tar.gz: 182d9df1e68adb7f825ba57a1b3ad61e39d42e1b0a42f2011302f0559113e0b9
 SHA512:
-  metadata.gz: 37b8173921e346aaeb9cf254ed372d239abd5a23b53f0357139ad85876c3f5d9f832d60cde27046a343302e3d1eca766c8a819580af8c2c5cc1235c9d8a68716
-  data.tar.gz: 2abe3d539e171cafdea9fce063300ef331e7be7c96fa50c56b437d51588019a8c30ece24c5bb5b4236176814e81481317c9adbf291f9cac18d115c522c5557fb
+  metadata.gz: bca4a5115ea7fcfbf351d961cd5390c8235068306d1480337d06b6a6177cd6617d4f9132976e980789ef853531ba9d67ba61cc876f2895fdc041796ed105affc
+  data.tar.gz: 333c32e5bd377d2947f3c705bd8ffb96af4d7a5c5720282eaf6264e5211342fb52e0851dfe5e0fe8bed6e9b341269f5e5509c264b06e1285f635673b5bad7ca3

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    ci_toolkit (1.4.12)
+    ci_toolkit (1.5.1)
       faraday
       faraday_middleware
+      gitlab
       jwt
       octokit
       openssl
@@ -15,7 +16,7 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    date (3.2.0)
+    date (3.2.1)
     diff-lcs (1.4.4)
     docile (1.4.0)
     faraday (1.8.0)
@@ -39,9 +40,19 @@ GEM
     faraday-rack (1.0.0)
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
+    gitlab (4.18.0)
+      httparty (~> 0.18)
+      terminal-table (>= 1.5.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
     ipaddr (1.2.3)
     json (2.5.1)
     jwt (2.3.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
     multipart-post (2.1.1)
     octokit (4.21.0)
       faraday (>= 0.9)
@@ -98,6 +109,8 @@ GEM
       json
       simplecov
     simplecov_json_formatter (0.1.3)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
     time (0.2.0)
       date
     unicode-display_width (2.1.0)
@@ -118,4 +131,4 @@ DEPENDENCIES
   simplecov-json
 
 BUNDLED WITH
-   2.2.30
+   2.3.16

data/README.md

@@ -1,6 +1,6 @@
-# CiToolkit [![Lint & run tests](https://github.com/crvshlab/ci_toolkit/actions/workflows/lint_test_and_release.yml/badge.svg)](https://github.com/crvshlab/ci_toolkit/actions/workflows/lint_and_run_tests.yml) [![CodeQL](https://github.com/crvshlab/ci_toolkit/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/crvshlab/ci_toolkit/actions/workflows/codeql-analysis.yml.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=crvshlab_ci_toolkit&metric=alert_status&token=f10d3b754be5144c5acced94b8f2fe8705045db7)](https://sonarcloud.io/dashboard?id=crvshlab_ci_toolkit) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=crvshlab_ci_toolkit&metric=coverage&token=f10d3b754be5144c5acced94b8f2fe8705045db7)](https://sonarcloud.io/dashboard?id=crvshlab_ci_toolkit) 
+# CiToolkit [![Lint & run tests](https://github.com/crvshlab/ci_toolkit/actions/workflows/lint_test_and_release.yml/badge.svg)](https://github.com/crvshlab/ci_toolkit/actions/workflows/lint_and_run_tests.yml) [![CodeQL](https://github.com/crvshlab/ci_toolkit/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/crvshlab/ci_toolkit/actions/workflows/codeql-analysis.yml.yml)
 
-A collection of utility classes used to glue information between Github and CI (Bitrise primarily)
+A collection of utility classes used to glue information between Github, Gitlab and CI (Bitrise primarily)
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/ci_toolkit/build_status.rb

@@ -4,7 +4,11 @@ module CiToolkit
   # allows to have a combined build status for all builds that are triggered for a pull request
   # it uses the description of the status check on Github to parse the number of builds remaining and total
   class BuildStatus
-    def initialize(context = "Builds", github = CiToolkit::GithubPr.new, env = CiToolkit::BitriseEnv.new)
+    def initialize(
+      context = "Builds",
+      github = CiToolkit::DvcsPrFactory.create(CiToolkit::BitriseEnv.new),
+      env = CiToolkit::BitriseEnv.new
+    )
       @context = context
       @github = github
       @env = env

data/lib/ci_toolkit/dvcs_pr.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Credits: https://metabates.com/2011/02/07/building-interfaces-and-abstract-classes-in-ruby/
+module AbstractInterface
+  # Use this if you want to enforce some form of contract for an implementing class
+  class InterfaceNotImplementedError < NoMethodError
+  end
+
+  def self.included(klass)
+    klass.send(:include, AbstractInterface::Methods)
+    klass.send(:extend, AbstractInterface::Methods)
+  end
+
+  # Use this to enforce that implementing class do implemented the needed contract
+  module Methods
+    def api_not_implemented(klass, method_name = nil)
+      if method_name.nil?
+        caller.first.match(/in `(.+)'/)
+        method_name = Regexp.last_match(1)
+      end
+      raise AbstractInterface::InterfaceNotImplementedError,
+            "#{klass.class.name} needs to implement '#{method_name}' for interface #{name}!"
+    end
+  end
+end
+
+module CiToolkit
+  # This needs to be implemented if you want to implement a distribution version control system be used by
+  # ci_toolkit. Similar to GithubPr and GitlabPr classes
+  class DvcsPr
+    include AbstractInterface
+
+    def title
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def number
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def lines_of_code_changed
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def comments
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def comment(_text)
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def delete_comments_including_text(_text)
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def delete_comment(_comment_id)
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def find_comments_including_text(_text)
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def labels
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def files
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def create_status(_state, _context, _target_url, _description)
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def get_status(_context)
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def build_types
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def infrastructure_work?
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def work_in_progress?
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def big?
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
+    def realm_module_modified?
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+  end
+end

data/lib/ci_toolkit/dvcs_pr_factory.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CiToolkit
+  # Use this to create an instance of Dvcs implementation based on the service type
+  # set in an environment value called DVCS_SERVICW with value of gitlab or github
+  class DvcsPrFactory
+    SERVICES = {
+      "gitlab" => CiToolkit::GitlabPr,
+      "github" => CiToolkit::GithubPr
+    }.freeze
+
+    private_constant :SERVICES
+
+    def self.create(bitrise_env = CiToolkit::BitriseEnv.new)
+      service = ENV["DVCS_SERVICE"]
+      (SERVICES[service.to_s.downcase] || CiToolkit::DvcsPr).new bitrise_env
+    end
+  end
+end

data/lib/ci_toolkit/github_pr.rb

@@ -4,13 +4,14 @@ require "octokit"
 
 module CiToolkit
   # Can be used to retrieve information about a PR on Github via the Github API
-  class GithubPr
+  class GithubPr < DvcsPr
     def initialize(
       env = CiToolkit::BitriseEnv.new,
       build_types = ENV["BUILD_TYPES"]&.split(/,/) || ["BluetoothDemo", "Acceptance PreProd", "Acceptance Prod",
                                                        "Latest Prod", "Latest PreProd", "Mock", "Design System"],
       client = Octokit::Client.new
     )
+      super()
       @pr_number = env.pull_request_number
       @repo_slug = env.repository_path
       @commit_sha = env.git_commit

data/lib/ci_toolkit/gitlab_pr.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "gitlab"
+
+module CiToolkit
+  # Can be used to retrieve information about a PR on Github via the Github API
+  class GitlabPr < DvcsPr
+    def initialize(
+      env = CiToolkit::BitriseEnv.new,
+      build_types = ENV["BUILD_TYPES"]&.split(/,/) || ["BluetoothDemo", "Acceptance PreProd", "Acceptance Prod",
+                                                       "Latest Prod", "Latest PreProd", "Mock", "Design System"],
+
+      client = Gitlab.client(endpoint: ENV["GITLAB_API_URL"] || "",
+                             private_token: ENV["GITLAB_USER_PRIVATE_TOKEN"] || "")
+    )
+      super()
+      @pr_number = env.pull_request_number
+      @repo_slug = env.repository_path
+      @commit_sha = env.git_commit
+      @_client = client
+      @build_types = build_types
+      @bot = CiToolkit::GithubBot.new
+    end
+
+    def title
+      client.merge_request(@repo_slug, @pr_number).title || ""
+    end
+
+    def number
+      @pr_number
+    end
+
+    def lines_of_code_changed
+      pr = client.merge_request(@repo_slug, @pr_number)
+      pr.changes_count
+    end
+
+    def comments
+      client.merge_request_notes(@repo_slug, @pr_number).map(&:body)
+    end
+
+    def comment(text)
+      # github comment character limit is 65536
+      client.create_merge_request_note(@repo_slug, @pr_number, text[0...65_500])
+    end
+
+    def delete_comments_including_text(text)
+      comments = find_comments_including_text(text)
+      comments.each { |comment| delete_comment(comment.id) }
+    end
+
+    def delete_comment(comment_id)
+      client.delete_merge_request_note(@repo_slug, @pr_number, comment_id)
+    end
+
+    def find_comments_including_text(text)
+      comments = []
+      client.merge_request_notes(@repo_slug, @pr_number).map do |item|
+        comments << item if item.body&.include? text
+      end
+      comments
+    end
+
+    def labels
+      client.merge_request(@repo_slug, @pr_number).labels.map { |item| item }
+    end
+
+    def files
+      client.merge_request_changes(@repo_slug, @pr_number)
+    end
+
+    def create_status(state, context, target_url, description)
+      client.update_commit_status(
+        @repo_slug,
+        @commit_sha,
+        state,
+        { context: context, target_url: target_url, description: description }
+      )
+    end
+
+    def get_status(context)
+      client.commit_status(@repo_slug, @commit_sha).each do |status|
+        return status if status.name == context
+      end
+      nil
+    end
+
+    def build_types
+      types = []
+      @build_types.each do |type|
+        if comments.include?("#{type} build") || labels.include?("#{type} build") ||
+           comments.include?(type) || labels.include?(type)
+          types.push(type)
+        end
+      end
+      types
+    end
+
+    def infrastructure_work?
+      !(title =~ /\[infra\]/i).nil? || labels.include?("Infra")
+    end
+
+    def work_in_progress?
+      title.include?("[WIP]") || labels.include?("WIP")
+    end
+
+    def big?
+      lines_of_code_changed > 500
+    end
+
+    def realm_module_modified?
+      modified_files = files.select { |file| file&.old_path&.start_with? "cache/" }
+      modified_files.length.positive?
+    end
+
+    private
+
+    def client
+      @_client = GitLab::Client.new if @_client.nil?
+      # @_client.access_token = @bot.create_token if @_client.access_token.nil?
+
+      @_client
+    end
+  end
+end

data/lib/ci_toolkit/pr_messenger.rb

@@ -4,7 +4,7 @@ module CiToolkit
   # Sends messages to a Github PR for predefined build events
   class PrMessenger
     def initialize(
-      github_pr = CiToolkit::GithubPr.new,
+      github_pr = CiToolkit::DvcsPrFactory.create(CiToolkit::BitriseEnv.new),
       messenger_text = CiToolkit::PrMessengerText.new
     )
       @github_pr = github_pr

data/lib/ci_toolkit.rb

@@ -4,8 +4,11 @@ require "ci_toolkit/bitrise_env"
 require "ci_toolkit/build"
 require "ci_toolkit/build_status"
 require "ci_toolkit/duplicate_files_finder"
+require "ci_toolkit/dvcs_pr"
 require "ci_toolkit/github_bot"
 require "ci_toolkit/github_pr"
+require "ci_toolkit/gitlab_pr"
+require "ci_toolkit/dvcs_pr_factory"
 require "ci_toolkit/git"
 require "ci_toolkit/jira"
 require "ci_toolkit/pr_messenger"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.4.12
+  version: 1.5.1
 platform: ruby
 authors:
 - Gero Keller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-12 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -208,9 +222,12 @@ files:
 - lib/ci_toolkit/build.rb
 - lib/ci_toolkit/build_status.rb
 - lib/ci_toolkit/duplicate_files_finder.rb
+- lib/ci_toolkit/dvcs_pr.rb
+- lib/ci_toolkit/dvcs_pr_factory.rb
 - lib/ci_toolkit/git.rb
 - lib/ci_toolkit/github_bot.rb
 - lib/ci_toolkit/github_pr.rb
+- lib/ci_toolkit/gitlab_pr.rb
 - lib/ci_toolkit/jira.rb
 - lib/ci_toolkit/pr_messenger.rb
 - lib/ci_toolkit/pr_messenger_text.rb