[FIXED JENKINS-8797] added CLI commands to manipulate jobs by their XML

definitions.
jenkinsci · Aug 10, 2011 · 6b2af91 · 6b2af91
1 parent 64a6428
commit 6b2af91
Show file tree

Hide file tree

Showing 4 changed files with 135 additions and 28 deletions.
diff --git a/changelog.html b/changelog.html
@@ -86,6 +86,9 @@
   <li class=rfe>
     If CLI fails to connect via a JNLP Slave port, fall back to HTTP full-duplex.
     (<a href="https://issues.jenkins-ci.org/browse/JENKINS-10611">issue 10611</a>)
+  <li class=rfe>
+    Added two CLI commands to manipulate job by its XML definition.
+    (<a href="https://issues.jenkins-ci.org/browse/JENKINS-8797">issue 8797</a>)
   <li class=rfe>
     Fixed unclear text for Tabs with no jobs
     (<a href="https://issues.jenkins-ci.org/browse/JENKINS-9330">issue 9330</a>)

diff --git a/core/src/main/java/hudson/cli/GetJobXmlCommand.java b/core/src/main/java/hudson/cli/GetJobXmlCommand.java
@@ -0,0 +1,50 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2011, CloudBees, Inc.
+ *
+ * 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 hudson.cli;
+
+import hudson.model.AbstractProject;
+import hudson.model.Item;
+import hudson.util.IOUtils;
+import org.kohsuke.args4j.Argument;
+
+/**
+ * @author Kohsuke Kawaguchi
+ */
+public class GetJobXmlCommand extends CLICommand {
+    @Argument(metaVar="JOB",usage="Name of the job",required=true)
+    public AbstractProject<?,?> job;
+
+    @Override
+    public String getShortDescription() {
+        return "Dumps the job definition XML to stdout";
+    }
+
+    protected int run() throws Exception {
+        job.checkPermission(Item.EXTENDED_READ);
+        IOUtils.copy(
+            job.getConfigFile().getFile(),
+            stdout);
+        return 0;
+    }
+}
diff --git a/core/src/main/java/hudson/cli/UpdateJobXmlCommand.java b/core/src/main/java/hudson/cli/UpdateJobXmlCommand.java
@@ -0,0 +1,49 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2011, CloudBees, Inc.
+ *
+ * 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 hudson.cli;
+
+import hudson.model.AbstractProject;
+import hudson.util.IOUtils;
+import org.kohsuke.args4j.Argument;
+
+import javax.xml.transform.stream.StreamSource;
+
+/**
+ * @author Kohsuke Kawaguchi
+ */
+public class UpdateJobXmlCommand extends CLICommand {
+    @Argument(metaVar="JOB",usage="Name of the job",required=true)
+    public AbstractProject<?,?> job;
+
+    @Override
+    public String getShortDescription() {
+        return "Updates the job definition XML from stdin. The opposite of the get-job-xml command";
+    }
+
+    protected int run() throws Exception {
+        job.updateByXml(new StreamSource(stdin));
+        return 0;
+    }
+}
+
diff --git a/core/src/main/java/hudson/model/AbstractItem.java b/core/src/main/java/hudson/model/AbstractItem.java
@@ -51,10 +51,8 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
 import org.kohsuke.stapler.StaplerRequest;
@@ -509,39 +507,46 @@ public void doConfigDotXml(StaplerRequest req, StaplerResponse rsp)
         }
         if (req.getMethod().equals("POST")) {
             // submission
-            checkPermission(CONFIGURE);
-            XmlFile configXmlFile = getConfigFile();
-            AtomicFileWriter out = new AtomicFileWriter(configXmlFile.getFile());
-            try {
-                try {
-                    // this allows us to use UTF-8 for storing data,
-                    // plus it checks any well-formedness issue in the submitted
-                    // data
-                    Transformer t = TransformerFactory.newInstance()
-                            .newTransformer();
-                    t.transform(new StreamSource(req.getReader()),
-                            new StreamResult(out));
-                    out.close();
-                } catch (TransformerException e) {
-                    throw new IOException2("Failed to persist configuration.xml", e);
-                }
-
-                // try to reflect the changes by reloading
-                new XmlFile(Items.XSTREAM, out.getTemporaryFile()).unmarshal(this);
-                onLoad(getParent(), getRootDir().getName());
-
-                // if everything went well, commit this new version
-                out.commit();
-            } finally {
-                out.abort(); // don't leave anything behind
-            }
+            updateByXml(new StreamSource(req.getReader()));
             return;
         }
 
         // huh?
         rsp.sendError(SC_BAD_REQUEST);
     }
 
+    /**
+     * Updates Job by its XML definition.
+     */
+    public void updateByXml(StreamSource source) throws IOException {
+        checkPermission(CONFIGURE);
+        XmlFile configXmlFile = getConfigFile();
+        AtomicFileWriter out = new AtomicFileWriter(configXmlFile.getFile());
+        try {
+            try {
+                // this allows us to use UTF-8 for storing data,
+                // plus it checks any well-formedness issue in the submitted
+                // data
+                Transformer t = TransformerFactory.newInstance()
+                        .newTransformer();
+                t.transform(source,
+                        new StreamResult(out));
+                out.close();
+            } catch (TransformerException e) {
+                throw new IOException2("Failed to persist configuration.xml", e);
+            }
+
+            // try to reflect the changes by reloading
+            new XmlFile(Items.XSTREAM, out.getTemporaryFile()).unmarshal(this);
+            onLoad(getParent(), getRootDir().getName());
+
+            // if everything went well, commit this new version
+            out.commit();
+        } finally {
+            out.abort(); // don't leave anything behind
+        }
+    }
+
     public String toString() {
         return super.toString()+'['+getFullName()+']';
     }