chore: visionos support for unit testing with vitest

Author: NathanWalker

docs/man_pages/project/testing/test-android.md

@@ -43,4 +43,5 @@ Command | Description
 --------|------------
 [test init](test-init.html) | Configures your project for unit testing with a selected framework.
 [test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
+[test visionos](test-visionos.html) | Runs the tests in your project in the visionOS Simulator or on Apple Vision Pro devices.
 <% } %>

docs/man_pages/project/testing/test-init.md

@@ -33,4 +33,5 @@ Command | Description
 --------|------------
 [test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
 [test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
+[test visionos](test-visionos.html) | Runs the tests in your project in the visionOS Simulator or on Apple Vision Pro devices.
 <% } %>

docs/man_pages/project/testing/test-ios.md

@@ -45,4 +45,5 @@ Command | Description
 --------|------------
 [test init](test-init.html) | Configures your project for unit testing with a selected framework.
 [test android](test-android.html) | Runs the tests in your project on Android devices or native emulators.
+[test visionos](test-visionos.html) | Runs the tests in your project in the visionOS Simulator or on Apple Vision Pro devices.
 <% } %>

docs/man_pages/project/testing/test-visionos.md

@@ -0,0 +1,46 @@
+<% if (isJekyll) { %>---
+title: ns test visionos
+position: 24
+---<% } %>
+
+# ns test visionos
+
+### Description
+
+Runs the tests in your project in the visionOS Simulator or on connected Apple Vision Pro devices.<% if(isConsole && isMacOS) { %> Your project must already be configured for unit testing with the Vitest framework by running `$ ns test init --framework vitest`.<% } %> Unit testing on visionOS requires the Vitest testing framework; the deprecated Karma-based frameworks are not supported on this platform.
+
+<% if(isConsole && (isLinux || isWindows)) { %>WARNING: You can run this command only on macOS systems. To view the complete help for this command, run `$ ns help test visionos`<% } %> 
+
+### Commands
+
+Usage | Synopsis
+------|-------
+Run tests in the visionOS Simulator | `$ ns test visionos`
+Run tests on a selected device | `$ ns test visionos --device <Device ID>`
+
+<% if((isConsole && isMacOS) || isHtml) { %>
+
+### Options
+
+* `--device` - Specifies the serial number or the index of the connected device on which you want to run tests. To list all connected devices, grouped by platform, run `$ ns device`. `<Device ID>` is the device index or identifier as listed by the `$ ns device` command.
+* `--env.codeCoverage` - If set, collects code coverage for the test run.
+* `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `ns migrate`.
+
+<% } %>
+
+<% if(isHtml) { %>
+
+### Prerequisites
+
+* Verify that [you have configured your project for unit testing](test-init.html) with the Vitest framework.
+* Verify that [you have stored your unit tests in `app` &#8594; `tests`](http://docs.nativescript.org/testing).
+* Verify that [you have configured your system and devices properly](http://docs.nativescript.org/testing).
+
+### Related Commands
+
+Command | Description
+--------|------------
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators.
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
+<% } %>

docs/man_pages/project/testing/test.md

@@ -28,7 +28,8 @@ Usage | Synopsis
 <% if((isConsole && isMacOS) || isHtml) { %>### Arguments
 `<Platform>` is the target mobile platform on which you want to run the tests. You can set the following target platforms.
 * `android` - Runs the tests in your project on connected Android devices or Android emulators. 
-* `ios` - Runs the tests in your project on connected iOS devices.<% } %>
+* `ios` - Runs the tests in your project on connected iOS devices.
+* `visionos` - Runs the tests in your project in the visionOS Simulator or on connected Apple Vision Pro devices. Requires the Vitest testing framework.<% } %>
 
 <% if(isHtml) { %>
 
@@ -45,4 +46,5 @@ Command | Description
 [test init](test-init.html) | Configures your project for unit testing with a selected framework.
 [test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
 [test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
+[test visionos](test-visionos.html) | Runs the tests in your project in the visionOS Simulator or on Apple Vision Pro devices.
 <% } %>

lib/bootstrap.ts

@@ -211,8 +211,8 @@ injector.requireCommand("dev-test|android", "./commands/test");
 injector.requireCommand("dev-test|ios", "./commands/test");
 injector.requireCommand("test|android", "./commands/test");
 injector.requireCommand("test|ios", "./commands/test");
-// injector.requireCommand("test|vision", "./commands/test");
-// injector.requireCommand("test|visionos", "./commands/test");
+injector.requireCommand("test|vision", "./commands/test");
+injector.requireCommand("test|visionos", "./commands/test");
 injector.requireCommand("test|init", "./commands/test-init");
 injector.requireCommand("dev-generate-help", "./commands/generate-help");
 

lib/commands/test-init.ts

@@ -345,14 +345,15 @@ class TestInitCommand implements ICommand {
 		const closingNotes = isVitest
 			? [
 					color.yellow(
-						`Note: emulator/simulator test runs connect over the local loopback. When testing on a physical Android device, keep it connected over USB (adb reverse is set up automatically); for a physical iOS device, pass a reachable 'url' to the coordinator in your test entry.`,
+						`Note: emulator/simulator test runs connect over the local loopback. When testing on a physical Android device, keep it connected over USB (adb reverse is set up automatically); for a physical iOS or visionOS device, pass a reachable 'url' to the coordinator in your test entry.`,
 					),
 					"",
 					"",
 					`You can now run your tests:`,
 					"",
 					`  ${greyDollarSign} ${color.green("ns test ios")}`,
 					`  ${greyDollarSign} ${color.green("ns test android")}`,
+					`  ${greyDollarSign} ${color.green("ns test visionos")}`,
 					"",
 					`or directly through Vitest (editor extensions, CI):`,
 					"",

lib/commands/test.ts

@@ -235,5 +235,56 @@ class TestIosCommand extends TestCommandBase implements ICommand {
 	}
 }
 
+class TestVisionOSCommand extends TestIosCommand {
+	protected platform = "visionOS";
+
+	// The injector discovers dependencies by parsing constructor source text,
+	// so an inherited constructor would resolve to zero dependencies.
+	constructor(
+		protected $projectData: IProjectData,
+		protected $testExecutionService: ITestExecutionService,
+		protected $vitestExecutionService: IVitestExecutionService,
+		protected $analyticsService: IAnalyticsService,
+		protected $options: IOptions,
+		protected $platformEnvironmentRequirements: IPlatformEnvironmentRequirements,
+		protected $errors: IErrors,
+		protected $cleanupService: ICleanupService,
+		protected $liveSyncCommandHelper: ILiveSyncCommandHelper,
+		protected $devicesService: Mobile.IDevicesService,
+		protected $migrateController: IMigrateController,
+		protected $logger: ILogger,
+	) {
+		super(
+			$projectData,
+			$testExecutionService,
+			$vitestExecutionService,
+			$analyticsService,
+			$options,
+			$platformEnvironmentRequirements,
+			$errors,
+			$cleanupService,
+			$liveSyncCommandHelper,
+			$devicesService,
+			$migrateController,
+			$logger,
+		);
+	}
+
+	async canExecute(args: string[]): Promise<boolean> {
+		this.$projectData.initializeProjectData();
+		// The Karma runner (v4 line) never supported visionOS — only the Vitest
+		// path can drive it.
+		if (!this.$vitestExecutionService.isVitestProject(this.$projectData)) {
+			this.$errors.fail(
+				"visionOS unit testing requires the Vitest runner. Run '$ ns test init --framework vitest' to configure your project.",
+			);
+		}
+
+		return super.canExecute(args);
+	}
+}
+
 injector.registerCommand("test|android", TestAndroidCommand);
 injector.registerCommand("test|ios", TestIosCommand);
+injector.registerCommand("test|vision", TestVisionOSCommand);
+injector.registerCommand("test|visionos", TestVisionOSCommand);

resources/test/vitest.config.mts

@@ -1,12 +1,12 @@
 import { defineConfig } from 'vitest/config';
 import { nativeScript } from '@nativescript/unit-test-runner';
 
-// Platform is selected per run: `ns test ios` / `ns test android`, or
-// NS_PLATFORM=ios npx vitest run
+// Platform is selected per run: `ns test ios` / `ns test android` /
+// `ns test visionos`, or NS_PLATFORM=ios npx vitest run
 export default defineConfig({
 	plugins: [
 		nativeScript({
-			platform: (process.env.NS_PLATFORM as 'android' | 'ios') || 'ios',
+			platform: process.env.NS_PLATFORM || 'ios', // 'android' | 'ios' | 'visionos'
 			device: process.env.NS_DEVICE || undefined,
 		}),
 	],