Refactor browser options #876

LaunchOptions struct serves also for browser options when using connect method, therefore it makes sense to rename it to a more generic naming that defines its purpose. Co-authored-by: ankur22 <ankur.agarwal@grafana.com>

A new env package is a better fit for the current implementation of IsRemoteBrowser than the k6ext package. In this new env package we can define a lookupper function type to be used across the rest of the codebase as a reference for environment variables lookup functions.

This will allow to have a common environment variable lookupper function definition across the codebase. Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>

This function allows to retrieve the scenario options associated with the given VU context. It is required in order to validate the browser options defined at the scenario.options.browser level.

Change its type from []any to []string to match the actual browser options struct. There is no need for it to be a slice of 'any'. Making it a string slice will also ease the set up as environment variable moving browser options to be parsed from ENV.

These methods are only used in the browser options parsing method, therefore, by now, it makes more sense to keep them in the same file instead than in a separate generic options implementation.

Avoid reading browser options defined at the JS layer for BrowserType.Launch and BrowserType.Connect methods. These options will be parsed from scenario options and environment variables.

This commit changes the way browser options are currently parsed in order to read them browser options field defined at the scenario level and also from environment variables.

The unit test should verify that any browser type set with a value different than 'chromium', currently the only supported browser type, returns an error. No browser type set also returns an error as this field is now mandatory.

This allows to define a default env.Lookupper function at the BrowserType level, which will be the one passed into browser options parsing function, and that can be overwritten from tests (e.g.: test browser) in order to be able to run tests that depend on environment browser options in parallel.

Because browser type option is now a mandatory field to be able to run k6 browser tests, we have to modify our mock VU implementation in order to add this field. This is done through the definition of a default scenario and a mock executor implementation for testing purposes.

Test browser had support for withContext option, which allowed to pass a custom context to test browser, which would be the one set as VU context. Usually this context was used in order to control from the test the cancellation of the test browser. The problem is that this context passed from the test implementation, was "divergent" from the test runtime context set up when calling setupHTTPTestModuleInstance() from test browser, which sets up all the VU related mock data, including the mandatory browser type field inside scenario options. Because this option is not mandatory, tests that were using a custom context were failing due to scenario options not being present in this context. This has been fixed by not allowing custom contexts to be set for test browser, and instead expose this component's context and context cancelling function so they can be handled from tests implementation. This commit also fixes the tests affected by this issue.

Based on #857, a decision was made to not expose slowMo browser option by now, and try to move it to the browser context level instead, which will provide more flexibility.

Modify JS examples removing browser options that now should be set as ENV variables and setting browser type option inside scenario options, which is now a mandatory field for any browser test. Also browser_args.js example is removed as it does not provide any value beyond showing how to set a browser arg in the previous implementation; and evaluate.js is modified in order to showcase 'evaluate' method functionality without requiring the usage of 'ignoreBrowserArgs' option.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor browser options #876

Refactor browser options #876

Commits on May 18, 2023