webdriverio-community / wdio-vscode-service

A service to test VSCode extensions from end to end using WebdriverIO

Home Page:https://webdriverio-community.github.io/wdio-vscode-service/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

A service failed in the 'onPrepare' hook

felixhaeberle opened this issue · comments

Hey there, I get the folllowing error when using this configuration:

Config

import type { Options } from "@wdio/types"
import url from "node:url"
import path from "node:path"

const debug = process.env.DEBUG
const __dirname = url.fileURLToPath(new URL(".", import.meta.url))

export const config: Options.Testrunner = {
	//
	// ====================
	// Runner Configuration
	// ====================
	// WebdriverIO supports running e2e tests as well as unit and component tests.
	runner: "local",
	autoCompileOpts: {
		autoCompile: true,
		tsNodeOpts: {
			project: "./test/tsconfig.json",
			transpileOnly: true,
		},
	},
	execArgv: debug ? ["--inspect"] : [],

	//
	// ==================
	// Specify Test Files
	// ==================
	// Define which test specs should run. The pattern is relative to the directory
	// of the configuration file being run.
	//
	// The specs are defined as an array of spec files (optionally using wildcards
	// that will be expanded). The test for each spec file will be run in a separate
	// worker process. In order to have a group of spec files run in the same worker
	// process simply enclose them in an array within the specs array.
	//
	// If you are calling `wdio` from an NPM script (see https://docs.npmjs.com/cli/run-script),
	// then the current working directory is where your `package.json` resides, so `wdio`
	// will be called from there.
	//
	specs: ["./specs/**/*.e2e.test.ts"],
	// Patterns to exclude.
	exclude: [
		// 'path/to/excluded/files'
	],
	//
	// ============
	// Capabilities
	// ============
	// Define your capabilities here. WebdriverIO can run multiple capabilities at the same
	// time. Depending on the number of capabilities, WebdriverIO launches several test
	// sessions. Within your capabilities you can overwrite the spec and exclude options in
	// order to group specific specs to a specific capability.
	//
	// First, you can define how many instances should be started at the same time. Let's
	// say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have
	// set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec
	// files and you set maxInstances to 10, all spec files will get tested at the same time
	// and 30 processes will get spawned. The property handles how many capabilities
	// from the same test should run tests.
	//
	maxInstances: debug ? 1 : 10,
	//
	// If you have trouble getting all important capabilities together, check out the
	// Sauce Labs platform configurator - a great tool to configure your capabilities:
	// https://saucelabs.com/platform/platform-configurator
	//
	capabilities: [
		{
			browserName: "vscode",
			browserVersion: "stable", // also possible: "insiders" or a specific version e.g. "1.80.0"
			"wdio:vscodeOptions": {
				verboseLogging: false,
				// points to directory where extension package.json is located
				extensionPath: path.join(__dirname, ".."),
				workspacePath: path.join(__dirname, "../../end-to-end-tests/inlang-nextjs"),
				// optional VS Code settings
				userSettings: {
					"editor.fontSize": 14,
				},
			},
		},
	],

	//
	// ===================
	// Test Configurations
	// ===================
	// Define all options that are relevant for the WebdriverIO instance here
	//
	// Level of logging verbosity: trace | debug | info | warn | error | silent
	logLevel: "warn",
	//
	// Set specific log levels per logger
	// loggers:
	// - webdriver, webdriverio
	// - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service
	// - @wdio/mocha-framework, @wdio/jasmine-framework
	// - @wdio/local-runner
	// - @wdio/sumologic-reporter
	// - @wdio/cli, @wdio/config, @wdio/utils
	// Level of logging verbosity: trace | debug | info | warn | error | silent
	// logLevels: {
	//     webdriver: 'info',
	//     '@wdio/appium-service': 'info'
	// },
	//
	// If you only want to run your tests until a specific amount of tests have failed use
	// bail (default is 0 - don't bail, run all tests).
	bail: 0,
	//
	// Set a base URL in order to shorten url command calls. If your `url` parameter starts
	// with `/`, the base url gets prepended, not including the path portion of your baseUrl.
	// If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
	// gets prepended directly.
	baseUrl: "",
	//
	// Default timeout for all waitFor* commands.
	waitforTimeout: 3000000,
	//
	// Default timeout in milliseconds for request
	// if browser driver or grid doesn't send response
	connectionRetryTimeout: 120000,
	//
	// Default request retries count
	connectionRetryCount: 3,
	//
	// Test runner services
	// Services take over a specific job you don't want to take care of. They enhance
	// your test setup with almost no effort. Unlike plugins, they don't add new
	// commands. Instead, they hook themselves up into the test process.
	services: ["vscode"],

	// Framework you want to run your specs with.
	// The following are supported: Mocha, Jasmine, and Cucumber
	// see also: https://webdriver.io/docs/frameworks
	//
	// Make sure you have the wdio adapter package for the specific framework installed
	// before running any tests.
	framework: "mocha",

	//
	// The number of times to retry the entire specfile when it fails as a whole
	// specFileRetries: 1,
	//
	// Delay in seconds between the spec file retry attempts
	// specFileRetriesDelay: 0,
	//
	// Whether or not retried spec files should be retried immediately or deferred to the end of the queue
	// specFileRetriesDeferred: false,
	//
	// Test reporter for stdout.
	// The only one supported by default is 'dot'
	// see also: https://webdriver.io/docs/dot-reporter
	reporters: ["spec"],

	// Options to be passed to Mocha.
	// See the full list at http://mochajs.org/
	mochaOpts: {
		ui: "bdd",
		timeout: debug ? 60 * 60 * 1000 : 50 * 60 * 1000,
	},

	//
	// =====
	// Hooks
	// =====
	// WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
	// it and to build services around it. You can either apply a single function or an array of
	// methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
	// resolved to continue.
	/**
	 * Gets executed once before all workers get launched.
	 * @param {object} config wdio configuration object
	 * @param {Array.<Object>} capabilities list of capabilities details
	 */
	// onPrepare: function (config, capabilities) {
	// },
	/**
	 * Gets executed before a worker process is spawned and can be used to initialize specific service
	 * for that worker as well as modify runtime environments in an async fashion.
	 * @param  {string} cid      capability id (e.g 0-0)
	 * @param  {object} caps     object containing capabilities for session that will be spawn in the worker
	 * @param  {object} specs    specs to be run in the worker process
	 * @param  {object} args     object that will be merged with the main configuration once worker is initialized
	 * @param  {object} execArgv list of string arguments passed to the worker process
	 */
	// onWorkerStart: function (cid, caps, specs, args, execArgv) {
	// },
	/**
	 * Gets executed just after a worker process has exited.
	 * @param  {string} cid      capability id (e.g 0-0)
	 * @param  {number} exitCode 0 - success, 1 - fail
	 * @param  {object} specs    specs to be run in the worker process
	 * @param  {number} retries  number of retries used
	 */
	// onWorkerEnd: function (cid, exitCode, specs, retries) {
	// },
	/**
	 * Gets executed just before initialising the webdriver session and test framework. It allows you
	 * to manipulate configurations depending on the capability or spec.
	 * @param {object} config wdio configuration object
	 * @param {Array.<Object>} capabilities list of capabilities details
	 * @param {Array.<String>} specs List of spec file paths that are to be run
	 * @param {string} cid worker id (e.g. 0-0)
	 */
	// beforeSession: function (config, capabilities, specs, cid) {
	// },
	/**
	 * Gets executed before test execution begins. At this point you can access to all global
	 * variables like `browser`. It is the perfect place to define custom commands.
	 * @param {Array.<Object>} capabilities list of capabilities details
	 * @param {Array.<String>} specs        List of spec file paths that are to be run
	 * @param {object}         browser      instance of created browser/device session
	 */
	// before: function (capabilities, specs) {
	// },
	/**
	 * Runs before a WebdriverIO command gets executed.
	 * @param {string} commandName hook command name
	 * @param {Array} args arguments that command would receive
	 */
	// beforeCommand: function (commandName, args) {
	// },
	/**
	 * Hook that gets executed before the suite starts
	 * @param {object} suite suite details
	 */
	// beforeSuite: function (suite) {
	// },
	/**
	 * Function to be executed before a test (in Mocha/Jasmine) starts.
	 */
	// beforeTest: function (test, context) {
	// },
	/**
	 * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling
	 * beforeEach in Mocha)
	 */
	// beforeHook: function (test, context, hookName) {
	// },
	/**
	 * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
	 * afterEach in Mocha)
	 */
	// afterHook: function (test, context, { error, result, duration, passed, retries }, hookName) {
	// },
	/**
	 * Function to be executed after a test (in Mocha/Jasmine only)
	 * @param {object}  test             test object
	 * @param {object}  context          scope object the test was executed with
	 * @param {Error}   result.error     error object in case the test fails, otherwise `undefined`
	 * @param {*}       result.result    return object of test function
	 * @param {number}  result.duration  duration of test
	 * @param {boolean} result.passed    true if test has passed, otherwise false
	 * @param {object}  result.retries   information about spec related retries, e.g. `{ attempts: 0, limit: 0 }`
	 */
	// afterTest: function(test, context, { error, result, duration, passed, retries }) {
	// },

	/**
	 * Hook that gets executed after the suite has ended
	 * @param {object} suite suite details
	 */
	// afterSuite: function (suite) {
	// },
	/**
	 * Runs after a WebdriverIO command gets executed
	 * @param {string} commandName hook command name
	 * @param {Array} args arguments that command would receive
	 * @param {number} result 0 - command success, 1 - command error
	 * @param {object} error error object if any
	 */
	// afterCommand: function (commandName, args, result, error) {
	// },
	/**
	 * Gets executed after all tests are done. You still have access to all global variables from
	 * the test.
	 * @param {number} result 0 - test pass, 1 - test fail
	 * @param {Array.<Object>} capabilities list of capabilities details
	 * @param {Array.<String>} specs List of spec file paths that ran
	 */
	// after: function (result, capabilities, specs) {
	// },
	/**
	 * Gets executed right after terminating the webdriver session.
	 * @param {object} config wdio configuration object
	 * @param {Array.<Object>} capabilities list of capabilities details
	 * @param {Array.<String>} specs List of spec file paths that ran
	 */
	// afterSession: function (config, capabilities, specs) {
	// },
	/**
	 * Gets executed after all workers got shut down and the process is about to exit. An error
	 * thrown in the onComplete hook will result in the test run failing.
	 * @param {object} exitCode 0 - success, 1 - fail
	 * @param {object} config wdio configuration object
	 * @param {Array.<Object>} capabilities list of capabilities details
	 * @param {<Object>} results object containing test results
	 */
	// onComplete: function(exitCode, config, capabilities, results) {
	// },
	/**
	 * Gets executed when a refresh happens.
	 * @param {string} oldSessionId session ID of the old session
	 * @param {string} newSessionId session ID of the new session
	 */
	// onReload: function(oldSessionId, newSessionId) {
	// }
	/**
	 * Hook that gets executed before a WebdriverIO assertion happens.
	 * @param {object} params information about the assertion to be executed
	 */
	// beforeAssertion: function(params) {
	// }
	/**
	 * Hook that gets executed after a WebdriverIO assertion happened.
	 * @param {object} params information about the assertion that was executed, including its results
	 */
	// afterAssertion: function(params) {
	// }
}

Error

Execution of 1 workers started at 2024-02-02T13:13:49.541Z
SevereServiceError in "onPrepare"
SevereServiceError: 
A service failed in the 'onPrepare' hook
SevereServiceError: Couldn't set up Chromedriver Response code 404 (Not Found)
    at VSCodeServiceLauncher._setupChromedriver (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/wdio-vscode-service@5.2.2_@wdio+types@8.24.12_chromedriver@119.0.1_webdriverio@8.29.0/node_modules/wdio-vscode-service/src/launcher.ts:235:19)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async VSCodeServiceLauncher._setupVSCodeDesktop (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/wdio-vscode-service@5.2.2_@wdio+types@8.24.12_chromedriver@119.0.1_webdriverio@8.29.0/node_modules/wdio-vscode-service/src/launcher.ts:191:72)
    at async VSCodeServiceLauncher.onPrepare (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/wdio-vscode-service@5.2.2_@wdio+types@8.24.12_chromedriver@119.0.1_webdriverio@8.29.0/node_modules/wdio-vscode-service/src/launcher.ts:107:17)
    at async file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/@wdio+cli@8.26.1_typescript@5.3.2/node_modules/@wdio/cli/build/utils.js:42:17
    at async Promise.all (index 0)
    at async Launcher.run (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/@wdio+cli@8.26.1_typescript@5.3.2/node_modules/@wdio/cli/build/launcher.js:98:13)



Stopping runner...
    at file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/@wdio+cli@8.26.1_typescript@5.3.2/node_modules/@wdio/cli/build/utils.js:58:35
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async Launcher.run (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/@wdio+cli@8.26.1_typescript@5.3.2/node_modules/@wdio/cli/build/launcher.js:98:13)
HookError [SevereServiceError]: 
A service failed in the 'onPrepare' hook
SevereServiceError: Couldn't set up Chromedriver Response code 404 (Not Found)
    at VSCodeServiceLauncher._setupChromedriver (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/wdio-vscode-service@5.2.2_@wdio+types@8.24.12_chromedriver@119.0.1_webdriverio@8.29.0/node_modules/wdio-vscode-service/src/launcher.ts:235:19)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async VSCodeServiceLauncher._setupVSCodeDesktop (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/wdio-vscode-service@5.2.2_@wdio+types@8.24.12_chromedriver@119.0.1_webdriverio@8.29.0/node_modules/wdio-vscode-service/src/launcher.ts:191:72)
    at async VSCodeServiceLauncher.onPrepare (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/wdio-vscode-service@5.2.2_@wdio+types@8.24.12_chromedriver@119.0.1_webdriverio@8.29.0/node_modules/wdio-vscode-service/src/launcher.ts:107:17)
    at async file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/@wdio+cli@8.26.1_typescript@5.3.2/node_modules/@wdio/cli/build/utils.js:42:17
    at async Promise.all (index 0)
    at async Launcher.run (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/@wdio+cli@8.26.1_typescript@5.3.2/node_modules/@wdio/cli/build/launcher.js:98:13)
Stopping runner...
    at file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/@wdio+cli@8.26.1_typescript@5.3.2/node_modules/@wdio/cli/build/utils.js:58:35
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async Launcher.run (file:///Users/felixhaberle/Desktop/git/monorepo/node_modules/.pnpm/@wdio+cli@8.26.1_typescript@5.3.2/node_modules/@wdio/cli/build/launcher.js:98:13) {
  origin: 'onPrepare'
}
 ELIFECYCLE  Command failed with exit code 1.

 ——————————————————————————————————————————————————————————————————————————————————————————————————————————————————

 >  NX   Ran target test:e2e for project vs-code-extension (7s)
 
    ✖    1/1 failed
    ✔    0/1 succeeded [0 read from cache]
 
   View structured, searchable error logs at https://cloud.nx.app/runs/E3KmKtVxkf

What is going wrong here? Thanks for the help!:)

This is related to #94

Is there a known workaround? This seems like a recent issue.

One workaround would be to revert the version of VS Code that you are testing against to 1.85.0 (or any recovery version from that month).

Try upgrading to v6.0.0 that was just released.

Closing this out.

@christian-bromann Thanks! This works again 🔥