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.octane.events;

import com.hp.octane.integrations.OctaneSDK;
import com.hp.octane.integrations.dto.DTOFactory;
import com.hp.octane.integrations.dto.events.CIEvent;
import com.hp.octane.integrations.dto.events.CIEventType;
import com.hp.octane.integrations.dto.events.ItemType;
import com.microfocus.application.automation.tools.octane.CIJenkinsServicesImpl;
import com.microfocus.application.automation.tools.octane.configuration.ConfigurationService;
import com.microfocus.application.automation.tools.octane.configuration.SDKBasedLoggerProvider;
import com.microfocus.application.automation.tools.octane.executor.UftTestDiscoveryDispatcher;
import com.microfocus.application.automation.tools.octane.model.processors.projects.JobProcessorFactory;
import com.microfocus.application.automation.tools.octane.tests.build.BuildHandlerUtils;
import com.microfocus.application.automation.tools.settings.OctaneServerSettingsGlobalConfiguration;
import hudson.Extension;
import hudson.model.Item;
import hudson.model.listeners.ItemListener;
import jenkins.model.Jenkins;
import org.apache.logging.log4j.Logger;
import org.jenkinsci.plugins.workflow.job.WorkflowJob;

/**
 * Run Listener that handles basic CI item events and dispatches notifications to the Octane server
 * User: shitritn
 * Date: 12/06/18
 * Time: 09:33
 */

@Extension
public class GlobalEventsListenerOctaneImpl extends ItemListener {
    private static final Logger logger = SDKBasedLoggerProvider.getLogger(GlobalEventsListenerOctaneImpl.class);
    private static final DTOFactory dtoFactory = DTOFactory.getInstance();

    @Override
    public void onLoaded() {
        logger.info("**********************************************************************");
        logger.info("********************STARTING JENKINS *********************************");
        logger.info("**********************************************************************");
        logger.info("Jenkins version " + Jenkins.getVersion());
        logger.info("Plugin version " + ConfigurationService.getPluginVersion());
        logger.info("CI SDK version " + OctaneSDK.SDK_VERSION);

        OctaneServerSettingsGlobalConfiguration.getInstance().initOctaneClients();
    }

    @Override
    public void onDeleted(Item item) {
        if(!OctaneSDK.hasClients()){
            return;
        }
        try {
            CIEvent event;
            if (item.getParent() != null && item.getParent().getClass().getName().equalsIgnoreCase(JobProcessorFactory.WORKFLOW_MULTI_BRANCH_JOB_NAME)) {
                event = dtoFactory.newDTO(CIEvent.class)
                        .setEventType(CIEventType.DELETED)
                        .setProject(JobProcessorFactory.getFlowProcessor((WorkflowJob) item).getTranslatedJobName());

                OctaneSDK.getClients().forEach(client -> client.getEventsService().publishEvent(event));
            }
        } catch (Throwable throwable) {
            logger.error("failed to build and/or dispatch DELETED event for " + item, throwable);
        }
    }

    @Override
    public void onBeforeShutdown() {
        OctaneSDK.getClients().forEach(OctaneSDK::removeClient);
        UftTestDiscoveryDispatcher dispatcher = Jenkins.get().getExtensionList(UftTestDiscoveryDispatcher.class).get(0);
        dispatcher.close();
    }

    @Override
    public void onLocationChanged(Item item, String oldFullName, String newFullName) {

        if (!OctaneSDK.hasClients()) {
            return;
        }

        boolean skip = JobProcessorFactory.isFolder(item) || JobProcessorFactory.isMultibranchChild(item);//for MultibranchChild - there is a logic in Octane that handle child on parent event
        logger.info("onLocationChanged '" + oldFullName + "' to '" + newFullName + "'" + (skip ? ". Skipped." : ""));
        if (skip) {
            return;
        }

        try {
            CIEvent event = dtoFactory.newDTO(CIEvent.class).setEventType(CIEventType.RENAMED);
            if (JobProcessorFactory.isJob(item)) {
                event.setItemType(ItemType.JOB);
            } else if (JobProcessorFactory.isMultibranch(item)) {
                event.setItemType(ItemType.MULTI_BRANCH);
            } else {
                logger.info("Cannot handle onLocationChanged for " + item.getClass().getName());
                return;
            }

            event.setProject(BuildHandlerUtils.translateFolderJobName(newFullName))
                    .setProjectDisplayName(newFullName)
                    .setPreviousProject(BuildHandlerUtils.translateFolderJobName(oldFullName))
                    .setPreviousProjectDisplayName(oldFullName);

            CIJenkinsServicesImpl.publishEventToRelevantClients(event);
            OctaneSDK.getClients().forEach(c -> {
                if (c.getConfigurationService().removeFromOctaneRoots(event.getPreviousProject())) {
                    c.getConfigurationService().addToOctaneRootsCache(event.getProject());
                }
            });
        } catch (Throwable throwable) {
            logger.error("failed to build and/or dispatch RENAMED event for " + item, throwable);
        }
    }
}