com.seleniumtests.driver.screenshots.ScreenShot Maven / Gradle / Ivy
/**
* 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.screenshots;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.nio.file.Paths;
import org.apache.commons.io.FileExistsException;
import org.apache.commons.io.FileUtils;
import org.apache.log4j.Logger;
import com.seleniumtests.core.SeleniumTestsContextManager;
import com.seleniumtests.util.logging.SeleniumRobotLogger;
public class ScreenShot {
private static final Logger logger = SeleniumRobotLogger.getLogger(ScreenShot.class);
private String location;
private String htmlSourcePath;
private String imagePath;
private String title;
private String suiteName;
private long duration;
private boolean isException;
private String outputDirectory;
public ScreenShot() {
this(null);
}
public ScreenShot(String imagePath) {
if (SeleniumTestsContextManager.getGlobalContext().getTestNGContext() != null) {
suiteName = SeleniumTestsContextManager.getGlobalContext().getTestNGContext().getSuite().getName();
outputDirectory = SeleniumTestsContextManager.getThreadContext().getOutputDirectory();
}
this.imagePath = imagePath;
this.duration = 0;
}
public boolean isException() {
return isException;
}
public void setException(final boolean isException) {
this.isException = isException;
}
/**
* @deprecated not used anymore
* @return
*/
@Deprecated
public String getSuiteName() {
return suiteName;
}
public String getOutputDirectory() {
return outputDirectory;
}
public void setOutputDirectory(final String outputDirectory) {
this.outputDirectory = outputDirectory;
}
public void setSuiteName(final String suiteName) {
this.suiteName = suiteName;
}
/**
* URL of the page for which this screenshot has been taken
* @return
*/
public String getLocation() {
return location;
}
public String getImageName() {
if (imagePath != null) {
return new File(imagePath).getName();
} else {
return "";
}
}
public void setLocation(String location) {
this.location = location;
}
public void setHtmlSourcePath(String htmlSourcePath) {
this.htmlSourcePath = htmlSourcePath;
}
public void setImagePath(String imagePath) {
this.imagePath = imagePath;
}
public String getHtmlSourcePath() {
return htmlSourcePath;
}
public String getHtmlSource() {
if (htmlSourcePath != null) {
try {
return FileUtils.readFileToString(new File(getFullHtmlPath()));
} catch (IOException e) {
logger.error("cannot read source file", e);
return "";
}
} else {
return "";
}
}
/**
* Get the image path relative to outputDirectory (directory where info for a specific test are recorded)
* @return
*/
public String getImagePath() {
return imagePath;
}
/**
* Get the title of the page associated to this screenshot
* @return
*/
public String getTitle() {
return title;
}
public void setTitle(final String title) {
this.title = title;
}
public String getFullImagePath() {
if (imagePath != null) {
return Paths.get(outputDirectory, imagePath).toString().replace("\\", "/");
} else {
return null;
}
}
public String getFullHtmlPath() {
if (htmlSourcePath != null) {
return Paths.get(outputDirectory, htmlSourcePath).toString().replace("\\", "/");
} else {
return null;
}
}
@Override
public String toString() {
return "!!!EXCEPTION:" + this.isException + "|APPLICATION URL:" + this.location + "|PAGE TITLE:" + this.title
+ "|PAGE HTML SOURCE:" + this.getFullHtmlPath() + "|PAGE IMAGE:" + this.getFullImagePath();
}
public long getDuration() {
return duration;
}
public void setDuration(long duration) {
this.duration = duration;
}
/**
* Move physically the image to 'destOutputDirectory'
* @param destOutputDirectory the output directory to copy to. It's a root directory where test results / image / html / video are stored
* @throws IOException
*/
public void relocate(String destOutputDirectory) throws IOException {
relocate(destOutputDirectory, imagePath, htmlSourcePath);
}
/**
* Move physically the image to 'destOutputDirectory'
* @param destOutputDirectory the output directory to copy to. It's a root directory where test results / image / html / video are stored
* @param newImagePath the new path of the image if it needs to be moved inside the output directory
* @throws IOException the new path of the html if it needs to be moved inside the output directory
*/
public void relocate(String destOutputDirectory, String newImagePath, String newHtmlPath) throws IOException {
new File(destOutputDirectory).mkdirs();
if (htmlSourcePath != null) {
if (newHtmlPath != null && !newHtmlPath.equals(htmlSourcePath)) {
try {
FileUtils.moveFile(Paths.get(outputDirectory, htmlSourcePath).toFile(), Paths.get(outputDirectory, newHtmlPath).toFile());
htmlSourcePath = newHtmlPath.replace("\\", "/");
} catch (IOException e) {
logger.warn(String.format("File renaming to %s failed", newHtmlPath));
}
}
File htmlSrc = Paths.get(outputDirectory, htmlSourcePath).toFile().getCanonicalFile();
File newHtmlSrc = new File(htmlSrc.getAbsolutePath().replace("\\", "/").replace(outputDirectory, destOutputDirectory));
try {
FileUtils.moveFile(htmlSrc, newHtmlSrc);
} catch (FileExistsException e) {
// nothing to do, file is there
} catch (FileNotFoundException e) {
logger.warn(String.format("File %s cannot be moved, it does not exist", htmlSourcePath));
return;
}
htmlSourcePath = Paths.get(destOutputDirectory).relativize(Paths.get(newHtmlSrc.getAbsolutePath())).toString().replace("\\", "/");
}
if (imagePath != null) {
if (newImagePath != null && !newImagePath.equals(imagePath)) {
try {
FileUtils.moveFile(Paths.get(outputDirectory, imagePath).toFile(), Paths.get(outputDirectory, newImagePath).toFile());
imagePath = newImagePath.replace("\\", "/");
} catch (IOException e) {
logger.warn(String.format("File renaming to %s failed", newImagePath));
}
}
File imgSrc = Paths.get(outputDirectory, imagePath).toFile().getCanonicalFile();
File newImgSrc = new File(imgSrc.getAbsolutePath().replace("\\", "/").replace(outputDirectory, destOutputDirectory));
try {
FileUtils.moveFile(imgSrc, newImgSrc);
} catch (FileExistsException e) {
// nothing to do, file is there
} catch (FileNotFoundException e) {
logger.warn(String.format("File %s cannot be moved, it does not exist", imagePath));
return;
}
imagePath = Paths.get(destOutputDirectory).relativize(Paths.get(newImgSrc.getAbsolutePath())).toString().replace("\\", "/");
}
outputDirectory = destOutputDirectory;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy