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.settings;

import com.microfocus.application.automation.tools.octane.configuration.SDKBasedLoggerProvider;
import hudson.XmlFile;
import jenkins.model.Jenkins;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.logging.log4j.Logger;

import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

public class ConfigurationMigrationUtil {

    private static final Logger logger = SDKBasedLoggerProvider.getLogger(ConfigurationMigrationUtil.class);

    private ConfigurationMigrationUtil(){
        //codacy : Add a private constructor to hide the implicit public one.
    }

    public static void migrateConfigurationFileIfRequired(XmlFile xmlFile, String oldFileName, String oldRootElementName, String newRootElementName) {
        if (!xmlFile.exists()) {
            //try to get from old path
            File oldXmlFile = new File(Jenkins.get().getRootDir(), oldFileName);
            if (oldXmlFile.exists()) {
                try {
                    String configuration = FileUtils.readFileToString(oldXmlFile, StandardCharsets.UTF_8.name());
                    String newConfiguration = StringUtils.replace(configuration,
                            oldRootElementName,
                            newRootElementName);
                    FileUtils.writeStringToFile(xmlFile.getFile(), newConfiguration, StandardCharsets.UTF_8.name());
                } catch (IOException e) {
                    logger.error("failed to migrate configuration to new 6.6 format  " + newRootElementName + " : " + e.getMessage());
                }
            }
        }
    }
}