FailureCauseMatrixAggregator.java

/*
 * The MIT License
 *
 * Copyright 2012 Sony Ericsson Mobile Communications. All rights reserved.
 * Copyright 2012 Sony Mobile Communications AB. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.sonyericsson.jenkins.plugins.bfa;

import com.sonyericsson.jenkins.plugins.bfa.model.FailureCauseMatrixBuildAction;
import hudson.Launcher;
import hudson.matrix.MatrixAggregator;
import hudson.matrix.MatrixBuild;
import hudson.matrix.MatrixRun;
import hudson.model.BuildListener;

import java.util.LinkedList;
import java.util.List;

/**
 *  Aggregates the failure causes from downstream builds to the parent build.
 *
 *  @author Tomas Westling <thomas.westling@sonyericsson.com>
 */
public class FailureCauseMatrixAggregator extends MatrixAggregator {

    /**
     * Standard constructor.
     *
     * @param build the MatrixBuild to aggregate FailureCauses for.
     * @param launcher the launcher.
     * @param listener the listener.
     */
    public FailureCauseMatrixAggregator(MatrixBuild build, Launcher launcher, BuildListener listener) {
        super(build, launcher, listener);
    }

    @Override
    public boolean endBuild() {
        if (PluginImpl.shouldScan(build) && PluginImpl.needToAnalyze(build.getResult())) {
            List<MatrixRun> runsWithCorrectNumber = getRuns(build);
            build.addAction(new FailureCauseMatrixBuildAction(build, runsWithCorrectNumber));
        }
        return true;
    }

    /**
     * Gets the runs that has the same number as the build.
     *
     * @param matrixBuild the build.
     * @return the list of runs.
     */
    public static List<MatrixRun> getRuns(MatrixBuild matrixBuild) {
        List<MatrixRun> runs = matrixBuild.getRuns();
        List<MatrixRun> runsWithCorrectNumber = new LinkedList<MatrixRun>();
        for (MatrixRun run : runs) {
            if (run.getNumber() == matrixBuild.getNumber()) {
                runsWithCorrectNumber.add(run);
            }
        }
        return runsWithCorrectNumber;
    }
}