Add release checks

Author: Taucher2003

.gitlab/ci/release-coordinator.canary.gitlab-ci.yml

@@ -1,5 +1,5 @@
 .release-coordinator:canary:stages:
-  - release-coordinator:canary:notify-start
+  - release-coordinator:canary:prepare
   - release-coordinator:canary:build
   - release-coordinator:canary:publish
   - release-coordinator:canary:notify-finish
@@ -11,12 +11,23 @@
 release-coordinator:canary:notify-start:
   extends:
     - .release-coordinator:canary
-  stage: release-coordinator:canary:notify-start
+  stage: release-coordinator:canary:prepare
   script:
     - bin/pyxis internal notify_new_coordinator --coordinator-pipeline-id $CI_PIPELINE_ID
   variables:
     DRY_RUN: "false"
 
+release-coordinator:canary:check:
+  extends:
+    - .release-coordinator:canary
+  stage: release-coordinator:canary:prepare
+  needs:
+    - release-coordinator:canary:notify-start
+  script:
+    - bin/pyxis internal check_canary_release --build-id-to-promote $BUILD_ID_TO_PROMOTE
+  variables:
+    DRY_RUN: "false"
+
 release-coordinator:canary:tmp-branch:
   extends:
     - .release-coordinator:canary

Gemfile

@@ -18,3 +18,5 @@ gem 'semantic_logger', '~> 4.16', require: 'semantic_logger/sync'
 gem 'json', '~> 2.12'
 
 gem 'discordrb', '~> 3.7'
+
+gem 'toml-rb', '~> 4.1'

Gemfile.lock

@@ -6,6 +6,7 @@ GEM
     ast (2.4.3)
     base64 (0.3.0)
     bigdecimal (4.0.1)
+    citrus (3.0.2)
     concurrent-ruby (1.3.5)
     discordrb (3.7.2)
       base64 (~> 0.2)
@@ -91,9 +92,9 @@ GEM
     semantic_logger (4.16.1)
       concurrent-ruby (~> 1.0)
     thor (1.3.2)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    toml-rb (4.1.0)
+      citrus (~> 3.0, > 3.0)
+      racc (~> 1.7)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
@@ -119,6 +120,7 @@ DEPENDENCIES
   rubocop (~> 1.76)
   semantic_logger (~> 4.16)
   thor (~> 1.3)
+  toml-rb (~> 4.1)
   zeitwerk (~> 2.7)
 
 BUNDLED WITH

lib/pyxis/checks/aggregated_check.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Pyxis
+  module Checks
+    class AggregatedCheck
+      include Check
+
+      attr_reader :check_context, :checks
+
+      def initialize(check_context, checks)
+        @check_context = check_context
+        @checks = checks
+      end
+
+      def perform_check!
+        checks.all?(&:pass?)
+      end
+
+      def status_message
+        message = []
+        message << if pass?
+                     "#{icon} #{check_context} checks pass"
+                   else
+                     "#{icon} #{check_context} checks fail"
+                   end
+        checks.each do |check|
+          message << ''
+          message << check.status_message
+        end
+
+        message.join("\n")
+      end
+    end
+  end
+end

lib/pyxis/checks/canary_release.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pyxis
+  module Checks
+    class CanaryRelease < AggregatedCheck
+      def initialize(build_id_to_promote)
+        info = Pyxis::ManagedVersioning::ComponentInfo.new(build_id: build_id_to_promote)
+        super(
+          'Canary release',
+          [
+            TucanaVersionMatch.new(info),
+            OpenIssues.new('release blocking', ['blocks-releases'])
+          ]
+        )
+      end
+    end
+  end
+end

lib/pyxis/checks/check.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Pyxis
+  module Checks
+    module Check
+      def perform_check!
+        raise NotImplementedError
+      end
+
+      def status_message
+        raise NotImplementedError
+      end
+
+      def pass?
+        return @pass if defined?(@pass)
+
+        @pass = perform_check!
+      end
+
+      def icon
+        if pass?
+          pass_icon
+        else
+          fail_icon
+        end
+      end
+
+      def pass_icon
+        '✅' # :white_check_mark:
+      end
+
+      def fail_icon
+        '❌' # :x:
+      end
+    end
+  end
+end

lib/pyxis/checks/open_issues.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Pyxis
+  module Checks
+    class OpenIssues
+      include Check
+
+      attr_reader :check_context, :labels
+
+      def initialize(check_context, labels)
+        @check_context = check_context
+        @labels = labels
+      end
+
+      def perform_check!
+        issues.empty?
+      end
+
+      def status_message
+        return "#{icon} No open #{check_context} issues" if pass?
+
+        message = []
+        message << "#{icon} Open #{check_context} issues"
+        issues.each do |issue|
+          message << "- [#{issue.title}](#{issue.html_url})"
+        end
+
+        message.join("\n")
+      end
+
+      private
+
+      def issues
+        @issues ||= GithubClient.octokit.search_issues(
+          "org:#{GithubClient::ORGANIZATION_NAME} is:open is:issue #{labels.map { |l| "label:#{l}" }.join(' ')}"
+        ).items
+      end
+    end
+  end
+end

lib/pyxis/checks/tucana_version_match.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Pyxis
+  module Checks
+    class TucanaVersionMatch
+      include Check
+
+      attr_reader :component_info
+
+      def initialize(component_info)
+        @component_info = component_info
+      end
+
+      def perform_check!
+        [sagittarius_version, aquila_version, draco_version, taurus_version].uniq.size == 1
+      end
+
+      def status_message
+        return "#{icon} Components use the same tucana version" if pass?
+
+        message = []
+        message << "#{icon} Components use different tucana versions"
+        message << ''
+        message << "sagittarius: #{sagittarius_version}"
+        message << "aquila: #{aquila_version}"
+        message << "draco: #{draco_version}"
+        message << "taurus: #{taurus_version}"
+
+        message.join("\n")
+      end
+
+      private
+
+      def sagittarius_version
+        return @sagittarius_version if defined?(@sagittarius_version)
+
+        gemfile_content = Base64.decode64 GithubClient.octokit.contents(
+          Project::Sagittarius.github_path,
+          path: 'Gemfile.lock',
+          ref: executed_component_info[:sagittarius]
+        ).content
+
+        @sagittarius_version = Bundler::LockfileParser.new(gemfile_content)
+                                                      .specs
+                                                      .find { |spec| spec.name == 'tucana' }
+                                                      .version
+                                                      .to_s
+      end
+
+      def aquila_version
+        @aquila_version ||= from_cargo_lockfile(
+          Base64.decode64(
+            GithubClient.octokit.contents(
+              Project::Aquila.github_path,
+              path: 'Cargo.lock',
+              ref: executed_component_info[:aquila]
+            ).content
+          )
+        )
+      end
+
+      def draco_version
+        @draco_version ||= from_cargo_lockfile(
+          Base64.decode64(
+            GithubClient.octokit.contents(
+              Project::Draco.github_path,
+              path: 'Cargo.lock',
+              ref: executed_component_info[:draco]
+            ).content
+          )
+        )
+      end
+
+      def taurus_version
+        @taurus_version ||= from_cargo_lockfile(
+          Base64.decode64(
+            GithubClient.octokit.contents(
+              Project::Taurus.github_path,
+              path: 'Cargo.lock',
+              ref: executed_component_info[:taurus]
+            ).content
+          )
+        )
+      end
+
+      def from_cargo_lockfile(lockfile)
+        toml = TomlRB.parse(lockfile, symbolize_keys: true)
+        toml[:package].find { |package| package[:name] == 'tucana' }[:version]
+      end
+
+      def executed_component_info
+        @executed_component_info ||= component_info.execute
+      end
+    end
+  end
+end

lib/pyxis/commands/internal.rb

@@ -76,6 +76,20 @@ def notify_finish_coordinator
           #{pipeline.web_url}
         DESC
       end
+
+      desc 'check_canary_release', ''
+      method_option :build_id_to_promote, required: true, type: :numeric
+      def check_canary_release
+        check = Pyxis::Checks::CanaryRelease.new(options[:build_id_to_promote])
+
+        severity = check.pass? ? :info : :error
+
+        Pyxis::DiscordClient.new.send_notification(check.status_message, severity)
+
+        puts check.status_message
+
+        exit(false) unless check.pass?
+      end
     end
   end
 end