com.hp.octane.integrations.executor.TestsToRunConverter Maven / Gradle / Ivy
/**
* Copyright 2017-2023 Open Text
*
* The only warranties for products and services of Open Text and
* its affiliates and licensors (“Open Text”) are as may be set forth
* in the express warranty statements accompanying such products and services.
* Nothing herein should be construed as constituting an additional warranty.
* Open Text shall not be liable for technical or editorial errors or
* omissions contained herein. The information contained herein is subject
* to change without notice.
*
* Except as specifically indicated otherwise, this document contains
* confidential information and a valid license is required for possession,
* use or copying. If this work is provided to the U.S. Government,
* consistent with FAR 12.211 and 12.212, Commercial Computer Software,
* Computer Software Documentation, and Technical Data for Commercial Items are
* licensed to the U.S. Government under vendor's standard commercial license.
*
* 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.hp.octane.integrations.executor;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.hp.octane.integrations.utils.SdkStringUtils;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import static com.hp.octane.integrations.executor.TestToRunData.TESTS_TO_RUN_STRING_VERSION;
public abstract class TestsToRunConverter {
public static final String DEFAULT_TESTS_TO_RUN_CONVERTED_PARAMETER = "testsToRunConverted";
private String testsToRunConvertedParameterName = DEFAULT_TESTS_TO_RUN_CONVERTED_PARAMETER;
private String format = "";
public TestsToRunConverter setFormat(String format) {
this.format = format;
return this;
}
protected String getFormat() {
return format;
}
public TestsToRunConverterResult convert(String testsToRunStr, String executionDirectory, Map globalParameters) {
List data = parse(testsToRunStr);
return convert(data, executionDirectory, globalParameters);
}
public TestsToRunConverterResult convert(List data, String executionDirectory, Map globalParameters) {
String converted = convertInternal(data, executionDirectory, globalParameters);
TestsToRunConverterResult result = new TestsToRunConverterResult(data, converted, executionDirectory, testsToRunConvertedParameterName);
afterConvert(result);
return result;
}
public void enrichTestsData(List tests, Map globalParameters) {
}
protected void afterConvert(TestsToRunConverterResult result) {
}
protected abstract String convertInternal(List data, String executionDirectory, Map globalParameters);
protected void setTestsToRunConvertedParameterName(String value) {
if (SdkStringUtils.isEmpty(value)) {
throw new IllegalArgumentException("TestsToRunConvertedParameter cannot be empty");
}
testsToRunConvertedParameterName = value;
}
public static List parse(String rawTests) {
//format: v1:package1|class1|test1|key1=val1|key2=val2;package2|class2|test2#arguments2;package3|class3|test3#arguments3
if (SdkStringUtils.isEmpty(rawTests)) {
return null;
}
boolean bTestToRunStringVersion = rawTests.startsWith(TESTS_TO_RUN_STRING_VERSION);
if (bTestToRunStringVersion) {
return parse(rawTests.substring(rawTests.indexOf(":") + 1).split(";"));
} else {
return parseJson(rawTests);
}
}
private static List parseJson(String rawTestsJson) {
try {
final ObjectMapper objectMapper = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
TestToRunDataCollection result = objectMapper.readValue(rawTestsJson, TestToRunDataCollection.class);
return result.getTestsToRun();
} catch (IOException e) {
throw new IllegalArgumentException("Invalid tests format: " + e.getMessage(), e);
}
}
private static List parse(String[] rawTestsArr) {
List result = new ArrayList<>(rawTestsArr.length);
int TEST_PARTS_MINIMAL_SIZE = 3;//package1|class1|test1
int PARAMETER_SIZE = 2;//key=value
for (String rawtest : rawTestsArr) {
String[] testParts = rawtest.split("\\|");
if (testParts.length < TEST_PARTS_MINIMAL_SIZE) {
throw new IllegalArgumentException("Test '" + rawtest + "' does not contains all required components");
}
TestToRunData data = new TestToRunData();
result.add(data);
data.setPackageName(testParts[0]).setClassName(testParts[1]).setTestName(testParts[2]);
for (int i = TEST_PARTS_MINIMAL_SIZE; i < testParts.length; i++) {
String[] parameterParts = testParts[i].split("=");
if (parameterParts.length != PARAMETER_SIZE) {
throw new IllegalArgumentException("Test' " + rawtest + "' contains an illegal parameter format." +
"\nTextual format uses the following characters as separators: |;=. Your values probably contain these characters." +
"Switch to JSON format by defining in ALM Octane the space parameter 'TESTS_TO_RUN_PARAMETER_JSON_FORMAT' = true.");
}
data.addParameters(parameterParts[0], parameterParts[1]);
}
}
return result;
}
}