feat: fix app package property tests

Author: jgresham

README.md

@@ -79,7 +79,7 @@ Unit tests with `npm run test`
 ### End-to-end (e2e) tests
 
 For e2e tests, we use webdriver and an electron plugin to automate testing.
-It requires a packaged build to complete the tests.
+**It requires a packaged build to run the tests!**
 
 To run them locally, package the source first (and after making any changes to anything other than `tests`), then run the e2e tests with `wdio`
 

package.json

@@ -22,7 +22,7 @@
     "prepare": "husky",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
-    "wdio": "cross-env NODE_ENV=test wdio run ./wdio.conf.ts",
+    "wdio": "wdio run ./wdio.conf.ts",
     "docs:nodeSpec": "typedoc --plugin typedoc-plugin-markdown --name \"Node Spec examples\" --readme src/common/index.md --entryDocument index.md --out docs src/common/*"
   },
   "devDependencies": {

src/main/files.ts

@@ -230,7 +230,7 @@ export const getAssetsFolder = (): string => {
     return path.resolve(__dirname, '..', '..', 'assets');
   }
 
-  if (process.env.NODE_ENV === 'test') {
+  if (process.env.TEST === 'true') {
     return 'assets';
   }
 

src/main/main.ts

@@ -41,11 +41,11 @@ if (process.env.NODE_ENV === 'development') {
 }
 
 // todo: when moving from require to imports
-// const isTest = process.env.NODE_ENV === 'test';
-// if (isTest) {
-//   console.log('NODE_ENV=TEST... requiring wdio-electron-service/main');
-//   require('wdio-electron-service/main');
-// }
+const isTest = process.env.TEST === 'true';
+if (isTest) {
+  logger.info('env.TEST=true... calling import(wdio-electron-service/main)');
+  import('wdio-electron-service/main');
+}
 
 // todo: Turned off when switching to ESM modules. Do we need this?
 // https://www.electronforge.io/config/makers/squirrel.windows#handling-startup-events
@@ -76,8 +76,6 @@ export const getMenuBuilder = () => menuBuilder;
 const isDevelopment =
   process.env.NODE_ENV === 'development' || process.env.DEBUG_PROD === 'true';
 
-const isTest = process.env.NODE_ENV === 'test';
-
 // if (isDevelopment) {
 //   require('electron-debug')();
 // }

src/main/preload.ts

@@ -10,12 +10,11 @@ import { CHANNELS_ARRAY } from './messenger';
 import type { AddNodePackageNodeService } from './nodePackageManager';
 import type { ThemeSetting } from './state/settings';
 
-// todo: when moving from require to imports
-// const isTest = process.env.NODE_ENV === 'test';
-// if (isTest) {
-//   console.log('NODE_ENV=TEST... requiring wdio-electron-service/main');
-//   require('wdio-electron-service/preload');
-// }
+const isTest = process.env.TEST === 'true';
+if (isTest) {
+  console.log('NODE_ENV=TEST... requiring wdio-electron-service/main');
+  import('wdio-electron-service/preload');
+}
 
 contextBridge.exposeInMainWorld('electron', {
   SENTRY_DSN: process.env.SENTRY_DSN,

test/specs/test.e2e.ts

@@ -1,6 +1,6 @@
 /* global $ */
 import { expect } from '@wdio/globals';
-// import { browser } from 'wdio-electron-service';
+import { browser } from 'wdio-electron-service';
 
 describe('Splash screen tests', () => {
   it('application should open to splash screen with welcome message', async () => {
@@ -15,12 +15,48 @@ describe('Splash screen tests', () => {
     await expect(elAddFirstNodeTitle).toBeDisplayed();
     await expect(elAddFirstNodeTitle).toHaveText('Add your first node');
   });
+});
+
+describe('App build property tests', () => {
+  // More Electron api test examples
+  // https://github.com/webdriverio-community/wdio-electron-service/blob/main/docs/electron-apis/mocking-apis.md
+  it('app name should be set', async () => {
+    expect(await browser.electron.execute((electron) => {
+      return electron.app.getName();
+    })).toEqual('NiceNode');
+  });
+
+  it('app version should be set and greater than 6.0.0', async () => {
+    expect(await browser.electron.execute((electron) => {
+      return electron.app.getVersion();
+    })).toBeDefined();
+    expect(await browser.electron.execute((electron) => {
+      return electron.app.getVersion();
+    }) > '6.0.0').toBeTruthy();
+  });
+
+  it('app menu should be contain NiceNode and Help', async () => {
+    const isNiceNodeMenuItemExists = await browser.electron.execute((electron) => {
+      // console.log('menu', electron.app.applicationMenu)
+      return electron.app.applicationMenu.items.some((item) => {
+        // console.log('item', item)
+        return item.label === 'NiceNode';
+      });
+    })
+    expect(isNiceNodeMenuItemExists).toBeTruthy();
+    const isHelpMenuItemExists = await browser.electron.execute((electron) => {
+      // console.log('menu', electron.app.applicationMenu)
+      return electron.app.applicationMenu.items.some((item) => {
+        // console.log('item', item)
+        return item.label === 'Help';
+      });
+    })
+    expect(isHelpMenuItemExists).toBeTruthy();
+  });
 
-  // todo: when moving from require to imports
-  // it('app name should be set', async () => {
-  //   await browser.electron.execute(async (electron) => {
-  //     const appName = await electron.app.getName();
-  //     await expect(appName).toEqual('NiceNode');
-  //   });
-  // });
+  it('logs dir path should contain logs', async () => {
+    expect(await browser.electron.execute((electron) => {
+      return electron.app.getPath('logs');
+    })).toContain('logs');
+  });
 });

wdio.conf.ts

@@ -15,6 +15,8 @@ if (process.platform === 'darwin') {
   appBinaryPath = path.join('out', `NiceNode-win32-${arch}`, 'nice-node.exe')
 }
 
+process.env.TEST = 'true';
+
 export const config: Options.Testrunner = {
   //
   // ====================
@@ -73,9 +75,9 @@ export const config: Options.Testrunner = {
       browserName: 'electron',
       // Electron service options
       // see https://webdriver.io/docs/wdio-electron-service/#configuration
-      'goog:chromeOptions': {
-        args:['--headless', '--disable-dev-shm-usage', '--no-sandbox', '--disable-gpu', '--window-size=1680,1050']
-      },
+      // 'goog:chromeOptions': {
+      //   args:['--headless', '--disable-dev-shm-usage', '--no-sandbox', '--disable-gpu', '--window-size=1680,1050']
+      // },
       'wdio:electronServiceOptions': {
         // custom application args
         // See https://github.com/webdriverio-community/wdio-electron-service#appargs