feat/WIP: e2e sibling test

.github/workflows/buildandtest.yml

@@ -169,6 +169,60 @@ jobs:
       - name: Run tests
         run: yarn test
 
+  job_e2e_test:
+    name: E2E Test
+    needs: job_build
+    continue-on-error: true
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out current commit (${{ github.sha }})
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install Corepack
+        run: npm install -g corepack
+
+      - run: corepack enable
+
+      - name: Install Yarn v3
+        run: corepack prepare yarn@3.8.6 --activate
+
+      - name: Install Yarn v1
+        run: corepack prepare yarn@1.22.22 --activate
+
+      - name: Check dependency cache
+        uses: actions/cache@v4.1.2
+        with:
+          path: ${{ env.CACHED_DEPENDENCY_PATHS }}
+          key: ${{ needs.job_build.outputs.dependency_cache_key }}
+      - name: Check build cache
+        uses: actions/cache@v4.1.2
+        with:
+          path: ${{ env.CACHED_BUILD_PATHS }}
+          key: ${{ env.BUILD_CACHE_KEY }}
+      - name: Install yalc
+        run: yarn  global add yalc
+      - name: Run tests
+        run: |
+            yarn install
+            yarn test:e2e
+
+      - name: Upload failed artifact with test logs and JSON files
+        if: failure()
+        uses: actions/upload-artifact@v4.1.0
+        with:
+          name: failed-e2e-${{ github.run_id }}
+          path: |
+            ./e2e-test/scripts/siblingsTests/npm*/*/*.log
+            ./e2e-test/scripts/siblingsTests/npm*/*/*.json
+            ./e2e-test/scripts/siblingsTests/yarn_*/*/*.log
+            ./e2e-test/scripts/siblingsTests/yarn_*/*/*.json
+
   job_artifacts:
     name: Upload Artifacts
     needs: job_build

.gitignore

@@ -9,6 +9,11 @@ node_modules/
 # Jest generated folder
 coverage/
 
+# e2e siblings
+/e2e-test/scripts/siblingsTests/*/newInstall*
+/e2e-test/scripts/siblingsTests/*/update*
+/e2e-test/scripts/siblingsTests/.yalc
+
 # example files
 example/*/dist
 example/*/node_modules

e2e-test/scripts/siblingsTests/npm_default/packagemanager.package.json

@@ -0,0 +1,2 @@
+{
+}

e2e-test/scripts/siblingsTests/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "2e2-sibling-test",
+  "version": "1.0.0",
+  "license": "MIT",
+  "scripts": {
+    "_comment": "postinstall scripts are not called from file packages so we copy the same post install from sentry capacitor",
+    "postinstall": "node node_modules/@sentry/capacitor/scripts/check-siblings.js"
+  },
+  "dependencies": {
+  }
+}

e2e-test/scripts/siblingsTests/yarn_v1/packagemanager.package.json

@@ -0,0 +1,3 @@
+{
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}

e2e-test/scripts/siblingsTests/yarn_v3/packagemanager.package.json

@@ -0,0 +1,3 @@
+{
+  "packageManager": "yarn@3.8.6"
+}

jest.e2e.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.(ts)$": "ts-jest"
+  },
+  setupFilesAfterEnv: ["jest-extended/all"],
+  globals: {
+    "__DEV__": true,
+    "ts-jest": {
+      tsconfig: "./tsconfig.json",
+      diagnostics: false
+    }
+  },
+  moduleFileExtensions: ["ts", "js"],
+  testMatch: ["**/test/scripts/**/*.test.(ts|tsx)"],
+};

package.json

@@ -18,6 +18,7 @@
     "watch": "tsc --watch",
     "clean": "rimraf ./dist ./coverage",
     "test": "jest",
+    "test:e2e": "./scripts/e2e-test.siblings.sh",
     "test:watch": "jest --watch",
     "lint": "eslint .",
     "fix": "eslint --fix test/* src/*",
@@ -74,9 +75,11 @@
     "@sentry-internal/eslint-plugin-sdk": "8.42.0",
     "@sentry-internal/typescript": "8.42.0",
     "@sentry/wizard": "3.34.2",
+    "@types/fs-extra": "^11.0.4",
     "@types/jest": "^29.5.3",
     "concurrently": "^8.2.2",
     "eslint": "^7.13.0",
+    "fs-extra": "^11.2.0",
     "jest": "^29.6.2",
     "jest-extended": "^4.0.2",
     "prettier": "^3.3.2",
@@ -127,7 +130,8 @@
       "js"
     ],
     "testPathIgnorePatterns": [
-      "<rootDir>/sample/"
+      "<rootDir>/sample/",
+      "<rootDir>/test/scripts/"
     ],
     "testEnvironment": "node",
     "testMatch": [

scripts/check-siblings.js

@@ -7,6 +7,12 @@ const updateArgument = '--update-sentry-capacitor';
 // Filters all Sentry packages but Capacitor, CLI and Wizard.
 const jsonFilter = /\s*\"\@sentry\/(?!capacitor|wizard|cli|typescript|electron)(?<packageName>[a-zA-Z]+)\"\:\s*\"(?<version>.+)\"/;
 
+const IsE2E = env.sentry_e2e == 'true';
+
+function LogE2E(message) {
+  IsE2E && console.log("E2E_TEST: " + message);
+}
+
 /**
  * If user requested to ignore the post-install
  * @return {Boolean} true if requested to skip the post-install check, false otherwise.
@@ -70,6 +76,7 @@ function ValidateSentryPackageParameters(packages, siblingVersion) {
   }
 
   if (errorMessages.length > 0) {
+    LogE2E("Incompatibility found");
     console.error(`⚠️   ${errorMessages.join("\n")}`);
     exit(1);
   }
@@ -114,21 +121,26 @@ function FormatPackageInstallCommand(sentryPackages) {
 }
 
 function CheckSiblings() {
+  LogE2E("Invoked");
   if (SkipPostInstall()) {
+    LogE2E("Skipped");
     return;
   }
 
   const siblingVersion = GetRequiredSiblingVersion();
   if (siblingVersion === undefined) {
+    LogE2E("Sibling not set");
     return;
   }
+  LogE2E(`Expecting sibling version ${siblingVersion}`);
 
   // Method 1: Validate user parameters when requesting to install/update a new Package.
   if (env.npm_config_argv) {
     // Only available on Yarn.
     const npmAction = JSON.parse(env.npm_config_argv);
     if (npmAction.original && npmAction.original.length > 1) {
       ValidateSentryPackageParameters(npmAction.original, siblingVersion);
+      LogE2E("OK");
       return;
     }
   }
@@ -154,11 +166,13 @@ function CheckSiblings() {
       `Please install the mentioned packages exactly with version ${siblingVersion} and with the argument ${updateArgument}.
 Your project will build with the wrong package but you may face Runtime errors.
 You can use the below command to fix your package.json:`);
+    LogE2E("Incompatibility found");
 
     console.error(`⚠️   ${IncompatibilityError.join("\n")}`);
     console.warn(`  ${FormatPackageInstallCommand(packagesList)}`);
     exit(1);
   }
+  LogE2E("OK");
 }
 
 CheckSiblings();

scripts/e2e-test.siblings.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Publish with yalc
+yalc publish --sig
+
+# Navigate to siblingsTests and publish without modifying package.json
+cd e2e-test/scripts/siblingsTests/
+
+rm -r .yalc
+rm -r node_modules
+
+cp package.json package.json.bak
+
+yalc add @sentry/capacitor
+
+rm yalc.lock
+rm package.json
+mv package.json.bak package.json
+
+cd ../../..
+
+# Run Jest
+jest -c jest.e2e.config.js

test/scripts/check-siblings.npm.test.ts

@@ -0,0 +1,118 @@
+import path from 'path';
+const { execSync } = require("child_process");
+
+import { ClearE2ETestFolder, CreateE2EPackage, CreateE2EStartPackage, e2ePath, GetInitialE2EPackage, GetLogs, GetPackageManagerVersion, InstallSDK, InvalidSentrySiblingVersion, readJsonOrEmpty, SDKPath, ValidSentrySiblingVersion } from './check-siblingsHelper';
+
+const CapacitorInstallArg = `file:${SDKPath}`
+
+describe('NPM tests', () => {
+  const npme2ePath = path.join(e2ePath, 'npm_default');
+  const PackageMangerVersion = execSync("npm --version").toString().trim();
+
+  describe('new Install', () => {
+    test('no warnings when correct sibling is installed', async () => {
+      // Setup.
+      const siblingVersion = ValidSentrySiblingVersion();
+
+      const testPath = path.join(npme2ePath, 'newInstallCorrectSibling');
+      const packageJsonPath = path.join(testPath, 'package.json');
+
+      ClearE2ETestFolder(testPath);
+      CreateE2EPackage(testPath);
+
+      expect(GetPackageManagerVersion('npm', testPath)).toBe(PackageMangerVersion);
+
+      const expectedPackageJson = {
+        ...GetInitialE2EPackage(testPath),
+        dependencies: {
+          '@sentry/capacitor': 'file:../../.yalc/@sentry/capacitor',
+          '@sentry/angular': siblingVersion
+        }
+      };
+
+
+      // Test
+      const result = InstallSDK('npm',['install', '--save-exact', '--foreground-scripts', CapacitorInstallArg, `@sentry/angular@${siblingVersion}`], testPath);
+      const packageJson = readJsonOrEmpty(packageJsonPath);
+      const e2eLogs = GetLogs(testPath);
+
+      // Expect
+      expect(result.status).toBe(0);
+      expect(packageJson).toEqual(expectedPackageJson);
+      expect(e2eLogs).toContain('E2E_TEST: OK');
+    });
+  });
+
+  describe('update packages', () => {
+    test('no warnings when correct sibling are updated', async () => {
+      // Setup.
+      const siblingVersion = ValidSentrySiblingVersion();
+
+      const testPath = path.join(npme2ePath, 'updateCorrectSibling');
+      const packageJsonPath = path.join(testPath, 'package.json');
+      const dependenciesJson = {
+        dependencies: {
+          '@sentry/capacitor': CapacitorInstallArg,
+          '@sentry/angular': siblingVersion
+        }
+      };
+
+      ClearE2ETestFolder(testPath);
+      CreateE2EStartPackage(testPath, dependenciesJson);
+      CreateE2EPackage(testPath);
+      expect(GetPackageManagerVersion('npm', testPath)).toBe(PackageMangerVersion);
+
+      const expectedPackageJson = {
+        ...GetInitialE2EPackage(testPath),
+        ...dependenciesJson
+      };
+
+      // Test
+      const result = InstallSDK('npm',['install'], testPath);
+      const packageJson = readJsonOrEmpty(packageJsonPath);
+      const e2eLogs = GetLogs(testPath);
+
+      // Expect
+      expect(result.status).toBe(0);
+      expect(packageJson).toEqual(expectedPackageJson);
+      expect(e2eLogs).toContain('E2E_TEST: OK');
+    });
+
+    test('warns when incorrect sibling is installed', async () => {
+      // Setup.
+      const siblingVersion = InvalidSentrySiblingVersion();
+
+      const testPath = path.join(npme2ePath, 'updateInorrectSibling');
+      const packageJsonPath = path.join(testPath, 'package.json');
+      const dependenciesJson = {
+        dependencies: {
+          '@sentry/capacitor': CapacitorInstallArg,
+          '@sentry/angular': siblingVersion
+        }
+      };
+
+      ClearE2ETestFolder(testPath);
+      CreateE2EStartPackage(testPath, dependenciesJson);
+      CreateE2EPackage(testPath);
+      expect(GetPackageManagerVersion('npm', testPath)).toBe(PackageMangerVersion);
+
+      const expectedPackageJson = {
+        ...GetInitialE2EPackage(testPath),
+        ...dependenciesJson
+      };
+
+      // Test
+      const result = InstallSDK('npm', ['install'], testPath);
+      const packageJson = readJsonOrEmpty(packageJsonPath);
+      const logs = GetLogs(testPath).join('\n');
+
+      // Expect
+      expect(result.status).toBe(1);
+      expect(packageJson).toEqual(expectedPackageJson);
+      expect(logs).toContain('E2E_TEST: Incompatibility found');
+      expect(logs).toContain(`⚠️   This version of Sentry Capacitor is incompatible with the following installed packages:
+@sentry/angular version ${siblingVersion}`);
+      expect(logs).toContain(`npm install --save-exact @sentry/angular@${ValidSentrySiblingVersion()}  --update-sentry-capacitor`);
+    });
+  });
+});