jenkinsci/hpe-application-automation-tools-plugin

/*
 * 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.service;

import com.microfocus.application.automation.tools.results.service.AlmRestTool;
import com.microfocus.application.automation.tools.results.service.almentities.AlmCommonProperties;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;

public class FolderService {

    private static final String FOLDER_SEPERATOR = "\\";
    private RestService restService;

    public FolderService(RestService restService) {
        this.restService = restService;
    }

    public Map<String, String> createOrFindPath(String prefix, String parentId, String path) {
        List<Map<String, String>> folders = new ArrayList<Map<String, String>>();
        StringTokenizer tokenizer = new StringTokenizer(path, FOLDER_SEPERATOR);
        while (tokenizer.hasMoreTokens()) {
            String itemString = tokenizer.nextToken();
            Map<String, String> folder = createFolder(prefix, parentId, itemString);
            if (folder != null) {
                folders.add(folder);
                parentId = folder.get("id");
            }
        }
        if (folders.size() > 0) {
            return folders.get(folders.size() - 1);
        } else  {
            return null;
        }
    }

    public Map<String, String> createFolder(String prefix, String parentId, String folderName) {
        Map<String, String> existsFolder = checkFolderExits(prefix, parentId, folderName);
        if (existsFolder == null) {
            existsFolder = new HashMap<>();
            existsFolder.put(AlmCommonProperties.PARENT_ID, parentId);
            existsFolder.put(AlmCommonProperties.NAME, folderName);
            return restService.create(prefix, existsFolder);
        } else {
            return existsFolder;
        }
    }

    public Map<String, String> checkFolderExits(String prefix, String parentId, String folderName) {
        String query = String.format("fields=id,name&query={parent-id[%s];name[%s]}",
                parentId,
                AlmRestTool.getEncodedString(folderName));
        List<Map<String, String>> entities = restService.get(null, prefix, query);
        if (entities.size() > 0) {
            return entities.get(0);
        } else {
            return null;
        }
    }

    public List<Map<String, String>> getSubFolders(String prefix, String parentFolderId) {
        String query = String.format("fields=id,name&query={parent-id[%s]}", parentFolderId);
        return restService.get(null, prefix, query);
    }

    public Map<String, String> findEntityInFolder(
            Map<String, String> testFolder,
            Map<String, String> test,
            String entityPrefix,
            String folderPrefix,
            String[] queryFields) {
        List<Map<String, String>> foundTests = new ArrayList<>();

        // Make criteria fields.
        test.put(CriteriaTranslator.CRITERIA_PREFIX + AlmCommonProperties.PARENT_ID,
                testFolder.get(AlmCommonProperties.ID));

        if (test.get(CriteriaTranslator.CRITERIA_PREFIX + AlmCommonProperties.ID) != null
                && !test.get(CriteriaTranslator.CRITERIA_PREFIX + AlmCommonProperties.ID).isEmpty()) {
            // If there's ID in the criteria, ignor name criteria.
        } else {
            test.put(CriteriaTranslator.CRITERIA_PREFIX + AlmCommonProperties.NAME,
                    test.get(AlmCommonProperties.NAME));
        }

        findEntityInFolderAndSub(foundTests, test, entityPrefix, folderPrefix, queryFields);
        return foundTests.size() > 0 ? foundTests.get(0) : null;
    }

    private void findEntityInFolderAndSub(List<Map<String, String>> foundTests,
                                          Map<String, String> test, String entityPrefix,
                                          String folderPrefix, String[] queryFields) {
        List<Map<String, String>> existTests = restService.get(null,
                entityPrefix, CriteriaTranslator.getCriteriaString(queryFields, test));

        if (existTests == null || existTests.size() == 0) {
            // Not in current folder, find in sub folders
            List<Map<String, String>> subFolders =
                    getSubFolders(folderPrefix, test.get(AlmCommonProperties.PARENT_ID));

            if (subFolders != null) {
                for (Map<String, String> subfolder : subFolders) {
                    // Make criteria fields.
                    test.put(CriteriaTranslator.CRITERIA_PREFIX + AlmCommonProperties.PARENT_ID,
                            subfolder.get(AlmCommonProperties.ID));
                    test.put(CriteriaTranslator.CRITERIA_PREFIX + AlmCommonProperties.NAME,
                            test.get(AlmCommonProperties.NAME));
                    findEntityInFolderAndSub(foundTests, test, entityPrefix, folderPrefix, queryFields);
                }
            }
        } else {
            foundTests.addAll(existTests);
        }
    }
}