Merge pull request #236 from NativeScript/tachev/debug-tests

Dimitar Tachev · web-flow · commit 9a9a46d34ce4 · 2019-02-18T18:40:24.000+02:00
feat: add Test configurations allowing unit tests debugging
diff --git a/package.json b/package.json
@@ -143,6 +143,20 @@
             "sourceMaps": true,
             "watch": true
           },
+          {
+            "name": "Test on iOS",
+            "type": "nativescript",
+            "request": "launch",
+            "platform": "ios",
+            "appRoot": "${workspaceRoot}",
+            "sourceMaps": true,
+            "watch": false,
+            "stopOnEntry": true,
+            "launchTests": true,
+            "tnsArgs": [
+              "--justlaunch"
+            ]
+          },
           {
             "name": "Attach on iOS",
             "type": "nativescript",
@@ -161,6 +175,20 @@
             "sourceMaps": true,
             "watch": true
           },
+          {
+            "name": "Test on Android",
+            "type": "nativescript",
+            "request": "launch",
+            "platform": "android",
+            "appRoot": "${workspaceRoot}",
+            "sourceMaps": true,
+            "watch": false,
+            "stopOnEntry": true,
+            "launchTests": true,
+            "tnsArgs": [
+              "--justlaunch"
+            ]
+          },
           {
             "name": "Attach on Android",
             "type": "nativescript",
@@ -281,6 +309,11 @@
                 "type": "object",
                 "description": "A set of mappings for rewriting the locations of source files from what the sourcemap says, to their locations on the disk.",
                 "default": null
+              },
+              "launchTests": {
+                "type": "boolean",
+                "description": "If true, the launch request will run the unit tests instead of the app itself.",
+                "default": false
               }
             }
           },
@@ -336,4 +369,4 @@
       }
     ]
   }
-}
+}
diff --git a/src/project/androidProject.ts b/src/project/androidProject.ts
@@ -31,14 +31,15 @@ export class AndroidProject extends Project {
         return { tnsProcess: debugProcess, tnsOutputEventEmitter };
     }
 
-    public debug(options: { stopOnEntry: boolean, watch: boolean }, tnsArgs?: string[]): IDebugResult {
+    public debug(options: { stopOnEntry: boolean, watch: boolean, launchTests: boolean }, tnsArgs?: string[]): IDebugResult {
         let args: string[] = [];
 
         args.push(options.watch ? '--watch' : '--no-watch');
         if (options.stopOnEntry) { args.push('--debug-brk'); }
         args = args.concat(tnsArgs);
 
-        const debugProcess: ChildProcess = super.executeDebugCommand(args);
+        const debugProcess: ChildProcess = options.launchTests ?
+            super.executeTestCommand(args) : super.executeDebugCommand(args);
         const tnsOutputEventEmitter: EventEmitter = new EventEmitter();
         const shouldWaitAfterRestartMessage = semver.lt(semver.coerce(this.cliVersion), '5.1.0');
         const waitForRestartMessage = shouldWaitAfterRestartMessage || args.indexOf('--debug-brk') > -1;
diff --git a/src/project/iosProject.ts b/src/project/iosProject.ts
@@ -32,14 +32,15 @@ export class IosProject extends Project {
         return { tnsProcess: debugProcess, tnsOutputEventEmitter };
     }
 
-    public debug(options: { stopOnEntry: boolean, watch: boolean }, tnsArgs?: string[]): IDebugResult {
+    public debug(options: { stopOnEntry: boolean, watch: boolean, launchTests: boolean }, tnsArgs?: string[]): IDebugResult {
         let args: string[] = [];
 
         args.push(options.watch ? '--watch' : '--no-watch');
         if (options.stopOnEntry) { args.push('--debug-brk'); }
         args = args.concat(tnsArgs);
+        const debugProcess: ChildProcess = options.launchTests ?
+            super.executeTestCommand(args) : super.executeDebugCommand(args);
 
-        const debugProcess: ChildProcess = super.executeDebugCommand(args);
         const tnsOutputEventEmitter: EventEmitter = new EventEmitter();
 
         this.configureReadyEvent(debugProcess.stdout, tnsOutputEventEmitter);
diff --git a/src/project/project.ts b/src/project/project.ts
@@ -27,7 +27,7 @@ export abstract class Project {
 
     public abstract attach(tnsArgs?: string[]): IDebugResult;
 
-    public abstract debug(options: { stopOnEntry: boolean, watch: boolean }, tnsArgs?: string[]): IDebugResult;
+    public abstract debug(options: { stopOnEntry: boolean, watch: boolean, launchTests: boolean }, tnsArgs?: string[]): IDebugResult;
 
     protected configureReadyEvent(readableStream: stream.Readable, eventEmitter: EventEmitter): void {
         new scanner.StringMatchingScanner(readableStream).onEveryMatch('TypeScript compiler failed', () => {
@@ -42,4 +42,8 @@ export abstract class Project {
     protected executeDebugCommand(args: string[]): ChildProcess {
         return this._cli.execute(['debug', this.platformName()].concat(args), this._appRoot);
     }
+
+    protected executeTestCommand(args: string[]): ChildProcess {
+        return this._cli.execute(['test', this.platformName()].concat(args), this._appRoot);
+    }
 }
diff --git a/src/services/buildService.ts b/src/services/buildService.ts
@@ -56,12 +56,12 @@ export class BuildService {
                 }
             }
 
-            cliCommand = project.debug({ stopOnEntry: args.stopOnEntry, watch: args.watch }, tnsArgs);
+            cliCommand = project.debug({ stopOnEntry: args.stopOnEntry, watch: args.watch, launchTests: args.launchTests }, tnsArgs);
         } else if (args.request === 'attach') {
             cliCommand = project.attach(args.tnsArgs);
         }
 
-        return new Promise<string | number> ((res, rej) => {
+        return new Promise<string | number>((res, rej) => {
             if (cliCommand.tnsProcess) {
                 this._tnsProcess = cliCommand.tnsProcess;
                 cliCommand.tnsProcess.stdout.on('data', (data) => { this._logger.log(data.toString()); });
@@ -109,7 +109,7 @@ export class BuildService {
             const teamIdArgIndex = tnsArgs.indexOf('--teamId');
 
             if (teamIdArgIndex > 0 && teamIdArgIndex + 1 < tnsArgs.length) {
-                return tnsArgs[ teamIdArgIndex + 1 ];
+                return tnsArgs[teamIdArgIndex + 1];
             }
         }
 
@@ -128,7 +128,7 @@ export class BuildService {
         const xcconfigFile = path.join(appRoot, 'App_Resources/iOS/build.xcconfig');
 
         if (fs.existsSync(xcconfigFile)) {
-            const text = fs.readFileSync(xcconfigFile, { encoding: 'utf8'});
+            const text = fs.readFileSync(xcconfigFile, { encoding: 'utf8' });
             let teamId: string;
 
             text.split(/\r?\n/).forEach((line) => {

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ export abstract class Project {`
`27`	`27`
`28`	`28`	`public abstract attach(tnsArgs?: string[]): IDebugResult;`
`29`	`29`
`30`		`- public abstract debug(options: { stopOnEntry: boolean, watch: boolean }, tnsArgs?: string[]): IDebugResult;`
	`30`	`+ public abstract debug(options: { stopOnEntry: boolean, watch: boolean, launchTests: boolean }, tnsArgs?: string[]): IDebugResult;`
`31`	`31`
`32`	`32`	`protected configureReadyEvent(readableStream: stream.Readable, eventEmitter: EventEmitter): void {`
`33`	`33`	`new scanner.StringMatchingScanner(readableStream).onEveryMatch('TypeScript compiler failed', () => {`
`@@ -42,4 +42,8 @@ export abstract class Project {`
`42`	`42`	`protected executeDebugCommand(args: string[]): ChildProcess {`
`43`	`43`	`return this._cli.execute(['debug', this.platformName()].concat(args), this._appRoot);`
`44`	`44`	`}`
	`45`	`+`
	`46`	`+ protected executeTestCommand(args: string[]): ChildProcess {`
	`47`	`+ return this._cli.execute(['test', this.platformName()].concat(args), this._appRoot);`
	`48`	`+ }`
`45`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,12 +56,12 @@ export class BuildService {`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`
`59`		`- cliCommand = project.debug({ stopOnEntry: args.stopOnEntry, watch: args.watch }, tnsArgs);`
	`59`	`+ cliCommand = project.debug({ stopOnEntry: args.stopOnEntry, watch: args.watch, launchTests: args.launchTests }, tnsArgs);`
`60`	`60`	`} else if (args.request === 'attach') {`
`61`	`61`	`cliCommand = project.attach(args.tnsArgs);`
`62`	`62`	`}`
`63`	`63`
`64`		`- return new Promise<string \| number> ((res, rej) => {`
	`64`	`+ return new Promise<string \| number>((res, rej) => {`
`65`	`65`	`if (cliCommand.tnsProcess) {`
`66`	`66`	`this._tnsProcess = cliCommand.tnsProcess;`
`67`	`67`	`cliCommand.tnsProcess.stdout.on('data', (data) => { this._logger.log(data.toString()); });`
`@@ -109,7 +109,7 @@ export class BuildService {`
`109`	`109`	`const teamIdArgIndex = tnsArgs.indexOf('--teamId');`
`110`	`110`
`111`	`111`	`if (teamIdArgIndex > 0 && teamIdArgIndex + 1 < tnsArgs.length) {`
`112`		`- return tnsArgs[ teamIdArgIndex + 1 ];`
	`112`	`+ return tnsArgs[teamIdArgIndex + 1];`
`113`	`113`	`}`
`114`	`114`	`}`
`115`	`115`
`@@ -128,7 +128,7 @@ export class BuildService {`
`128`	`128`	`const xcconfigFile = path.join(appRoot, 'App_Resources/iOS/build.xcconfig');`
`129`	`129`
`130`	`130`	`if (fs.existsSync(xcconfigFile)) {`
`131`		`- const text = fs.readFileSync(xcconfigFile, { encoding: 'utf8'});`
	`131`	`+ const text = fs.readFileSync(xcconfigFile, { encoding: 'utf8' });`
`132`	`132`	`let teamId: string;`
`133`	`133`
`134`	`134`	`text.split(/\r?\n/).forEach((line) => {`