CAPT-1702 Migrate test environment to AKS

.github/workflows/build_and_deploy.yml

@@ -1,6 +1,8 @@
 name: Build and deploy to AKS cluster
 
 on:
+  push:
+    branches: [master]
   pull_request:
     types: [labeled, opened, reopened, synchronize]
 
@@ -13,7 +15,6 @@ permissions:
 jobs:
   build:
     runs-on: ubuntu-latest
-    if: ${{ contains(github.event.pull_request.labels.*.name, 'deploy') }}
     outputs:
       docker-image-tag: ${{ steps.build-image.outputs.tag }}
 
@@ -33,6 +34,7 @@ jobs:
     name: Deploy to review environment
     concurrency: deploy_review_${{ github.event.pull_request.number }}
     runs-on: ubuntu-latest
+    if: ${{ contains(github.event.pull_request.labels.*.name, 'deploy') }}
     needs: [build]
     environment:
       name: review-aks
@@ -78,3 +80,60 @@ jobs:
             | Additional Payments | <${{ env.APP_URL }}/additional-payments/claim> |
             | Student Loans       | <${{ env.APP_URL }}/student-loans/claim>       |
             | Admin               | <${{ env.APP_URL }}/admin>                     |
+
+  deploy_test:
+    name: Deploy to test environment
+    concurrency: deploy_test
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+    needs: [build]
+    environment:
+      name: test-aks
+      url: ${{ steps.deploy.outputs.environment_url }}
+    outputs:
+      environment_url: ${{ steps.deploy.outputs.environment_url }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: azure/login@v2
+        with:
+          creds: ${{ secrets.AZURE_CREDENTIALS }}
+
+      - uses: ./.github/actions/deploy-environment
+        id: deploy
+        with:
+          environment: test-aks
+          docker-image: ${{ needs.build.outputs.docker-image-tag }}
+          azure-credentials: ${{ secrets.AZURE_CREDENTIALS }}
+
+      - name: Run migrations
+        shell: bash
+        run: |
+          make ci test-aks get-cluster-credentials
+          kubectl exec -n srtl-test deployment/claim-additional-payments-for-teaching-test-worker -- sh -c "DISABLE_DATABASE_ENVIRONMENT_CHECK=1 bin/prepare-database"
+
+      - name: Install Ruby 3.2.4
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 3.2.4
+
+      - name: Run smoke tests
+        shell: bash
+        run: bundle exec rspec spec/smoke -t smoke:true -b
+        env:
+          RAILS_ENV: test
+          SMOKE_TEST_APP_HOST: ${{ env.APP_URL }}
+          BASIC_AUTH_USERNAME: ${{ secrets.BASIC_AUTH_USERNAME }}
+          BASIC_AUTH_PASSWORD: ${{ secrets.BASIC_AUTH_PASSWORD }}
+
+      - name: Notify on failure
+        if: failure()
+        uses: rtCamp/action-slack-notify@master
+        env:
+          SLACK_COLOR: failure
+          SLACK_TITLE: Failure deploying release to test
+          SLACK_MESSAGE: Failure deploying release to test - Docker tag ${{ needs.build.outputs.docker-image-tag }}
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}

Gemfile

@@ -124,6 +124,8 @@ group :test do
   gem "launchy"
   gem "rack_session_access"
   gem "simplecov", require: false
+  # Return null object for active record connection rather than raising error
+  gem "activerecord-nulldb-adapter"
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem

Gemfile.lock

@@ -73,6 +73,8 @@ GEM
       activesupport (= 7.0.8.4)
     activerecord-copy (1.1.0)
       activerecord (>= 3.1)
+    activerecord-nulldb-adapter (1.0.1)
+      activerecord (>= 5.2.0, < 7.2)
     activestorage (7.0.8.4)
       actionpack (= 7.0.8.4)
       activejob (= 7.0.8.4)
@@ -552,6 +554,7 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord-copy
+  activerecord-nulldb-adapter
   application_insights!
   bootsnap (>= 1.1.0)
   brakeman

Makefile

@@ -29,7 +29,6 @@ review-aks: test-cluster
 	$(eval ENVIRONMENT=review-${PR_NUMBER})
 	$(eval export TF_VAR_environment=${ENVIRONMENT})
 	$(eval include global_config/review.sh)
-	echo https://claim-additional-payments-for-teaching-review-$(PR_NUMBER).test.teacherservices.cloud will be created in aks
 
 .PHONY: test-aks
 test-aks: test-cluster

spec/rails_helper.rb

@@ -22,13 +22,17 @@
 #
 Dir[Rails.root.join("spec", "support", "**", "*.rb")].sort.each { |f| require f }
 
-# Checks for pending migrations and applies them before tests are run.
-# If you are not using ActiveRecord, you can remove these lines.
-begin
-  ActiveRecord::Migration.maintain_test_schema!
-rescue ActiveRecord::PendingMigrationError => e
-  puts e.to_s.strip
-  exit 1
+if ENV["SMOKE_TEST_APP_HOST"].present?
+  ActiveRecord::Base.establish_connection adapter: :nulldb
+else
+  # Checks for pending migrations and applies them before tests are run.
+  # If you are not using ActiveRecord, you can remove these lines.
+  begin
+    ActiveRecord::Migration.maintain_test_schema!
+  rescue ActiveRecord::PendingMigrationError => e
+    puts e.to_s.strip
+    exit 1
+  end
 end
 
 RSpec.configure do |config|
@@ -82,6 +86,7 @@
     OmniAuth.config.mock_auth[:default] = nil
   end
 
+  config.filter_run_excluding :smoke
   config.filter_run_excluding flaky: true unless ENV["RUN_FLAKY_SPECS"] == "true"
   config.filter_run_excluding js: true unless ENV["RUN_JS_SPECS"] == "true"
   config.filter_run_excluding slow: true unless ENV["RUN_SLOW_SPECS"] == "true"

spec/smoke/start_a_claim_spec.rb

@@ -0,0 +1,24 @@
+require "rails_helper"
+
+RSpec.describe "Start a claim", :smoke, type: :feature do
+  # To test this locally you will need to add to your .env file:
+  #
+  # SMOKE_TEST_APP_HOST
+  # BASIC_AUTH_USERNAME
+  # BASIC_AUTH_PASSWORD
+
+  scenario "User starts a claim" do
+    visit url_with_basic_auth
+    expect(page).to have_text("Teachers: claim back your student loan repayments")
+  end
+
+  def url_with_basic_auth
+    host = ENV.fetch("SMOKE_TEST_APP_HOST")
+    path = new_claim_path(Journeys::TeacherStudentLoanReimbursement::ROUTING_NAME)
+    uri = URI.join(host, path)
+
+    uri.user = ENV.fetch("BASIC_AUTH_USERNAME", nil)
+    uri.password = ENV.fetch("BASIC_AUTH_PASSWORD", nil)
+    uri.to_s
+  end
+end

spec/support/capybara.rb

@@ -27,3 +27,13 @@
 end
 
 Capybara.automatic_label_click = true
+
+RSpec.configure do |config|
+  config.around(:each, :smoke) do |example|
+    Capybara.current_driver = Capybara.javascript_driver
+    Capybara.run_server = false
+    example.run
+    Capybara.run_server = true
+    Capybara.current_driver = Capybara.default_driver
+  end
+end

terraform/application/application.tf

@@ -38,6 +38,8 @@ module "web_application" {
 
   docker_image = var.docker_image
   command      = var.startup_command
+
+  replicas     = var.web_replicas
 }
 
 module "worker_application" {

terraform/application/config/test.tfvars.json

@@ -0,0 +1,10 @@
+{
+  "cluster": "test",
+  "namespace": "srtl-test",
+  "config": "test",
+  "environment": "test",
+  "canonical_hostname": "claim-additional-payments-for-teaching-test-web.test.teacherservices.cloud",
+  "web_replicas": 2,
+  "startup_command": ["/bin/sh", "-c", "bin/rails server -b 0.0.0.0"],
+  "worker_command": ["/bin/sh", "-c", "bin/bundle exec bin/delayed_job run -n 1"]
+}

terraform/application/config/test_Terrafile

@@ -0,0 +1,3 @@
+aks:
+    source:  "https://github.com/DFE-Digital/terraform-modules"
+    version: "testing"

terraform/application/config/test_app_env.yml

@@ -0,0 +1,2 @@
+---
+SUPPRESS_DFE_ANALYTICS_INIT: true

terraform/application/database.tf

@@ -11,5 +11,6 @@ module "postgres" {
   use_azure                   = var.deploy_azure_backing_services
   azure_enable_monitoring     = var.enable_monitoring
   azure_enable_backup_storage = var.enable_postgres_backup_storage
+  azure_extensions            = ["pg_trgm", "pgcrypto", "plpgsql"]
   server_version              = "16"
 }

terraform/application/variables.tf

@@ -60,6 +60,10 @@ variable "canonical_hostname" {
   description = "External domain name for the app service"
   default     = null
 }
+variable "web_replicas" {
+  description = "Number of replicas of the web app"
+  default = 1
+}
 
 locals {
   postgres_ssl_mode = var.enable_postgres_ssl ? "require" : "disable"