Merge pull request #1222 from layer5io/copilot/use-meshery-ui-for-testing

[CI] Add Meshery UI integration testing for pull requests

Author: leecalcote

.github/workflows/test-meshery-integration.yml

@@ -0,0 +1,102 @@
+name: Test Sistent with Meshery UI
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths-ignore:
+      - 'system/**/*'
+      - '*.md'
+
+jobs:
+  test-with-meshery-ui:
+    name: Integration Test with Meshery UI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout Sistent PR
+        uses: actions/checkout@v6
+        with:
+          path: sistent
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: sistent/package-lock.json
+
+      - name: Install Sistent Dependencies
+        working-directory: sistent
+        run: npm install
+
+      - name: Build Sistent
+        working-directory: sistent
+        run: npm run build
+
+      - name: Pack Sistent for Installation
+        working-directory: sistent
+        run: |
+          npm pack
+          SISTENT_PACKAGE=$(ls sistent-sistent-*.tgz 2>/dev/null | \
+            head -n 1)
+          if [ -z "$SISTENT_PACKAGE" ]; then
+            echo "Error: No Sistent package found"
+            exit 1
+          fi
+          echo "SISTENT_PACKAGE=$SISTENT_PACKAGE" >> $GITHUB_ENV
+          echo "Created package: $SISTENT_PACKAGE"
+
+      - name: Checkout Meshery UI
+        uses: actions/checkout@v6
+        with:
+          repository: meshery/meshery
+          path: meshery
+          fetch-depth: 1
+
+      - name: Install Meshery UI Dependencies
+        working-directory: meshery/ui
+        run: npm install
+
+      - name: Install Sistent from PR
+        working-directory: meshery/ui
+        run: npm install ../../sistent/${{ env.SISTENT_PACKAGE }}
+
+      - name: Build Meshery UI
+        working-directory: meshery/ui
+        run: |
+          npm run build
+        continue-on-error: false
+
+      - name: Run Meshery UI Tests
+        working-directory: meshery/ui
+        run: |
+          if grep -qE '"test"\s*:' package.json; then
+            npm run test -- --passWithNoTests
+          else
+            echo "No tests found in Meshery UI, skipping test step"
+          fi
+        continue-on-error: false
+
+      - name: Integration Test Summary
+        if: always()
+        run: |
+          {
+            echo "## Integration Test Results"
+            echo ""
+            if [ "${{ job.status }}" == "success" ]; then
+              echo "✅ Sistent changes were successfully tested"
+              echo "   against Meshery UI"
+            else
+              echo "❌ Integration test failed"
+            fi
+            echo ""
+            echo "### Details"
+            echo "- **Sistent Package**: ${{ env.SISTENT_PACKAGE }}"
+            if [ "${{ job.status }}" == "success" ]; then
+              echo "- **Meshery UI Build**: ✅ Successful"
+            else
+              echo "- **Meshery UI Build**: ❌ Failed"
+            fi
+            echo "- **Node Version**: 20"
+          } >> $GITHUB_STEP_SUMMARY

README.md

@@ -54,6 +54,19 @@ To run tests:
 make tests
 ```
 
+### Continuous Integration
+
+#### Automated Integration Testing with Meshery UI
+
+Sistent includes automated integration testing in CI to ensure changes don't break downstream applications. When you create a pull request, the CI automatically:
+
+1. **Builds Sistent** with your changes
+2. **Tests against Meshery UI** by installing your Sistent build into Meshery UI
+3. **Runs Meshery UI's build and tests** to verify compatibility
+4. **Reports results** in the PR checks
+
+This ensures that your Sistent changes are validated against real-world usage in Meshery UI before merging. The workflow runs automatically on all pull requests, providing fast feedback on integration issues.
+
 ### Using your local Sistent Fork in a Project
 
 #### Method 1: Manual Installation