feat: changed testPath to pomPath (#9)

Author: anthonygauthier

.github/workflows/test.yaml

@@ -9,50 +9,18 @@ env:
   BRANCH_NAME: main
 
 jobs:
-  # test-local-folder:
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v3
-
-  #     # Doing this here to simulate already having the test suite within the repo
-  #     - name: Checkout repo locally
-  #       uses: actions/checkout@v3
-  #       with:
-  #         repository: liatrio/gatling-maven-showcase
-  #         ref: ${{ env.BRANCH_NAME }}
-  #         path: ./test
-
-  #     - name: Run Gatling Test Suite from local folder
-  #       uses: ./
-
-  test-with-repo:
+  test-local-folder:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
 
-      - name: Run Gatling Test Suite from repository
-        uses: ./
+      # Doing this here to simulate already having the test suite within the repo
+      - name: Checkout repo locally
+        uses: actions/checkout@v3
         with:
-          repoName: liatrio/gatling-maven-showcase
-          repoRef: ${{ env.BRANCH_NAME }}
+          repository: liatrio/gatling-maven-showcase
+          ref: ${{ env.BRANCH_NAME }}
+          path: test
 
-  test-specific-simulation:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Run a specific simulation of the Gatling Test Suite
+      - name: Run Gatling Test Suite from local folder
         uses: ./
-        with:
-          repoName: liatrio/gatling-maven-showcase
-          repoRef: ${{ env.BRANCH_NAME }}
-          simulationClass: "simulations.GoogleStressSimulation"
-
-  testing-remote-action:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: liatrio/run-gatling@main
-        with:
-          repoName: liatrio/gatling-maven-showcase
-          repoRef: ${{ env.BRANCH_NAME }}
-          simulationClass: "simulations.GoogleStressSimulation"

README.md

@@ -18,9 +18,9 @@ This action tries to solve that exact problem by enabling development teams to t
     # Default: 'microsoft'
     javaDistribution: ''
 
-    # Path to the Gatling Test Suite
+    # Path to the Gatling Test Suite's pom.xml file
     # Default: './test'
-    testPath: ''
+    pomPath: ''
 
     # Name of the repository to checkout ('org/repo')
     # Default: ''
@@ -47,14 +47,14 @@ This action tries to solve that exact problem by enabling development teams to t
 ```yaml
 - uses: liatrio/[email protected]
   with:
-    testPath: my_test_suite/path
+    pomPath: my_test_suite/path
 ```
 
 ## Execute a specific simulation
 ```yaml
 - uses: liatrio/[email protected]
   with:
-    testPath: my_test_suite/path
+    pomPath: my_test_suite/path
     simulationClass: simulationsPkg.MySimulationClass
 ```
 

action.yaml

@@ -9,48 +9,67 @@ inputs:
     description: "Java distribution to use"
     default: "microsoft"
     required: true
-  testPath:
-    description: "Path to the Gatling Test Suite"
+  pomPath:
+    description: "Path to the Gatling Test Suite's pom.xml file"
     default: "test"
     required: true
-  repoName:
-    description: "Name of the repository to checkout ('org/repo')" 
-    required: false
-  repoRef:
-    description: "Tag, Branch, or Commit SHA for the Test Suite repository"
-    default: "main"
-    required: false
   simulationClass:
     description: "Full classpath of the simulation to run"
     required: false
 runs:
   using: "composite"
   steps:
-    - name: Checkout action code
-      uses: actions/checkout@v3
-      
-    - name: Checkout Test Suite if not local
-      if: ${{ !hashFiles(inputs.testPath) }}
-      uses: actions/checkout@v3
-      with:
-        repository: ${{ inputs.repoName }}
-        ref: ${{ inputs.repoRef }}
-        path: ${{ inputs.testPath }}
-
     - name: Execute Gatling Test Suite
       uses: actions/setup-java@v3
       with:
         distribution: ${{ inputs.javaDistribution }}
         java-version: ${{ inputs.javaVersion }}
 
-    - run: mvn -f $GITHUB_WORKSPACE/${{ inputs.testPath }} gatling:test ${{ inputs.simulationClass != '' && '-Dgatling.simulationClass=' || '' }}${{ inputs.simulationClass }}
+    - run: mvn -f $GITHUB_WORKSPACE/${{ inputs.pomPath }} gatling:test ${{ inputs.simulationClass != '' && '-Dgatling.simulationClass=' || '' }}${{ inputs.simulationClass }}
       shell: bash
 
     - name: Generate Job Summary 
       uses: actions/github-script@v6
       env:
-        TEST_PATH: ${{ inputs.testPath }}
+        TEST_PATH: ${{ inputs.pomPath }}
       with:
         script: |
-          const script = require(`${process.env.GITHUB_WORKSPACE}/dist/index.js`)
-          await script({github, context, core})
+          const fs = require('fs')
+          const pomPath = process.env.TEST_PATH
+          const lastRuns = fs.readFileSync(`${pomPath}/target/gatling/lastRun.txt`).toString().trim().split('\n');
+
+          for(const run of lastRuns) {
+              const results = JSON.parse(fs.readFileSync(`${pomPath}/target/gatling/${run}/js/stats.json`).toString());
+              let tableContent = [
+                  [
+                      {data: 'Request', header: true}, 
+                      {data: 'Success ✅', header: true}, 
+                      {data: 'Errors ❌', header: true}, 
+                      {data: 'Min', header: true},
+                      {data: 'Max', header: true},
+                      {data: 'Avg.', header: true},
+                      {data: 'Std. Dev.', header: true},
+                      {data: 'RPS', header: true},
+                  ]
+              ];
+              
+              for(const result in results.contents) {
+                  const requestMetrics = results.contents[result].stats;
+                  tableContent.push([
+                      requestMetrics.name,
+                      requestMetrics.numberOfRequests.ok.toString(),
+                      requestMetrics.numberOfRequests.ko.toString(),
+                      requestMetrics.minResponseTime.total.toString(),
+                      requestMetrics.maxResponseTime.total.toString(),
+                      requestMetrics.meanResponseTime.total.toString(),
+                      requestMetrics.standardDeviation.total.toString(),
+                      requestMetrics.meanNumberOfRequestsPerSecond.total.toString(),
+                  ]);
+              }
+
+              await core.summary
+                  .addHeading(`Results for ${run}`)
+                  .addTable(tableContent)
+                  .addQuote('All times are in millisecond (ms). RPS means "Requests per Second"')
+                  .write()
+          }

dist/index.js

@@ -7,11 +7,11 @@
 const fs   = __nccwpck_require__(147);
 
 module.exports = async ({github, context, core}) => {
-    const testPath = process.env.TEST_PATH
-    const lastRuns = fs.readFileSync(`${testPath}/target/gatling/lastRun.txt`).toString().trim().split('\n');
+    const pomPath = process.env.TEST_PATH
+    const lastRuns = fs.readFileSync(`${pomPath}/target/gatling/lastRun.txt`).toString().trim().split('\n');
 
     for(const run of lastRuns) {
-        const results = JSON.parse(fs.readFileSync(`${testPath}/target/gatling/${run}/js/stats.json`).toString());
+        const results = JSON.parse(fs.readFileSync(`${pomPath}/target/gatling/${run}/js/stats.json`).toString());
         let tableContent = [
             [
                 {data: 'Request', header: true}, 

index.js

@@ -1,11 +1,11 @@
 const fs   = require('fs');
 
 module.exports = async ({github, context, core}) => {
-    const testPath = process.env.TEST_PATH
-    const lastRuns = fs.readFileSync(`${testPath}/target/gatling/lastRun.txt`).toString().trim().split('\n');
+    const pomPath = process.env.TEST_PATH
+    const lastRuns = fs.readFileSync(`${pomPath}/target/gatling/lastRun.txt`).toString().trim().split('\n');
 
     for(const run of lastRuns) {
-        const results = JSON.parse(fs.readFileSync(`${testPath}/target/gatling/${run}/js/stats.json`).toString());
+        const results = JSON.parse(fs.readFileSync(`${pomPath}/target/gatling/${run}/js/stats.json`).toString());
         let tableContent = [
             [
                 {data: 'Request', header: true},