Docker modernization (#186)

* Docker modernization
- Remove separate docker-compose file just used for tests.
- Remove wait-for in favor of healthchecks
- Produce HTML coverage report by default
- Remove Makefile.PL since we use prove

.github/workflows/tests.yml

@@ -22,9 +22,9 @@ jobs:
           submodules: true
 
       - name: Build docker image
-        run: docker compose --file docker-compose.test.yml build
+        run: docker compose build
 
       - name: Run tests
-        run: docker compose --file docker-compose.test.yml run sut
+        run: docker compose run test scripts/test_and_cover.sh
         env:
           GITHUB_TOKEN: ${{ secrets.github_token }}

Dockerfile

@@ -161,9 +161,6 @@ RUN cpanm --notest \
 
 ENV SDRROOT /htapps/babel
 ENV ROOTDIR "${SDRROOT}/crms"
-
-RUN wget -O /usr/local/bin/wait-for https://github.com/eficode/wait-for/releases/download/v2.2.3/wait-for; chmod +x /usr/local/bin/wait-for
-
 RUN mkdir -p $ROOTDIR
 COPY . $ROOTDIR
 WORKDIR $ROOTDIR

README.md

@@ -12,18 +12,13 @@ A web app and suite of tools for performing copyright review projects.
 git submodule init
 git submodule update
 docker compose build
-docker compose up -d mariadb
+docker compose up -d mariadb mariadb-ht
 docker compose run --rm test
 ```
 
-## Running Tests with Coverage
-
-```
-scripts/cover.sh
-```
-
-The other coverage script -- `scripts/test_and_cover.sh` -- is used by GitHub actions
-to upload results to Coveralls.
+By default the `test` service produces a `Devel::Cover` HTML report using
+`scripts/test.sh`. The other script, `scripts/test_and_cover.sh`, is for upload to
+Coveralls and is used in the GitHub action.
 
 ## What is Where
 
@@ -32,7 +27,7 @@ to upload results to Coveralls.
 - `docker` Database seeds
 - `lib` Perl modules (new development and refactored modules from `cgi`)
 - `prep` Destination for some log files and reports
-- `scripts` Binaries run as part of development or by GitHub
+- `scripts` Testing wrappers run as part of development or by GitHub
 - `t` Tests
 - `web` Static assets including images, JS, CSS
 

docker-compose.yml

@@ -1,22 +1,37 @@
-version: '3'
+---
+
+x-condition-healthy: &healthy
+  condition: service_healthy
+
+x-healthcheck-defaults: &healthcheck-defaults
+  interval: 5s
+  timeout: 10s
+  start_period: 10s
+  retries: 5
 
 services:
 
   mariadb:
     build: docker/db
     restart: always
     environment:
-      MYSQL_ROOT_PASSWORD: 'crms'
+      MYSQL_RANDOM_ROOT_PASSWORD: 1
     ports:
       - 3306:3306
+    healthcheck:
+      <<: *healthcheck-defaults
+      test: [ "CMD", "healthcheck.sh", "--su-mysql", "--connect", "--innodb_initialized" ]
 
   mariadb_ht:
     image: ghcr.io/hathitrust/db-image:latest
     restart: always
     environment:
-      MYSQL_ROOT_PASSWORD: 'crms'
+      MYSQL_RANDOM_ROOT_PASSWORD: 1
     ports:
       - 3307:3306
+    healthcheck:
+      <<: *healthcheck-defaults
+      test: [ "CMD", "healthcheck.sh", "--su-mysql", "--connect", "--innodb_initialized" ]
 
   test:
     build: .
@@ -27,7 +42,15 @@ services:
       - CRMS_DB_HOST=mariadb
       - CRMS_DB_HOST_DEVELOPMENT=mariadb
       - CRMS_HT_DB_HOST=mariadb_ht
+      # pass through info needed by coveralls uploader
+      - GITHUB_TOKEN
+      - GITHUB_RUN_ID
+      - GITHUB_EVENT_TOKEN
+      - GITHUB_EVENT_PATH
+      - GITHUB_SHA
+      - GITHUB_REF
+      - GITHUB_ACTIONS
     depends_on:
-      - mariadb
-      - mariadb_ht
+      mariadb: *healthy
+      mariadb_ht: *healthy
     command: scripts/test.sh

docker/db/Dockerfile

@@ -1,4 +1,4 @@
-FROM mariadb:10.1
+FROM mariadb:10.11
 
 # copy schema files inside
 COPY sql/* /docker-entrypoint-initdb.d/

scripts/test.sh

@@ -1,6 +1,3 @@
 #!/bin/bash
 
-perl /htapps/babel/crms/Makefile.PL
-/usr/local/bin/wait-for --timeout=300 mariadb:3306
-/usr/local/bin/wait-for --timeout=30 mariadb_ht:3306
-make test TEST_VERBOSE=1
+cover -test -ignore_re '^t/' +ignore_re '^post' -report html -make 'prove -r t/; exit $?'

scripts/test_and_cover.sh

@@ -1,5 +1,3 @@
 #!/bin/bash
 
-/usr/local/bin/wait-for --timeout=300 mariadb:3306
-/usr/local/bin/wait-for --timeout=30 mariadb_ht:3306
 cover -test -ignore_re '^t/' +ignore_re '^post' -report Coveralls -make 'prove -r t/; exit $?'