From af79b58741dc9e18098ccade83adedf9d1936e75 Mon Sep 17 00:00:00 2001
From: Rachael Booth <Rachael.Booth@softwire.com>
Date: Fri, 6 Dec 2024 16:51:49 +0000
Subject: [PATCH] Separate services tests to improve pipeline times (#2853)

* Display slowest test

* Attempt to improve test times on github

* Run services tests in parallel

* Try keeping services in Tests

* Revert "Try keeping services in Tests"

This reverts commit ef2e1bf4d255ed9a4bf87abda2b4d2b33787d406.

* Fix parallel setup for services tests

* Remove profiling
---
 .github/workflows/run_tests.yml        | 411 +++++++++++++++++++++++++
 .github/workflows/staging_pipeline.yml | 347 +--------------------
 spec/db/seeds_spec.rb                  |   7 +-
 3 files changed, 417 insertions(+), 348 deletions(-)
 create mode 100644 .github/workflows/run_tests.yml

diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml
new file mode 100644
index 000000000..1965a4034
--- /dev/null
+++ b/.github/workflows/run_tests.yml
@@ -0,0 +1,411 @@
+name: Run Tests
+
+on:
+  workflow_call:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+  merge_group:
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:13.5
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_USER: postgres
+          POSTGRES_DB: data_collector
+        ports:
+          - 5432:5432
+        # Needed because the Postgres container does not provide a health check
+        # tmpfs makes database faster by using RAM
+        options: >-
+          --mount type=tmpfs,destination=/var/lib/postgresql/data
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      RAILS_ENV: test
+      GEMFILE_RUBY_VERSION: 3.1.1
+      DB_HOST: localhost
+      DB_DATABASE: data_collector
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+      PARALLEL_TEST_PROCESSORS: 4
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: 20
+
+      - name: Create database
+        run: |
+          bundle exec rake parallel:setup
+
+      - name: Compile assets
+        run: |
+          bundle exec rake assets:precompile
+
+      - name: Run tests
+        run: |
+          bundle exec rake parallel:spec['spec\/(?!features|models|requests|services)']
+
+  feature_test:
+    name: Feature Tests
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:13.5
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_USER: postgres
+          POSTGRES_DB: data_collector
+        ports:
+          - 5432:5432
+        # Needed because the Postgres container does not provide a health check
+        # tmpfs makes database faster by using RAM
+        options: >-
+          --mount type=tmpfs,destination=/var/lib/postgresql/data
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      RAILS_ENV: test
+      GEMFILE_RUBY_VERSION: 3.1.1
+      DB_HOST: localhost
+      DB_DATABASE: data_collector
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: 20
+
+      - name: Create database
+        run: |
+          bundle exec rake db:prepare
+
+      - name: Compile assets
+        run: |
+          bundle exec rake assets:precompile
+
+      - name: Run tests
+        run: |
+          bundle exec rspec spec/features --fail-fast --exclude-pattern "spec/features/accessibility_spec.rb"
+
+  model_test:
+    name: Model tests
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:13.5
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_USER: postgres
+          POSTGRES_DB: data_collector
+        ports:
+          - 5432:5432
+        # Needed because the Postgres container does not provide a health check
+        # tmpfs makes database faster by using RAM
+        options: >-
+          --mount type=tmpfs,destination=/var/lib/postgresql/data
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      RAILS_ENV: test
+      GEMFILE_RUBY_VERSION: 3.1.1
+      DB_HOST: localhost
+      DB_DATABASE: data_collector
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: 20
+
+      - name: Create database
+        run: |
+          bundle exec rake db:prepare
+
+      - name: Compile assets
+        run: |
+          bundle exec rake assets:precompile
+
+      - name: Run tests
+        run: |
+          bundle exec rspec spec/models --fail-fast
+
+  requests_test:
+    name: Requests tests
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:13.5
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_USER: postgres
+          POSTGRES_DB: data_collector
+        ports:
+          - 5432:5432
+        # Needed because the Postgres container does not provide a health check
+        # tmpfs makes database faster by using RAM
+        options: >-
+          --mount type=tmpfs,destination=/var/lib/postgresql/data
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      RAILS_ENV: test
+      GEMFILE_RUBY_VERSION: 3.1.1
+      DB_HOST: localhost
+      DB_DATABASE: data_collector
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+      PARALLEL_TEST_PROCESSORS: 4
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: 20
+
+      - name: Create database
+        run: |
+          bundle exec rake parallel:setup
+
+      - name: Compile assets
+        run: |
+          bundle exec rake assets:precompile
+
+      - name: Run tests
+        run: |
+          bundle exec rake parallel:spec['spec/requests']
+
+  services_test:
+    name: Services Tests
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:13.5
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_USER: postgres
+          POSTGRES_DB: data_collector
+        ports:
+          - 5432:5432
+        # Needed because the Postgres container does not provide a health check
+        # tmpfs makes database faster by using RAM
+        options: >-
+          --mount type=tmpfs,destination=/var/lib/postgresql/data
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      RAILS_ENV: test
+      GEMFILE_RUBY_VERSION: 3.1.1
+      DB_HOST: localhost
+      DB_DATABASE: data_collector
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+      PARALLEL_TEST_PROCESSORS: 4
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: 20
+
+      - name: Create database
+        run: |
+          bundle exec rake parallel:setup
+
+      - name: Compile assets
+        run: |
+          bundle exec rake assets:precompile
+
+      - name: Run tests
+        run: |
+          bundle exec rake parallel:spec['spec\/services']
+
+  accessibility_test:
+    name: Accessibility tests
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:13.5
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_USER: postgres
+          POSTGRES_DB: data_collector
+        ports:
+          - 5432:5432
+        # Needed because the Postgres container does not provide a health check
+        # tmpfs makes database faster by using RAM
+        options: >-
+          --mount type=tmpfs,destination=/var/lib/postgresql/data
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    env:
+      RAILS_ENV: test
+      GEMFILE_RUBY_VERSION: 3.1.1
+      DB_HOST: localhost
+      DB_DATABASE: data_collector
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+      PARALLEL_TEST_PROCESSORS: 4
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: 20
+
+      - name: Create database
+        run: |
+          bundle exec rake parallel:setup
+
+      - name: Compile assets
+        run: |
+          bundle exec rake assets:precompile
+
+      - name: Run tests
+        run: |
+          bundle exec rspec spec/features/accessibility_spec.rb --fail-fast
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: 20
+
+      - name: Install packages and symlink local dependencies
+        run: |
+          yarn install --immutable --immutable-cache --check-cache
+
+      - name: Lint
+        run: |
+          bundle exec rake lint
+
+  audit:
+    name: Audit dependencies
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Audit
+        run: |
+          bundle exec bundler-audit
diff --git a/.github/workflows/staging_pipeline.yml b/.github/workflows/staging_pipeline.yml
index aff0fe5f0..a2e777db0 100644
--- a/.github/workflows/staging_pipeline.yml
+++ b/.github/workflows/staging_pipeline.yml
@@ -4,11 +4,6 @@ on:
   push:
     branches:
       - main
-  pull_request:
-    types:
-      - opened
-      - synchronize
-  merge_group:
   workflow_dispatch:
 
 defaults:
@@ -21,347 +16,13 @@ env:
   repository: core
 
 jobs:
-  test:
-    name: Tests
-    runs-on: ubuntu-latest
-
-    services:
-      postgres:
-        image: postgres:13.5
-        env:
-          POSTGRES_PASSWORD: password
-          POSTGRES_USER: postgres
-          POSTGRES_DB: data_collector
-        ports:
-          - 5432:5432
-        # Needed because the Postgres container does not provide a health check
-        # tmpfs makes database faster by using RAM
-        options: >-
-          --mount type=tmpfs,destination=/var/lib/postgresql/data
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
-    env:
-      RAILS_ENV: test
-      GEMFILE_RUBY_VERSION: 3.1.1
-      DB_HOST: localhost
-      DB_DATABASE: data_collector
-      DB_USERNAME: postgres
-      DB_PASSWORD: password
-      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
-      PARALLEL_TEST_PROCESSORS: 4
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          cache: yarn
-          node-version: 20
-
-      - name: Create database
-        run: |
-          bundle exec rake parallel:setup
-
-      - name: Compile assets
-        run: |
-          bundle exec rake assets:precompile
-
-      - name: Run tests
-        run: |
-          bundle exec rake parallel:spec['spec\/(?!features|models|requests)']
-
-  feature_test:
-    name: Feature Tests
-    runs-on: ubuntu-latest
-
-    services:
-      postgres:
-        image: postgres:13.5
-        env:
-          POSTGRES_PASSWORD: password
-          POSTGRES_USER: postgres
-          POSTGRES_DB: data_collector
-        ports:
-          - 5432:5432
-        # Needed because the Postgres container does not provide a health check
-        # tmpfs makes database faster by using RAM
-        options: >-
-          --mount type=tmpfs,destination=/var/lib/postgresql/data
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
-    env:
-      RAILS_ENV: test
-      GEMFILE_RUBY_VERSION: 3.1.1
-      DB_HOST: localhost
-      DB_DATABASE: data_collector
-      DB_USERNAME: postgres
-      DB_PASSWORD: password
-      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          cache: yarn
-          node-version: 20
-
-      - name: Create database
-        run: |
-          bundle exec rake db:prepare
-
-      - name: Compile assets
-        run: |
-          bundle exec rake assets:precompile
-
-      - name: Run tests
-        run: |
-          bundle exec rspec spec/features --fail-fast --exclude-pattern "spec/features/accessibility_spec.rb"
-
-  model_test:
-    name: Model tests
-    runs-on: ubuntu-latest
-
-    services:
-      postgres:
-        image: postgres:13.5
-        env:
-          POSTGRES_PASSWORD: password
-          POSTGRES_USER: postgres
-          POSTGRES_DB: data_collector
-        ports:
-          - 5432:5432
-        # Needed because the Postgres container does not provide a health check
-        # tmpfs makes database faster by using RAM
-        options: >-
-          --mount type=tmpfs,destination=/var/lib/postgresql/data
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
-    env:
-      RAILS_ENV: test
-      GEMFILE_RUBY_VERSION: 3.1.1
-      DB_HOST: localhost
-      DB_DATABASE: data_collector
-      DB_USERNAME: postgres
-      DB_PASSWORD: password
-      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          cache: yarn
-          node-version: 20
-
-      - name: Create database
-        run: |
-          bundle exec rake db:prepare
-
-      - name: Compile assets
-        run: |
-          bundle exec rake assets:precompile
-
-      - name: Run tests
-        run: |
-          bundle exec rspec spec/models --fail-fast
-
-  requests_test:
-    name: Requests tests
-    runs-on: ubuntu-latest
-
-    services:
-      postgres:
-        image: postgres:13.5
-        env:
-          POSTGRES_PASSWORD: password
-          POSTGRES_USER: postgres
-          POSTGRES_DB: data_collector
-        ports:
-          - 5432:5432
-        # Needed because the Postgres container does not provide a health check
-        # tmpfs makes database faster by using RAM
-        options: >-
-          --mount type=tmpfs,destination=/var/lib/postgresql/data
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
-    env:
-      RAILS_ENV: test
-      GEMFILE_RUBY_VERSION: 3.1.1
-      DB_HOST: localhost
-      DB_DATABASE: data_collector
-      DB_USERNAME: postgres
-      DB_PASSWORD: password
-      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
-      PARALLEL_TEST_PROCESSORS: 4
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          cache: yarn
-          node-version: 20
-
-      - name: Create database
-        run: |
-          bundle exec rake parallel:setup
-
-      - name: Compile assets
-        run: |
-          bundle exec rake assets:precompile
-
-      - name: Run tests
-        run: |
-          bundle exec rake parallel:spec['spec/requests']
-
-  accessibility_test:
-    name: Accessibility tests
-    runs-on: ubuntu-latest
-
-    services:
-      postgres:
-        image: postgres:13.5
-        env:
-          POSTGRES_PASSWORD: password
-          POSTGRES_USER: postgres
-          POSTGRES_DB: data_collector
-        ports:
-          - 5432:5432
-        # Needed because the Postgres container does not provide a health check
-        # tmpfs makes database faster by using RAM
-        options: >-
-          --mount type=tmpfs,destination=/var/lib/postgresql/data
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
-    env:
-      RAILS_ENV: test
-      GEMFILE_RUBY_VERSION: 3.1.1
-      DB_HOST: localhost
-      DB_DATABASE: data_collector
-      DB_USERNAME: postgres
-      DB_PASSWORD: password
-      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
-      PARALLEL_TEST_PROCESSORS: 4
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          cache: yarn
-          node-version: 20
-
-      - name: Create database
-        run: |
-          bundle exec rake parallel:setup
-
-      - name: Compile assets
-        run: |
-          bundle exec rake assets:precompile
-
-      - name: Run tests
-        run: |
-          bundle exec rspec spec/features/accessibility_spec.rb --fail-fast
-
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          cache: yarn
-          node-version: 20
-
-      - name: Install packages and symlink local dependencies
-        run: |
-          yarn install --immutable --immutable-cache --check-cache
-
-      - name: Lint
-        run: |
-          bundle exec rake lint
-
-  audit:
-    name: Audit dependencies
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-
-      - name: Audit
-        run: |
-          bundle exec bundler-audit
+  tests:
+    name: Run Tests
+    uses: ./.github/workflows/run_tests.yml
 
   aws_deploy:
     name: AWS Deploy
-    if: github.ref == 'refs/heads/main'
-    needs: [lint, test, feature_test, requests_test, model_test, audit]
+    needs: [tests]
     uses: ./.github/workflows/aws_deploy.yml
     with:
       aws_account_id: 107155005276
diff --git a/spec/db/seeds_spec.rb b/spec/db/seeds_spec.rb
index 316f04ba6..6ae07ddb0 100644
--- a/spec/db/seeds_spec.rb
+++ b/spec/db/seeds_spec.rb
@@ -21,7 +21,8 @@ RSpec.describe "seeding process", type: task do
     allow(Rails.env).to receive(:review?).and_return(true)
   end
 
-  it "sets up correct data" do
+  # Doing this in one test should save ~2 minutes
+  it "sets up correct data idempotently" do
     expect {
       Rails.application.load_seed
     }.to change(User, :count)
@@ -30,10 +31,6 @@ RSpec.describe "seeding process", type: task do
      .and change(Scheme, :count)
      .and change(Location, :count)
      .and change(LaRentRange, :count)
-  end
-
-  it "is idempotent" do
-    Rails.application.load_seed
 
     expect {
       Rails.application.load_seed