feat: add UI E2E tests [IDE-1347]

.cursorrules

@@ -0,0 +1,49 @@
+** general **
+- always be concise, direct and don't try to appease me.
+- DOUBLE CHECK THAT YOUR CHANGES ARE REALLY NEEDED. ALWAYS STICK TO THE GIVEN GOAL, NOT MORE.
+- I repeat: don't optimize, don't refactor if not needed.
+- Adhere to the rules, fix linting & test issues that are newly introduced.
+- the `issueID` is usually specified in the current branch in the format `XXX-XXXX`.
+- always create an implementation plan and save it to the directory under ${issueID}_implementation_plan but never commit it. take it as a reference for each step and how to proceed. Get confirmation that the plan is ok.
+- Maintain existing code patterns and conventions
+- always commit the .cursorrules when they have changed
+- add the implementation plan to jira and update it while progressing using the jira mcp tools
+
+** how to implement **
+- don't comment what is done, instead comment why something is done if the code is not clear
+- always write and update test cases. iterate until they pass.
+- please check the build.gradle.kts, gradle.properties and settings.gradle.kts for build manager targets
+- use existing mocks, don't write new ones.
+- if you use mocks, use mockk to generate them.
+- always run the tests after editing.
+- always use the linter, fix newly created linting issues
+- don't change code that does not need to be changed. only do the minimum changes.
+- this is not a library. if files are not used or needed anymore, delete them instead of deprecating them.
+- if a tool call fails, analyze why it failed and correct your approach. don't prompt the user for help.
+- if you don't know something, read the code instead of assuming it.
+- commenting out code to fix errors is not a solution. instead, fix the error.
+- don't do shortcuts
+- always produce production-ready code
+- example code that does not fully implement functionality is not allowed
+
+** security **
+- determine the absolute path of the project directory. you can do that e.g. by executing pwd on the shell within the directory.
+- always use snyk for sca and code scanning. scan with both tools. you need to pass the absolute path of the directory we are scanning.
+- run snyk code tests after each edit. pass the absolute path of the project directory as a parameter
+- run snyk sca tests after updating go.mod and pass the absolute path of the project directory as a parameter.
+- run snyk sca and code test before committing. if not test data, fix issues before committing.
+
+** fixing issues **
+- fix security issues if they are fixable. take the snyk scan results and the test results as input
+- don't fix test data
+
+** committing **
+- do atomic commits
+- when asked to commit, always use conventional commit messages (Conventional Commit Style (Subject + Body)). be descriptive in the body. if you find a JIRA issue (XXX-XXXX) in the branch name, use it as a postfix to the subject line in the format [XXX-XXXX]
+- consider all commits in the current branch when committing, to have the context of the current changes.
+when asked to push, always use 'git push --set-upstream origin $(git_current_branch)' with git_current_branch being the current branch we are on
+- never force push
+- never push without asking
+- regularly fetch main branch and offer to merge it into git_current_branch
+- after pushing offer to create a PR on github. analyze the changes by comparing the current branch ($(git_current_branch)) with origin/main, and craft a PR description and title.
+use the github pr template in this repository

.github/workflows/e2e-tests.yml

@@ -0,0 +1,102 @@
+name: E2E Tests
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Run nightly at 2 AM UTC
+    - cron: '0 2 * * *'
+
+jobs:
+  e2e-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: "OSS Scan"
+            test: "SnykOssScanE2ETest"
+          - name: "Code Security"
+            test: "SnykCodeSecurityE2ETest"
+          - name: "IaC Scan"
+            test: "SnykIacScanE2ETest"
+          - name: "Authentication"
+            test: "SnykAuthE2ETest"
+          - name: "Project Trust"
+            test: "SnykProjectTrustE2ETest"
+          - name: "Workflow"
+            test: "SnykWorkflowE2ETest"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+
+      - name: Download Robot Server Plugin
+        run: |
+          mkdir -p build
+          curl -L "https://plugins.jetbrains.com/plugin/download?rel=true&updateId=465614" -o build/robot-server-plugin.zip
+
+      - name: Set up virtual display
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y xvfb
+          export DISPLAY=:99.0
+          Xvfb :99 -screen 0 1920x1080x24 > /dev/null 2>&1 &
+
+      - name: Build Plugin
+        run: ./gradlew buildPlugin
+
+      - name: Start IDE with Robot Server
+        env:
+          DISPLAY: :99.0
+        run: |
+          ./gradlew runIdeForUiTests &
+          IDE_PID=$!
+          echo "IDE_PID=$IDE_PID" >> $GITHUB_ENV
+
+          # Wait for IDE to start and robot server to be ready
+          echo "Waiting for IDE to start..."
+          for i in {1..60}; do
+            if curl -s http://localhost:8082 > /dev/null; then
+              echo "Robot Server is ready!"
+              break
+            fi
+            echo "Waiting for Robot Server... (attempt $i/60)"
+            sleep 2
+          done
+
+      - name: Run E2E Test - ${{ matrix.name }}
+        env:
+          DISPLAY: :99.0
+        run: ./gradlew test --tests "*${{ matrix.test }}" --info
+
+      - name: Stop IDE
+        if: always()
+        run: |
+          if [ ! -z "$IDE_PID" ]; then
+            kill $IDE_PID || true
+          fi
+
+      - name: Upload Test Results
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: e2e-test-results-${{ matrix.test }}
+          path: |
+            build/reports/tests/
+            build/test-results/
+
+      - name: Test Report
+        uses: dorny/test-reporter@v1
+        if: always()
+        with:
+          name: E2E Tests - ${{ matrix.name }}
+          path: build/test-results/test/*.xml
+          reporter: java-junit

.github/workflows/ui-tests-pr.yml

@@ -0,0 +1,66 @@
+name: UI Tests - PR
+
+on:
+  pull_request:
+    paths:
+      - 'src/main/kotlin/io/snyk/plugin/ui/**'
+      - 'src/test/kotlin/io/snyk/plugin/ui/**'
+      - 'build.gradle.kts'
+      - '.github/workflows/ui-tests-pr.yml'
+
+jobs:
+  ui-component-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+
+      - name: Cache Gradle packages
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Setup virtual display
+        run: |
+          export DISPLAY=:99
+          Xvfb :99 -screen 0 1920x1080x24 > /dev/null 2>&1 &
+          echo "DISPLAY=:99" >> $GITHUB_ENV
+
+      - name: Build Plugin
+        run: ./gradlew buildPlugin --info
+
+      - name: Run Component UI Tests
+        run: ./gradlew runUiTests --tests "*UITest" --info
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: ui-test-results
+          path: |
+            build/reports/tests/
+            build/test-results/
+
+      - name: Generate test report
+        if: always()
+        uses: dorny/test-reporter@v1
+        with:
+          name: 'UI Component Test Results'
+          path: 'build/test-results/**/*.xml'
+          reporter: java-junit
+          fail-on-error: false

.github/workflows/ui-tests.yml

@@ -0,0 +1,137 @@
+name: UI Tests
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  ui-tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        include:
+          - os: ubuntu-latest
+            display: ':99'
+          - os: macos-latest
+            display: ':1'
+          - os: windows-latest
+            display: ':0'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: wrapper
+
+      - name: Cache Gradle packages
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Setup display (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          export DISPLAY=${{ matrix.display }}
+          Xvfb ${{ matrix.display }} -screen 0 1920x1080x24 > /dev/null 2>&1 &
+
+      - name: Download Robot Server Plugin
+        run: |
+          mkdir -p build
+          curl -L "https://plugins.jetbrains.com/plugin/download?rel=true&updateId=465614" \
+            -o "build/robot-server-plugin.zip"
+
+      - name: Build Plugin
+        run: ./gradlew buildPlugin
+
+      - name: Run Component UI Tests
+        run: ./gradlew runUiTests --tests "*UITest" --info
+        env:
+          DISPLAY: ${{ matrix.display }}
+
+      - name: Run E2E UI Tests (Optional)
+        if: matrix.os == 'ubuntu-latest'  # Run E2E tests only on Linux for now
+        run: |
+          # Start IDE with robot server in background
+          ./gradlew runIde \
+            -Drobot-server.port=8082 \
+            -Dide.mac.message.dialogs.as.sheets=false \
+            -Djb.privacy.policy.text="<!--999.999-->" \
+            -Djb.consents.confirmation.enabled=false \
+            -Didea.trust.all.projects=true \
+            -Dide.show.tips.on.startup.default.value=false \
+            -PrunIdeWithPlugins="build/robot-server-plugin.zip" &
+
+          IDE_PID=$!
+
+          # Wait for IDE to start
+          echo "Waiting for IDE to start..."
+          sleep 60
+
+          # Check if robot server is accessible
+          max_attempts=30
+          attempt=0
+          while [ $attempt -lt $max_attempts ]; do
+            if curl -s "http://localhost:8082" > /dev/null; then
+              echo "Robot Server is ready!"
+              break
+            fi
+            echo "Waiting for Robot Server... (attempt $((attempt + 1))/$max_attempts)"
+            sleep 5
+            attempt=$((attempt + 1))
+          done
+
+          if [ $attempt -eq $max_attempts ]; then
+            echo "Robot Server failed to start!"
+            kill $IDE_PID 2>/dev/null || true
+            exit 1
+          fi
+
+          # Run E2E tests
+          ./gradlew test --tests "*E2ETest" --info || E2E_RESULT=$?
+
+          # Stop IDE
+          kill $IDE_PID 2>/dev/null || true
+
+          # Exit with E2E test result
+          exit ${E2E_RESULT:-0}
+        env:
+          DISPLAY: ${{ matrix.display }}
+        continue-on-error: true  # E2E tests are optional for now
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-${{ matrix.os }}
+          path: |
+            build/reports/tests/
+            build/test-results/
+
+      - name: Generate test report
+        if: always()
+        uses: dorny/test-reporter@v1
+        with:
+          name: 'UI Test Results - ${{ matrix.os }}'
+          path: 'build/test-results/**/*.xml'
+          reporter: java-junit
+          fail-on-error: false

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "automatic"
+}