POC: Unit tests in Github Actions

.github/workflows/test.yml

@@ -0,0 +1,133 @@
+# Please do NOT manually edit this file.
+# This file is generated by 'bundle exec rake github:actions:test_template'
+---
+name: Unit Tests
+'on':
+  push:
+    branches:
+    - master
+    - poc/**
+  schedule:
+  - cron: 0 7 * * *
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: "${{ github.ref != 'refs/heads/master' }}"
+jobs:
+  compute_tasks:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        engine:
+        - name: ruby
+          version: '3.3'
+          alias: ruby-33
+        - name: ruby
+          version: '3.2'
+          alias: ruby-32
+    container:
+      image: ghcr.io/datadog/images-rb/engines/${{ matrix.engine.name }}:${{ matrix.engine.version }}
+    outputs:
+      ruby-33-matrix: "${{ steps.set-matrix.outputs.ruby-33 }}"
+      ruby-32-matrix: "${{ steps.set-matrix.outputs.ruby-32 }}"
+    steps:
+    - uses: actions/checkout@v4
+    - run: bundle install
+    - id: set-matrix
+      run: |
+        matrix_json=$(bundle exec rake github:generate_matrix)
+        # Debug output
+        echo "Generated JSON:"
+        echo "$matrix_json"
+        # Set the output
+        echo "${{ matrix.engine.alias }}=$(echo "$matrix_json")" >> $GITHUB_OUTPUT
+    - run: bundle cache
+    - uses: actions/upload-artifact@v4
+      with:
+        name: bundled-dependencies-${{ github.run_id }}-${{ matrix.engine.alias }}
+        retention-days: 1
+        path: |
+          Gemfile.lock
+          vendor/
+  test-ruby-33:
+    name: 'ruby-3.3: ${{ matrix.task }} (${{ matrix.group }})'
+    needs:
+    - compute_tasks
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include: "${{ fromJson(needs.compute_tasks.outputs.ruby-33-matrix) }}"
+    container:
+      image: ghcr.io/datadog/images-rb/engines/ruby:3.3
+      env:
+        TEST_POSTGRES_HOST: postgres
+        TEST_REDIS_HOST: redis
+    services:
+      postgres:
+        image: postgres:9.6
+        credentials:
+          username: "${{ secrets.DOCKERHUB_USERNAME }}"
+          password: "${{ secrets.DOCKERHUB_TOKEN }}"
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_USER: postgres
+          POSTGRES_DB: postgres
+      redis:
+        image: redis:6.2
+        credentials:
+          username: "${{ secrets.DOCKERHUB_USERNAME }}"
+          password: "${{ secrets.DOCKERHUB_TOKEN }}"
+    steps:
+    - uses: actions/checkout@v4
+    - name: Configure Git
+      run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+    - uses: actions/download-artifact@v4
+      with:
+        name: bundled-dependencies-${{ github.run_id }}-ruby-33
+    - run: bundle install --local
+    - name: Test ${{ matrix.task }} with ${{ matrix.gemfile }}
+      env:
+        BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+      run: bundle install && bundle exec rake spec:${{ matrix.task }}
+  test-ruby-32:
+    name: 'ruby-3.2: ${{ matrix.task }} (${{ matrix.group }})'
+    needs:
+    - compute_tasks
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include: "${{ fromJson(needs.compute_tasks.outputs.ruby-32-matrix) }}"
+    container:
+      image: ghcr.io/datadog/images-rb/engines/ruby:3.2
+      env:
+        TEST_POSTGRES_HOST: postgres
+        TEST_REDIS_HOST: redis
+    services:
+      postgres:
+        image: postgres:9.6
+        credentials:
+          username: "${{ secrets.DOCKERHUB_USERNAME }}"
+          password: "${{ secrets.DOCKERHUB_TOKEN }}"
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_USER: postgres
+          POSTGRES_DB: postgres
+      redis:
+        image: redis:6.2
+        credentials:
+          username: "${{ secrets.DOCKERHUB_USERNAME }}"
+          password: "${{ secrets.DOCKERHUB_TOKEN }}"
+    steps:
+    - uses: actions/checkout@v4
+    - name: Configure Git
+      run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+    - uses: actions/download-artifact@v4
+      with:
+        name: bundled-dependencies-${{ github.run_id }}-ruby-32
+    - run: bundle install --local
+    - name: Test ${{ matrix.task }} with ${{ matrix.gemfile }}
+      env:
+        BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+      run: bundle install && bundle exec rake spec:${{ matrix.task }}

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
   "files.associations": {
     "*.gemfile": "ruby",
+    "Matrixfile": "ruby",
     "Dockerfile*": "dockerfile"
   }
 }

tasks/github.rake

@@ -0,0 +1,232 @@
+require 'json'
+require "psych"
+require 'ostruct'
+require_relative 'appraisal_conversion'
+
+# rubocop:disable Metrics/BlockLength
+namespace :github do
+  namespace :actions do
+    task :test_template do |t|
+      ubuntu = "ubuntu-22.04"
+
+      # Still being rate limited
+      docker_login_credentials = {
+        "username" => '${{ secrets.DOCKERHUB_USERNAME }}',
+        "password" => '${{ secrets.DOCKERHUB_TOKEN }}'
+      }
+
+      postgres = {
+        "image" => "postgres:9.6",
+        "credentials" => docker_login_credentials,
+        "env" => {
+          "POSTGRES_PASSWORD" => "postgres",
+          "POSTGRES_USER" => "postgres",
+          "POSTGRES_DB" => "postgres",
+        }
+      }
+
+      redis = {
+        "image" => "redis:6.2",
+        "credentials" => docker_login_credentials,
+      }
+
+      runtimes = [
+        "ruby:3.3",
+        "ruby:3.2",
+        # "ruby:3.1",
+        # "ruby:3.0",
+        # "ruby:2.7",
+        # "ruby:2.6",
+        # "ruby:2.5",
+        # "jruby:9.4",
+        # "jruby:9.3",
+        # "jruby:9.2",
+      ].map do |runtime|
+        engine, version = runtime.split(':')
+        runtime_alias = "#{engine}-#{version.gsub('.', '')}"
+
+        OpenStruct.new(
+          "engine" => engine,
+          "version" => version,
+          "alias" => runtime_alias,
+          "image" => "ghcr.io/datadog/images-rb/engines/#{engine}:#{version}"
+        )
+      end
+
+      test_jobs = runtimes.map do |runtime|
+        {
+          "test-#{runtime.alias}" => {
+            "name" => "#{runtime.engine}-#{runtime.version}: ${{ matrix.task }} (${{ matrix.group }})",
+            "needs" => ["compute_tasks"],
+            "runs-on" => ubuntu,
+            "strategy" => {
+              "fail-fast" => false,
+              "matrix" => {
+                "include" => "${{ fromJson(needs.compute_tasks.outputs.#{runtime.alias}-matrix) }}"
+              }
+            },
+            "container" => {
+              "image" => runtime.image,
+              "env" => {
+                "TEST_POSTGRES_HOST" => "postgres",
+                "TEST_REDIS_HOST" => "redis",
+              }
+            },
+            "services" => {
+              "postgres" => postgres,
+              "redis" => redis,
+            },
+            "steps" => [
+              { "uses" => "actions/checkout@v4" },
+              {
+                "name" => "Configure Git",
+                "run" => 'git config --global --add safe.directory "$GITHUB_WORKSPACE"'
+              },
+              {
+                "uses" => "actions/download-artifact@v4",
+                "with" => {
+                  "name" => "bundled-dependencies-${{ github.run_id }}-#{runtime.alias}",
+                }
+              },
+              { "run" => "bundle install --local" },
+              {
+                "name" => "Test ${{ matrix.task }} with ${{ matrix.gemfile }}",
+                "env" => { "BUNDLE_GEMFILE" => "${{ matrix.gemfile }}" },
+                "run" => "bundle install && bundle exec rake spec:${{ matrix.task }}"
+              }
+            ]
+          }
+        }
+      end
+
+      compute_tasks = {
+        "runs-on" => ubuntu,
+        "strategy" => {
+          "fail-fast" => false,
+          "matrix" => {
+            "engine" => runtimes.map do |runtime|
+              { "name" => runtime.engine, "version" => runtime.version, "alias" => runtime.alias }
+            end
+          }
+        },
+        "container" =>{
+          "image" => "ghcr.io/datadog/images-rb/engines/${{ matrix.engine.name }}:${{ matrix.engine.version }}"
+        },
+        "outputs" => runtimes.each_with_object({}) do |runtime, hash|
+          hash["#{runtime.alias}-matrix"] = "${{ steps.set-matrix.outputs.#{runtime.alias} }}"
+        end,
+        "steps" => [
+          { "uses" => "actions/checkout@v4" },
+          { "run" => "bundle install" },
+          {
+            "id" => "set-matrix",
+            "run" => <<~BASH
+              matrix_json=$(bundle exec rake github:generate_matrix)
+              # Debug output
+              echo "Generated JSON:"
+              echo "$matrix_json"
+              # Set the output
+              echo "${{ matrix.engine.alias }}=$(echo "$matrix_json")" >> $GITHUB_OUTPUT
+            BASH
+          },
+          { "run" => "bundle cache" },
+          {
+            "uses" => "actions/upload-artifact@v4",
+            "with" => {
+              "name" => "bundled-dependencies-${{ github.run_id }}-${{ matrix.engine.alias }}",
+              "retention-days" => 1,
+              "path" => <<~STRING
+                Gemfile.lock
+                vendor/
+              STRING
+            }
+          },
+        ]
+      }
+
+      base = {
+        "name" => 'Unit Tests',
+        "on" => {
+          "push" => {
+            "branches" => [
+              "master",
+              "poc/**",
+            ]
+          },
+          "schedule" => [
+            { "cron" => '0 7 * * *' }
+          ]
+        },
+        "concurrency" => {
+          "group" => '${{ github.workflow }}-${{ github.ref }}',
+          "cancel-in-progress" => '${{ github.ref != \'refs/heads/master\' }}'
+        },
+        "jobs" => {
+          "compute_tasks" => compute_tasks,
+          **test_jobs.reduce(&:merge)
+        }
+      }
+
+      # `Psych.dump` directly creates anchors, but Github Actions does not support anchors for YAML,
+      # convert to JSON first to avoid anchors
+      json = JSON.dump(base)
+      yaml = Psych.safe_load(json)
+
+      string = +""
+      string << <<~EOS
+        # Please do NOT manually edit this file.
+        # This file is generated by 'bundle exec rake #{t.name}'
+      EOS
+      string << Psych.dump(yaml, line_width: 120)
+      File.binwrite(".github/workflows/test.yml", string)
+    end
+  end
+
+  task :generate_matrix do
+    matrix = eval(File.read('Matrixfile')).freeze # rubocop:disable Security/Eval
+
+    candidates = [
+      'main',
+      'pg',
+      'rack',
+      'redis',
+      'sinatra',
+      'stripe'
+    ]
+
+    remainders = matrix.keys - candidates
+
+    if remainders.empty?
+      raise "No remainder found. Use the matrix directly (without candidate filtering)."
+    end
+
+    matrix = matrix.slice(*candidates)
+
+    ruby_version = RUBY_VERSION[0..2]
+    major, minor, = Gem::Version.new(RUBY_ENGINE_VERSION).segments
+    ruby_runtime = "#{RUBY_ENGINE}-#{major}.#{minor}"
+    array = []
+    matrix.each do |key, spec_metadata|
+      spec_metadata.each do |group, rubies|
+        matched = if RUBY_PLATFORM == 'java'
+          rubies.include?("✅ #{ruby_version}") && rubies.include?('✅ jruby')
+        else
+          rubies.include?("✅ #{ruby_version}")
+        end
+
+        if matched
+          gemfile = AppraisalConversion.to_bundle_gemfile(group) rescue "Gemfile"
+
+          array << {
+            group: group,
+            gemfile: gemfile,
+            task: key
+          }
+        end
+      end
+    end
+
+    puts JSON.dump(array)
+  end
+end
+# rubocop:enable Metrics/BlockLength