Merge pull request #234 from simonladen/FISH-8908-set-up-automated-tests

FISH-8908 - add e2e tests

Author: simonladen

Jenkinsfile

@@ -22,7 +22,7 @@ pipeline {
         stage('Install Dependencies') {
             steps {
                 // Install project dependencies 
-                sh 'curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -'
+                sh 'curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -'
                 sh 'sudo apt-get install -y nodejs'
                 sh 'sudo npm install -g yarn'
 

package.json

@@ -711,7 +711,7 @@
 		"compile": "tsc -p ./",
 		"watch": "tsc -watch -p ./",
 		"pretest": "yarn run compile",
-		"test": "node ./out/test/runTest.js",
+		"test:e2e": "playwright test -c src/test/e2e/playwright.config.ts",
 		"tslint": "tslint -t verbose src/**/*.ts"
 	},
 	"dependencies": {
@@ -733,17 +733,19 @@
 		"xml2js": "^0.6.0"
 	},
 	"devDependencies": {
+		"@playwright/test": "^1.47.2",
 		"@types/fs-extra": "^11.0.1",
 		"@types/glob": "^8.0.0",
 		"@types/lodash": "^4.14.155",
-		"@types/mocha": "^10.0.0",
+		"@types/mocha": "10.0.8",
 		"@types/node": "^22.5.4",
 		"@types/vscode": "^1.93.0",
+		"@vscode/test-electron": "2.4.1",
 		"glob": "^7.1.7",
-		"mocha": "^10.0.0",
+		"mocha": "10.7.3",
 		"os": "^0.1.1",
+		"playwright": "^1.47.2",
 		"tslint": "^6.1.0",
-		"typescript": "^5.0.3",
-		"vscode-test": "^1.2.2"
+		"typescript": "^5.0.3"
 	}
 }

src/test/e2e/README.md

@@ -0,0 +1,71 @@
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import type { Page } from '@playwright/test';
+import { _electron, test as base } from '@playwright/test';
+import { downloadAndUnzipVSCode } from '@vscode/test-electron/out/download';
+
+export { expect } from '@playwright/test';
+
+export type TestOptions = {
+	vscodeVersion: string;
+};
+
+type TestFixtures = TestOptions & {
+	page: Page;
+	createTmpDir: () => Promise<string>;
+};
+
+export const MaxTimeout = 10000;
+
+let testProjectPath: string;
+export const test = base.extend<TestFixtures>({
+	vscodeVersion: ['insiders', { option: true }],
+	page: async ({ vscodeVersion, createTmpDir }, use) => {
+		const defaultCachePath = await createTmpDir();
+		const vscodePath = await downloadAndUnzipVSCode(vscodeVersion);
+		testProjectPath = path.join(__dirname, '..', '..', '..');
+
+		const electronApp = await _electron.launch({
+			executablePath: vscodePath,
+			// Got it from https://github.com/gitkraken/vscode-gitlens/blob/main/tests/e2e/specs/baseTest.ts
+			args: [
+				'--no-sandbox', 
+				'--disable-gpu-sandbox', 
+				'--disable-updates', 
+				'--skip-welcome',
+				'--skip-release-notes',
+				'--disable-workspace-trust',
+				`--extensionDevelopmentPath=${path.join(__dirname, '..', '..', '..')}`,
+				`--extensions-dir=${path.join(defaultCachePath, 'extensions')}`,
+				`--user-data-dir=${path.join(defaultCachePath, 'user-data')}`,
+				testProjectPath,
+			],
+		});
+
+		const page = await electronApp.firstWindow();
+
+		await use(page);
+
+		await electronApp.close();
+
+		const logPath = path.join(defaultCachePath, 'user-data');
+		if (fs.existsSync(logPath)) {
+			const logOutputPath = test.info().outputPath('vscode-logs');
+			await fs.promises.cp(logPath, logOutputPath, { recursive: true });
+		}
+	},
+
+	// eslint-disable-next-line no-empty-pattern
+	createTmpDir: async ({}, use) => {
+		const tempDirs: string[] = [];
+		await use(async () => {
+			const tempDir = await fs.promises.realpath(await fs.promises.mkdtemp(path.join(os.tmpdir(), 'gltest-')));
+			tempDirs.push(tempDir);
+			return tempDir;
+		});
+		for (const tempDir of tempDirs) {
+			await fs.promises.rm(tempDir, { recursive: true });
+		}
+	},
+});

src/test/e2e/basePage.ts

@@ -0,0 +1,33 @@
+import { defineConfig } from '@playwright/test';
+import type { TestOptions } from './basePage.js';
+
+// eslint-disable-next-line import-x/no-default-export
+export default defineConfig<TestOptions>({
+	use: {
+		headless: true, // Ensure headless mode is enabled - Electron does not have a headless mode
+		viewport: { width: 1920, height: 1080 },
+	},
+	reporter: 'list', // process.env.CI ? 'html' : 'list',
+	timeout: 60000, // 1 minute
+	workers: 1,
+	expect: {
+		timeout: 60000, // 1 minute
+	},
+	globalSetup: './setup',
+	outputDir: '../../../out/test-results',
+	projects: [
+		{
+			name: 'VSCode stable',
+			use: {
+				vscodeVersion: 'stable',
+			},
+		},
+		{
+			name: 'VSCode insiders',
+			use: {
+				vscodeVersion: 'insiders',
+			},
+		},
+	],
+	testMatch: '**/*.test.ts'
+});

src/test/e2e/playwright.config.ts

@@ -0,0 +1,7 @@
+import { downloadAndUnzipVSCode } from '@vscode/test-electron';
+
+// eslint-disable-next-line import-x/no-default-export
+export default async () => {
+	await downloadAndUnzipVSCode('insiders');
+	await downloadAndUnzipVSCode('stable');
+};

src/test/e2e/setup.ts

@@ -0,0 +1,29 @@
+import { Page } from 'playwright/test';
+import { expect, test } from '../basePage.js';
+
+test.describe('Test Payara layout', () => {
+	test.beforeEach('Open Payara plugin', async ({page}) =>{
+		await page.getByRole('tab', { name: 'Payara' }).waitFor();
+		const payaraIcon = page.getByRole('tab', { name: 'Payara' });
+		await payaraIcon.click();
+	});
+
+	test('should contain Payara icon in activity bar', async ({page}) => {
+		await page.getByRole('tab', { name: 'Payara' }).waitFor();
+		const payaraIcon = page.getByRole('tab', { name: 'Payara' });
+		expect(payaraIcon).toHaveCount(1);
+	});
+
+	test('should contain Payara in the title', async ({page}) => {
+		await page.getByRole('heading', {name: 'PAYARA'}).waitFor();
+		const payaraTitle = page.getByRole('heading', {name: 'PAYARA'});
+		expect(payaraTitle).toHaveCount(1);
+	});
+
+	test('should have one section for Servers and one for Micro', async ({page}) => {
+		const payaraServerSection = page.getByRole('button', {name: 'Servers'});
+		const payaraMicroSection = page.getByRole('button', {name: 'Micro Instances'});
+		expect(payaraServerSection).toHaveCount(1);
+		expect(payaraMicroSection).toHaveCount(1);
+	});
+});

src/test/e2e/specs/payara_layout.test.ts

@@ -0,0 +1,16 @@
+{
+	"extends": "../../../tsconfig.json",
+	"compilerOptions": {
+		"target": "es2022",
+		"module": "node16",
+		"moduleResolution": "node16",
+		"strict": true,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": true,
+		"outDir": "./out",
+		"rootDir": ".",
+		"sourceMap": true
+	},
+	"include": ["**/*.ts"]
+}