improved error message when trying to change the type of a view (#888)

Author: daspilker

docs/Home.md

@@ -40,6 +40,8 @@ Browse the Jenkins issue tracker to see any [open issues](https://issues.jenkins
    see [Job DSL Commands](Job-DSL-Commands#seed-job)
  * Fixed issues with embedded API Viewer
    ([#886](https://github.com/jenkinsci/job-dsl-plugin/pull/886))
+ * Improved error message when trying to change the type of a view
+   ([#888](https://github.com/jenkinsci/job-dsl-plugin/pull/888))
  * Removed anything that has been deprecated in 1.42, see [Migration](Migration#migrating-to-142)
 * 1.48 (June 24 2016)
  * Added option to ignore missing DSL script files or empty wildcards

job-dsl-plugin/src/main/groovy/javaposse/jobdsl/plugin/JenkinsJobManagement.java

@@ -169,6 +169,8 @@ public void createOrUpdateView(String path, String config, boolean ignoreExistin
                         LOGGER.log(Level.WARNING, format("Could not create view within %s", parent.getClass()));
                     }
                 } else if (!ignoreExisting) {
+                    checkItemType(view, inputStream);
+                    inputStream.reset();
                     view.updateByXml(new StreamSource(inputStream));
                 }
             } else if (parent == null) {
@@ -522,6 +524,27 @@ private void checkItemType(AbstractItem item, javaposse.jobdsl.dsl.Item dslItem)
         }
     }
 
+    private void checkItemType(View view, InputStream config) {
+        Node newConfig;
+
+        try {
+            newConfig = new XmlParser().parse(config);
+        } catch (Exception e) {
+            throw new DslException(format(
+                    Messages.UpdateExistingView_CouldNotParseConfig(),
+                    view.getViewName()
+            ), e);
+        }
+
+        Class viewType = Jenkins.XSTREAM2.getMapper().realClass(newConfig.name().toString());
+        if (!viewType.equals(view.getClass())) {
+            throw new DslException(format(
+                    Messages.UpdateExistingView_ViewTypeDoesNotMatch(),
+                    view.getViewName()
+            ));
+        }
+    }
+
     private boolean createNewItem(String path, javaposse.jobdsl.dsl.Item dslItem) {
         String config = dslItem.getXml();
         LOGGER.log(Level.FINE, format("Creating item as %s", config));

job-dsl-plugin/src/main/resources/javaposse/jobdsl/plugin/Messages.properties

@@ -28,3 +28,7 @@ UpdateExistingItem.CouldNotReadConfig=\
   Could not read configuration file %s for job %s
 UpdateExistingItem.ItemTypeDoesNotMatch=\
   Type of item "%s" does not match existing type, item type can not be changed
+UpdateExistingView.CouldNotParseConfig=\
+  Could not parse generated configuration for view "%s"
+UpdateExistingView.ViewTypeDoesNotMatch=\
+  Type of view "%s" does not match existing type, view type can not be changed

job-dsl-plugin/src/test/groovy/javaposse/jobdsl/plugin/JenkinsJobManagementSpec.groovy

@@ -5,6 +5,7 @@ import com.google.common.io.Resources
 import hudson.FilePath
 import hudson.LocalPluginManager
 import hudson.model.AbstractBuild
+import hudson.model.AllView
 import hudson.model.Cause
 import hudson.model.Failure
 import hudson.model.FreeStyleBuild
@@ -518,6 +519,22 @@ class JenkinsJobManagementSpec extends Specification {
         e.message == 'Type of item "my-job" does not match existing type, item type can not be changed'
     }
 
+    def 'createOrUpdateView should fail if view type does not match'() {
+        setup:
+        jenkinsRule.jenkins.addView(new AllView('foo'))
+
+        when:
+        jobManagement.createOrUpdateView(
+                'foo',
+                JenkinsJobManagementSpec.getResourceAsStream('/javaposse/jobdsl/dsl/views/ListView-template.xml').text,
+                false
+        )
+
+        then:
+        Exception e = thrown(DslException)
+        e.message == 'Type of view "foo" does not match existing type, view type can not be changed'
+    }
+
     def isMinimumPluginVersionInstalled() {
         when:
         boolean result = jobManagement.isMinimumPluginVersionInstalled('cvs', '0.1')