chore: Added capability of running ITs using ok-to-test

.github/workflows/pr-automation.yml

@@ -71,6 +71,7 @@ jobs:
         shell: bash
     outputs:
       tags: ${{ steps.parseTags.outputs.tags }}
+      its: ${{ steps.parseTags.outputs.its }}
       spec: ${{ steps.parseTags.outputs.spec }}
       matrix: ${{ steps.checkAll.outputs.matrix }}
     steps:
@@ -129,6 +130,7 @@ jobs:
     uses: ./.github/workflows/pr-cypress.yml
     secrets: inherit
     with:
+      its: ${{ needs.parse-tags.outputs.its}}
       tags: ${{ needs.parse-tags.outputs.tags}}
       spec: ${{ needs.parse-tags.outputs.spec}}
       matrix: ${{ needs.parse-tags.outputs.matrix}}

.github/workflows/pr-cypress.yml

@@ -3,6 +3,10 @@ name: Cypress test suite
 on:
   workflow_call:
     inputs:
+      its:
+        required: false
+        type: string
+        default: "false"
       tags:
         required: true
         type: string
@@ -45,6 +49,15 @@ jobs:
     with:
       pr: ${{ github.event.number }}
 
+  server-it:
+    needs: [ server-build, rts-build ]
+    if: success() && inputs.its == 'true'
+    uses: ./.github/workflows/server-integration-tests.yml
+    secrets: inherit
+    with:
+      pr: ${{ github.event.number }}
+      is-pg-build: ${{ github.event.pull_request.base.ref == 'pg' }}
+
   build-docker-image:
     needs: [client-build, server-build, rts-build]
     # Only run if the build step is successful
@@ -69,7 +82,7 @@ jobs:
       matrix: ${{ inputs.matrix }}
 
   ci-test-result:
-    needs: [ci-test]
+    needs: [ci-test, server-it]
     # Only run if the ci-test with matrices step is successful
     if: always()
     runs-on: ubuntu-latest

.github/workflows/scripts/test-tag-parser.js

@@ -21,25 +21,37 @@ module.exports = function ({core, context, github}) {
   }
 
   core.setOutput("tags", parseResult.tags ?? "");
+  core.setOutput("its", parseResult.its ?? "");
   core.setOutput("spec", parseResult.spec ?? "");
 }
 
 function parseTags(body) {
   const allTags = require(process.env.GITHUB_WORKSPACE + "/app/client/cypress/tags.js").Tag;
 
   // "/ok-to-test" matcher. Takes precedence over the "/test" matcher.
-  const strictMatch = body.match(/^\/ok-to-test tags="(.+?)"/m)?.[1];
-  if (strictMatch) {
-    if (strictMatch === "@tag.All") {
-      return { tags: strictMatch };
-    }
-    const parts = strictMatch.split(/\s*,\s*/);
-    for (const part of parts) {
-      if (!allTags.includes(part)) {
-        throw new Error("Unknown tag: " + part);
+  const okToTestPattern = body.match(/^(\/ok-to-test) tags="(.+?)"( it=true)?/m);
+
+  if (okToTestPattern?.[1]) {
+    var response = {};
+    const tagsMatch = okToTestPattern?.[2];
+    if (tagsMatch) {
+      if (tagsMatch === "@tag.All") {
+        response = { tags: tagsMatch };
+      } else {
+        const parts = tagsMatch.split(/\s*,\s*/);
+        for (const part of parts) {
+          if (!allTags.includes(part)) {
+            throw new Error("Unknown tag: " + part);
+          }
+        }
+        response = { tags: tagsMatch };
       }
     }
-    return { tags: strictMatch };
+    const itsMatch = okToTestPattern?.[3];
+    if (itsMatch) {
+      response = { ...response, its: 'true' };
+    }
+    return response;
   }
 
   // "/test" code-fence matcher.

.github/workflows/server-build.yml

@@ -5,20 +5,20 @@ on:
   workflow_call:
     inputs:
       pr:
-        description: "This is the PR number in case the workflow is being called in a pull request"
+        description: "PR number for the workflow"
         required: false
         type: number
       skip-tests:
-        description: "This is a boolean value in case the workflow is being called in build deploy-preview"
+        description: "Skip tests flag"
         required: false
         type: string
         default: "false"
       branch:
-        description: "This is the branch to be used for the build."
+        description: "Branch for the build"
         required: false
         type: string
       is-pg-build:
-        description: "This is a boolean value in case the workflow is being called for a PG build"
+        description: "Flag for PG build"
         required: false
         type: string
         default: "false"
@@ -210,6 +210,15 @@ jobs:
             fi
 
             args=()
+
+            # Check if this run is requesting for unit tests or integration tests
+            # As of today, we don't expect both to get triggered in the same workflow
+            if [[ "${{ inputs.its }}" == "true" ]]; then
+                args+=("-DskipUTs=true")
+            else
+                args+=("-DskipITs=true")
+            fi
+
             if [[ "${{ steps.run_result.outputs.run_result }}" == "failedtest" ]]; then
                 failed_tests="${{ steps.failed_tests.outputs.tests }}"
                 args+=("-DfailIfNoTests=false" "-Dsurefire.failIfNoSpecifiedTests=false" "-Dtest=${failed_tests}")
@@ -362,6 +371,7 @@ jobs:
 
       # Upload the build artifact so that it can be used by the test & deploy job in the workflow
       - name: Upload server build bundle
+        if: inputs.its != 'true'
         uses: actions/upload-artifact@v4
         with:
           name: server-build

.github/workflows/server-integration-tests.yml

@@ -0,0 +1,104 @@
+name: Server Integrations Tests Workflow
+
+on:
+  # This line enables manual triggering of this workflow.
+  workflow_dispatch:
+  workflow_call:
+    inputs:
+      pr:
+        description: "This is the PR number in case the workflow is being called in a pull request"
+        required: false
+        type: number
+      is-pg-build:
+        description: "Flag for PG build"
+        required: false
+        type: string
+        default: "false"
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    if: |
+      github.event.pull_request.head.repo.full_name == github.repository ||
+      github.event_name == 'workflow_dispatch'
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      # Check out merge commit
+      - name: Fork based /ok-to-test checkout
+        if: inputs.pr != 0
+        uses: actions/checkout@v4
+        with:
+          ref: "refs/pull/${{ inputs.pr }}/merge"
+
+      # Checkout the code in the current branch in case the workflow is called because of a branch push event
+      - name: Checkout the head commit of the branch
+        if: inputs.pr == 0
+        uses: actions/checkout@v4
+
+      # Setup Java
+      - name: Set up JDK 17
+        if: steps.run_result.outputs.run_result != 'success'  && (steps.changed-files-specific.outputs.any_changed == 'true' ||  github.event_name == 'push' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule')
+        uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: "17"
+
+      - name: Conditionally start PostgreSQL
+        if: |
+          inputs.is-pg-build == 'true' && inputs.skip-tests != 'true'
+        run: |
+          docker run --name appsmith-pg -p 5432:5432 -d -e POSTGRES_PASSWORD=password postgres:alpine postgres -N 1500
+
+      - name: Download the server build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: server-build
+          path: app/server/dist/
+
+      - name: Download the rts build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: rts-dist
+          path: app/client/packages/rts/dist
+
+      - name: Un-tar the rts folder
+        run: |
+          tar -xvf app/client/packages/rts/dist/rts-dist.tar -C app/client/packages/rts/
+          echo "Cleaning up the rts tar files"
+          rm app/client/packages/rts/dist/rts-dist.tar
+
+      - name: Run rts using the untarred files
+        run: |
+          node app/client/packages/rts/dist/bundle/server.js
+
+      - name: Run only integration tests on server
+        env:
+          ACTIVE_PROFILE: test
+          APPSMITH_CLOUD_SERVICES_BASE_URL: "https://release-cs.appsmith.com"
+          APPSMITH_CLOUD_SERVICES_TEMPLATE_UPLOAD_AUTH: ${{ secrets.APPSMITH_CLOUD_SERVICES_TEMPLATE_UPLOAD_AUTH }}
+          APPSMITH_REDIS_URL: "redis://127.0.0.1:6379"
+          APPSMITH_ENCRYPTION_PASSWORD: "password"
+          APPSMITH_ENCRYPTION_SALT: "salt"
+          APPSMITH_ENVFILE_PATH: /tmp/dummy.env
+          APPSMITH_VERBOSE_LOGGING_ENABLED: false
+        run: |
+            if [[ "${{ inputs.is-pg-build }}" == "true" ]]; then
+                export APPSMITH_DB_URL="postgresql://postgres:password@localhost:5432/postgres"
+            else
+                export APPSMITH_DB_URL="mongodb://localhost:27017/mobtools"
+            fi
+
+            args=()
+
+            if [[ "${{ steps.run_result.outputs.run_result }}" == "failedtest" ]]; then
+                failed_tests="${{ steps.failed_tests.outputs.tests }}"
+                args+=("-DfailIfNoTests=false" "-Dsurefire.failIfNoSpecifiedTests=false" "-Dtest=${failed_tests}")
+            fi
+
+            # Run tests and capture logs
+            mvn verify -DskipUTs=true "${args[@]}" | tee mvn_integration_test.log
+
+

app/server/README.md

@@ -2,4 +2,4 @@
 
 This is the server-side repository for the Appsmith framework.
 <br><br>
-For details on setting up your development machine, please refer to this [Setup Guide](../../contributions/ServerSetup.md).
+For details on setting up your development machine, please refer to this [setup Guide](../../contributions/ServerSetup.md).

app/server/appsmith-server/src/test/it/com/appsmith/server/git/GitBranchesIT.java

@@ -212,6 +212,8 @@ void test(GitContext gitContext, ExtensionContext extensionContext) throws IOExc
 
         assertThat(autoCommitResponseDTO).isNotNull();
         AutoCommitResponseDTO.AutoCommitResponse autoCommitProgress = autoCommitResponseDTO.getAutoCommitResponse();
+        // This check requires RTS to be running on your local since client side changes come in from there
+        // Please make sure to run RTS before triggering this test
         assertThat(autoCommitProgress).isEqualTo(AutoCommitResponseDTO.AutoCommitResponse.PUBLISHED);
 
         // Wait for auto-commit to complete