hudson.cli.ListChangesCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudson-core Show documentation
Contains the core Hudson code and view files to render HTML.
The newest version!
/*******************************************************************************
 *
 * Copyright (c) 2004-2010 Oracle Corporation.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *
 *
 *******************************************************************************/ 

package hudson.cli;

import hudson.Extension;
import hudson.model.AbstractBuild;
import hudson.scm.ChangeLogSet;
import hudson.scm.ChangeLogSet.Entry;
import hudson.util.QuotedStringTokenizer;
import org.kohsuke.args4j.Option;
import org.kohsuke.stapler.export.Flavor;
import org.kohsuke.stapler.export.Model;
import org.kohsuke.stapler.export.ModelBuilder;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;

/**
 * Retrieves a change list for the specified builds.
 *
 * @author Kohsuke Kawaguchi
 */
@Extension
public class ListChangesCommand extends AbstractBuildRangeCommand {

    @Override
    public String getShortDescription() {
        return "Dumps the changelog for the specified build(s)";
    }

//    @Override
//    protected void printUsageSummary(PrintStream stderr) {
//        TODO
//    }
    enum Format {

        XML, CSV, PLAIN
    }
    @Option(name = "-format", usage = "Controls how the output from this command is printed.")
    public Format format = Format.PLAIN;

    @Override
    protected int act(List> builds) throws IOException {
        // Loading job for this CLI command requires Item.READ permission.
        // No other permission check needed.
        switch (format) {
            case XML:
                PrintWriter w = new PrintWriter(stdout);
                w.println("");
                for (AbstractBuild build : builds) {
                    w.println("");
                    ChangeLogSet cs = build.getChangeSet();
                    Model p = new ModelBuilder().get(cs.getClass());
                    p.writeTo(cs, Flavor.XML.createDataWriter(cs, w));
                    w.println("");
                }
                w.println("");
                w.flush();
                break;
            case CSV:
                for (AbstractBuild build : builds) {
                    ChangeLogSet cs = build.getChangeSet();
                    for (Entry e : cs) {
                        stdout.printf("%s,%s\n",
                                QuotedStringTokenizer.quote(e.getAuthor().getId()),
                                QuotedStringTokenizer.quote(e.getMsg()));
                    }
                }
                break;
            case PLAIN:
                for (AbstractBuild build : builds) {
                    ChangeLogSet cs = build.getChangeSet();
                    for (Entry e : cs) {
                        stdout.printf("%s\t%s\n", e.getAuthor(), e.getMsg());
                        for (String p : e.getAffectedPaths()) {
                            stdout.println("  " + p);
                        }
                    }
                }
                break;
        }

        return 0;
    }
}