Run CI tests on all OSes (#2)

* test on all common operating systems * fix test on Mac * use nodejs to link directory * add gitattributes file * fix test * tweak * tweak * tweak * tweak * tweak * tweak * check cachdir * execute script with node * tweak * deal with extension properly * return path * fix * fix test
webdriverio-community · Mar 24, 2022 · 8b2fef9 · 8b2fef9
1 parent 2561a79
commit 8b2fef9
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 29 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
diff --git a/.github/scripts/link.mjs b/.github/scripts/link.mjs
@@ -0,0 +1,21 @@
+import fs from 'fs/promises'
+import path from 'path'
+import url from 'url'
+
+console.log('Start linking wdio-vscode-service into node_modules');
+
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+const ROOT = path.join(__dirname, '..', '..')
+const LINKED_DIR = path.join(ROOT, 'node_modules', 'wdio-vscode-service')
+
+const relative = (from, to) => path.relative(
+    path.dirname(from),
+    path.resolve(to)
+)
+
+await fs.rm(LINKED_DIR, {
+    recursive: true
+}).catch((e) => console.warn(`Linked dir doesn't exists: ${e.message}`))
+
+await fs.symlink(relative(LINKED_DIR, ROOT), LINKED_DIR, 'dir')
+console.log('Successful linked package');
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,7 +10,10 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
 
     steps:
       - uses: actions/checkout@v2
@@ -22,10 +25,8 @@ jobs:
         run: yarn install --frozen-lockfile
       - name: Build
         run: yarn build
-      - name: Run Tests
-        run: |
-          sudo apt-get install xvfb
-          export DISPLAY=:99.0
-          Xvfb -ac :99 -screen 0 1920x1080x16 &
-          npm test
+      - name: 🧪 Run Tests
+        uses: GabrielBB/xvfb-action@v1
+        with:
+          run: yarn test
 
diff --git a/package.json b/package.json
@@ -22,7 +22,7 @@
     "release:minor": "npm run release -- minor",
     "release:major": "npm run release -- major",
     "test": "run-s test:*",
-    "test:setup": "cd node_modules && rm -rf ./wdio-vscode-service && ln -s ../ wdio-vscode-service && cd ..",
+    "test:setup": "node ./.github/scripts/link.mjs",
     "test:lint": "eslint src test example",
     "test:e2e": "run-s test:e2e:*",
     "test:e2e:run": "wdio run ./test/wdio.conf.ts",
@@ -43,7 +43,7 @@
     "download": "^8.0.0",
     "tmp-promise": "^3.0.3",
     "undici": "^4.15.1",
-    "wdio-chromedriver-service": "^7.3.1"
+    "wdio-chromedriver-service": "^7.3.2"
   },
   "peerDependencies": {
     "webdriverio": "^7.17.4"

diff --git a/src/launcher.ts b/src/launcher.ts
@@ -1,3 +1,4 @@
+import os from 'os'
 import fs from 'fs/promises'
 import path from 'path'
 import { format } from 'util'
@@ -50,7 +51,6 @@ export default class VSCodeServiceLauncher extends ChromedriverServiceLauncher {
         this._cachePath = this._options.cachePath || DEFAULT_CACHE_PATH
     }
 
-    // @ts-expect-error parent class has different structure
     async onPrepare (_: never, capabilities: ServiceCapabilities[]) {
         const version = this._options.vscode?.version || DEFAULT_CHANNEL
 
@@ -71,7 +71,6 @@ export default class VSCodeServiceLauncher extends ChromedriverServiceLauncher {
                     + `and Chromedriver v${content[version]?.chromedriver} already exist`
                 )
 
-                // @ts-expect-error `chromedriverCustomPath` is not defined in parent class
                 this.chromedriverCustomPath = chromedriverPath
                 this._populateCaps(capabilities, {
                     chromedriver: { version: content[version]!.chromedriver, path: chromedriverPath },
@@ -84,12 +83,8 @@ export default class VSCodeServiceLauncher extends ChromedriverServiceLauncher {
             }
         }
 
-        const [vscodeVersion, chromedriverVersion] = await this._setupChromedriver(version)
-        // @ts-expect-error `chromedriverCustomPath` is not defined
-        const chromedriverPath = this.chromedriverCustomPath = path.join(
-            this._cachePath,
-            `chromedriver-${chromedriverVersion}`
-        )
+        const [vscodeVersion, chromedriverVersion, chromedriverPath] = await this._setupChromedriver(version)
+        this.chromedriverCustomPath = chromedriverPath
         const serviceArgs: ServiceCapability = {
             chromedriver: { version: chromedriverVersion, path: chromedriverPath },
             vscode: { version: vscodeVersion, path: await this._setupVSCode(vscodeVersion) }
@@ -112,7 +107,7 @@ export default class VSCodeServiceLauncher extends ChromedriverServiceLauncher {
      *                              or a concrete version e.g. 1.66.0
      * @returns "insiders" if `desiredReleaseChannel` is set to this otherwise a concrete version
      */
-    private async _setupChromedriver (desiredReleaseChannel?: VSCodeChannel) {
+    private async _setupChromedriver (desiredReleaseChannel: VSCodeChannel) {
         const version = await this._fetchVSCodeVersion(desiredReleaseChannel)
 
         try {
@@ -125,15 +120,16 @@ export default class VSCodeServiceLauncher extends ChromedriverServiceLauncher {
                 { extract: true, strip: 1 }
             )
 
-            const chromedriverPath = path.join(this._cachePath, `chromedriver-${chromedriverVersion}`)
-            await fs.rename(path.join(this._cachePath, 'chromedriver'), chromedriverPath)
+            const ext = os.platform().startsWith('win') ? '.exe' : ''
+            const chromedriverPath = path.join(this._cachePath, `chromedriver-${chromedriverVersion}${ext}`)
+            await fs.rename(path.join(this._cachePath, `chromedriver${ext}`), chromedriverPath)
 
             /**
              * return 'insiders' if desired release channel
              */
             return version === 'main'
-                ? [desiredReleaseChannel!, chromedriverVersion]
-                : [version, chromedriverVersion]
+                ? [desiredReleaseChannel, chromedriverVersion, chromedriverPath]
+                : [version, chromedriverVersion, chromedriverPath]
         } catch (err: any) {
             throw new SevereServiceError(`Couldn't set up Chromedriver ${err.message}`)
         }

diff --git a/test/specs/basic.e2e.ts b/test/specs/basic.e2e.ts
@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference
 /// <reference path="../../dist/service.d.ts" />
 
-import { PluginDecorator, IPluginDecorator, BasePage } from 'wdio-vscode-service'
+import { PluginDecorator, IPluginDecorator, BasePage } from '../..'
 
 const locators = {
     marquee: {
@@ -35,7 +35,12 @@ describe('WDIO VSCode Service', () => {
 
     it('should be able to load VSCode', async () => {
         const workbench = await browser.getWorkbench()
-        expect(await workbench.getTitleBar().getTitle())
-            .toBe('[Extension Development Host] - README.md - wdio-vscode-service - Visual Studio Code')
+        const title = await workbench.getTitleBar().getTitle()
+
+        /**
+         * actual title is "[Extension Development Host] - README.md - wdio-vscode-service"
+         * but test fails on different operating systems due to different "-" chars
+         */
+        expect(title).toContain('wdio-vscode-service')
     })
 })
diff --git a/yarn.lock b/yarn.lock
@@ -5399,10 +5399,10 @@ wcwidth@^1.0.1:
   dependencies:
     defaults "^1.0.3"
 
-wdio-chromedriver-service@^7.3.1:
-  version "7.3.1"
-  resolved "https://registry.yarnpkg.com/wdio-chromedriver-service/-/wdio-chromedriver-service-7.3.1.tgz#f65fe6dadd55cb5caa925ef478767dea3c7683ba"
-  integrity sha512-0LnkUJW63WgKPZliH9ueluRuIBLaC8l8LcE1F3PSYy0ZbBJq/i3ObBJVVQBJlco3I2pjXuBCNJ/VyXUCCNflcA==
+wdio-chromedriver-service@^7.3.2:
+  version "7.3.2"
+  resolved "https://registry.yarnpkg.com/wdio-chromedriver-service/-/wdio-chromedriver-service-7.3.2.tgz#569053df4ceaf6ce9e43bebcdd540197f516e313"
+  integrity sha512-4M3OqFzBSC4FdbqkfwOrUMeroMEuyIFCHfcUebkU6tJ1w5GenWO61YweJ8NKlhPZx9nkO8223+20MpvBjv+fTg==
   dependencies:
     "@wdio/logger" "^7.5.3"
     fs-extra "^9.1.0"