Restore LoadTestIT

.github/workflows/README.md

@@ -6,14 +6,24 @@ Utilizing GitHub Actions, the workflows build, test, and deliver CWS by configur
 
 ## CWS CI Camunda Workflow
 
-The CWS CI Camunda workflow is triggered upon any push to the repository, including commits, pull requests, and merges. The workflow is also scheduled to run every day at 5 AM PST / 12 PM UTC. It is composed of two jobs: `build-and-test-cws` and `publish-cws-image`. Both jobs run on separate GitHub runners with the latest version of Ubuntu.
+The CWS CI Camunda workflow is triggered upon any push to the repository, including commits, pull requests, and merges. The workflow is also scheduled to run every Monday at 5 AM PST / 12 PM UTC. It is composed of three jobs: `build-and-test-cws`, `advanced-test`, and `publish-cws-image`. All jobs run on separate GitHub runners with the latest version of Ubuntu.
 
 The `build-and-test-cws` job performs all the necessary preliminary steps required to configure and build CWS with Camunda security. Once these steps are completed, a fully-functioning instance of CWS is built. Following the build, unit and integration tests are run, with resulting artifacts being saved to the workflow run. Afterwards, data from the workflow is sent to the development team.
 
-The `publish-cws-image` job is the CD component of the workflow, triggered upon a commit message containing the word "version," and dependant upon successful completion of the `build-and-test-cws job`.
+The `advanced-test` job is fundamentally the same for the build of CWS, except 2 workers being started instead of 1. Following the build, an advanced integration test requiring additional workers is run.
+
+The `publish-cws-image` job is the CD component of the workflow, triggered upon a commit with a tag and dependant upon successful completion of the `build-and-test-cws` and `advanced-test` jobs.
+
+> **Note**
+> The current GitHub runner configuration used for the build and test of CWS, as well as the advanced test, supports up to 1 console and 2 workers.
+> More than 2 workers may result in test failures due to the stress on the runner.
 
 ### build-and-test-cws Job
 
+- [**Services**](https://docs.github.com/en/actions/using-containerized-services/about-service-containers):
+  - MariaDB
+    - Image: mariadb:10.3
+    - Ports: 3306:3306
 - [**checkout**](https://github.com/marketplace/actions/checkout): This action checks out the repository under `$GITHUB_WORKSPACE`, so the workflow can access it.
 - Set up JDK 8:
   - [**setup-java**](https://github.com/marketplace/actions/setup-java-jdk): This action downloads and sets up a requested version of Java
@@ -35,16 +45,14 @@ The `publish-cws-image` job is the CD component of the workflow, triggered upon
 - **Set up Elasticsearch**:
   - Creates and starts a Docker container with Elasticsearch
   - Runs in the background (detached mode)
-- **Set up CWS database using Docker**:
-  - Creates and starts a Docker container with MariaDB database instance for CWS
-  - Runs in the background (detached mode)
-  - Uses port 3306:3306, with name `cws_dev`
 - **Show Docker containers**: Shows all Docker containers and their statuses
 - **Build CWS**:
   - Builds and runs CWS
   - Begins by running the first bash script in the build process: run_ci.sh
-  - The bash script is passed the `SECURITY` environmental variable to run CWS in a specific security mode
-  - The CWS security mode for this workflow is `CAMUNDA`
+    - The bash script is passed the `SECURITY` environmental variable to run CWS in a specific security mode
+      - The CWS security mode for this workflow is `CAMUNDA`
+    - The bash script is passed the `WORKERS` environmental variable to start the specified number of workers
+      - Current configuration is set to run 1 console and 1 worker
 - **Show CWS Log**:
   - List files in the directory where `cws.log` is expected
   - The presence of the file verifies successful deployment of the Apache Tomcat server
@@ -63,6 +71,18 @@ The `publish-cws-image` job is the CD component of the workflow, triggered upon
     - Sends GitHub Actions workflow data to a Slack channel via a webhook URL
     - Requires a Slack workflow using webhooks to be created
 
+### advanced-test Job
+- **Build CWS**:
+  - Builds and runs CWS
+  - Begins by running the first bash script in the build process: run_ci.sh
+    - The bash script is passed the `SECURITY` environmental variable to run CWS in a specific security mode
+      - The CWS security mode for this workflow is `CAMUNDA`
+    - The bash script is passed the `WORKERS` environmental variable to start the specified number of workers
+      - Current configuration is set to run 1 console and 2 workers
+- **Run Load Integration Test**:
+  - Runs the Selenium-based LoadTestIT
+  - Requires a minimum of 2 workers to be started in order to run properly
+
 ### publish-cws-image Job
 - **Check out the repo**:
   - Utilizes the same `checkout` action to check out the repository again
@@ -81,21 +101,27 @@ The `publish-cws-image` job is the CD component of the workflow, triggered upon
 
 ## CWS CI LDAP Workflow
 
-The CWS CI LDAP workflow is triggered upon any push to the repository, including commits, pull requests, and merges. The workflow is also scheduled to run every day at 5 AM PST / 12 PM UTC. It is composed of one job, `build-and-test-cws`, and runs on a GitHub runner with the latest version of Ubuntu.
+The CWS CI LDAP workflow is triggered upon any push to the repository, including commits, pull requests, and merges. The workflow is also scheduled to run every Monday at 5 AM PST / 12 PM UTC. It is composed of one job, `build-and-test-cws`, and runs on a GitHub runner with the latest version of Ubuntu.
 
 The `build-and-test-cws` job performs all the necessary preliminary steps required to configure and build CWS with LDAP security. Once these steps are completed, a fully-functioning instance of CWS is built. Following the build, LDAP-specific integration tests are run. Afterwards, data from the workflow is sent to the development team.
 
 The following are key differences in the steps of the `build-and-test-cws` job between the `CWS CI Camunda` and `CWS CI LDAP` workflows.
 
+> **Note**
+> The current GitHub runner configuration used for the build and test of CWS supports up to 1 console and 2 workers.
+> More than 2 workers may result in test failures due to the stress on the runner.
+
 ### build-and-test-cws Job
 - **Set up CWS LDAP Server**:
   - Creates and starts a Docker container with an LDAP server
   - Runs in the background (detached mode)
 - **Build CWS**:
   - Builds and runs CWS
   - Begins by running the first bash script in the build process: run_ci.sh
-  - The bash script is passed the `SECURITY` environmental variable to run CWS in a specific security mode
-  - The CWS security mode for this workflow is `LDAP`
+    - The bash script is passed the `SECURITY` environmental variable to run CWS in a specific security mode
+      - The CWS security mode for this workflow is `LDAP`
+    - The bash script is passed the `WORKERS` environmental variable to start the specified number of workers
+      - Current configuration is set to run 1 console and 1 worker
 - **Run LDAP Integration Tests**:
   - Runs LDAP-specific, Selenium-based integration tests
   - Uses a different naming scheme to prevent the tests from running with the standard unit and integration tests

.github/workflows/camunda.yml

@@ -0,0 +1,282 @@
+name: CWS CI Camunda
+
+# Triggers the workflow on push
+on:
+  push:
+  schedule:
+    # trigger a build and test of CWS weekly on Monday at 5 AM PST / 12 PM UTC
+    - cron: '0 12 * * 1'
+
+env:
+  TEAM: ("jamesfwood" "voxparcxls" "galenhollins" "galenatjpl" "jeffreypon")
+
+jobs:
+
+  build-and-test-cws:
+
+    runs-on: ubuntu-latest
+    env:
+      SECURITY: "CAMUNDA"
+      WORKERS: 1
+
+    services:
+      mdb103:
+        image: mariadb:10.3
+        ports:
+          - 3306:3306
+        env:
+          MYSQL_DATABASE: cws_dev
+          MYSQL_ROOT_PASSWORD: adminpw
+        options: >-
+          --name mdb103
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+          cache: maven
+
+      - name: Create open-source certs
+        run: |
+          cd cws-certs
+          chmod +x generate-certs.sh
+          ./generate-certs.sh
+
+      - name: Download Logstash
+        uses: carlosperate/download-file-action@v1
+        with:
+          file-url: https://artifacts.elastic.co/downloads/logstash/logstash-oss-7.16.2-windows-x86_64.zip
+          file-name: logstash-7.16.2.zip
+          location: install/logging/
+
+      - name: Check for Logstash
+        run: |
+          cd install/logging/
+          ls -l
+
+      - name: Set up Elasticsearch
+        run: |
+          cd install/docker/es-only
+          docker-compose up -d
+
+      - name: Show Docker containers
+        run: |
+          sleep 5s
+          docker ps -a
+
+      - name: Build CWS
+        id: build
+        run:  |
+          cd ci
+          chmod +x run_ci.sh
+          ./run_ci.sh $SECURITY $WORKERS
+        shell: bash
+
+      - name: Show CWS Log
+        run: |
+          cd dist/console-only/cws/server/apache-tomcat-9.0.33/logs
+          ls -al
+
+      - name: Set up Google Chrome
+        run:  |
+          sudo apt-get update
+          sudo apt-get --only-upgrade install google-chrome-stable
+
+      - name: Display Google Chrome version
+        run: google-chrome --version
+
+      - name: Run Unit Tests
+        id: unit
+        run: mvn -Dmaven.compiler.debug=true -Dmaven.compiler.debuglevel=lines,vars,source clean test jacoco:report-aggregate
+        shell: bash
+
+      - name: Run Integration Tests
+        id: integration
+        run: mvn -Dmaven.compiler.debug=true -Dmaven.compiler.debuglevel=lines,vars,source integration-test verify -DskipTests
+        shell: bash
+
+      - name: Upload Jacoco report
+        uses: actions/upload-artifact@v3
+        with:
+          name: jacoco-report
+          path: jacoco-reports/aggregate/index.html
+
+      - name: Upload test screenshots
+        if: ${{ always() && steps.build.outcome == 'success' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-screenshots
+          path: test-screenshots/
+
+      - name: Send custom JSON data to Slack workflow
+        if: ${{ always() && contains(env.TEAM, github.actor) }}
+        id: slack
+        uses: slackapi/[email protected]
+        with:
+          # This data can be any valid JSON from a previous step in the GitHub Action
+          payload: |
+            {
+              "status": "CWS CI Camunda build and test result: ${{ job.status }}\n${{ github.event.pull_request.html_url || github.event.head_commit.url }}\nBuild result: ${{ steps.build.outcome }}\nUnit test result: ${{ steps.unit.outcome }}\nIntegration test result: ${{ steps.integration.outcome }}",
+              "blocks": [
+                {
+                  "type": "section",
+                  "text": {
+                    "type": "mrkdwn",
+                    "text": "CWS CI Camunda build and test result: ${{ job.status }}\n${{ github.event.pull_request.html_url || github.event.head_commit.url }}\nBuild result: ${{ steps.build.outcome }}\nUnit test result: ${{ steps.unit.outcome }}\nIntegration test result: ${{ steps.integration.outcome }}"
+                  }
+                }
+              ]
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+
+  advanced-test:
+
+    runs-on: ubuntu-latest
+    env:
+      SECURITY: "CAMUNDA"
+      WORKERS: 2
+
+    services:
+      mdb103:
+        image: mariadb:10.3
+        ports:
+          - 3306:3306
+        env:
+          MYSQL_DATABASE: cws_dev
+          MYSQL_ROOT_PASSWORD: adminpw
+        options: >-
+          --name mdb103
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+          cache: maven
+
+      - name: Create open-source certs
+        run: |
+          cd cws-certs
+          chmod +x generate-certs.sh
+          ./generate-certs.sh
+
+      - name: Download Logstash
+        uses: carlosperate/download-file-action@v1
+        with:
+          file-url: https://artifacts.elastic.co/downloads/logstash/logstash-oss-7.16.2-windows-x86_64.zip
+          file-name: logstash-7.16.2.zip
+          location: install/logging/
+
+      - name: Check for Logstash
+        run: |
+          cd install/logging/
+          ls -l
+
+      - name: Set up Elasticsearch
+        run: |
+          cd install/docker/es-only
+          docker-compose up -d
+
+      - name: Show Docker containers
+        run: |
+          sleep 5s
+          docker ps -a
+
+      - name: Build CWS
+        id: build
+        run:  |
+          cd ci
+          chmod +x run_ci.sh
+          ./run_ci.sh $SECURITY $WORKERS
+        shell: bash
+
+      - name: Show CWS Log
+        run: |
+          cd dist/console-only/cws/server/apache-tomcat-9.0.33/logs
+          ls -al
+
+      - name: Set up Google Chrome
+        run:  |
+          sudo apt-get update
+          sudo apt-get --only-upgrade install google-chrome-stable
+
+      - name: Display Google Chrome version
+        run: google-chrome --version
+
+      - name: Run Load Integration Test
+        id: load
+        run: mvn -Dmaven.compiler.debug=true -Dmaven.compiler.debuglevel=lines,vars, -Dit.test=LoadTestIT verify -DskipTests
+        shell: bash
+
+      - name: Upload test screenshots
+        if: ${{ always() && steps.build.outcome == 'success' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-screenshots-advanced
+          path: test-screenshots/
+
+      - name: Send custom JSON data to Slack workflow
+        if: ${{ always() && contains(env.TEAM, github.actor) }}
+        id: slack
+        uses: slackapi/[email protected]
+        with:
+          # This data can be any valid JSON from a previous step in the GitHub Action
+          payload: |
+            {
+              "status": "CWS CI Camunda advanced test result: ${{ job.status }}\n${{ github.event.pull_request.html_url || github.event.head_commit.url }}\nBuild result: ${{ steps.build.outcome }}\nLoad integration test result: ${{ steps.load.outcome }}",
+              "blocks": [
+                {
+                  "type": "section",
+                  "text": {
+                    "type": "mrkdwn",
+                    "text": "CWS CI Camunda advanced test result: ${{ job.status }}\n${{ github.event.pull_request.html_url || github.event.head_commit.url }}\nBuild result: ${{ steps.build.outcome }}\nLoad integration test result: ${{ steps.load.outcome }}"
+                  }
+                }
+              ]
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+
+  publish-cws-image:
+
+    if: ${{ github.ref_type == 'tag' }}
+    needs: [build-and-test-cws, advanced-test]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+          cache: maven
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Generate CWS Docker image
+        run: |
+          cd install/docker/cws-image
+          ./build.sh
+
+      - name: Re-Tag CWS Docker image for open source
+        run: docker tag nasa-ammos/common-workflow-service:${{ github.ref_name }} ${{ secrets.DOCKER_USERNAME }}/common-workflow-service:${{ github.ref_name }}
+
+      - name: Push CWS Docker image
+        run: docker push ${{ secrets.DOCKER_USERNAME }}/common-workflow-service:${{ github.ref_name }}