Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions DirectDriverConfig.wiki
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ This tab contains some custom options for each browser. Their names are meaningf
=== Chrome ===
In the Options tab of Chrome for instance, you can specify the location of a Chrome Binary in case you want to test a different version of Chrome from the standard one. Leave this field blank if you are happy to test the Chrome that is defined in your path variable.

There is also a 'Command line options' section, which lets you pass specific command line flags to the Chrome binary. These are mainly useful when running headless load tests in containers or on virtualized machines, and can remove the need to wrap the browser in a custom launcher script. The available flags are:

* 'Disable GPU' (--disable-gpu) - disables hardware GPU acceleration;
* 'Disable /dev/shm usage' (--disable-dev-shm-usage) - makes Chrome write its temporary files to /tmp instead of /dev/shm, avoiding out-of-memory crashes in containers with a small shared memory area;
* 'Disable extensions' (--disable-extensions) - prevents the loading of browser extensions;
* 'Disable background networking' (--disable-background-networking) - prevents background network activity, such as component updates;
* 'Disable metrics recording' (--metrics-recording-off) - disables metrics collection;
* 'Mute audio' (--mute-audio) - suppresses all audio output.

You can find more information on the Chrome options presented in this tab at [https://chromedriver.chromium.org/capabilities Capabilities & ChromeOptions].

=== Edge ===
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,13 @@ public abstract class WebDriverConfig<T extends WebDriver> extends ConfigTestEle
// Constants for Chrome
private static final String CHROME_ADDITIONAL_ARGS = "ChromeDriverConfig.additional_args";
private static final String CHROME_BINARY_PATH = "ChromeDriverConfig.binary_path";
private static final String CHROME_DISABLE_GPU = "ChromeDriverConfig.disable_gpu";
private static final String CHROME_DISABLE_DEV_SHM_USAGE = "ChromeDriverConfig.disable_dev_shm_usage";
private static final String CHROME_DISABLE_EXTENSIONS = "ChromeDriverConfig.disable_extensions";
private static final String CHROME_DISABLE_BACKGROUND_NETWORKING = "ChromeDriverConfig.disable_background_networking";
private static final String CHROME_METRICS_RECORDING_OFF = "ChromeDriverConfig.metrics_recording_off";
private static final String CHROME_MUTE_AUDIO = "ChromeDriverConfig.mute_audio";
private static final String CHROME_NO_SANDBOX = "ChromeDriverConfig.no_sandbox_enabled";

// Constants for Edge
private static final String EDGE_ADDITIONAL_ARGS = "EdgeDriverConfig.additional_args";
Expand Down Expand Up @@ -294,6 +301,27 @@ protected ChromeOptions createChromeOptions() {
if (isHeadless()) {
options.addArguments("--headless=new");
}
if (isDisableGpu()) {
options.addArguments("--disable-gpu");
}
if (isDisableDevShmUsage()) {
options.addArguments("--disable-dev-shm-usage");
}
if (isDisableExtensions()) {
options.addArguments("--disable-extensions");
}
if (isDisableBackgroundNetworking()) {
options.addArguments("--disable-background-networking");
}
if (isMetricsRecordingOff()) {
options.addArguments("--metrics-recording-off");
}
if (isMuteAudio()) {
options.addArguments("--mute-audio");
}
if (isNoSandboxEnabled()) {
options.addArguments("--no-sandbox");
}

String additionalArgs = trimmed(getChromeAdditionalArgs());
if (null != additionalArgs && !additionalArgs.isEmpty()) {
Expand Down Expand Up @@ -491,6 +519,55 @@ public void setChromeAdditionalArgs(String additionalArgs) {
setProperty(CHROME_ADDITIONAL_ARGS, additionalArgs);
}

public boolean isDisableGpu() {
return getPropertyAsBoolean(CHROME_DISABLE_GPU);
}
public void setDisableGpu(boolean state) {
setProperty(CHROME_DISABLE_GPU, state);
}

public boolean isDisableDevShmUsage() {
return getPropertyAsBoolean(CHROME_DISABLE_DEV_SHM_USAGE);
}
public void setDisableDevShmUsage(boolean state) {
setProperty(CHROME_DISABLE_DEV_SHM_USAGE, state);
}

public boolean isDisableExtensions() {
return getPropertyAsBoolean(CHROME_DISABLE_EXTENSIONS);
}
public void setDisableExtensions(boolean state) {
setProperty(CHROME_DISABLE_EXTENSIONS, state);
}

public boolean isDisableBackgroundNetworking() {
return getPropertyAsBoolean(CHROME_DISABLE_BACKGROUND_NETWORKING);
}
public void setDisableBackgroundNetworking(boolean state) {
setProperty(CHROME_DISABLE_BACKGROUND_NETWORKING, state);
}

public boolean isMetricsRecordingOff() {
return getPropertyAsBoolean(CHROME_METRICS_RECORDING_OFF);
}
public void setMetricsRecordingOff(boolean state) {
setProperty(CHROME_METRICS_RECORDING_OFF, state);
}

public boolean isMuteAudio() {
return getPropertyAsBoolean(CHROME_MUTE_AUDIO);
}
public void setMuteAudio(boolean state) {
setProperty(CHROME_MUTE_AUDIO, state);
}

public boolean isNoSandboxEnabled() {
return getPropertyAsBoolean(CHROME_NO_SANDBOX);
}
public void setNoSandboxEnabled(boolean state) {
setProperty(CHROME_NO_SANDBOX, state);
}

public String getEdgeAdditionalArgs() {
return getPropertyAsString(EDGE_ADDITIONAL_ARGS);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,13 @@ public abstract class WebDriverConfigGui extends AbstractConfigGui implements Fo
// Chrome variables
JTextField chromeAdditionalArgs;
JTextField chromeBinaryPath;
JCheckBox chromeDisableGpu;
JCheckBox chromeDisableDevShmUsage;
JCheckBox chromeDisableExtensions;
JCheckBox chromeDisableBackgroundNetworking;
JCheckBox chromeMetricsRecordingOff;
JCheckBox chromeMuteAudio;
JCheckBox chromeNoSandbox;

// Edge variables
JTextField edgeAdditionalArgs;
Expand Down Expand Up @@ -250,6 +257,24 @@ private JPanel crteChromeOptionsPanel() {
additionalArgsPanel.add(chromeAdditionalArgs);
browserPanel.add(additionalArgsPanel);

final JPanel commandLineOptionsPanel = new VerticalPanel();
commandLineOptionsPanel.setBorder(BorderFactory.createTitledBorder("Command line options"));
chromeDisableGpu = new JCheckBox("Disable GPU");
commandLineOptionsPanel.add(chromeDisableGpu);
chromeDisableDevShmUsage = new JCheckBox("Disable /dev/shm usage (useful when running in a container)");
commandLineOptionsPanel.add(chromeDisableDevShmUsage);
chromeDisableExtensions = new JCheckBox("Disable extensions");
commandLineOptionsPanel.add(chromeDisableExtensions);
chromeDisableBackgroundNetworking = new JCheckBox("Disable background networking");
commandLineOptionsPanel.add(chromeDisableBackgroundNetworking);
chromeMetricsRecordingOff = new JCheckBox("Disable metrics recording");
commandLineOptionsPanel.add(chromeMetricsRecordingOff);
chromeMuteAudio = new JCheckBox("Mute audio");
commandLineOptionsPanel.add(chromeMuteAudio);
chromeNoSandbox = new JCheckBox("Run in No sandbox mode");
commandLineOptionsPanel.add(chromeNoSandbox);
browserPanel.add(commandLineOptionsPanel);

return browserPanel;
}

Expand Down Expand Up @@ -608,6 +633,13 @@ public void clearGui() {
if ((browserName().equals("chrome")) || (browserName().equals("Remote"))) {
chromeAdditionalArgs.setText("");
chromeBinaryPath.setText("");
chromeDisableGpu.setSelected(false);
chromeDisableDevShmUsage.setSelected(false);
chromeDisableExtensions.setSelected(false);
chromeDisableBackgroundNetworking.setSelected(false);
chromeMetricsRecordingOff.setSelected(false);
chromeMuteAudio.setSelected(false);
chromeNoSandbox.setSelected(false);
}

if ((browserName().equals("edge")) || (browserName().equals("Remote"))) {
Expand Down Expand Up @@ -681,6 +713,13 @@ public void configure(TestElement element) {
if ((browserName().equals("chrome")) || (browserName().equals("Remote"))) {
chromeAdditionalArgs.setText(webDriverConfig.getChromeAdditionalArgs());
chromeBinaryPath.setText(webDriverConfig.getChromeBinaryPath());
chromeDisableGpu.setSelected(webDriverConfig.isDisableGpu());
chromeDisableDevShmUsage.setSelected(webDriverConfig.isDisableDevShmUsage());
chromeDisableExtensions.setSelected(webDriverConfig.isDisableExtensions());
chromeDisableBackgroundNetworking.setSelected(webDriverConfig.isDisableBackgroundNetworking());
chromeMetricsRecordingOff.setSelected(webDriverConfig.isMetricsRecordingOff());
chromeMuteAudio.setSelected(webDriverConfig.isMuteAudio());
chromeNoSandbox.setSelected(webDriverConfig.isNoSandboxEnabled());
}

// Edge configs
Expand Down Expand Up @@ -777,6 +816,13 @@ public void modifyTestElement(TestElement element) {
if ((browserName().equals("chrome")) || (browserName().equals("Remote"))) {
webDriverConfig.setChromeAdditionalArgs(chromeAdditionalArgs.getText());
webDriverConfig.setChromeBinaryPath(chromeBinaryPath.getText());
webDriverConfig.setDisableGpu(chromeDisableGpu.isSelected());
webDriverConfig.setDisableDevShmUsage(chromeDisableDevShmUsage.isSelected());
webDriverConfig.setDisableExtensions(chromeDisableExtensions.isSelected());
webDriverConfig.setDisableBackgroundNetworking(chromeDisableBackgroundNetworking.isSelected());
webDriverConfig.setMetricsRecordingOff(chromeMetricsRecordingOff.isSelected());
webDriverConfig.setMuteAudio(chromeMuteAudio.isSelected());
webDriverConfig.setNoSandboxEnabled(chromeNoSandbox.isSelected());
}

// Edge elements
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.googlecode.jmeter.plugins.webdriver.config;

import static org.hamcrest.CoreMatchers.hasItem;
import static org.hamcrest.CoreMatchers.not;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.core.Is.is;
Expand Down Expand Up @@ -235,4 +236,94 @@ public void getSetAdditionalArgs() {
config.setChromeAdditionalArgs("additional args");
assertThat(config.getChromeAdditionalArgs(), is("additional args"));
}

@Test
public void shouldAddSelectedCommandLineOptionsToChromeOptions() {
config.setDisableGpu(true);
config.setDisableDevShmUsage(true);
config.setDisableExtensions(true);
config.setDisableBackgroundNetworking(true);
config.setMetricsRecordingOff(true);
config.setMuteAudio(true);
config.setNoSandboxEnabled(true);
final ChromeOptions options = config.createChromeOptions();
@SuppressWarnings("unchecked")
Map<String,Object> capability = (Map<String,Object>) options.getCapability(ChromeOptions.CAPABILITY);
assertThat(capability, is(notNullValue()));
@SuppressWarnings("unchecked")
List<String> args = (List<String>) capability.get("args");
assertThat(args, hasItem("--disable-gpu"));
assertThat(args, hasItem("--disable-dev-shm-usage"));
assertThat(args, hasItem("--disable-extensions"));
assertThat(args, hasItem("--disable-background-networking"));
assertThat(args, hasItem("--metrics-recording-off"));
assertThat(args, hasItem("--mute-audio"));
assertThat(args, hasItem("--no-sandbox"));
}

@Test
public void shouldNotAddCommandLineOptionsWhenNotEnabled() {
final ChromeOptions options = config.createChromeOptions();
@SuppressWarnings("unchecked")
Map<String,Object> capability = (Map<String,Object>) options.getCapability(ChromeOptions.CAPABILITY);
assertThat(capability, is(notNullValue()));
@SuppressWarnings("unchecked")
List<String> args = (List<String>) capability.get("args");
assertThat(args, is(not(hasItem("--disable-gpu"))));
assertThat(args, is(not(hasItem("--disable-dev-shm-usage"))));
assertThat(args, is(not(hasItem("--disable-extensions"))));
assertThat(args, is(not(hasItem("--disable-background-networking"))));
assertThat(args, is(not(hasItem("--metrics-recording-off"))));
assertThat(args, is(not(hasItem("--mute-audio"))));
assertThat(args, is(not(hasItem("--no-sandbox"))));
}

@Test
public void getSetDisableGpu() {
assertThat(config.isDisableGpu(), is(false));
config.setDisableGpu(true);
assertThat(config.isDisableGpu(), is(true));
}

@Test
public void getSetDisableDevShmUsage() {
assertThat(config.isDisableDevShmUsage(), is(false));
config.setDisableDevShmUsage(true);
assertThat(config.isDisableDevShmUsage(), is(true));
}

@Test
public void getSetDisableExtensions() {
assertThat(config.isDisableExtensions(), is(false));
config.setDisableExtensions(true);
assertThat(config.isDisableExtensions(), is(true));
}

@Test
public void getSetDisableBackgroundNetworking() {
assertThat(config.isDisableBackgroundNetworking(), is(false));
config.setDisableBackgroundNetworking(true);
assertThat(config.isDisableBackgroundNetworking(), is(true));
}

@Test
public void getSetMetricsRecordingOff() {
assertThat(config.isMetricsRecordingOff(), is(false));
config.setMetricsRecordingOff(true);
assertThat(config.isMetricsRecordingOff(), is(true));
}

@Test
public void getSetMuteAudio() {
assertThat(config.isMuteAudio(), is(false));
config.setMuteAudio(true);
assertThat(config.isMuteAudio(), is(true));
}

@Test
public void getSetNoSandboxEnabled() {
assertThat(config.isNoSandboxEnabled(), is(false));
config.setNoSandboxEnabled(true);
assertThat(config.isNoSandboxEnabled(), is(true));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,55 @@ public void shouldSetAdditionalArgs() {
assertThat(testElement.getChromeAdditionalArgs(), is("additionalArgs"));
}

@Test
public void shouldSetCommandLineOptions() {
gui.chromeDisableGpu.setSelected(true);
gui.chromeDisableDevShmUsage.setSelected(true);
gui.chromeDisableExtensions.setSelected(true);
gui.chromeDisableBackgroundNetworking.setSelected(true);
gui.chromeMetricsRecordingOff.setSelected(true);
gui.chromeMuteAudio.setSelected(true);
gui.chromeNoSandbox.setSelected(true);

final ChromeDriverConfig testElement = (ChromeDriverConfig) gui.createTestElement();

assertThat(testElement.isDisableGpu(), is(true));
assertThat(testElement.isDisableDevShmUsage(), is(true));
assertThat(testElement.isDisableExtensions(), is(true));
assertThat(testElement.isDisableBackgroundNetworking(), is(true));
assertThat(testElement.isMetricsRecordingOff(), is(true));
assertThat(testElement.isMuteAudio(), is(true));
assertThat(testElement.isNoSandboxEnabled(), is(true));
}

@Test
public void shouldResetValuesOnClearGui() {
gui.driverPath.setText("path");
gui.chromeBinaryPath.setText("path/binary");
gui.headless.setSelected(true);
gui.acceptInsecureCerts.setSelected(true);
gui.chromeAdditionalArgs.setText("additional");
gui.chromeDisableGpu.setSelected(true);
gui.chromeDisableDevShmUsage.setSelected(true);
gui.chromeDisableExtensions.setSelected(true);
gui.chromeDisableBackgroundNetworking.setSelected(true);
gui.chromeMetricsRecordingOff.setSelected(true);
gui.chromeMuteAudio.setSelected(true);
gui.chromeNoSandbox.setSelected(true);

gui.clearGui();

assertThat(gui.driverPath.getText(), is("path to driver.exe of the relevant browser"));
assertThat(gui.headless.isSelected(), is(false));
assertThat(gui.acceptInsecureCerts.isSelected(), is(false));
assertThat(gui.chromeAdditionalArgs.getText(), is(""));
assertThat(gui.chromeDisableGpu.isSelected(), is(false));
assertThat(gui.chromeDisableDevShmUsage.isSelected(), is(false));
assertThat(gui.chromeDisableExtensions.isSelected(), is(false));
assertThat(gui.chromeDisableBackgroundNetworking.isSelected(), is(false));
assertThat(gui.chromeMetricsRecordingOff.isSelected(), is(false));
assertThat(gui.chromeMuteAudio.isSelected(), is(false));
assertThat(gui.chromeNoSandbox.isSelected(), is(false));
}

@Test
Expand Down Expand Up @@ -127,6 +162,27 @@ public void shouldSetInsecureCertsEnabledOnConfigure() {
assertThat(gui.acceptInsecureCerts.isSelected(), is(config.isAcceptInsecureCerts()));
}

@Test
public void shouldSetCommandLineOptionsOnConfigure() {
ChromeDriverConfig config = new ChromeDriverConfig();
config.setDisableGpu(true);
config.setDisableDevShmUsage(true);
config.setDisableExtensions(true);
config.setDisableBackgroundNetworking(true);
config.setMetricsRecordingOff(true);
config.setMuteAudio(true);
config.setNoSandboxEnabled(true);
gui.configure(config);

assertThat(gui.chromeDisableGpu.isSelected(), is(config.isDisableGpu()));
assertThat(gui.chromeDisableDevShmUsage.isSelected(), is(config.isDisableDevShmUsage()));
assertThat(gui.chromeDisableExtensions.isSelected(), is(config.isDisableExtensions()));
assertThat(gui.chromeDisableBackgroundNetworking.isSelected(), is(config.isDisableBackgroundNetworking()));
assertThat(gui.chromeMetricsRecordingOff.isSelected(), is(config.isMetricsRecordingOff()));
assertThat(gui.chromeMuteAudio.isSelected(), is(config.isMuteAudio()));
assertThat(gui.chromeNoSandbox.isSelected(), is(config.isNoSandboxEnabled()));
}

@Test
public void shouldEnableProxyAndBrowser() throws Exception {
assertThat(gui.isBrowser(), is(true));
Expand Down
Loading