You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by jk...@apache.org on 2015/08/03 11:20:18 UTC
tapestry-5 git commit: jist testing: provide our own version of
org.openqa.selenium.server.browserlaunchers.FirefoxChromeLauncher with
https://github.com/SeleniumHQ/selenium/commit/5331865dcaf4273d4b2ba9a3bbd5e37c845dccef
cherry-picked
Repository: tapestry-5
Updated Branches:
refs/heads/master 13f4070ea -> 20b2c26f7
jist testing: provide our own version of org.openqa.selenium.server.browserlaunchers.FirefoxChromeLauncher with https://github.com/SeleniumHQ/selenium/commit/5331865dcaf4273d4b2ba9a3bbd5e37c845dccef cherry-picked
Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo
Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/20b2c26f
Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/20b2c26f
Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/20b2c26f
Branch: refs/heads/master
Commit: 20b2c26f75dcbbb99a0ae7ac9e60f8ce6d47198b
Parents: 13f4070
Author: Jochen Kemnade <jo...@eddyson.de>
Authored: Mon Aug 3 11:18:05 2015 +0200
Committer: Jochen Kemnade <jo...@eddyson.de>
Committed: Mon Aug 3 11:18:05 2015 +0200
----------------------------------------------------------------------
.../browserlaunchers/FirefoxChromeLauncher.java | 347 +++++++++++++++++++
1 file changed, 347 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/20b2c26f/tapestry-test/src/main/java/org/openqa/selenium/server/browserlaunchers/FirefoxChromeLauncher.java
----------------------------------------------------------------------
diff --git a/tapestry-test/src/main/java/org/openqa/selenium/server/browserlaunchers/FirefoxChromeLauncher.java b/tapestry-test/src/main/java/org/openqa/selenium/server/browserlaunchers/FirefoxChromeLauncher.java
new file mode 100644
index 0000000..36ae0b9
--- /dev/null
+++ b/tapestry-test/src/main/java/org/openqa/selenium/server/browserlaunchers/FirefoxChromeLauncher.java
@@ -0,0 +1,347 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.openqa.selenium.server.browserlaunchers;
+
+
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.Platform;
+import org.openqa.selenium.browserlaunchers.locators.BrowserInstallation;
+import org.openqa.selenium.browserlaunchers.locators.FirefoxLocator;
+import org.openqa.selenium.os.CommandLine;
+import org.openqa.selenium.remote.BrowserType;
+import org.openqa.selenium.server.ApplicationRegistry;
+import org.openqa.selenium.server.RemoteControlConfiguration;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.logging.Logger;
+
+public class FirefoxChromeLauncher extends AbstractBrowserLauncher {
+ private static final Logger log = Logger.getLogger(FirefoxChromeLauncher.class.getName());
+
+ private File customProfileDir = null;
+ private boolean closed = false;
+ private BrowserInstallation browserInstallation;
+ private CommandLine process = null;
+
+ private boolean changeMaxConnections = false;
+
+ public FirefoxChromeLauncher(Capabilities browserOptions,
+ RemoteControlConfiguration configuration, String sessionId, String browserString)
+ throws InvalidBrowserExecutableException {
+ this(browserOptions, configuration,
+ sessionId, ApplicationRegistry.instance()
+ .browserInstallationCache().locateBrowserInstallation(
+ BrowserType.CHROME, browserString, new FirefoxLocator()));
+ if (browserInstallation == null) {
+ throw new InvalidBrowserExecutableException(
+ "The specified path to the browser executable is invalid.");
+ }
+ }
+
+ public FirefoxChromeLauncher(Capabilities browserOptions,
+ RemoteControlConfiguration configuration, String sessionId,
+ BrowserInstallation browserInstallation) {
+ super(sessionId, configuration, browserOptions);
+
+ if (browserInstallation == null) {
+ throw new InvalidBrowserExecutableException(
+ "The specified path to the browser executable is invalid.");
+ }
+ this.browserInstallation = browserInstallation;
+ }
+
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.openqa.selenium.server.browserlaunchers.AbstractBrowserLauncher#launch(java.lang.String)
+ */
+
+ @Override
+ protected void launch(String url) {
+ final String profilePath;
+ final String homePage;
+
+ try {
+ homePage = new ChromeUrlConvert().convert(url);
+ profilePath = makeCustomProfile(homePage);
+ populateCustomProfileDirectory(profilePath);
+
+ log.info("Launching Firefox...");
+ process = prepareCommand(
+ browserInstallation.launcherFilePath(),
+ "-profile",
+ profilePath
+ );
+ process.setEnvironmentVariable("NO_EM_RESTART", "1");
+ process.executeAsync();
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ private void populateCustomProfileDirectory(String profilePath) {
+ /*
+ * The first time we launch Firefox with an empty profile directory, Firefox will launch itself,
+ * populate the profile directory, then kill/relaunch itself, so our process handle goes out of
+ * date. So, the first time we launch Firefox, we'll start it up at an URL that will immediately
+ * shut itself down.
+ */
+ CommandLine command = prepareCommand(browserInstallation.launcherFilePath(),
+ "-profile", profilePath
+ );
+ command.setDynamicLibraryPath(browserInstallation.libraryPath());
+ log.info("Preparing Firefox profile...");
+ command.execute();
+ try {
+ waitForFullProfileToBeCreated(20 * 1000);
+ } catch (RuntimeException e) {
+ command.destroy();
+ throw e;
+ }
+ }
+
+ protected CommandLine prepareCommand(String... commands) {
+ CommandLine command = new CommandLine(commands);
+ command.setEnvironmentVariable("MOZ_NO_REMOTE", "1");
+
+ // don't set the library path on Snow Leopard
+ Platform platform = Platform.getCurrent();
+ if (!platform.is(Platform.MAC) || ((platform.is(Platform.MAC))
+ && platform.getMajorVersion() <= 10
+ && platform.getMinorVersion() <= 5)) {
+ command.setDynamicLibraryPath(browserInstallation.libraryPath());
+ }
+
+ return command;
+ }
+
+ protected void createCustomProfileDir() {
+ customProfileDir = LauncherUtils.createCustomProfileDir(sessionId);
+ }
+
+ protected void copyDirectory(File sourceDir, File destDir) {
+ LauncherUtils.copyDirectory(sourceDir, destDir);
+ }
+
+ protected File initProfileTemplate() {
+ File firefoxProfileTemplate;
+
+ String relativeProfile = BrowserOptions
+ .getProfile(browserConfigurationOptions);
+ if (relativeProfile == null) {
+ relativeProfile = "";
+ }
+
+ File profilesLocation = getConfiguration().getProfilesLocation();
+ if (profilesLocation != null && !"".equals(relativeProfile)) {
+
+ firefoxProfileTemplate = getFileFromParent(profilesLocation, relativeProfile);
+ if (!firefoxProfileTemplate.exists()) {
+ throw new RuntimeException(
+ "The profile specified '" + firefoxProfileTemplate.getAbsolutePath()
+ + "' does not exist");
+ }
+ } else {
+ firefoxProfileTemplate =
+ BrowserOptions.getFile(browserConfigurationOptions, "firefoxProfileTemplate");
+ }
+
+ if (firefoxProfileTemplate != null) {
+ copyDirectory(firefoxProfileTemplate, customProfileDir);
+ }
+
+ return firefoxProfileTemplate;
+ }
+
+ protected void extractProfileFromJar() throws IOException {
+ ResourceExtractor.extractResourcePath(getClass(), "/customProfileDirCUSTFFCHROME",
+ customProfileDir);
+ }
+
+ protected void copySingleFileWithOverwrite(File sourceFile, File destFile) {
+ LauncherUtils.copySingleFileWithOverwrite(sourceFile, destFile, true);
+ }
+
+ protected File getFileFromParent(final File parent, String child) {
+ return new File(parent, child);
+ }
+
+ protected void copyCert8db(final File firefoxProfileTemplate) {
+ // Make sure that cert8.db of firefoxProfileTemplate is stored into customProfileDir
+ if (firefoxProfileTemplate != null) {
+ File sourceCertFile = getFileFromParent(firefoxProfileTemplate, "cert8.db");
+ if (sourceCertFile.exists()) {
+ File destCertFile = new File(customProfileDir, "cert8.db");
+ copySingleFileWithOverwrite(sourceCertFile, destCertFile);
+ }
+ }
+ }
+
+ protected void generatePacAndPrefJs(String homePage) throws IOException {
+ browserConfigurationOptions = Proxies.setProxyRequired(browserConfigurationOptions, false);
+ if (browserConfigurationOptions.is("captureNetworkTraffic") ||
+ browserConfigurationOptions.is("addCustomRequestHeaders") ||
+ browserConfigurationOptions.is("trustAllSSLCertificates")) {
+ browserConfigurationOptions = Proxies.setProxyEverything(browserConfigurationOptions, true);
+ browserConfigurationOptions = Proxies.setProxyRequired(browserConfigurationOptions, true);
+ }
+
+ LauncherUtils.generatePacAndPrefJs(customProfileDir, getPort(), homePage,
+ changeMaxConnections, getTimeout(), browserConfigurationOptions);
+ }
+
+ private String makeCustomProfile(String homePage) throws IOException {
+
+ createCustomProfileDir();
+
+ File firefoxProfileTemplate = initProfileTemplate();
+
+ extractProfileFromJar();
+
+ copyCert8db(firefoxProfileTemplate);
+
+ copyRunnerHtmlFiles();
+
+ changeMaxConnections = browserConfigurationOptions.is("changeMaxConnections");
+
+ generatePacAndPrefJs(homePage);
+
+ return customProfileDir.getAbsolutePath();
+ }
+
+
+ private void copyRunnerHtmlFiles() {
+ String guid = "{503A0CD4-EDC8-489b-853B-19E0BAA8F0A4}";
+ File extensionDir = new File(customProfileDir, "extensions/" + guid);
+ File htmlDir = new File(extensionDir, "chrome");
+ htmlDir.mkdirs();
+
+ LauncherUtils.extractHTAFile(htmlDir, getPort(), "/core/TestRunner.html", "TestRunner.html");
+ LauncherUtils.extractHTAFile(htmlDir, getPort(), "/core/TestPrompt.html", "TestPrompt.html");
+ LauncherUtils.extractHTAFile(htmlDir, getPort(), "/core/RemoteRunner.html",
+ "RemoteRunner.html");
+
+ }
+
+
+ public void close() {
+ if (closed) {
+ return;
+ }
+ if (process != null) {
+ try {
+ killFirefoxProcess();
+ } catch (RuntimeException e) {
+ log.warning("Unable to kill firefox process.");
+ }
+ }
+ if (customProfileDir != null) {
+ try {
+ removeCustomProfileDir();
+ } catch (RuntimeException e) {
+ throw e;
+ }
+ }
+ closed = true;
+ }
+
+ /**
+ * Wrapper to allow for stubbed-out testing *
+ */
+ protected void removeCustomProfileDir() throws RuntimeException {
+ LauncherUtils.deleteTryTryAgain(customProfileDir, 6);
+ }
+
+ /**
+ * Wrapper to allow for stubbed-out testing *
+ */
+ protected void killFirefoxProcess() {
+ log.info("Killing Firefox...");
+ int exitValue = process.destroy();
+ if (exitValue == 0) {
+ log.warning("Firefox seems to have ended on its own (did we kill the real browser???)");
+ }
+ }
+
+ /**
+ * Wait for one of the Firefox-generated files to come into existence, then wait for Firefox to
+ * exit
+ *
+ * @param timeout the maximum amount of time to wait for the profile to be created
+ */
+ private void waitForFullProfileToBeCreated(long timeout) {
+ // This will be a characteristic file in the profile
+ File testFile = new File(customProfileDir, "extensions.ini");
+ long start = System.currentTimeMillis();
+ for (; System.currentTimeMillis() < start + timeout;) {
+
+ Sleeper.sleepTight(500);
+ if (testFile.exists()) {
+ break;
+ }
+ }
+ if (!testFile.exists()) {
+ throw new RuntimeException("Timed out waiting for profile to be created!");
+ }
+ }
+
+ // visible for testing
+
+ protected void setCustomProfileDir(File value) {
+ customProfileDir = value;
+ }
+
+ // visible for testing
+
+ protected void setCommandLine(CommandLine p) {
+ process = p;
+ }
+
+ public static class ChromeUrlConvert {
+ public String convert(String httpUrl) throws MalformedURLException {
+ String query = LauncherUtils.getQueryString(httpUrl);
+ String file = new File(new URL(httpUrl).getPath()).getName();
+ return "chrome://src/content/" + file + "?" + query;
+ }
+ }
+
+ @Override
+ // need to specify an absolute resultsUrl
+ public void launchHTMLSuite(String suiteUrl, String browserURL) {
+ // If navigating to TestPrompt, use the baked-in version instead.
+ if (suiteUrl != null && suiteUrl.startsWith("TestPrompt.html?")) {
+ suiteUrl =
+ suiteUrl.replaceFirst("^TestPrompt\\.html\\?", "chrome://src/content/TestPrompt.html?");
+ }
+ launch(LauncherUtils.getDefaultHTMLSuiteUrl(browserURL, suiteUrl,
+ (!BrowserOptions.isSingleWindow(browserConfigurationOptions)), getPort()));
+ }
+
+ @Override
+ // need to specify an absolute driverUrl
+ public void launchRemoteSession(String browserURL) {
+ launch(LauncherUtils.getDefaultRemoteSessionUrl(browserURL, sessionId,
+ (!BrowserOptions.isSingleWindow(browserConfigurationOptions)), getPort(),
+ browserConfigurationOptions.is("browserSideLog")));
+ }
+
+}