io.qameta.allure.FileSystemResultsWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of allure-java-commons Show documentation
Show all versions of allure-java-commons Show documentation
Module allure-java-commons of Allure Framework.
/*
* Copyright 2016-2024 Qameta Software Inc
*
* 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 io.qameta.allure;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.qameta.allure.internal.Allure2ModelJackson;
import io.qameta.allure.model.TestResult;
import io.qameta.allure.model.TestResultContainer;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Objects;
import java.util.UUID;
/**
* @author charlie (Dmitry Baev).
*/
public class FileSystemResultsWriter implements AllureResultsWriter {
private final Path outputDirectory;
private final ObjectMapper mapper;
public FileSystemResultsWriter(final Path outputDirectory) {
this.outputDirectory = outputDirectory;
this.mapper = Allure2ModelJackson.createMapper();
}
@Override
public void write(final TestResult testResult) {
final String testResultName = Objects.isNull(testResult.getUuid())
? generateTestResultName()
: generateTestResultName(testResult.getUuid());
createDirectories(outputDirectory);
final Path file = outputDirectory.resolve(testResultName);
try {
mapper.writeValue(file.toFile(), testResult);
} catch (IOException e) {
throw new AllureResultsWriteException("Could not write Allure test result", e);
}
}
@Override
public void write(final TestResultContainer testResultContainer) {
final String testResultContainerName = Objects.isNull(testResultContainer.getUuid())
? generateTestResultContainerName()
: generateTestResultContainerName(testResultContainer.getUuid());
createDirectories(outputDirectory);
final Path file = outputDirectory.resolve(testResultContainerName);
try {
mapper.writeValue(file.toFile(), testResultContainer);
} catch (IOException e) {
throw new AllureResultsWriteException("Could not write Allure test result container", e);
}
}
@Override
public void write(final String source, final InputStream attachment) {
createDirectories(outputDirectory);
final Path file = outputDirectory.resolve(source);
try (InputStream is = attachment) {
Files.copy(is, file);
} catch (IOException e) {
throw new AllureResultsWriteException("Could not write Allure attachment", e);
}
}
private void createDirectories(final Path directory) {
try {
Files.createDirectories(directory);
} catch (IOException e) {
throw new AllureResultsWriteException("Could not create Allure results directory", e);
}
}
protected static String generateTestResultName() {
return generateTestResultName(UUID.randomUUID().toString());
}
protected static String generateTestResultName(final String uuid) {
return uuid + AllureConstants.TEST_RESULT_FILE_SUFFIX;
}
protected static String generateTestResultContainerName() {
return generateTestResultContainerName(UUID.randomUUID().toString());
}
protected static String generateTestResultContainerName(final String uuid) {
return uuid + AllureConstants.TEST_RESULT_CONTAINER_FILE_SUFFIX;
}
}