add more enviroment variables for the Firefox profile used in tests

Author: hbenl

src/test/.env

@@ -1,7 +1,7 @@
 # this file defines environment variables used in tests
 
-# optional: set the Firefox executable and profile to be used in the tests
-# and whether the tests should run in headless mode
-# FIREFOX_EXECUTABLE=/usr/bin/firefox
-# FIREFOX_PROFILE=debug
+# FIREFOX_EXECUTABLE=developer
+# FIREFOX_PROFILE=test
+# FIREFOX_PROFILE_DIR=/tmp/firefox-test-profile
+# KEEP_PROFILE_CHANGES=true
 HEADLESS=true

src/test/testTerminateAndCleanup.ts

@@ -14,6 +14,11 @@ describe('Terminate and cleanup: The debugger', function() {
 
 	it('should eventually delete the temporary profile after terminating Firefox', async function() {
 
+		if (process.env['KEEP_PROFILE_CHANGES'] === 'true') {
+			this.skip();
+			return;
+		}
+
 		const tmpDir = path.join(os.tmpdir(), `vscode-firefox-debug-test-${uuid.v4()}`);
 		const dc = await util.initDebugClient(TESTDATA_PATH, true, { tmpDir });
 

src/test/util.ts

@@ -20,17 +20,7 @@ export async function initDebugClient(
 		file: path.join(testDataPath, 'web/index.html')
 	};
 
-	if (process.env['FIREFOX_EXECUTABLE']) {
-		launchArgs.firefoxExecutable = process.env['FIREFOX_EXECUTABLE'];
-	}
-
-	if (process.env['FIREFOX_PROFILE']) {
-		launchArgs.profile = process.env['FIREFOX_PROFILE'];
-	}
-
-	if (process.env['HEADLESS'] === "true") {
-		launchArgs.firefoxArgs = ["-headless"];
-	}
+	processEnvironmentVariables(launchArgs);
 
 	if (extraLaunchArgs !== undefined) {
 		launchArgs = Object.assign(launchArgs, extraLaunchArgs);
@@ -77,17 +67,7 @@ export async function initDebugClientForAddon(
 		dcArgs.file = path.join(testDataPath, `webExtension/index.html`);
 	}
 
-	if (process.env['FIREFOX_EXECUTABLE']) {
-		dcArgs.firefoxExecutable = process.env['FIREFOX_EXECUTABLE'];
-	}
-
-	if (process.env['FIREFOX_PROFILE']) {
-		dcArgs.profile = process.env['FIREFOX_PROFILE'];
-	}
-
-	if (process.env['HEADLESS'] === "true") {
-		dcArgs.firefoxArgs = ["-headless"];
-	}
+	processEnvironmentVariables(dcArgs);
 
 	let dc = new DebugClient('node', './dist/adapter.bundle.js', 'firefox');
 
@@ -113,6 +93,28 @@ export async function initDebugClientForAddon(
 	return dc;
 }
 
+function processEnvironmentVariables(launchArgs: LaunchConfiguration) {
+	if (process.env['FIREFOX_EXECUTABLE']) {
+		launchArgs.firefoxExecutable = process.env['FIREFOX_EXECUTABLE'];
+	}
+
+	if (process.env['FIREFOX_PROFILE']) {
+		launchArgs.profile = process.env['FIREFOX_PROFILE'];
+	}
+
+	if (process.env['FIREFOX_PROFILE_DIR']) {
+		launchArgs.profileDir = process.env['FIREFOX_PROFILE_DIR'];
+	}
+
+	if (process.env['KEEP_PROFILE_CHANGES'] === 'true') {
+		launchArgs.keepProfileChanges = true;
+	}
+
+	if (process.env['HEADLESS'] === 'true') {
+		launchArgs.firefoxArgs = ['-headless'];
+	}
+}
+
 async function waitForUnoccupiedPort(port: number, timeout: number) {
 	if (!await isPortOccupied(port)) {
 		return;