BuildContributorsController.java

/*
 *  The MIT License
 *
 *  Copyright 2011 Sony Ericsson Mobile Communications. 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.hudson.plugins.metadata.contributors;

import com.sonyericsson.hudson.plugins.metadata.Messages;
import com.sonyericsson.hudson.plugins.metadata.model.MetadataBuildAction;
import com.sonyericsson.hudson.plugins.metadata.model.MetadataJobProperty;
import com.sonyericsson.hudson.plugins.metadata.model.values.MetadataValue;
import com.sonyericsson.hudson.plugins.metadata.model.values.TreeStructureUtil;
import hudson.Extension;
import hudson.ExtensionList;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.model.JobProperty;
import hudson.model.TaskListener;
import hudson.model.listeners.RunListener;

import java.util.Collection;
import java.util.List;
import java.util.logging.Logger;

/**
 * The controller for {@link BuildMetadataContributor}s.
 *
 * @author Robert Sandell <robert.sandell@sonyericsson.com>
 */
@Extension
public class BuildContributorsController extends RunListener<AbstractBuild> {

    private static final Logger logger = Logger.getLogger(BuildContributorsController.class.getName());

    @Override
    public void onCompleted(AbstractBuild build, TaskListener listener) {
        logger.entering(BuildContributorsController.class.getName(), "onCompleted({0})", build);
        MetadataBuildAction action = build.getAction(MetadataBuildAction.class);
        if (action == null) {
            action = new MetadataBuildAction();
            build.addAction(action);
        }
        listener.getLogger().println(Messages.BuildContributorsController_LogMessage_Collecting());
        logger.finest("Starting collection.");
        ExtensionList<BuildMetadataContributor> contributors = BuildMetadataContributor.all();
        for (BuildMetadataContributor contributor : contributors) {
            List<MetadataValue> values = contributor.getMetaDataFor(build);
            Collection<MetadataValue> leftovers = action.addChildren(values);
            if (leftovers != null && !leftovers.isEmpty()) {
                String pretty = "\n" + TreeStructureUtil.prettyPrint(leftovers, "\t");
                listener.getLogger().println(
                        Messages.BuildContributorsController_LogMessage_LeftOvers(pretty));
                logger.warning("Some metadata failed to be merged for build " + build + pretty);
            }
        }
        listener.getLogger().println(Messages.BuildContributorsController_LogMessage_Done());
        logger.finest("Done collecting.");
    }

    /**
     * Adds all the job metadata as build metadata.
     * @param build the build to work with.
     * @param listener the listener for this build. This can be used to produce log messages, for example,
     *      which becomes a part of the "console output" of this build.
     */
    @Override
    public void onStarted(AbstractBuild build, TaskListener listener) {
        logger.entering(BuildContributorsController.class.getName(), "onStarted({0})", build);
        AbstractProject project = build.getProject();
        JobProperty property = project.getProperty(MetadataJobProperty.class);
        if (property == null) {
            return;
        }
        MetadataBuildAction action = build.getAction(MetadataBuildAction.class);
        if (action == null) {
            action = new MetadataBuildAction();
            build.addAction(action);
        }

        MetadataJobProperty metadataJobProperty = (MetadataJobProperty)property;
        logger.finest("Starting job to build metadata conversion.");
        for (MetadataValue value : metadataJobProperty.getChildren()) {
            try {
                action.addChild(value.clone());
            } catch (CloneNotSupportedException e) {
                listener.getLogger().println(
                        Messages.BuildContributorsController_LogMessage_CopyFailure(e.getMessage()));
                logger.warning("Could not copy the job metadata: " + e.getMessage());
            }
        }
        logger.finest("Done converting.");
    }
}