Improves testing w/Sinatra app

- Scaffolds a simple Sinatra app in order to better test the testing functionality of the workflow.
- Adds an $ARTIFACTS_DIR environment variable pointing to a directory whose contents will be saved as a build artifact.
- Adds the parsed/merged compose file, service logs, and docker event logs to artifacts automatically.

Author: danschmidt5189

.dockerignore

@@ -0,0 +1,6 @@
+.dockerignore
+.DS_Store
+.git*
+.gitignore
+docker-compose*
+Dockerfile

.github/workflows/build.yml

@@ -49,6 +49,9 @@ jobs:
     runs-on: ubuntu-latest
     needs:
       - build
+    env:
+      COMPOSE_FILE: docker-compose.yml:docker-compose.ci.yml
+      DOCKER_APP_IMAGE: ${{ needs.build.outputs.build-image }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -66,11 +69,37 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Set ARTIFACTS_DIR
+        run: echo "ARTIFACTS_DIR=${RUNNER_TEMP}/artifacts" >> $GITHUB_ENV
+
+      - name: Create the artifacts directory
+        run: mkdir -p "$ARTIFACTS_DIR"
+
+      - name: Record start time
+        run: TEST_START=`date +%s` >> $GITHUB_ENV
+
       - name: Run the tests
         run: bin/test
-        env:
-          COMPOSE_FILE: docker-compose.yml:docker-compose.ci.yml
-          DOCKER_APP_IMAGE: ${{ needs.build.outputs.build-image }}
+
+      - name: Retain the compose file
+        if: ${{ always() }}
+        run: docker compose config | tee "${ARTIFACTS_DIR}/docker-compose.yml"
+
+      - name: Retain compose logs
+        if: ${{ always() }}
+        run: docker compose logs | tee "${ARTIFACTS_DIR}/docker-services.log"
+
+      - name: Retain Docker events
+        if: ${{ always() }}
+        run: docker events --json --since $TEST_START --until `date +%s` | tee "${ARTIFACTS_DIR}/docker-events.json"
+
+      - name: Upload test report
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: Test Report (${{ github.sha }}-${{ github.run_id }}-${{ github.run_attempt }})
+          path: ${{ env.ARTIFACTS_DIR }}
+          if-no-files-found: error
 
   push:
     runs-on: ubuntu-latest

Dockerfile

@@ -1 +1,8 @@
-FROM hello-world
+FROM ruby:3
+
+WORKDIR /opt/app
+COPY Gemfile* .
+RUN bundle install
+COPY . .
+CMD ["bundle", "exec", "ruby", "app.rb", "-o", "0.0.0.0"]
+EXPOSE 4567

Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "puma"
+gem "rack-test"
+gem "rackup"
+gem "rspec"
+gem "sinatra"

Gemfile.lock

@@ -0,0 +1,59 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.3.0)
+    diff-lcs (1.6.2)
+    logger (1.7.0)
+    mustermann (3.0.4)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.7.4)
+    puma (6.6.1)
+      nio4r (~> 2.0)
+    rack (3.2.0)
+    rack-protection (4.1.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.5)
+    ruby2_keywords (0.0.5)
+    sinatra (4.1.1)
+      logger (>= 1.6.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.1.1)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
+    tilt (2.6.1)
+
+PLATFORMS
+  aarch64-linux
+  ruby
+
+DEPENDENCIES
+  puma
+  rack-test
+  rackup
+  rspec
+  sinatra
+
+BUNDLED WITH
+   2.6.9

app.rb

@@ -0,0 +1,5 @@
+require 'sinatra'
+
+get '/' do
+  "Hello, world!"
+end

bin/test

@@ -1,4 +1,6 @@
-#!/bin/sh -e
+#!/bin/bash -e
 
-docker compose up --exit-code-from app --no-build
-docker compose run --rm app | grep -q 'Hello from Docker!'
+docker compose up --detach --no-build
+docker compose exec app rspec \
+  --format html --out "${RUNNER_TEMP}/test-results.html" \
+  --format documentation

docker-compose.ci.yml

@@ -2,4 +2,7 @@
 
 services:
   app:
+    build: !reset
     image: ${DOCKER_APP_IMAGE}
+    ports: !reset
+    volumes: !reset

docker-compose.yml

@@ -3,3 +3,7 @@
 services:
   app:
     build: .
+    ports:
+      - 4567:4567
+    volumes:
+      - ./:/opt/app

spec/home_spec.rb

@@ -0,0 +1,19 @@
+ENV['APP_ENV'] = 'test'
+
+require_relative '../app.rb'
+require 'rspec'
+require 'rack/test'
+
+RSpec.describe 'The Test App' do
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  it "says hello" do
+    get '/'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('Hello, world!')
+  end
+end