Create Test Script

Author: gmitch215

.github/test.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Build Docker
+
+docker build -t codemc/mariadb src/test/docker/mariadb
+docker run -d -p 3306:3306 --name mariadb codemc/mariadb
+
+docker build -t codemc/jenkins src/test/docker/jenkins
+docker run -d -p 8080:8080 --name jenkins-rest codemc/jenkins
+
+docker build -t codemc/nexus src/test/docker/nexus
+docker run -d -p 8081:8081 --name nexus-rest codemc/nexus
+
+# Wait for Services
+
+echo "Waiting for MariaDB to be ready..."
+until docker exec mariadb mariadb -u root -e "SELECT 1"; do
+  sleep 2
+done
+
+echo "Waiting for Jenkins to be ready..."
+until curl -s "http://localhost:8080" | grep "Dashboard"; do
+  sleep 2
+done
+
+echo "Waiting for Nexus to be ready..."
+until curl -s "http://localhost:8081"; do
+  sleep 2
+done
+
+# Run Docker
+
+docker cp nexus-rest:/nexus-data/admin.password /tmp/admin.password
+./gradlew clean test
+rm -rf /tmp/admin.password

.github/workflows/build.yml

@@ -42,32 +42,8 @@ jobs:
           cache: 'gradle'
       - name: Change Permissions
         run: chmod +x ./gradlew
-      - name: Setup Servers
-        run: |
-          docker build -t nexus-rest/nexus src/test/docker/nexus
-          docker run -d -p 8081:8081 --name nexus-rest nexus-rest/nexus
-          
-          docker build -t jenkins-rest/jenkins src/test/docker/jenkins
-          docker run -d -p 8080:8080 --name jenkins-rest jenkins-rest/jenkins
-      - name: Wait for Jenkins
-        run: |
-          echo "Waiting for Jenkins to be ready..."
-          sleep 60
-          until curl -s http://localhost:8080 | grep "Dashboard"; do
-            sleep 10
-          done
-      - name: Wait for Nexus
-        run: |
-          echo "Waiting for Nexus to be ready..."
-          sleep 60
-          until curl -s http://localhost:8081; do
-            sleep 10
-          done
       - name: Gradle Test
-        run: |
-          docker cp nexus-rest:/nexus-data/admin.password /tmp/admin.password
-          ./gradlew test
-          rm -rf /tmp/admin.password
+        run: bash .github/test.sh
       - name: Stop Servers
         if: success() || failure()
         run: |
@@ -76,6 +52,9 @@ jobs:
 
           docker stop nexus-rest
           docker rm nexus-rest
+          
+          docker stop mariadb
+          docker rm mariadb
       - name: Collect JaCoCo Report
         if: ${{ github.event_name != 'pull_request' }}
         id: jacoco_reporter

README.md

@@ -66,12 +66,22 @@ dependencies {
 
 ## Local Testing
 
-Test suites rely on both an active Nexus and Jenkins instance at ports `8081` and `8080` respectively.
+Test suites rely on both an active services, such as Nexus and Jenkins instances.
 Luckily, the project comes with Docker files to set these up yourself.
 
 Without the services, some test suites will fail.
 
-### [Act](https://nektosact.com) (preferred)
+### Test Script (preferred)
+
+A bash script is provided to build the containers and run the tests. This is the easiest way to test the project.
+
+Requires [Docker](https://www.docker.com) to be installed.
+
+```bash
+bash .github/test.sh
+```
+
+### [Act](https://nektosact.com)
 
 Test the project by using Act, a GitHub Action emulator. This will set up and test everything for you.
 
@@ -84,16 +94,20 @@ act push -j 'test'
 First, build and run both containers:
 
 ```bash
-# Docker
-docker build -t nexus-rest/nexus src/test/docker/nexus
-docker run -d -p 8081:8081 --name nexus-rest nexus-rest/nexus
+# MariaDB
+docker build -t codemc/mariadb src/test/docker/mariadb
+docker run -d -p 3306:3306 --name mariadb codemc/mariadb
 
 # Jenkins
-docker build -t jenkins-rest/jenkins src/test/docker/jenkins
-docker run -d -p 8080:8080 --name jenkins-rest jenkins-rest/jenkins
+docker build -t codemc/jenkins src/test/docker/jenkins
+docker run -d -p 8080:8080 --name jenkins-rest codemc/jenkins
+
+# Nexus
+docker build -t codemc/nexus src/test/docker/nexus
+docker run -d -p 8081:8081 --name nexus-rest codemc/nexus
 ```
 
-Before running, copy over the `admin.password` file into the `/tmp/` folder (yes, you will need to make it on Windows) so that the API can log in to the newly created Nexus instance.
+Before running, copy over the `admin.password` file into the `/tmp/` folder so that the API can log in to the newly created Nexus instance.
 
 ```bash
 docker cp nexus-rest:/nexus-data/admin.password /tmp/admin.password