Merging to pre-release (#328)

* Unify e2e tests into one file

* Switch test taskpane to use Office.onReady

* Log useragent

* Try switching order of tests

* Use different manifest for debugging test

* Disable IE webview test case

* Removing unneed protocol property (#325)

Removing unneeded property in launch.json. VScode complains it is not allowed and documentation also says it does not exist when the mode is attach.

* Making debugger hit and bind (#324)

Making breakpoints from the source code be hit again.
Fixes the problem where the debugger wouldn't be hit unless debugging directly.

This very probably wouldn't work on Mac, as it requires a direct reference to LocalAppData, which only exists in windows.

Pretty much we needed to directly reference the code that actually runs in the WEF cache.

Co-authored-by: Darren Miller <darrmill@microsoft.com>
Co-authored-by: Darren Miller <millerds@users.noreply.github.com>

Author: igor-ribeiiro

.azure-devops/full-pipeline.yml

@@ -29,18 +29,19 @@ jobs:
         parameters:
           webView: "edge-legacy"
 
-  - job: WebView_IE
-    pool:
-      name: OE-OfficeClientApps
-    steps:
-      - template: ./install.yml
-      - template: ./lint.yml
-      - template: ./build.yml
-      - template: ./devcerts.yml
-      - template: ./edgewebview.yml
-      - template: ./test.yml
-        parameters:
-          webView: "ie"
+  # Need to determin why the IE test doesn't pass in the lab
+  # - job: WebView_IE
+  #   pool:
+  #     name: OE-OfficeClientApps
+  #   steps:
+  #     - template: ./install.yml
+  #     - template: ./lint.yml
+  #     - template: ./build.yml
+  #     - template: ./devcerts.yml
+  #     - template: ./edgewebview.yml
+  #     - template: ./test.yml
+  #       parameters:
+  #         webView: "ie"
 
   - job: Mac
     pool:

.vscode/launch.json

@@ -51,10 +51,10 @@
       "type": "node",
       "request": "attach",
       "port": 9229,
-      "protocol": "inspector",
       "timeout": 600000,
       "preLaunchTask": "Debug: Excel Desktop",
-      "postDebugTask": "Stop Debug"
+      "postDebugTask": "Stop Debug",
+      "resolveSourceMapLocations": null
     },
     {
       "name": "Excel Desktop (Edge Chromium)",

package.json

@@ -23,7 +23,7 @@
     "start:web": "office-addin-debugging start manifest.xml web",
     "stop": "office-addin-debugging stop manifest.xml",
     "test": "npm run test:unit && npm run test:e2e",
-    "test:e2e": "mocha -r ts-node/register test/end-to-end/*.ts",
+    "test:e2e": "mocha -r ts-node/register test/end-to-end/tests.ts",
     "test:unit": "mocha -r ts-node/register test/unit/*.test.ts",
     "validate": "office-addin-manifest validate manifest.xml",
     "watch": "webpack --mode development --watch"

test/end-to-end/debugging-test.ts

@@ -2,23 +2,24 @@ import * as functionsJsonData from "./test-data.json";
 import { pingTestServer, sendTestResults } from "office-addin-test-helpers";
 import { closeWorkbook, sleep } from "./test-helpers";
 
-/* global Office, document, Excel, run */
+/* global Office, document, Excel, run, navigator */
 const customFunctionsData = (<any>functionsJsonData).functions;
 const port: number = 4201;
 let testValues = [];
 
-Office.initialize = async () => {
+Office.onReady(async () => {
   document.getElementById("sideload-msg").style.display = "none";
   document.getElementById("app-body").style.display = "flex";
   document.getElementById("run").onclick = run;
+  addTestResult("UserAgent", navigator.userAgent);
 
   const testServerResponse: object = await pingTestServer(port);
   if (testServerResponse["status"] === 200) {
     await runCfTests();
     await sendTestResults(testValues, port);
     await closeWorkbook();
   }
-};
+});
 
 async function runCfTests(): Promise<void> {
   // Exercise custom functions

test/end-to-end/src/test-taskpane.ts

@@ -0,0 +1,141 @@
+import * as assert from "assert";
+import * as fs from "fs";
+import { parseNumber } from "office-addin-cli";
+import { AppType, startDebugging, stopDebugging } from "office-addin-debugging";
+import { toOfficeApp } from "office-addin-manifest";
+import { pingTestServer } from "office-addin-test-helpers";
+import { closeDesktopApplication } from "./src/test-helpers";
+import { connectToWebsocket, enableDebugging, pauseDebugging } from "./src/debugger-websocket";
+import * as officeAddinTestServer from "office-addin-test-server";
+import * as path from "path";
+
+/* global process, describe, before, it, after, console */
+const host: string = "excel";
+const manifestPath = path.resolve(`${process.cwd()}/test/end-to-end/test-manifest.xml`);
+const manifestPathDebugging = path.resolve(`${process.cwd()}/test/end-to-end/test-manifest-debugging.xml`);
+const port: number = 4201;
+const testDataFile: string = `${process.cwd()}/test/end-to-end/src/test-data.json`;
+const testJsonData = JSON.parse(fs.readFileSync(testDataFile).toString());
+const testServer = new officeAddinTestServer.TestServer(port);
+let testValues: any = [];
+
+describe("Test Excel Custom Functions", function () {
+  describe("UI Tests", function () {
+    before(`Setup test environment and sideload ${host}`, async function () {
+      this.timeout(0);
+      // Start test server and ping to ensure it's started
+      const testServerStarted = await testServer.startTestServer(true /* mochaTest */);
+      const serverResponse = await pingTestServer(port);
+      assert.strictEqual(serverResponse["status"], 200);
+      assert.strictEqual(testServerStarted, true);
+
+      // Call startDebugging to start dev-server and sideload
+      const devServerCmd = `npm run dev-server -- --config ./test/end-to-end/webpack.config.js`;
+      const devServerPort = parseNumber(process.env.npm_package_config_dev_server_port || 3000);
+      const options = {
+        appType: AppType.Desktop,
+        app: toOfficeApp(host),
+        devServerCommandLine: devServerCmd,
+        devServerPort: devServerPort,
+        enableDebugging: false,
+      };
+      await startDebugging(manifestPath, options);
+    });
+    describe("Get test results for custom functions and validate results", function () {
+      it("should get results from the taskpane application", async function () {
+        this.timeout(0);
+        // Expecting six result values + user agent
+        testValues = await testServer.getTestResults();
+        console.log(`User Agent: ${testValues[0].Value}`);
+        assert.strictEqual(testValues.length, 7);
+      });
+      it("ADD function should return expected value", async function () {
+        assert.strictEqual(testJsonData.functions.ADD.result, testValues[1].Value);
+      });
+      it("CLOCK function should return expected value", async function () {
+        // Check that captured values are different to ensure the function is streaming
+        assert.notStrictEqual(testValues[2].Value, testValues[3].Value);
+        // Check if the returned string contains 'AM', 'PM', or 'GMT', indicating it's a time-stamp
+        assert.strictEqual(
+          testValues[2].Value.includes(testJsonData.functions.CLOCK.result.amString) ||
+          testValues[2].Value.includes(testJsonData.functions.CLOCK.result.pmString) ||
+          testValues[2].Value.includes(testJsonData.functions.CLOCK.result.timeZoneString),
+          true,
+          "Found timestamp indicator string in first value '" + testValues[2].Value + "'"
+        );
+        assert.strictEqual(
+          testValues[3].Value.includes(testJsonData.functions.CLOCK.result.amString) ||
+          testValues[3].Value.includes(testJsonData.functions.CLOCK.result.pmString) ||
+          testValues[3].Value.includes(testJsonData.functions.CLOCK.result.timeZoneString),
+          true,
+          "Found timestamp indicator string in second value '" + testValues[3].Value + "'"
+        );
+      });
+      it("INCREMENT function should return expected value", async function () {
+        // Check that captured values are different to ensure the function is streaming
+        assert.notStrictEqual(testValues[3].Value, testValues[4].Value);
+        // Check to see that both captured streaming values are divisible by 4
+        assert.strictEqual(0, testValues[4].Value % testJsonData.functions.INCREMENT.result);
+        assert.strictEqual(0, testValues[5].Value % testJsonData.functions.INCREMENT.result);
+      });
+      it("LOG function should return expected value", async function () {
+        assert.strictEqual(testJsonData.functions.LOG.result, testValues[6].Value);
+      });
+    });
+    after("Teardown test environment", async function () {
+      this.timeout(0);
+      // Stop the test server
+      const stopTestServer = await testServer.stopTestServer();
+      assert.strictEqual(stopTestServer, true);
+
+      // Close excel
+      const applicationClosed = await closeDesktopApplication();
+      assert.strictEqual(applicationClosed, true);
+
+      // Unregister the add-in
+      await stopDebugging(manifestPath);
+    });
+  });
+  describe("Debugger Tests", function () {
+    before(`Setup test environment and sideload ${host}`, async function () {
+      this.timeout(0);
+      // Call startDebugging to start dev-server and sideload
+      const devServerCmd: string = `npm run dev-server -- --config ./test/end-to-end/webpack.config.js --env testType=debugger`;
+      const devServerPort: number = 3001;
+      const options = {
+        appType: AppType.Desktop,
+        app: toOfficeApp(host),
+        devServerCommandLine: devServerCmd,
+        devServerPort: devServerPort,
+        enableDebugging: true,
+      };
+      await startDebugging(manifestPathDebugging, options);
+    });
+    describe("Test Debugger", function () {
+      let ws: WebSocket;
+      before("Open websocket connection to Debugger", async function () {
+        this.timeout(60 * 1000);
+        ws = await connectToWebsocket();
+        assert.notStrictEqual(ws, undefined, "Unable to connect to the websocket.");
+      });
+      it("enable debugging", async function () {
+        await enableDebugging(ws);
+      });
+      it("pause debugging", async function () {
+        await pauseDebugging(ws);
+      });
+      after("Close websocket connection", async function () {
+        ws.close();
+      });
+    });
+    after("Teardown test environment", async function () {
+      this.timeout(0);
+      // Close excel
+      const applicationClosed = await closeDesktopApplication();
+      assert.strictEqual(applicationClosed, true);
+
+      // Unregister the add-in
+      await stopDebugging(manifestPathDebugging);
+    });
+  });
+});