Skip Gradle tests by default and enable it on CI

Author: kraenhansen

.github/workflows/check.yml

@@ -3,6 +3,8 @@ name: Check
 env:
   # Version here should match the one in React Native template and packages/cmake-rn/src/cli.ts
   NDK_VERSION: 27.1.12297006
+  # Enabling the Gradle test on CI (disabled by default because it downloads a lot)
+  ENABLE_GRADLE_TESTS: true
 
 on:
   push:

packages/host/package.json

@@ -47,6 +47,7 @@
     "build-weak-node-api": "cmake-rn --no-auto-link --no-weak-node-api-linkage --xcframework-extension --source ./weak-node-api --out ./weak-node-api",
     "build-weak-node-api:all-triplets": "cmake-rn --android --apple --no-auto-link --no-weak-node-api-linkage --xcframework-extension --source ./weak-node-api --out ./weak-node-api",
     "test": "tsx --test --test-reporter=@reporters/github --test-reporter-destination=stdout --test-reporter=spec --test-reporter-destination=stdout src/node/**/*.test.ts src/node/*.test.ts",
+    "test:gradle": "ENABLE_GRADLE_TESTS=true node --run test",
     "bootstrap": "node --run copy-node-api-headers && node --run generate-weak-node-api-injector && node --run generate-weak-node-api && node --run build-weak-node-api",
     "prerelease": "node --run copy-node-api-headers && node --run generate-weak-node-api-injector && node --run generate-weak-node-api && node --run build-weak-node-api:all-triplets"
   },

packages/host/src/node/gradle.test.ts

@@ -7,55 +7,60 @@ const PACKAGE_ROOT = path.join(__dirname, "../..");
 const MONOREPO_ROOT = path.join(PACKAGE_ROOT, "../..");
 const TEST_APP_ANDROID_PATH = path.join(MONOREPO_ROOT, "apps/test-app/android");
 
-describe("Gradle tasks", () => {
-  describe("checkHermesOverride task", () => {
-    it("should fail if REACT_NATIVE_OVERRIDE_HERMES_DIR is not set", () => {
-      const { status, stdout, stderr } = cp.spawnSync(
-        "sh",
-        ["gradlew", "react-native-node-api:checkHermesOverride"],
-        {
-          cwd: TEST_APP_ANDROID_PATH,
-          env: {
-            ...process.env,
-            REACT_NATIVE_OVERRIDE_HERMES_DIR: undefined,
+describe(
+  "Gradle tasks",
+  // Skipping these tests by default, as they download a lot and takes a long time
+  { skip: process.env.ENABLE_GRADLE_TESTS !== "true" },
+  () => {
+    describe("checkHermesOverride task", () => {
+      it("should fail if REACT_NATIVE_OVERRIDE_HERMES_DIR is not set", () => {
+        const { status, stdout, stderr } = cp.spawnSync(
+          "sh",
+          ["gradlew", "react-native-node-api:checkHermesOverride"],
+          {
+            cwd: TEST_APP_ANDROID_PATH,
+            env: {
+              ...process.env,
+              REACT_NATIVE_OVERRIDE_HERMES_DIR: undefined,
+            },
+            encoding: "utf-8",
           },
-          encoding: "utf-8",
-        },
-      );
+        );
 
-      assert.notEqual(status, 0, `Expected failure: ${stdout} ${stderr}`);
-      assert.match(
-        stderr,
-        /React Native Node-API needs a custom version of Hermes with Node-API enabled/,
-      );
-      assert.match(
-        stderr,
-        /Run the following in your terminal, to clone Hermes and instruct React Native to use it/,
-      );
-      assert.match(
-        stderr,
-        /export REACT_NATIVE_OVERRIDE_HERMES_DIR=`npx react-native-node-api vendor-hermes --silent --force`/,
-      );
-      assert.match(
-        stderr,
-        /And follow this guide to build React Native from source/,
-      );
+        assert.notEqual(status, 0, `Expected failure: ${stdout} ${stderr}`);
+        assert.match(
+          stderr,
+          /React Native Node-API needs a custom version of Hermes with Node-API enabled/,
+        );
+        assert.match(
+          stderr,
+          /Run the following in your terminal, to clone Hermes and instruct React Native to use it/,
+        );
+        assert.match(
+          stderr,
+          /export REACT_NATIVE_OVERRIDE_HERMES_DIR=`npx react-native-node-api vendor-hermes --silent --force`/,
+        );
+        assert.match(
+          stderr,
+          /And follow this guide to build React Native from source/,
+        );
+      });
     });
-  });
 
-  describe("linkNodeApiModules task", () => {
-    it("should call the CLI to autolink", () => {
-      const { status, stdout, stderr } = cp.spawnSync(
-        "sh",
-        ["gradlew", "react-native-node-api:linkNodeApiModules"],
-        {
-          cwd: TEST_APP_ANDROID_PATH,
-          encoding: "utf-8",
-        },
-      );
+    describe("linkNodeApiModules task", () => {
+      it("should call the CLI to autolink", () => {
+        const { status, stdout, stderr } = cp.spawnSync(
+          "sh",
+          ["gradlew", "react-native-node-api:linkNodeApiModules"],
+          {
+            cwd: TEST_APP_ANDROID_PATH,
+            encoding: "utf-8",
+          },
+        );
 
-      assert.equal(status, 0, `Expected failure: ${stdout} ${stderr}`);
-      assert.match(stdout, /Auto-linking Node-API modules/);
+        assert.equal(status, 0, `Expected failure: ${stdout} ${stderr}`);
+        assert.match(stdout, /Auto-linking Node-API modules/);
+      });
     });
-  });
-});
+  },
+);