tests for app launching and appusermodelid

electron-userland · Feb 27, 2020 · 051288a · 051288a
1 parent 0704872
commit 051288a
Show file tree

Hide file tree

Showing 8 changed files with 165 additions and 13 deletions.
diff --git a/e2e/package-lock.json b/e2e/package-lock.json
diff --git a/e2e/package.json b/e2e/package.json
@@ -6,7 +6,7 @@
   "scripts": {
     "test": "npm run build && npm run e2e",
     "build": "tsc --pretty",
-    "e2e": "mocha lib/**/*.js --timeout 100000 --reporter spec",
+    "e2e": "mocha lib/**/*.js --timeout 30000 --reporter spec",
     "lint": "tslint -c tslint.json 'src/**/*.ts'"
   },
   "author": "Jan Hannemann",
@@ -29,11 +29,13 @@
     "@types/mocha": "^7.0.1",
     "@types/node": "^13.7.4",
     "@types/node-powershell": "^3.1.1",
+    "@types/ps-list": "^6.2.1",
     "@types/semver": "^6.2.0",
     "expect.js": "^0.3.1",
     "hasha": "^5.2.0",
     "mocha": "^7.0.1",
     "node-powershell": "^4.0.0",
+    "ps-list": "^7.0.0",
     "spawn-rx": "^3.0.0",
     "tslint": "^5.20.1"
   }

diff --git a/e2e/src/ambient.d.ts b/e2e/src/ambient.d.ts
diff --git a/e2e/src/e2e.ts b/e2e/src/e2e.ts
@@ -4,7 +4,9 @@ import hasha from 'hasha';
 import path from 'path';
 
 import { getWindowsCompliantVersion } from '../../lib/utils/version-util';
+import { getProcessPath, kill, launch, runs } from './utils/app-process';
 import { checkInstall, getInstallPaths, install, uninstall, uninstallViaPowershell } from './utils/installer';
+import { readAppUserModelId } from './utils/lnk-inspector';
 import { defaultOptions, HARNESS_APP_DIR, OUT_DIR, packageSampleApp } from './utils/packager';
 
 const msiPath = path.join(OUT_DIR, 'HelloWix.msi');
@@ -30,6 +32,7 @@ interface TestConfig {
   arch: 'x86' | 'x64';
   shortcutFolderName?: string;
   shortcutName?: string;
+  appUserModelId?: string;
 }
 
 describe('Electron WIX MSI', () => {
@@ -41,7 +44,7 @@ describe('Electron WIX MSI', () => {
 
   const tests: TestConfig[] = [
     {arch: 'x86'},
-    {arch: 'x86', shortcutFolderName: 'SuperWix', shortcutName: 'SuperHello'},
+    {arch: 'x86', shortcutFolderName: 'SuperWix', shortcutName: 'SuperHello', appUserModelId: 'com.wix.super.hello'},
     {arch: 'x64'},
   ];
 
@@ -59,7 +62,9 @@ describe('Electron WIX MSI', () => {
         configString += test.shortcutFolderName ? '\\' : '';
         configString += test.shortcutName || '';
       }
-      return configString;
+      configString +=  test.appUserModelId ? `|aumid:${test.appUserModelId}` : '';
+
+      return `(${configString})`;
     };
 
     describe(`Packaging ${getTestConfigString()}`, () =>  {
@@ -70,31 +75,65 @@ describe('Electron WIX MSI', () => {
     });
 
     describe(`Installing ${getTestConfigString()}`, () =>  {
+      before(async () => {
+        await kill(options.exe);
+      });
+      after(async () => {
+        await kill(options.exe);
+      });
+
+      const paths = getInstallPaths(options);
+
       it('installs', async () => {
         await install(msiPath);
         const version = getWindowsCompliantVersion(options.version);
         expect(await checkInstall(options.name, version)).ok();
       });
 
       it('has all files in program files', () => {
-        const paths = getInstallPaths(options);
-        console.log(paths);
         expect(fs.pathExistsSync(paths.stubExe)).ok();
         expectSameFolderContent(HARNESS_APP_DIR, paths.appFolder);
       });
 
       it('has shortcuts', () => {
-        const paths = getInstallPaths(options);
         expect(fs.pathExistsSync(paths.startMenuShortcut)).ok();
         expect(fs.pathExistsSync(paths.desktopShortcut)).ok();
       });
+
+      it('has AppUserModelId', async () => {
+        const aumid = await readAppUserModelId(paths.startMenuShortcut);
+        expect(aumid).to.be(paths.appUserModelId);
+      });
+
+      const entryPoints = [
+        { name: 'stubExe', path: paths.stubExe },
+        { name: 'start menu shortcut', path: paths.startMenuShortcut },
+        { name: 'desktop shortcut', path: paths.desktopShortcut },
+      ];
+
+      entryPoints.forEach((entryPoint) => {
+        it(`runs the correct binary via ${entryPoint.name}`, async () => {
+          await launch(paths.startMenuShortcut);
+          expect(await runs(options.exe)).ok();
+          expect(await getProcessPath(options.exe)).to.be(paths.appExe);
+          await kill(options.exe);
+         });
+      });
     });
 
+    const options124 = {
+      ...options,
+      version: '1.2.4'
+    };
     describe(`Updating ${getTestConfigString()}`, () =>  {
-      const options124 = {
-        ...options,
-        version: '1.2.4'
-      };
+      before(async () => {
+        await kill(options.exe);
+      });
+      after(async () => {
+        await kill(options.exe);
+      });
+
+      const paths = getInstallPaths(options124);
 
       it('updates', async () => {
         await packageSampleApp(options124);
@@ -104,22 +143,40 @@ describe('Electron WIX MSI', () => {
       });
 
       it('has all files in program files', () => {
-        const paths = getInstallPaths(options124);
         expect(fs.pathExistsSync(paths.stubExe)).ok();
         expectSameFolderContent(HARNESS_APP_DIR, paths.appFolder);
       });
 
       it('has shortcuts', () => {
-        const paths = getInstallPaths(options124);
         expect(fs.pathExistsSync(paths.startMenuShortcut)).ok();
         expect(fs.pathExistsSync(paths.desktopShortcut)).ok();
       });
+
+      const entryPoints = [
+        { name: 'stubExe', path: paths.stubExe },
+        { name: 'start menu shortcut', path: paths.startMenuShortcut },
+        { name: 'desktop shortcut', path: paths.desktopShortcut },
+      ];
+
+      entryPoints.forEach((entryPoint) => {
+        it(`runs the correct binary via ${entryPoint.name}`, async () => {
+          await launch(paths.startMenuShortcut);
+          expect(await runs(options.exe)).ok();
+          expect(await getProcessPath(options.exe)).to.be(paths.appExe);
+          await kill(options.exe);
+         });
+      });
     });
 
     describe(`Uninstalling ${getTestConfigString()}`, () =>  {
       it('uninstalls', async () => {
+        const paths = getInstallPaths(options124);
+
         await uninstall(msiPath);
         expect(await checkInstall(options.name)).not.ok();
+        expect(fs.pathExistsSync(paths.appRootFolder)).not.ok();
+        expect(fs.pathExistsSync(paths.startMenuShortcut)).not.ok();
+        expect(fs.pathExistsSync(paths.desktopShortcut)).not.ok();
       });
     });
   });

diff --git a/e2e/src/utils/app-process.ts b/e2e/src/utils/app-process.ts
@@ -0,0 +1,64 @@
+import Shell from 'node-powershell';
+
+export const launch = async (path: string) => {
+  const ps = new Shell({
+    executionPolicy: 'Bypass',
+    noProfile: true
+  });
+
+  try {
+    ps.addCommand(`try { Start-Process "${path}" -ErrorAction Stop } catch {}`);
+    await ps.invoke();
+  } finally {
+    ps.dispose();
+  }
+};
+
+export const runs = async (name: string) => {
+  const ps = new Shell({
+    executionPolicy: 'Bypass',
+    noProfile: true
+  });
+
+  let process: string;
+  try {
+    ps.addCommand(`Get-Process ${name.replace('.exe', '')} -ErrorAction SilentlyContinue`);
+    process = await ps.invoke();
+    process = process.replace(/(\r\n|\n|\r)/gm, '');
+  } finally {
+    ps.dispose();
+  }
+  return process !== '';
+};
+
+export const getProcessPath = async (name: string) => {
+  const ps = new Shell({
+    executionPolicy: 'Bypass',
+    noProfile: true
+  });
+
+  let processPath: string;
+  try {
+    ps.addCommand(`$p = Get-Process ${name.replace('.exe', '')} -ErrorAction SilentlyContinue | Select -First 1`);
+    ps.addCommand(`$p.Path`);
+    processPath = await ps.invoke();
+    processPath = processPath.replace(/(\r\n|\n|\r)/gm, '');
+  } finally {
+    ps.dispose();
+  }
+  return processPath;
+};
+
+export const kill = async (name: string) => {
+  const ps = new Shell({
+    executionPolicy: 'Bypass',
+    noProfile: true
+  });
+
+  try {
+    ps.addCommand(`Get-Process ${name.replace('.exe', '')} -ErrorAction SilentlyContinue | kill -ErrorAction SilentlyContinue`);
+    await ps.invoke();
+  } finally {
+    ps.dispose();
+  }
+};
diff --git a/e2e/src/utils/bin/Lnkspector.exe b/e2e/src/utils/bin/Lnkspector.exe
diff --git a/e2e/src/utils/installer.ts b/e2e/src/utils/installer.ts
@@ -7,9 +7,11 @@ import { MSICreatorOptions } from '../../../lib/index';
 export interface InstallPaths {
   appRootFolder: string;
   appFolder: string;
+  appExe: string;
   stubExe: string;
   startMenuShortcut: string;
   desktopShortcut: string;
+  appUserModelId: string;
 }
 
 export const install = async (msi: string) => {
@@ -61,12 +63,17 @@ export const checkInstall = async (name: string, version?: string) => {
 export const getInstallPaths = (options: MSICreatorOptions): InstallPaths => {
   const programFiles = options.arch === 'x64' || options.arch === 'ia64' ? process.env.ProgramFiles! : process.env['ProgramFiles(x86)']!;
   const appRootFolder = path.join(programFiles, options.name);
+
+  const shortName = options.shortName || options.name;
+  const appUserModelId = options.appUserModelId || `com.squirrel.${shortName}.${options.exe.replace(/\.exe$/, '')}`;
   return {
     appRootFolder,
     stubExe: path.join(appRootFolder, options.exe),
     appFolder: path.join(appRootFolder, `app-${options.version}`),
+    appExe: path.join(appRootFolder, `app-${options.version}`, options.exe),
     startMenuShortcut: path.join(process.env.ProgramData!, `Microsoft/Windows/Start Menu/Programs/${options.shortcutFolderName || options.manufacturer}/${options.shortcutName || options.name}.lnk`),
     desktopShortcut: path.join(process.env.Public!, `Desktop/${options.shortcutName || options.name}.lnk`),
+    appUserModelId,
   };
 };
 
diff --git a/e2e/src/utils/lnk-inspector.ts b/e2e/src/utils/lnk-inspector.ts
@@ -0,0 +1,8 @@
+import path from 'path';
+import { spawnPromise } from 'spawn-rx';
+
+export const readAppUserModelId = async (lnkPath: string) => {
+  const lnkspector = path.join(__dirname, '../../src/utils/bin/Lnkspector.exe');
+  const aumid = await spawnPromise(lnkspector, ['-aumid', lnkPath]);
+  return aumid.replace(/(\r\n|\n|\r)/gm, '');
+};