ci_toolkit 1.6.2 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcff525b13f81bed444cb020bd0b41da763c049a3fc701ab69667b95667c45f1
-  data.tar.gz: 7838f0ab23174aef2eacf27438fa01359a35d0a39742d734372a25b18af239ad
+  metadata.gz: bf8748ff0d666c907fac0f8bb328531e6536c49b19cd39fd99662d8aea067d8a
+  data.tar.gz: 79caaeae3543c703d77c8f239c3b7f37e0d86aae44f78a22c542e7694855a11a
 SHA512:
-  metadata.gz: 777b3ed09754c520fc539b29021f50f6b814b56a4cb2aee5d1cc4169b1840159aca5d16d6091677497dec6b7528c7ae1feb72cc1f306b6a43113513d27f63a7d
-  data.tar.gz: 9db6afb245cd1f70fbb8fbef7b35d1198b0b5937ea70c7c8e78962d9001022443d787f5cd8a7227b1e9ea318729d720fd914b64cc1f30389ce834fbf5af4c45e
+  metadata.gz: 88c8227691bc19dac3d5b6c7b79a785067780d1021488035b355dcbd9f02c70250196db31410c6ff245187ab7fa1376dd98f4f07117c8a2aa208eaf60c93a261
+  data.tar.gz: fb4df2fe415536e4a61872a93f507da43e0378b47af051050e35b4b82fc10413c153ad065e87c6f17a3d40b2463a722f2de7a472062115b347b325d497267951

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ci_toolkit (1.6.2)
+    ci_toolkit (1.6.4)
       faraday
       faraday-multipart
       faraday_middleware
@@ -124,6 +124,7 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  aarch64-linux
   universal-darwin-20
   x86_64-darwin-21
   x86_64-darwin-22

data/README.md

@@ -23,6 +23,13 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+## Docker Install
+If you've docker already [installed](https://docs.docker.com/docker-for-mac/install/) you can build and run the image to get started.
+
+```shell
+docker-compose run app sh
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/crvshlab/ci_toolkit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ci_toolkit/blob/master/CODE_OF_CONDUCT.md).

data/RELEASING.md

@@ -0,0 +1,7 @@
+### How to make a release
+
+- Bump the version number in `Gemfile.lock` to the new version.
+- Bump the version number in `ci_toolkit.gemspec` to the new version.
+- `git commit -am "Version X.Y.Z."` (where X.Y.Z is the new version).
+- `git tag -a vX.Y.X -m "Version X.Y.Z"` (where X.Y.Z is the new version).
+- `git push && git push --tags`.

data/ci_toolkit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "ci_toolkit"
-  spec.version       = "1.6.2"
+  spec.version       = "1.6.4"
   spec.authors       = ["Gero Keller"]
   spec.email         = ["gero.f.keller@gmail.com"]
 

data/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3'
+services:
+  app:
+    build:
+      context: .
+      dockerfile: ./.devcontainer/Dockerfile
+    volumes:
+      - .:/opt/ci_toolkit

data/lib/ci_toolkit/build_types.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CiToolkit
+  # util class to get actual valid list of build types
+  class BuildTypes
+    # get actual valid list of build types
+    def get_build_types(build_types_arr, comments, labels)
+      types = []
+      build_types_arr.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
+  end
+end

data/lib/ci_toolkit/dvcs_pr.rb

@@ -98,6 +98,10 @@ module CiToolkit
       CiToolkit::DvcsPr.api_not_implemented(self)
     end
 
+    def certificate_pinning_logic_modified?
+      CiToolkit::DvcsPr.api_not_implemented(self)
+    end
+
     def get_status_description(_context)
       CiToolkit::DvcsPr.api_not_implemented(self)
     end

data/lib/ci_toolkit/github_pr.rb

@@ -18,6 +18,8 @@ module CiToolkit
       @_client = client
       @build_types = build_types
       @bot = CiToolkit::GithubBot.new
+      @changes_detector = GithubSpecificFilesChangesDetector.new
+      @build_types_getter = CiToolkit::BuildTypes.new
     end
 
     def title
@@ -83,14 +85,7 @@ module CiToolkit
     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
+      @build_types_getter.get_build_types(@build_types, comments, labels)
     end
 
     def infrastructure_work?
@@ -106,8 +101,11 @@ module CiToolkit
     end
 
     def realm_module_modified?
-      modified_files = files.select { |file| file[:filename]&.start_with? "cache/" }
-      modified_files.length.positive?
+      @changes_detector.realm_module_modified(files)
+    end
+
+    def certificate_pinning_logic_modified?
+      @changes_detector.certificate_pinning_logic_modified(files)
     end
 
     def get_status_description(context)
@@ -126,4 +124,30 @@ module CiToolkit
       @_client
     end
   end
+
+  # util class to verify modifications in app files that may have been broken in the past
+  class GithubSpecificFilesChangesDetector
+    def realm_module_modified(files)
+      modified_files = files.select { |file| file[:filename]&.start_with? "cache/" }
+      modified_files.length.positive?
+    end
+
+    def certificate_pinning_logic_modified(files)
+      modified_files = files.select do |file|
+        contains_substring(file[:filename],
+                           %w[HttpClientFactory SecurePreferences CertificatePinningConfiguration SSLPinner
+                              CertificateDateChecker])
+      end
+      modified_files.length.positive?
+    end
+
+    private
+
+    def contains_substring(input_string, substrings)
+      return false if input_string.nil?
+
+      regex = Regexp.union(substrings.map { |s| Regexp.new(s, Regexp::IGNORECASE) })
+      !!(input_string =~ regex)
+    end
+  end
 end

data/lib/ci_toolkit/gitlab_pr.rb

@@ -20,6 +20,8 @@ module CiToolkit
       @_client = bot.client
       @build_types = build_types
       @bot = bot
+      @changes_detector = GitlabSpecificFilesChangesDetector.new
+      @build_types_getter = CiToolkit::BuildTypes.new
     end
 
     def title
@@ -86,14 +88,7 @@ module CiToolkit
     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
+      @build_types_getter.get_build_types(@build_types, comments, labels)
     end
 
     def infrastructure_work?
@@ -109,8 +104,11 @@ module CiToolkit
     end
 
     def realm_module_modified?
-      modified_files = files.select { |file| file&.old_path&.start_with? "cache/" }
-      modified_files.length.positive?
+      @changes_detector.realm_module_modified(files)
+    end
+
+    def certificate_pinning_logic_modified?
+      @changes_detector.certificate_pinning_logic_modified(files)
     end
 
     def get_status_description(context)
@@ -127,4 +125,30 @@ module CiToolkit
       @_client
     end
   end
+
+  # util class to verify modifications in app files that may have been broken in the past
+  class GitlabSpecificFilesChangesDetector
+    def realm_module_modified(files)
+      modified_files = files.select { |file| file&.old_path&.start_with? "cache/" }
+      modified_files.length.positive?
+    end
+
+    def certificate_pinning_logic_modified(files)
+      modified_files = files.select do |file|
+        contains_substring(file&.old_path,
+                           %w[HttpClientFactory SecurePreferences CertificatePinningConfiguration SSLPinner
+                              CertificateDateChecker])
+      end
+      modified_files.length.positive?
+    end
+
+    private
+
+    def contains_substring(input_string, substrings)
+      return false if input_string.nil?
+
+      regex = Regexp.union(substrings.map { |s| Regexp.new(s, Regexp::IGNORECASE) })
+      !!(input_string =~ regex)
+    end
+  end
 end

data/lib/ci_toolkit/pr_messenger.rb

@@ -55,6 +55,15 @@ module CiToolkit
       delete(@messenger_text.realm_modified_warning_title)
     end
 
+    def send_certificate_pinning_modified_android_warning
+      delete_certificate_pinning_modified_android_warning
+      send(@messenger_text.certificate_pinning_logic_modified_android_title)
+    end
+
+    def delete_certificate_pinning_modified_android_warning
+      delete(@messenger_text.certificate_pinning_logic_modified_android_title)
+    end
+
     def send_big_pr_warning
       delete_big_pr_warning
       send(@messenger_text.big_pr_warning_title)

data/lib/ci_toolkit/pr_messenger_text.rb

@@ -45,6 +45,13 @@ module CiToolkit
       warning_with_message("Realm module modified. Did you remember to add migrations?")
     end
 
+    def certificate_pinning_logic_modified_android_title
+      warning_with_message("Detected modifications in Certificate pinning related files " \
+                           "(HttpClientFactory / SecurePreferences / CertificatePinningConfiguration / " \
+                           "SSLPinner / CertificateDateChecker). If you are doing temporary changes " \
+                           "to pinning, do not merge this MR until you revert them!")
+    end
+
     def big_pr_warning_title
       warning_with_message("Big PR")
     end

data/lib/ci_toolkit/seetest_bot.rb

@@ -3,10 +3,12 @@
 require "gitlab"
 
 module CiToolkit
-  # Utility class that provides an faraday connection
+  # Utility class that provides a faraday connection
   class SeeTestBot
     attr_reader :faraday_conn
 
+    TIMEOUT = 60
+
     # Provides a base url, an endpoint and an access token that can be used to
     # interact with the SeeTest web service
     class Credentials
@@ -24,6 +26,8 @@ module CiToolkit
     def initialize(
       credentials = CiToolkit::SeeTestBot::Credentials.new,
       faraday_conn = Faraday.new(url: credentials.base_url) do |f|
+        f.options.timeout = TIMEOUT
+        f.options.open_timeout = TIMEOUT
         f.request :authorization, "Bearer", credentials.access_token
         f.request :multipart
         f.request :url_encoded

data/lib/ci_toolkit.rb

@@ -18,6 +18,7 @@ require "ci_toolkit/jira"
 require "ci_toolkit/pr_messenger"
 require "ci_toolkit/pr_messenger_text"
 require "ci_toolkit/bitrise_client"
+require "ci_toolkit/build_types"
 
 module CiToolkit
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.4
 platform: ruby
 authors:
 - Gero Keller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -226,16 +226,19 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - bin/console
 - bin/setup
 - ci_toolkit.gemspec
+- docker-compose.yml
 - duplicate_files_whitelist.txt
 - lib/ci_toolkit.rb
 - lib/ci_toolkit/bitrise_client.rb
 - lib/ci_toolkit/bitrise_env.rb
 - lib/ci_toolkit/build.rb
 - lib/ci_toolkit/build_status.rb
+- lib/ci_toolkit/build_types.rb
 - lib/ci_toolkit/duplicate_files_finder.rb
 - lib/ci_toolkit/dvcs_pr.rb
 - lib/ci_toolkit/dvcs_pr_factory.rb
@@ -275,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Set of CI utilities