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.model.processors.scm;

import com.hp.octane.integrations.dto.DTOFactory;
import com.hp.octane.integrations.dto.scm.SCMChange;
import com.hp.octane.integrations.dto.scm.SCMCommit;
import com.hp.octane.integrations.dto.scm.SCMData;
import com.hp.octane.integrations.dto.scm.SCMRepository;
import com.hp.octane.integrations.dto.scm.SCMType;
import com.microfocus.application.automation.tools.octane.configuration.SDKBasedLoggerProvider;
import hudson.model.AbstractBuild;
import hudson.model.Run;
import hudson.model.User;
import hudson.model.UserProperty;
import hudson.scm.ChangeLogSet;
import hudson.scm.SCM;
import hudson.tasks.Mailer;
import org.apache.logging.log4j.Logger;
import org.jenkinsci.plugins.workflow.job.WorkflowRun;

import java.util.ArrayList;
import java.util.List;

/**
 * Created by benmeior on 9/8/2016.
 */

class GenericSCMProcessor implements SCMProcessor {
    private static final Logger logger = SDKBasedLoggerProvider.getLogger(GenericSCMProcessor.class);
    private static final DTOFactory dtoFactory = DTOFactory.getInstance();

    @Override
    public SCMData getSCMData(AbstractBuild build, SCM scm) {
        List<ChangeLogSet<? extends ChangeLogSet.Entry>> changes = new ArrayList<>();
        changes.add(build.getChangeSet());
        return extractSCMData(scm, changes);
    }

    @Override
    public SCMData getSCMData(WorkflowRun run, SCM scm) {
        return extractSCMData(scm, run.getChangeSets());
    }

    @Override
    public CommonOriginRevision getCommonOriginRevision(Run run) {
        return null;
    }

    private SCMData extractSCMData(SCM scm, List<ChangeLogSet<? extends ChangeLogSet.Entry>> changes) {
        logger.info("building generic scm data for SCM of type " + scm.getType());

        SCMRepository repository = buildScmRepository();
        List<SCMCommit> tmpCommits = extractCommits(changes);

        return dtoFactory.newDTO(SCMData.class)
                .setRepository(repository)
                .setCommits(tmpCommits);
    }

    private List<SCMCommit> extractCommits(List<ChangeLogSet<? extends ChangeLogSet.Entry>> changes) {
        List<SCMCommit> tmpCommits = new ArrayList<>();
        List<SCMChange> tmpChanges;
        SCMChange tmpChange;

        for (ChangeLogSet<? extends ChangeLogSet.Entry> set : changes) {
            for (ChangeLogSet.Entry change : set) {
                User user = change.getAuthor();
                String userEmail = null;

                tmpChanges = new ArrayList<>();

                for (ChangeLogSet.AffectedFile item : change.getAffectedFiles()) {
                    tmpChange = dtoFactory.newDTO(SCMChange.class)
                            .setType(item.getEditType().getName())
                            .setFile(item.getPath());
                    tmpChanges.add(tmpChange);
                }

                for (UserProperty property : user.getAllProperties()) {
                    if (property instanceof Mailer.UserProperty) {
                        userEmail = ((Mailer.UserProperty) property).getAddress();
                    }
                }
                SCMCommit tmpCommit = buildScmCommit(tmpChanges, change, userEmail);
                tmpCommits.add(tmpCommit);
            }
        }
        return tmpCommits;
    }

    private SCMCommit buildScmCommit(List<SCMChange> tmpChanges, ChangeLogSet.Entry commit, String userEmail) {
        return dtoFactory.newDTO(SCMCommit.class)
                .setTime(commit.getTimestamp())
                .setUser(commit.getAuthor().getId())
                .setUserEmail(userEmail)
                .setRevId(commit.getCommitId())
                .setComment(commit.getMsg().trim())
                .setChanges(tmpChanges);
    }

    private SCMRepository buildScmRepository() {
        return dtoFactory.newDTO(SCMRepository.class)
                .setType(SCMType.UNKNOWN);
    }
}