Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Chrome for testing #369

Merged
merged 4 commits into from
Nov 23, 2023
Merged
Show file tree
Hide file tree
Changes from 2 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
7 changes: 5 additions & 2 deletions acceptance-tests/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,11 @@ jenkinsVersions
.withNormalizer(ClasspathNormalizer::class)

onlyIf {
// Do not run on Jenkins since acceptance tests don't work there for some reason, one of them:
// https://github.com/jenkinsci/acceptance-test-harness/issues/1170
//
// Do not run on Windows as written here: https://github.com/jenkinsci/acceptance-test-harness/blob/master/docs/EXTERNAL.md
!OperatingSystem.current().isWindows
!ciJenkinsBuild && !OperatingSystem.current().isWindows
}

javaLauncher.set(javaToolchains.launcherFor {
Expand All @@ -98,7 +101,7 @@ jenkinsVersions
mapOf(
"JENKINS_WAR" to downloadJenkinsTask.get().outputs.files.singleFile,
"LOCAL_JARS" to gradlePlugin.singleFile,
"BROWSER" to if (ciJenkinsBuild) "firefox-container" else "chrome"
"BROWSER" to "chrome"
)
)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@
import hudson.plugin.gradle.ath.updatecenter.VersionOverridesDecorator;
import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.jenkinsci.test.acceptance.guice.TestScope;
import org.jenkinsci.test.acceptance.update_center.UpdateCenterMetadata;
import org.jenkinsci.test.acceptance.update_center.UpdateCenterMetadataProvider;
import org.openqa.selenium.WebDriver;

import java.io.File;
import java.util.function.Consumer;
Expand All @@ -31,6 +33,7 @@ protected void configure() {
Matchers.returns(Matchers.subclassesOf(UpdateCenterMetadata.class)),
new ResultDecoratingAdapter<>(new VersionOverridesDecorator())
);
bind(WebDriver.class).toProvider(WebDriverProvider.class).in(TestScope.class);
}

private static class ResultDecoratingAdapter<T> implements MethodInterceptor {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
package hudson.plugin.gradle.ath.config;

import com.google.common.collect.ImmutableMap;
import com.google.inject.Inject;
import com.google.inject.Provider;
import org.jenkinsci.test.acceptance.FallbackConfig;
import org.jenkinsci.test.acceptance.guice.TestCleaner;
import org.jenkinsci.test.acceptance.guice.TestName;
import org.jenkinsci.test.acceptance.selenium.Scroller;
import org.jenkinsci.test.acceptance.utils.ElasticTime;
import org.junit.runners.model.Statement;
import org.openqa.selenium.Dimension;
import org.openqa.selenium.UnsupportedCommandException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.chrome.ChromeOptions;
import org.openqa.selenium.support.events.EventFiringWebDriver;

import java.io.IOException;
import java.time.Duration;
import java.util.Locale;
import java.util.logging.Logger;

class WebDriverProvider implements Provider<WebDriver> {

private static final Logger LOGGER = Logger.getLogger(FallbackConfig.class.getName());
private final TestCleaner testCleaner;
private final FallbackConfig fallbackConfig;
private final TestName testName;
private final ElasticTime time;

@Inject
public WebDriverProvider(
TestCleaner testCleaner,
FallbackConfig fallbackConfig,
TestName testName,
ElasticTime time) {
this.testCleaner = testCleaner;
this.fallbackConfig = fallbackConfig;
this.testName = testName;
this.time = time;
}

private String getBrowser() {
String browser = System.getenv("BROWSER");
if (browser == null) browser = "chrome-container";
browser = browser.toLowerCase(Locale.ENGLISH);
return browser;
}

@Override
public WebDriver get() {
if ("chrome".equals(getBrowser())) {
return createChromeWebDriver();
}
try {
return fallbackConfig.createWebDriver(testCleaner, testName, time);
} catch (IOException e) {
throw new RuntimeException(e);
}
}

private WebDriver createChromeWebDriver() {
ChromeOptions chromeOptions = new ChromeOptions();
chromeOptions.setBinary("/usr/bin/google-chrome-for-testing");

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using /usr/bin/google-chrome-for-testing would point you to the latest version and as soon as we would update this would conflict with your chromedriver version.

I would change this to: /opt/google/119.0.6045.105/chrome-linux64/chrome

zielezin@dev34:~$ /opt/google/119.0.6045.105/chrome-linux64/chrome --version
Google Chrome for Testing 119.0.6045.105

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So actually, after investigating, it turned out we can delegate all the driver plumbing to Selenium. It will try to find the specified Chrome version installed and if not found, download it. So my latest commit specifies the version to stable which should afaik try to find a stable Chrome installed, and if not present will download the latest stable.

chromeOptions.addArguments("--window-position=0,0");
chromeOptions.addArguments("--window-size=1280,720");
chromeOptions.addArguments("--lang=en_US");
chromeOptions.setExperimentalOption("prefs", ImmutableMap.of("intl.accept_languages", "en_US"));
ChromeDriver d = new ChromeDriver(chromeOptions);
Dimension oldSize = d.manage().window().getSize();
if (oldSize.height < 1050 || oldSize.width < 1680) {
d.manage().window().setSize(new Dimension(1680, 1050));
}
final EventFiringWebDriver driver = new EventFiringWebDriver(d);
driver.register(new Scroller());
try {
driver.manage().timeouts().pageLoadTimeout(Duration.ofMillis(time.seconds(FallbackConfig.PAGE_LOAD_TIMEOUT)));
driver.manage().timeouts().implicitlyWait(Duration.ofMillis(time.seconds(FallbackConfig.IMPLICIT_WAIT_TIMEOUT)));
} catch (UnsupportedCommandException e) {
// sauce labs RemoteWebDriver doesn't support this
LOGGER.info(d + " doesn't support page load timeout");
}
testCleaner.addTask(new Statement() {
@Override
public void evaluate() {
driver.quit();
}

@Override
public String toString() {
return "Close WebDriver after test";
}
});
return driver;
}
}
1 change: 1 addition & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ tasks.test {
maxRetries.set(2)
maxFailures.set(5)
}
failOnPassedAfterRetry.set(false)
}
useJUnitPlatform()
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import spock.lang.Unroll
@Subject(BuildScanLogScanner)
class BuildScanLogScannerTest extends Specification {

def 'properly captures build scan url given #log'(List<String> log, List<String> expectedUrls) {
def 'properly captures build scan url given #label'(String label, List<String> log, List<String> expectedUrls) {
given:
def listener = new SimpleBuildScanPublishedListener()
def scanner = new BuildScanLogScanner(listener)
Expand All @@ -20,12 +20,12 @@ class BuildScanLogScannerTest extends Specification {
listener.buildScans == expectedUrls

where:
log || expectedUrls
logWithBuildScans(["https://scans.gradle.com/s/bzb4vn64kx3bc"]) || ["https://scans.gradle.com/s/bzb4vn64kx3bc"]
logWithBuildScans(["https://scans.gradle.com/s/bzb4vn64kx3bc", "https://scans.gradle.com/s/asc9wm73ly1do"]) || ["https://scans.gradle.com/s/bzb4vn64kx3bc", "https://scans.gradle.com/s/asc9wm73ly1do"]
logWithBuildScans(["https://scans.gradle.com/bzb4vn64kx3bc"]) || []
logWithBuildScans(["https://scans.gradle.com/s/bzb4vn64kx3bc"], 1010) || []
logWithBuildScans(["https://scans.gradle.com/s/bzb4vn64kx3bc"], 900) || ["https://scans.gradle.com/s/bzb4vn64kx3bc"]
label | log || expectedUrls
'One build scan URL' | logWithBuildScans(["https://scans.gradle.com/s/bzb4vn64kx3bc"]) || ["https://scans.gradle.com/s/bzb4vn64kx3bc"]
'Two build scan URLs' | logWithBuildScans(["https://scans.gradle.com/s/bzb4vn64kx3bc", "https://scans.gradle.com/s/asc9wm73ly1do"]) || ["https://scans.gradle.com/s/bzb4vn64kx3bc", "https://scans.gradle.com/s/asc9wm73ly1do"]
'Non build scan URL' | logWithBuildScans(["https://scans.gradle.com/bzb4vn64kx3bc"]) || []
'Too many lines before build scan URL' | logWithBuildScans(["https://scans.gradle.com/s/bzb4vn64kx3bc"], 1010) || []
'Lot of lines before build scan URL' | logWithBuildScans(["https://scans.gradle.com/s/bzb4vn64kx3bc"], 900) || ["https://scans.gradle.com/s/bzb4vn64kx3bc"]
}

static List<String> logWithBuildScans(List<String> scanLinks, linesBetween = 10) {
Expand Down