src/main/java/com/microfocus/application/automation/tools/commonResultUpload/uploader/TestUploader.java
/*
* Certain versions of software accessible here may contain branding from Hewlett-Packard Company (now HP Inc.) and Hewlett Packard Enterprise Company.
* This software was acquired by Micro Focus on September 1, 2017, and is now offered by OpenText.
* Any reference to the HP and Hewlett Packard Enterprise/HPE marks is historical in nature, and the HP and Hewlett Packard Enterprise/HPE marks are the property of their respective owners.
* __________________________________________________________________
* MIT License
*
* Copyright 2012-2024 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.
*
* 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.microfocus.application.automation.tools.commonResultUpload.uploader;
import com.microfocus.application.automation.tools.commonResultUpload.CommonUploadLogger;
import com.microfocus.application.automation.tools.commonResultUpload.service.CriteriaTranslator;
import com.microfocus.application.automation.tools.commonResultUpload.service.CustomizationService;
import com.microfocus.application.automation.tools.commonResultUpload.service.FolderService;
import com.microfocus.application.automation.tools.commonResultUpload.service.RestService;
import com.microfocus.application.automation.tools.commonResultUpload.service.VersionControlService;
import com.microfocus.application.automation.tools.commonResultUpload.xmlreader.model.XmlResultEntity;
import com.microfocus.application.automation.tools.results.service.almentities.AlmCommonProperties;
import org.apache.commons.lang.StringUtils;
import java.util.List;
import java.util.Map;
import static com.microfocus.application.automation.tools.commonResultUpload.ParamConstant.ALM_TEST_FOLDER;
import static com.microfocus.application.automation.tools.commonResultUpload.ParamConstant.CREATE_NEW_TEST;
public class TestUploader {
public static final String TEST_REST_PREFIX = "tests";
private static final String TEST_FOLDERS_REST_PREFIX = "test-folders";
public static final String[] NO_VERSION_TESTS = new String[]{"ALT-SCENARIO",
"LEANFT-TEST", "LR-SCENARIO", "QAINSPECT-TEST"};
private static final String VC_VERSION_NUMBER = "vc-version-number";
private static final String SUB_TYPE_ID = "subtype-id";
private Map<String, String> params;
private CommonUploadLogger logger;
private RestService restService;
private FolderService folderService;
private CustomizationService customizationService;
private TestInstanceUploader testInstanceUploader;
private VersionControlService versionControlService;
public TestUploader(CommonUploadLogger logger, Map<String, String> params,
RestService restService, FolderService folderService,
TestInstanceUploader testInstanceUploader,
CustomizationService customizationService,
VersionControlService versionControlService) {
this.logger = logger;
this.params = params;
this.restService = restService;
this.folderService = folderService;
this.testInstanceUploader = testInstanceUploader;
this.customizationService = customizationService;
this.versionControlService = versionControlService;
}
public void upload(Map<String, String> testset, List<XmlResultEntity> xmlResultEntities) {
logger.info("Test upload start.");
for (XmlResultEntity xmlResultEntity : xmlResultEntities) {
Map<String, String> test = xmlResultEntity.getValueMap();
Map<String, String> newTest;
String attachment = test.get("attachment");
test.remove("attachment");
if (!StringUtils.isEmpty(params.get(ALM_TEST_FOLDER))) {
// Create or find a exists folder
Map<String, String> folder = folderService.createOrFindPath(
TEST_FOLDERS_REST_PREFIX, "2", params.get(ALM_TEST_FOLDER));
if (folder == null) {
continue;
}
// Find exists test under folder
Map<String, String> existsTest = folderService.findEntityInFolder(folder, test,
TEST_REST_PREFIX, TEST_FOLDERS_REST_PREFIX,
new String[]{"id", "name", SUB_TYPE_ID, VC_VERSION_NUMBER});
if (existsTest != null) {
// If exists, update the test.
existsTest.putAll(test);
newTest = restService.update(TEST_REST_PREFIX, existsTest);
} else {
logger.log("Test not found by criteria:");
for (Map.Entry<String, String> entry : test.entrySet()) {
if (entry.getKey().equals("name") || entry.getKey().startsWith(CriteriaTranslator.CRITERIA_PREFIX)) {
logger.log("----" + entry.getKey() + "=" + entry.getValue());
}
}
// If not, create the test under the folder
test.put(AlmCommonProperties.PARENT_ID, folder.get(AlmCommonProperties.ID));
if (params.get(CREATE_NEW_TEST).equals("true")) {
newTest = restService.create(TEST_REST_PREFIX, test);
} else {
newTest = null;
logger.log("Test not found and not created: " + test.toString());
}
}
} else {
// If no path was specified, put test under root
test.put(AlmCommonProperties.PARENT_ID, "0");
if (params.get(CREATE_NEW_TEST).equals("true")) {
newTest = restService.create(TEST_REST_PREFIX, test);
} else {
newTest = null;
logger.log("Test not found and not created: " + test.toString());
}
}
if (newTest == null) {
continue;
} else {
// upload test instance
getVersionNumberForVC(newTest);
test.putAll(newTest);
testInstanceUploader.upload(testset, xmlResultEntity, attachment);
}
}
}
private void getVersionNumberForVC(Map<String, String> newTest) {
// Some test type doesn't have version support
for (String noVersionTest : NO_VERSION_TESTS) {
if (newTest.get(SUB_TYPE_ID).equals(noVersionTest)) {
return;
}
}
boolean versioningEnabled = customizationService.isVersioningEnabled(
CustomizationService.TEST_ENTITY_NAME);
if (versioningEnabled && StringUtils.isEmpty(newTest.get(VC_VERSION_NUMBER))) {
versionControlService.refreshEntityVersion(TEST_REST_PREFIX,
newTest.get(AlmCommonProperties.ID));
newTest.putAll(restService.get(newTest.get(AlmCommonProperties.ID),
TEST_REST_PREFIX, CriteriaTranslator.getCriteriaString(
new String[]{"id", "name", SUB_TYPE_ID, VC_VERSION_NUMBER}, newTest)).get(0));
}
}
}