com.seleniumtests.util.FileUtility Maven / Gradle / Ivy
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.util;
import java.awt.image.BufferedImage;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileFilter;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarFile;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import java.util.zip.ZipOutputStream;
import javax.imageio.ImageIO;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.logging.log4j.Logger;
import org.zeroturnaround.zip.ZipUtil;
import com.seleniumtests.util.logging.SeleniumRobotLogger;
import com.seleniumtests.util.osutility.OSUtility;
public class FileUtility {
private static final Logger logger = SeleniumRobotLogger.getLogger(FileUtility.class);
static final int BUFFER = 2048;
private FileUtility() {
// As a utility method, it is not made to be instantiated.
}
public static void extractJar(final String storeLocation, final Class clz) throws IOException {
File firefoxProfile = new File(storeLocation);
String location = clz.getProtectionDomain().getCodeSource().getLocation().getFile();
try (JarFile jar = new JarFile(location);) {
logger.info("Extracting jar file::: " + location);
firefoxProfile.mkdir();
Enumeration jarFiles = jar.entries();
while (jarFiles.hasMoreElements()) {
ZipEntry entry = (ZipEntry) jarFiles.nextElement();
String currentEntry = entry.getName();
// correct javasecurity:S6096
File entryFile = new File(entry.getName());
if (entryFile.isAbsolute() || !entryFile.getCanonicalPath().startsWith(new File(".").getCanonicalPath())) {
continue;
}
File destinationFile = new File(storeLocation, currentEntry);
File destinationParent = destinationFile.getParentFile();
// create the parent directory structure if required
destinationParent.mkdirs();
if (!entry.isDirectory()) {
BufferedInputStream is = new BufferedInputStream(jar.getInputStream(entry));
int currentByte;
// buffer for writing file
byte[] data = new byte[BUFFER];
// write the current file to disk
try (FileOutputStream fos = new FileOutputStream(destinationFile);) {
BufferedOutputStream destination = new BufferedOutputStream(fos, BUFFER);
// read and write till last byte
while ((currentByte = is.read(data, 0, BUFFER)) != -1) {
destination.write(data, 0, currentByte);
}
destination.flush();
destination.close();
is.close();
}
}
}
}
FileUtils.deleteDirectory(new File(storeLocation + "\\META-INF"));
File classFile;
if (OSUtility.isWindows()) {
classFile = new File(storeLocation + File.pathSeparator + clz.getCanonicalName().replace(".", "\\\\") + ".class");
} else {
classFile = new File(storeLocation + File.pathSeparator + clz.getCanonicalName().replace(".", "/") + ".class");
}
try {
Files.delete(classFile.toPath());
} catch (IOException e) {
logger.warn("Cannot delete class file");
}
}
/**
* Constructs ImageElement from bytes and stores it.
*
* @param path
*/
public static synchronized void writeImage(final String path, final byte[] byteArray) {
if (byteArray.length == 0) {
return;
}
byte[] decodeBuffer = Base64.decodeBase64(byteArray);
try (InputStream in = new ByteArrayInputStream(decodeBuffer)) {
BufferedImage img = ImageIO.read(in);
writeImage(path, img);
} catch (Exception e) {
logger.warn(e);
}
}
/**
* Constructs ImageElement from bytes and stores it.
*
* @param path
*/
public static synchronized void writeImage(final String path, BufferedImage bufImage) {
if (bufImage == null) {
return;
}
File parentDir = new File(path).getParentFile();
if (!parentDir.exists()) {
parentDir.mkdirs();
}
try (FileOutputStream fos = new FileOutputStream(path)) {
ImageIO.write(bufImage, "png", fos);
} catch (Exception e) {
logger.warn(e);
}
}
public static String getLatestFile(final String folder) {
String file = null;
File folderFile = new File(folder);
if (folderFile.exists() && folderFile.isDirectory()) {
File[] files = folderFile.listFiles();
long date = 0;
for (int i = 0; i < files.length; i++) {
if (files[i].lastModified() > date) {
date = files[i].lastModified();
file = files[i].getAbsolutePath();
}
}
}
return file;
}
public static String decodePath(final String path) throws UnsupportedEncodingException {
return URLDecoder.decode(path, "UTF-8");
}
public static boolean fileExists(String path) {
return new File(path).exists();
}
/**
* Create a zip file from list of files to a temp directory. They will be added at the root of zip file
* @param files
* @return the zipped file
* @throws IOException
*/
public static File createZipArchiveFromFiles(List files) throws IOException {
final File zipArchive = File.createTempFile("temp_zip_", ".zip");
try (
final ZipOutputStream out = new ZipOutputStream(new FileOutputStream(zipArchive))) {
for (File f: files) {
if (!f.exists()) {
logger.warn(String.format("File %s does not exist", f.getName()));
continue;
}
ZipEntry e = new ZipEntry(f.getName());
out.putNextEntry(e);
IOUtils.write(FileUtils.readFileToByteArray(f), out);
out.closeEntry();
}
}
return zipArchive;
}
/**
* Unzip file to a temp directory
* @param zippedFile
* @return the output folder
* @throws IOException
*/
public static File unzipFile(final File zippedFile) throws IOException {
File outputFolder = Files.createTempDirectory("tmp").toFile();
try (ZipFile zipFile = new ZipFile(zippedFile)) {
final Enumeration entries = zipFile.entries();
while (entries.hasMoreElements()) {
final ZipEntry entry = entries.nextElement();
String entryName = entry.getName();
File entryFile = new File(entryName);
// correct javasecurity:S6096
if (entryFile.isAbsolute() || !entryFile.getCanonicalPath().startsWith(new File(".").getCanonicalPath())) {
continue;
}
final File entryDestination = new File(outputFolder, entryName);
if (entry.isDirectory()) {
//noinspection ResultOfMethodCallIgnored
entryDestination.mkdirs();
} else {
//noinspection ResultOfMethodCallIgnored
entryDestination.getParentFile().mkdirs();
try (final InputStream in = zipFile.getInputStream(entry);
final OutputStream out = new FileOutputStream(entryDestination)) {
IOUtils.copy(in, out);
}
}
}
}
return outputFolder;
}
/**
* Zip the folder and place resulting file into 'destZipFile'
* @param folder folder to zip
* @param destZipFile location where resulting file will be copied
*/
public static void zipFolder(final File folder, final File destZipFile) {
try {
zipFolder(folder, destZipFile, null, false);
} catch (IOException e) {
logger.error("cannot zip folder: " + e.getMessage());
}
}
/**
* Zip the folder and place resulting file into 'destZipFile'. If the destination file already exists, it's overwritten
* @param folder folder to zip
* @param destZipFile location where resulting file will be copied
* @param fileFilter filter to use when inserting files into zip
* @param zipParentDirectory whether the parent directory is the root of the zip (if we zip folder "result/..", zip may contain the 'result/file1' or just 'file1'
*/
public static void zipFolder(final File folder, final File destZipFile, FileFilter fileFilter, boolean zipParentDirectory) throws IOException {
Path rootDir = Files.createTempDirectory("res");
Path tempDir = rootDir;
if (zipParentDirectory) {
tempDir = rootDir.resolve(folder.getName());
}
// copy test results
FileUtils.copyDirectory(folder, tempDir.toFile(), fileFilter);
try {
File tempZip = File.createTempFile(destZipFile.getName(), ".zip");
tempZip.deleteOnExit();
ZipUtil.pack(rootDir.toFile(), tempZip);
copyFile(tempZip, destZipFile);
} catch (IOException e) {
logger.error("cannot create zip file", e);
}
try {
FileUtils.deleteDirectory(rootDir.toFile());
}catch (IOException e) {
logger.error("cannot delete temp directory file", e);
}
}
/**
* Copy file ignoring when srcFile and destFile are identical
* @param srcFile
* @param destFile
* @throws IOException
*/
public static void copyFile(final File srcFile, final File destFile) throws IOException {
try {
FileUtils.copyFile(srcFile, destFile);
} catch (IllegalArgumentException e) {
// nothing to do in case srcFile and destFile are identical
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy