feat: support vitest unit tests (#6123)

Author: NathanWalker

config/test-dependencies.json

@@ -1,15 +1,40 @@
 [
     {
-        "name": "@jsdevtools/coverage-istanbul-loader"
+        "name": "vitest",
+        "framework": "vitest",
+        "version": "~4.1.10"
     },
     {
-        "name": "karma"
+        "name": "@vitest/runner",
+        "framework": "vitest",
+        "version": "~4.1.10"
     },
     {
-        "name": "karma-coverage"
+        "name": "@nativescript/unit-test-runner",
+        "framework": "vitest",
+        "version": "^5.0.0-alpha.0"
     },
     {
-        "name": "karma-nativescript-launcher"
+        "name": "@valor/nativescript-websockets",
+        "framework": "vitest",
+        "version": "^2.0.3",
+        "saveInDependencies": true
+    },
+    {
+        "name": "@jsdevtools/coverage-istanbul-loader",
+        "frameworks": ["jasmine", "mocha", "qunit"]
+    },
+    {
+        "name": "karma",
+        "frameworks": ["jasmine", "mocha", "qunit"]
+    },
+    {
+        "name": "karma-coverage",
+        "frameworks": ["jasmine", "mocha", "qunit"]
+    },
+    {
+        "name": "karma-nativescript-launcher",
+        "frameworks": ["jasmine", "mocha", "qunit"]
     },
     {
         "name": "mocha",
@@ -53,6 +78,7 @@
         "projectType": ".ts"
     },
     {
-        "name": "nyc"
+        "name": "nyc",
+        "frameworks": ["jasmine", "mocha", "qunit"]
     }
-]
+]

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

@@ -9,6 +9,8 @@ position: 21
 
 Configures your project for unit testing with a selected framework. This operation installs the @nativescript/unit-test-runner npm module and its dependencies and creates a `tests` folder in the `app` directory.
 
+The recommended framework is `vitest`, which runs your specs inside real NativeScript runtimes on device/emulator and also supports UI testing. The Karma-based frameworks (jasmine, mocha, qunit) are deprecated and will be removed in a future release.
+
 ### Commands
 
 Usage | Synopsis
@@ -17,7 +19,7 @@ General | `$ ns test init [--framework <Framework>]`
 
 ### Options
 
-* `--framework <Framework>` - Sets the unit testing framework to install. The following frameworks are available: mocha, jasmine and qunit.
+* `--framework <Framework>` - Sets the unit testing framework to install. The following frameworks are available: vitest (recommended), mocha, jasmine and qunit (deprecated).
 
 <% if(isHtml) { %>
 
@@ -31,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

@@ -203,12 +203,16 @@ injector.requireCommand("deploy", "./commands/deploy");
 injector.requireCommand("embed", "./commands/embedding/embed");
 
 injector.require("testExecutionService", "./services/test-execution-service");
+injector.require(
+	"vitestExecutionService",
+	"./services/vitest-execution-service",
+);
 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");