Skip to content

Commit

Permalink
make ftp and socks proxies optional
Browse files Browse the repository at this point in the history
  • Loading branch information
Li, George (gl741q) committed Jul 1, 2024
1 parent 3f2db60 commit 7252c1c
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 29 deletions.
32 changes: 30 additions & 2 deletions src/main/java/com/googlecode/jmeter/plugins/webdriver/config/WebDriverConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,10 @@ public abstract class WebDriverConfig<T extends WebDriver> extends ConfigTestEle
private static final String USE_HTTP_FOR_ALL_PROTOCOLS = "WebDriverConfig.use_http_for_all_protocols";
private static final String HTTPS_HOST = "WebDriverConfig.https_host";
private static final String HTTPS_PORT = "WebDriverConfig.https_port";
private static final String USE_FTP_PROXY = "WebDriverConfig.use_ftp_proxy";
private static final String FTP_HOST = "WebDriverConfig.ftp_host";
private static final String FTP_PORT = "WebDriverConfig.ftp_port";
private static final String USE_SOCKS_PROXY = "WebDriverConfig.use_socks_proxy";
private static final String SOCKS_HOST = "WebDriverConfig.socks_host";
private static final String SOCKS_PORT = "WebDriverConfig.socks_port";
private static final String NO_PROXY = "WebDriverConfig.no_proxy";
Expand Down Expand Up @@ -255,8 +257,18 @@ public Proxy createProxy() {
}
ProxyHostPort http = new ProxyHostPort(getHttpHost(), getHttpPort());
ProxyHostPort https = new ProxyHostPort(getHttpsHost(), getHttpsPort());
ProxyHostPort ftp = new ProxyHostPort(getFtpHost(), getFtpPort());
ProxyHostPort socks = new ProxyHostPort(getSocksHost(), getSocksPort());

ProxyHostPort ftp = null;
if (isUseFtpProxy()) {
ftp = new ProxyHostPort(getFtpHost(), getFtpPort());
}

ProxyHostPort socks = null;

if (isUseSocksProxy()) {
socks = new ProxyHostPort(getSocksHost(), getSocksPort());
}

return proxyFactory.getManualProxy(http, https, ftp, socks, getNoProxyHost());
default:
return proxyFactory.getSystemProxy();
Expand Down Expand Up @@ -587,6 +599,22 @@ public void setUseHttpSettingsForAllProtocols(boolean override) {
setProperty(USE_HTTP_FOR_ALL_PROTOCOLS, override);
}

public boolean isUseFtpProxy() {
return getPropertyAsBoolean(USE_FTP_PROXY, true);
}

public void setUseFtpProxy(boolean useFtpProxy) {
setProperty(USE_FTP_PROXY, useFtpProxy);
}

public boolean isUseSocksProxy() {
return getPropertyAsBoolean(USE_SOCKS_PROXY, true);
}

public void setUseSocksProxy(boolean useSocksProxy) {
setProperty(USE_SOCKS_PROXY, useSocksProxy);
}

public boolean isHeadless() {
return getPropertyAsBoolean(ENABLE_HEADLESS);
}
Expand Down
36 changes: 31 additions & 5 deletions src/main/java/com/googlecode/jmeter/plugins/webdriver/config/gui/WebDriverConfigGui.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ public abstract class WebDriverConfigGui extends AbstractConfigGui implements Fo
JFormattedTextField socksProxyPort;
JRadioButton systemProxy;
JCheckBox useHttpSettingsForAllProtocols;
JCheckBox useFtpProxy;
JCheckBox useSocksProxy;

JTextArea customCapabilitiesTextArea;

public static final String WIKIPAGE = "https://github.com/undera/jmeter-plugins-webdriver";
Expand Down Expand Up @@ -390,11 +393,24 @@ private void createManualProxy(JPanel panel, ButtonGroup group) {
httpsProxyPort.setText(String.valueOf(DEFAULT_PROXY_PORT));
manualPanel.add(createProxyHostAndPortPanel(httpsProxyHost, httpsProxyPort, "SSL Proxy:"));

useFtpProxy = new JCheckBox("Set the FTP proxy");
useFtpProxy.setSelected(true);
useFtpProxy.setEnabled(false);
useFtpProxy.addItemListener(this);
manualPanel.add(useFtpProxy);

ftpProxyHost = new JTextField();
ftpProxyPort = new JFormattedTextField(NUMBER_FORMAT);
ftpProxyPort.setText(String.valueOf(DEFAULT_PROXY_PORT));
manualPanel.add(createProxyHostAndPortPanel(ftpProxyHost, ftpProxyPort, "FTP Proxy:"));


useSocksProxy = new JCheckBox("Set the SOCKS proxy");
useSocksProxy.setSelected(true);
useSocksProxy.setEnabled(false);
useSocksProxy.addItemListener(this);
manualPanel.add(useSocksProxy);

socksProxyHost = new JTextField();
socksProxyPort = new JFormattedTextField(NUMBER_FORMAT);
socksProxyPort.setText(String.valueOf(DEFAULT_PROXY_PORT));
Expand Down Expand Up @@ -550,6 +566,8 @@ public void itemStateChanged(ItemEvent itemEvent) {
enableOtherProtocolsOnlyIfManualProxySelectedAndUseHttpSettingsIsNotSelected();
} else if (itemEvent.getSource() == useHttpSettingsForAllProtocols) {
enableOtherProtocolsOnlyIfManualProxySelectedAndUseHttpSettingsIsNotSelected();
} else if (itemEvent.getSource() == useFtpProxy || itemEvent.getSource() == useSocksProxy) {
enableOtherProtocolsOnlyIfManualProxySelectedAndUseHttpSettingsIsNotSelected();
} else if (itemEvent.getSource() == userAgentOverrideCheckbox) {
userAgentOverrideText.setEnabled(userAgentOverrideCheckbox.isSelected());
}
Expand All @@ -559,10 +577,12 @@ private void enableOtherProtocolsOnlyIfManualProxySelectedAndUseHttpSettingsIsNo
final boolean enabledState = !useHttpSettingsForAllProtocols.isSelected() && manualProxy.isSelected();
httpsProxyHost.setEnabled(enabledState);
httpsProxyPort.setEnabled(enabledState);
ftpProxyHost.setEnabled(enabledState);
ftpProxyPort.setEnabled(enabledState);
socksProxyHost.setEnabled(enabledState);
socksProxyPort.setEnabled(enabledState);
useFtpProxy.setEnabled(!useHttpSettingsForAllProtocols.isSelected());
ftpProxyHost.setEnabled(enabledState && useFtpProxy.isSelected());
ftpProxyPort.setEnabled(enabledState && useFtpProxy.isSelected());
useSocksProxy.setEnabled(!useHttpSettingsForAllProtocols.isSelected());
socksProxyHost.setEnabled(enabledState && useSocksProxy.isSelected());
socksProxyPort.setEnabled(enabledState && useSocksProxy.isSelected());
}

@Override
Expand Down Expand Up @@ -625,8 +645,10 @@ private void clearProxy() {
useHttpSettingsForAllProtocols.setSelected(true);
httpsProxyHost.setText("");
httpsProxyPort.setText(String.valueOf(DEFAULT_PROXY_PORT));
useFtpProxy.setSelected(true);
ftpProxyHost.setText("");
ftpProxyPort.setText(String.valueOf(DEFAULT_PROXY_PORT));
useSocksProxy.setSelected(true);
socksProxyHost.setText("");
socksProxyPort.setText(String.valueOf(DEFAULT_PROXY_PORT));
noProxyList.setText(DEFAULT_NO_PROXY_LIST);
Expand Down Expand Up @@ -668,7 +690,7 @@ public void configure(TestElement element) {
}

// Firefox configs
if ((browserName().equals("firefox")) || (browserName().equals("Remote"))) {
if ((browserName().equals("firefox")) || (browserName().equals("Remote"))) {
userAgentOverrideCheckbox.setSelected(webDriverConfig.isUserAgentOverridden());
userAgentOverrideText.setText(webDriverConfig.getUserAgentOverride());
userAgentOverrideText.setEnabled(webDriverConfig.isUserAgentOverridden());
Expand Down Expand Up @@ -720,8 +742,10 @@ private void configureProxy(WebDriverConfig<?> webDriverConfig) {
useHttpSettingsForAllProtocols.setSelected(webDriverConfig.isUseHttpSettingsForAllProtocols());
httpsProxyHost.setText(webDriverConfig.getHttpsHost());
httpsProxyPort.setText(String.valueOf(webDriverConfig.getHttpsPort()));
useFtpProxy.setSelected(webDriverConfig.isUseFtpProxy());
ftpProxyHost.setText(webDriverConfig.getFtpHost());
ftpProxyPort.setText(String.valueOf(webDriverConfig.getFtpPort()));
useSocksProxy.setSelected(webDriverConfig.isUseSocksProxy());
socksProxyHost.setText(webDriverConfig.getSocksHost());
socksProxyPort.setText(String.valueOf(webDriverConfig.getSocksPort()));
noProxyList.setText(webDriverConfig.getNoProxyHost());
Expand Down Expand Up @@ -806,8 +830,10 @@ private void modifyProxy(WebDriverConfig<?> webDriverConfig) {
webDriverConfig.setUseHttpSettingsForAllProtocols(useHttpSettingsForAllProtocols.isSelected());
webDriverConfig.setHttpsHost(httpsProxyHost.getText());
webDriverConfig.setHttpsPort(Integer.parseInt(httpsProxyPort.getText()));
webDriverConfig.setUseFtpProxy(useFtpProxy.isSelected());
webDriverConfig.setFtpHost(ftpProxyHost.getText());
webDriverConfig.setFtpPort(Integer.parseInt(ftpProxyPort.getText()));
webDriverConfig.setUseSocksProxy(useSocksProxy.isSelected());
webDriverConfig.setSocksHost(socksProxyHost.getText());
webDriverConfig.setSocksPort(Integer.parseInt(socksProxyPort.getText()));
webDriverConfig.setNoProxyHost(noProxyList.getText());
Expand Down
58 changes: 36 additions & 22 deletions src/main/java/com/googlecode/jmeter/plugins/webdriver/proxy/ProxyFactory.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,39 @@ public static ProxyFactory getInstance() {
return INSTANCE;
}

private ProxyFactory() {}
private ProxyFactory() {
}

/**
* This returns a {@link Proxy} with HTTP, HTTPS and FTP hosts and ports configured as specified.
* This returns a {@link Proxy} with HTTP, HTTPS and FTP hosts and ports
* configured as specified.
*
*
* @param httpProxy is the http proxy host and port
* @param httpProxy is the http proxy host and port
* @param httpsProxy is the https proxy host and port
* @param ftpProxy is the ftp proxy host and port
* @param ftpProxy is the ftp proxy host and port
* @param socksProxy is the socks proxy host and port
* @param noProxy is a comma separated list of hosts that will bypass the proxy
* @param noProxy is a comma separated list of hosts that will bypass the
* proxy
*
* @return a proxy object with the hosts manually specified.
*/
public Proxy getManualProxy(ProxyHostPort httpProxy, ProxyHostPort httpsProxy, ProxyHostPort ftpProxy, ProxyHostPort socksProxy, String noProxy) {
return new Proxy()
.setProxyType(Proxy.ProxyType.MANUAL)
.setHttpProxy(httpProxy.toUnifiedForm())
.setSslProxy(httpsProxy.toUnifiedForm())
.setFtpProxy(ftpProxy.toUnifiedForm())
.setSocksProxy(socksProxy.toUnifiedForm())
.setNoProxy(noProxy);
public Proxy getManualProxy(ProxyHostPort httpProxy, ProxyHostPort httpsProxy, ProxyHostPort ftpProxy,
ProxyHostPort socksProxy, String noProxy) {
Proxy proxy = new Proxy().setProxyType(Proxy.ProxyType.MANUAL).setNoProxy(noProxy);
if (httpProxy != null) {
proxy.setHttpProxy(httpProxy.toUnifiedForm());
}
if (httpsProxy != null) {
proxy.setSslProxy(httpsProxy.toUnifiedForm());
}
if (ftpProxy != null) {
proxy.setFtpProxy(ftpProxy.toUnifiedForm());
}
if (socksProxy != null) {
proxy.setSocksProxy(socksProxy.toUnifiedForm());
}
return proxy;
}

/**
Expand All @@ -43,31 +54,34 @@ public Proxy getManualProxy(ProxyHostPort httpProxy, ProxyHostPort httpsProxy, P
*/
public Proxy getDirectProxy() {
return new Proxy()
.setProxyType(Proxy.ProxyType.DIRECT);
.setProxyType(Proxy.ProxyType.DIRECT);
}

/**
* This is a proxy which will have its settings automatically configured.
*
* @return a proxy object which will try to automatically detect the proxy settings.
* @return a proxy object which will try to automatically detect the proxy
* settings.
*/
public Proxy getAutodetectProxy() {
return new Proxy()
.setProxyType(Proxy.ProxyType.AUTODETECT)
.setAutodetect(true);
.setProxyType(Proxy.ProxyType.AUTODETECT)
.setAutodetect(true);
}

/**
* If the proxy can be configured using a PAC file at a URL, set this value to the location of this PAC file.
* If the proxy can be configured using a PAC file at a URL, set this value to
* the location of this PAC file.
*
* @param pacUrl is the url to the Proxy PAC file
*
* @return a proxy object with its proxies configured automatically using a PAC file.
* @return a proxy object with its proxies configured automatically using a PAC
* file.
*/
public Proxy getConfigUrlProxy(String pacUrl) {
return new Proxy()
.setProxyType(Proxy.ProxyType.PAC)
.setProxyAutoconfigUrl(pacUrl);
.setProxyType(Proxy.ProxyType.PAC)
.setProxyAutoconfigUrl(pacUrl);
}

/**
Expand All @@ -77,6 +91,6 @@ public Proxy getConfigUrlProxy(String pacUrl) {
*/
public Proxy getSystemProxy() {
return new Proxy()
.setProxyType(Proxy.ProxyType.SYSTEM);
.setProxyType(Proxy.ProxyType.SYSTEM);
}
}

0 comments on commit 7252c1c

Please sign in to comment.