com.seleniumtests.driver.DriverExtractor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-selenium4 Show documentation
The newest version!
/**
 * Orignal work: Copyright 2015 www.seleniumtests.com
 * Modified work: Copyright 2016 www.infotel.com
 * 				Copyright 2017-2019 B.Hecquet
 *
 * Licensed 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 com.seleniumtests.driver;

import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;

import org.apache.commons.io.FileUtils;
import org.apache.logging.log4j.Logger;

import com.seleniumtests.core.SeleniumTestsContextManager;
import com.seleniumtests.customexception.DriverExceptions;
import com.seleniumtests.util.PackageUtility;
import com.seleniumtests.util.logging.SeleniumRobotLogger;
import com.seleniumtests.util.osutility.OSUtility;
import com.seleniumtests.util.osutility.OSUtilityFactory;

/**
 * Extract drivers from resources so that they are available from IDE execution
 * without having need to extract them manually
 * 
 * @author behe
 *
 */
public class DriverExtractor {
	
	private static final String DRIVER_VERSION_FILE = "version_%s.txt";
	private static final String DRIVER_FOLDER = "drivers";
	private static final Logger logger = SeleniumRobotLogger.getLogger(DriverExtractor.class);
	private String rootPath;
	private String os;
	
	public DriverExtractor() {
		this(SeleniumTestsContextManager.getRootPath());
	}
	
	public DriverExtractor(String rootPath) {
		this.rootPath = rootPath;
		
		os = OSUtility.getCurrentPlatorm().toString().toLowerCase();
	}
	
	/**
	 * Get the version of the driver from text file which is created when a driver is copied to /drivers/ folder
	 * @param driverName
	 * @return
	 */
	private String getDriverVersion(String driverName) {
		try {
			return FileUtils.readFileToString(Paths.get(getDriverPath().toFile().getAbsolutePath(), getDriverVersionFileName(driverName)).toFile(), StandardCharsets.UTF_8);
		} catch (IOException e) {
			return null;
		}
	}
	
	private String getDriverVersionFileName(String driverName) {
		return String.format(DRIVER_VERSION_FILE, driverName);
	}
	
	/**
	 * Extract drivers from JAR
	 * first, check if a driver directory is available in the same directory as the jar
	 * If not, extract
	 * If yes, check version of drivers and compare it to seleniumRobot version
	 * In case of difference, extract
	 * @throws IOException 
	 */
	public String extractDriver(String driverName) {
		
		if (driverName == null) {
			return null;
		}
		
		String installedDriverVersion = getDriverVersion(driverName);
		String driverArtifactVersion = PackageUtility.getDriverVersion();
		Path driverPath = getDriverPath(driverName);
		
		// copy driver only when it was not copied for this driver artifact version
		if (driverPath.toFile().exists() && (installedDriverVersion == null || !installedDriverVersion.equals(driverArtifactVersion))
				|| !driverPath.toFile().exists()) {
			copyDriver(driverName);
		} 
		
		// write version file
		try {
			FileUtils.writeStringToFile(Paths.get(getDriverPath().toFile().getAbsolutePath(), getDriverVersionFileName(driverName)).toFile(), driverArtifactVersion, StandardCharsets.UTF_8);
		} catch (IOException e) {
			logger.error("driver version not written", e);
		}
		
		return driverPath.toString();
	}
	
	public void copyDriver(String driverName) {
		InputStream driver = Thread.currentThread().getContextClassLoader().getResourceAsStream(String.format("drivers/%s/%s%s", 
						os, 
						driverName,
						OSUtilityFactory.getInstance().getProgramExtension()));
		
		if (driver == null) {
			throw new DriverExceptions(String.format("Driver %s does not exist in resources", driverName));
		}
		Path driverPath = getDriverPath(driverName);
		
		driverPath.toFile().getParentFile().mkdirs();
		
		try {
			Files.copy(driver, driverPath, StandardCopyOption.REPLACE_EXISTING);
			if (!driverPath.toFile().setExecutable(true)) {
				logger.warn(String.format("Driver %s could not be set to executable", driverPath));
			}
			logger.info(String.format("Driver %s copied to %s", driverName, driverPath));
		} catch (IOException e) {
			logger.info(String.format("Driver not copied: %s - it may be in use", driverName));
		}
		
	}
	
	public Path getDriverPath() {
		return Paths.get(rootPath, DRIVER_FOLDER);
	}
	
	public Path getDriverPath(String driverName) {
		return Paths.get(rootPath, DRIVER_FOLDER, driverName + OSUtilityFactory.getInstance().getProgramExtension());
	}
}