Merged PR 221263: Fix test results

This PR does a few things:
1. Fix broken get theme test
2. Remove noisy unnecessary logs
3. Remove unused headless chrome browser when [kjhtml reporter](https://www.npmjs.com/package/karma-jasmine-html-reporter) is used (using a headless browser for UI debugging doesn't make sense)
4. Fix test failures not leading to Azure DevOps build pipeline failure (align with [official documentation](http://karma-runner.github.io/6.3/dev/public-api.html))
5. Add JUnit test results reported so that Azure DevOps can report test failures nicely (base don front end implementation)

You can see JUnit yourselves by going to the failed build and clicking on the tests tab like you do in the front end or backend but here is a picture

![image.png](https://powerbi.visualstudio.com/4c7b5adb-c2d0-4f18-b23c-edc4ac30f4e1/_apis/git/repositories/1dd63332-e003-46a3-ac6f-70213a1bcc2e/pullRequests/221263/attachments/image.png)

Author: Shahak Yosef

.pipelines/pipeline.user.windows.yml

@@ -119,7 +119,6 @@ test:
       command: '.pipelines\cdpx_run_ps.cmd'
       testresults:
         - title: 'powerbi-javascript test results'
-          type: 'jasmine'
-          from: 'reports'
+          type: 'junit'
           include:
-            - "**coverage/**/index.html"
+            - ".\\tmp\\testresults.xml"

gulpfile.js

@@ -220,8 +220,9 @@ gulp.task('test:js', 'Run js tests', function (done) {
     configFile: __dirname + '/karma.conf.js',
     singleRun: argv.watch ? false : true,
     captureTimeout: argv.timeout || 60000
-  }, function () {
+  }, function (exitStatus) {
     done();
+    process.exit(exitStatus);
   })
     .on('browser_register', (browser) => {
       if (argv.chrome) {

karma.conf.js

@@ -23,7 +23,7 @@ module.exports = function (config) {
       { pattern: './test/**/*.html', served: true, included: false }
     ],
     exclude: [],
-    reporters: argv.debug ? ['spec', 'kjhtml'] : ['spec', 'coverage', 'kjhtml'],
+    reporters: argv.chrome ? ['coverage', 'kjhtml'] : ['spec', 'coverage', 'junit'],
     autoWatch: true,
     browsers: [browserName],
     browserNoActivityTimeout: 300000,
@@ -34,11 +34,12 @@ module.exports = function (config) {
       'karma-spec-reporter',
       'karma-phantomjs-launcher',
       'karma-coverage',
-      'karma-jasmine-html-reporter'
+      'karma-jasmine-html-reporter',
+      'karma-junit-reporter'
     ],
     customLaunchers: {
       'Chrome_headless': {
-        base: argv.debug ? 'Chrome' : 'ChromeHeadless',
+        base: 'Chrome',
         flags: flags.concat("--no-sandbox", "--window-size=800,800"),
       },
     },
@@ -49,11 +50,15 @@ module.exports = function (config) {
         { type: 'text-summary' }
       ]
     },
+    junitReporter: {
+      outputDir: 'tmp',
+      outputFile: 'testresults.xml',
+      useBrowserName: false
+    },
     retryLimit: 0,
     logLevel: argv.debug ? config.LOG_DEBUG : config.LOG_INFO,
     client: {
       clearContext: false, // leave Jasmine Spec Runner output visible in browser
-      args: argv.logMessages ? ['logMessages'] : []
     }
   });
 };

package.json

@@ -16,7 +16,7 @@
     "prestart": "cd demo && npm install",
     "test": "gulp test",
     "gulp": "gulp",
-    "tests": "npm test -- --chrome --watch --debug"
+    "tests": "npm test -- --chrome --watch"
   },
   "keywords": [
     "microsoft",
@@ -68,6 +68,7 @@
     "karma-firefox-launcher": "^1.2.0",
     "karma-jasmine": "4.0.1",
     "karma-jasmine-html-reporter": "1.7.0",
+    "karma-junit-reporter": "^2.0.1",
     "karma-phantomjs-launcher": "^1.0.4",
     "karma-spec-reporter": "0.0.32",
     "moment": "^2.14.1",

test/SDK-to-HPM.spec.ts

@@ -2072,7 +2072,7 @@ describe('SDK-to-HPM', function () {
         spyHpm.get.and.returnValue(Promise.resolve(testData.response));
         try {
           await report.getTheme();
-          expect(spyHpm.put).toHaveBeenCalledWith('/report/theme', expectedHeaders, jasmine.any(Object));
+          expect(spyHpm.get).toHaveBeenCalledWith('/report/theme', expectedHeaders, jasmine.any(Object));
         } catch (error) {
           console.log("getTheme failed with", error);
           fail("getTheme failed");

test/SDK-to-MockApp.spec.ts

@@ -11,7 +11,7 @@ import * as models from 'powerbi-models';
 import * as factories from '../src/factories';
 import * as util from '../src/util';
 import { spyApp, setupEmbedMockApp } from './utility/mockEmbed';
-import { logMessages, iframeSrc } from './constsants';
+import { iframeSrc } from './constsants';
 
 describe('SDK-to-MockApp', function () {
   let element: HTMLDivElement;
@@ -29,8 +29,7 @@ describe('SDK-to-MockApp', function () {
 
   beforeEach(async function () {
     powerbi = new service.Service(factories.hpmFactory, factories.wpmpFactory, factories.routerFactory, {
-      wpmpName: 'SDK-to-MockApp HostWpmp',
-      logMessages
+      wpmpName: 'SDK-to-MockApp HostWpmp'
     });
     element = document.createElement('div');
     element.id = "reportContainer1";
@@ -49,7 +48,7 @@ describe('SDK-to-MockApp', function () {
     (<any>powerbi.wpmp).eventSourceOverrideWindow = iframe.contentWindow;
     // Register Iframe side
     let hpmPostSpy = spyOn(powerbi.hpm, "post").and.returnValue(Promise.resolve(<any>{}));
-    iframeHpm = setupEmbedMockApp(iframe.contentWindow, window, logMessages, 'SDK-to-MockApp IframeWpmp');
+    iframeHpm = setupEmbedMockApp(iframe.contentWindow, window, 'SDK-to-MockApp IframeWpmp');
 
     await new Promise<void>((resolve, _reject) => {
       iframe.addEventListener('load', () => {
@@ -542,7 +541,7 @@ describe('SDK-to-MockApp', function () {
         document.body.appendChild(element2);
         const report2 = <report.Report>powerbi.embed(element2, embedConfiguration);
         const iframe2 = element2.getElementsByTagName('iframe')[0];
-        setupEmbedMockApp(iframe2.contentWindow, window, logMessages, 'SDK-to-MockApp IframeWpmp2');
+        setupEmbedMockApp(iframe2.contentWindow, window, 'SDK-to-MockApp IframeWpmp2');
         await new Promise<void>((resolve, _reject) => {
           iframe2.addEventListener('load', () => {
             resolve(null);

test/constsants.ts

@@ -7,8 +7,6 @@ declare global {
   }
 }
 
-export const logMessages = (window.__karma__.config.args[0] === 'logMessages');
-
 export const iframeSrc = "base/test/utility/noop.html";
 window.onbeforeunload = null;
 

test/protocol.spec.ts

@@ -4,7 +4,7 @@ import { WindowPostMessageProxy } from 'window-post-message-proxy';
 import { HttpPostMessage } from 'http-post-message';
 import { spyApp, setupEmbedMockApp } from './utility/mockEmbed';
 import { hpmFactory, routerFactory, wpmpFactory } from '../src/factories';
-import { iframeSrc, logMessages } from './constsants';
+import { iframeSrc } from './constsants';
 import * as models from 'powerbi-models';
 
 describe('Protocol', function () {
@@ -27,10 +27,10 @@ describe('Protocol', function () {
     await new Promise(resolve => iframe.addEventListener('load', () => resolve(null)));
 
     // Register Iframe side
-    iframeHpm = setupEmbedMockApp(iframe.contentWindow, window, logMessages, 'ProtocolMockAppWpmp');
+    iframeHpm = setupEmbedMockApp(iframe.contentWindow, window, 'ProtocolMockAppWpmp');
 
     // Register SDK side WPMP
-    wpmp = wpmpFactory('HostProxyDefaultNoHandlers', logMessages, iframe.contentWindow);
+    wpmp = wpmpFactory('HostProxyDefaultNoHandlers',false, iframe.contentWindow);
     hpm = hpmFactory(wpmp, iframe.contentWindow, 'testVersion');
 
     const router = routerFactory(wpmp);

test/utility/mockEmbed.ts

@@ -9,7 +9,7 @@ import * as models from 'powerbi-models';
 
 export const spyApp = mockAppSpyObj;
 
-export function setupEmbedMockApp(iframeContentWindow: Window, parentWindow: Window, logMessages: boolean, name: string = 'MockAppWindowPostMessageProxy'): HttpPostMessage {
+export function setupEmbedMockApp(iframeContentWindow: Window, parentWindow: Window, name: string = 'MockAppWindowPostMessageProxy'): HttpPostMessage {
   const parent = parentWindow || iframeContentWindow.parent;
   const wpmp = new WindowPostMessageProxy({
     processTrackingProperties: {
@@ -19,7 +19,6 @@ export function setupEmbedMockApp(iframeContentWindow: Window, parentWindow: Win
     isErrorMessage: HttpPostMessage.isErrorMessage,
     receiveWindow: iframeContentWindow,
     name,
-    logMessages
   });
   const hpm = new HttpPostMessage(wpmp, {
     'origin': 'reportEmbedMock',