You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2016/05/06 18:24:43 UTC

svn commit: r1742579 - in /maven/release/trunk/maven-release-manager/src: main/java/org/apache/maven/shared/release/phase/ main/java/org/apache/maven/shared/release/transform/jdom/ test/java/org/apache/maven/shared/release/transform/jdom/

Author: rfscholte
Date: Fri May  6 18:24:43 2016
New Revision: 1742579

URL: http://svn.apache.org/viewvc?rev=1742579&view=rev
Log:
[MRELEASE-952] Replace JDom as XML transformer
Introduce JDomModel

Added:
    maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomModel.java
    maven/release/trunk/maven-release-manager/src/test/java/org/apache/maven/shared/release/transform/jdom/JDomModelTest.java
Modified:
    maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java
    maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java
    maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForReleasePhase.java
    maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomScm.java

Modified: maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java?rev=1742579&r1=1742578&r2=1742579&view=diff
==============================================================================
--- maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java (original)
+++ maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java Fri May  6 18:24:43 2016
@@ -24,6 +24,7 @@ import java.util.List;
 import java.util.Map;
 
 import org.apache.maven.artifact.ArtifactUtils;
+import org.apache.maven.model.Model;
 import org.apache.maven.model.Scm;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.scm.repository.ScmRepository;
@@ -31,7 +32,7 @@ import org.apache.maven.shared.release.R
 import org.apache.maven.shared.release.ReleaseResult;
 import org.apache.maven.shared.release.config.ReleaseDescriptor;
 import org.apache.maven.shared.release.scm.ScmTranslator;
-import org.apache.maven.shared.release.transform.jdom.JDomScm;
+import org.apache.maven.shared.release.transform.jdom.JDomModel;
 import org.apache.maven.shared.release.util.ReleaseUtil;
 import org.jdom.Element;
 import org.jdom.Namespace;
@@ -53,18 +54,17 @@ public class RewritePomsForBranchPhase
         // If SCM is null in original model, it is inherited, no mods needed
         if ( project.getScm() != null )
         {
-            Element scmRoot = rootElement.getChild( "scm", namespace );
+            Model modelTarget = new JDomModel( rootElement );
+            Scm scmRoot = modelTarget.getScm();
             
             if ( scmRoot != null )
             {
-                Scm scmTarget = new JDomScm( scmRoot );
-                
                 Scm scm = buildScm( project );
                 releaseDescriptor.mapOriginalScmInfo( projectId, scm );
 
                 try
                 {
-                    translateScm( project, releaseDescriptor, scmTarget, scmRepository, result, commonBasedir );
+                    translateScm( project, releaseDescriptor, scmRoot, scmRepository, result, commonBasedir );
                 }
                 catch ( IOException e )
                 {
@@ -84,16 +84,16 @@ public class RewritePomsForBranchPhase
                     if ( !releaseDescriptor.getOriginalScmInfo().containsKey( parentId ) )
                     {
                         // we need to add it, since it has changed from the inherited value
-                        scmRoot = new Element( "scm" );
-                        scmRoot.addContent( "\n  " );
+                        scmRoot = new Scm();
+                        // reset default value (HEAD)
+                        scmRoot.setTag( null );
 
-                        Scm scmTarget = new JDomScm( scmRoot );
                         try
                         {
-                            if ( translateScm( project, releaseDescriptor, scmTarget, scmRepository, result,
+                            if ( translateScm( project, releaseDescriptor, scmRoot, scmRepository, result,
                                                commonBasedir ) )
                             {
-                                rootElement.addContent( "\n  " ).addContent( scmRoot ).addContent( "\n" );
+                                modelTarget.setScm( scmRoot );
                             }
                         }
                         catch ( IOException e )

Modified: maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java?rev=1742579&r1=1742578&r2=1742579&view=diff
==============================================================================
--- maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java (original)
+++ maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java Fri May  6 18:24:43 2016
@@ -22,6 +22,7 @@ package org.apache.maven.shared.release.
 import java.util.List;
 import java.util.Map;
 
+import org.apache.maven.model.Model;
 import org.apache.maven.model.Scm;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.scm.repository.ScmRepository;
@@ -29,7 +30,7 @@ import org.apache.maven.shared.release.R
 import org.apache.maven.shared.release.ReleaseResult;
 import org.apache.maven.shared.release.config.ReleaseDescriptor;
 import org.apache.maven.shared.release.scm.ScmTranslator;
-import org.apache.maven.shared.release.transform.jdom.JDomUtils;
+import org.apache.maven.shared.release.transform.jdom.JDomModel;
 import org.jdom.Element;
 import org.jdom.Namespace;
 
@@ -50,7 +51,9 @@ public class RewritePomsForDevelopmentPh
         // If SCM is null in original model, it is inherited, no mods needed
         if ( project.getScm() != null )
         {
-            Element scmRoot = rootElement.getChild( "scm", namespace );
+            Model modelTarget = new JDomModel( rootElement );
+            
+            Scm scmRoot = modelTarget.getScm();
             if ( scmRoot != null )
             {
                 @SuppressWarnings( "unchecked" )
@@ -69,16 +72,15 @@ public class RewritePomsForDevelopmentPh
 
                     if ( scm != null )
                     {
-                        JDomUtils.rewriteElement( "connection", scm.getConnection(), scmRoot, namespace );
-                        JDomUtils.rewriteElement( "developerConnection", scm.getDeveloperConnection(), scmRoot,
-                                                  namespace );
-                        JDomUtils.rewriteElement( "url", scm.getUrl(), scmRoot, namespace );
-                        JDomUtils.rewriteElement( "tag", translator.resolveTag( scm.getTag() ), scmRoot, namespace );
+                        scmRoot.setConnection( scm.getConnection() );
+                        scmRoot.setDeveloperConnection( scm.getDeveloperConnection() );
+                        scmRoot.setUrl( scm.getUrl() );
+                        scmRoot.setTag( translator.resolveTag( scm.getTag() ) );
                     }
                     else
                     {
                         // cleanly remove the SCM element
-                        JDomUtils.rewriteElement( "scm", null, rootElement, namespace );
+                        modelTarget.setScm( null );
                     }
                 }
                 else

Modified: maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForReleasePhase.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForReleasePhase.java?rev=1742579&r1=1742578&r2=1742579&view=diff
==============================================================================
--- maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForReleasePhase.java (original)
+++ maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForReleasePhase.java Fri May  6 18:24:43 2016
@@ -31,7 +31,7 @@ import org.apache.maven.shared.release.R
 import org.apache.maven.shared.release.ReleaseResult;
 import org.apache.maven.shared.release.config.ReleaseDescriptor;
 import org.apache.maven.shared.release.scm.ScmTranslator;
-import org.apache.maven.shared.release.transform.jdom.JDomScm;
+import org.apache.maven.shared.release.transform.jdom.JDomModel;
 import org.apache.maven.shared.release.util.ReleaseUtil;
 import org.jdom.Element;
 import org.jdom.Namespace;
@@ -54,16 +54,17 @@ public class RewritePomsForReleasePhase
         // If SCM is null in original model, it is inherited, no mods needed
         if ( project.getScm() != null )
         {
-            Element scmRoot = rootElement.getChild( "scm", namespace );
+            JDomModel model = new JDomModel( rootElement );
+            
+            Scm scmRoot = model.getScm();
             if ( scmRoot != null )
             {
                 Scm scm = buildScm( project );
                 releaseDescriptor.mapOriginalScmInfo( projectId, scm );
 
-                Scm scmTarget = new JDomScm( scmRoot );
                 try
                 {
-                    translateScm( project, releaseDescriptor, scmTarget, scmRepository, result, commonBasedir );
+                    translateScm( project, releaseDescriptor, scmRoot, scmRepository, result, commonBasedir );
                 }
                 catch ( IOException e )
                 {
@@ -83,16 +84,16 @@ public class RewritePomsForReleasePhase
                     if ( !releaseDescriptor.getOriginalScmInfo().containsKey( parentId ) )
                     {
                         // we need to add it, since it has changed from the inherited value
-                        scmRoot = new Element( "scm" );
-                        scmRoot.addContent( "\n  " );
-
-                        Scm scmTarget = new JDomScm( scmRoot );
+                        Scm scmTarget = new Scm();
+                        // reset default value (HEAD)
+                        scmTarget.setTag( null );
+                        
                         try
                         {
                             if ( translateScm( project, releaseDescriptor, scmTarget, scmRepository, result,
                                                commonBasedir ) )
                             {
-                                rootElement.addContent( "\n  " ).addContent( scmRoot ).addContent( "\n" );
+                                model.setScm( scmTarget );
                             }
                         }
                         catch ( IOException e )

Added: maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomModel.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomModel.java?rev=1742579&view=auto
==============================================================================
--- maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomModel.java (added)
+++ maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomModel.java Fri May  6 18:24:43 2016
@@ -0,0 +1,83 @@
+package org.apache.maven.shared.release.transform.jdom;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.maven.model.Model;
+import org.apache.maven.model.Scm;
+import org.jdom.Document;
+import org.jdom.Element;
+
+/**
+ * JDom implementation of poms PROJECT element
+ * 
+ * @author Robert Scholte
+ * @since 3.0
+ */
+public class JDomModel extends Model
+{
+    private Element project;
+    
+    public JDomModel( Document document )
+    {
+        this.project = document.getRootElement();
+    }
+    
+    public JDomModel( Element project )
+    {
+        this.project = project;
+    }
+    
+    @Override
+    public void setScm( Scm scm )
+    {
+        if ( scm == null )
+        {
+            JDomUtils.rewriteElement( "scm", null, project, project.getNamespace() );
+        }
+        else
+        {
+            Element scmRoot = new Element( "scm" );
+            scmRoot.addContent( "\n  " );
+            
+            // Write current values to JDom tree
+            Scm jdomScm = new JDomScm( scmRoot );
+            jdomScm.setConnection( scm.getConnection() );
+            jdomScm.setDeveloperConnection( scm.getDeveloperConnection() );
+            jdomScm.setTag( scm.getTag() );
+            jdomScm.setUrl( scm.getUrl() );
+            
+            project.addContent( "\n  " ).addContent( scmRoot ).addContent( "\n" );
+        }
+    }
+    
+    @Override
+    public Scm getScm()
+    {   Element elm = project.getChild( "scm", project.getNamespace() );
+        if ( elm == null )
+        {
+            return null;
+        }
+        else
+        {
+            // this way scm setters change DOM tree immediately
+            return new JDomScm( elm );
+        }
+    }
+}

Modified: maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomScm.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomScm.java?rev=1742579&r1=1742578&r2=1742579&view=diff
==============================================================================
--- maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomScm.java (original)
+++ maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom/JDomScm.java Fri May  6 18:24:43 2016
@@ -32,7 +32,7 @@ public class JDomScm extends Scm
 {
     private Element scm;
 
-    public JDomScm( Element scm )
+    JDomScm( Element scm )
     {
         this.scm = scm;
     }
@@ -84,4 +84,13 @@ public class JDomScm extends Scm
     {
         JDomUtils.rewriteElement( "url", url, scm, scm.getNamespace() );
     }
+
+    @Override
+    public int hashCode()
+    {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + ( ( scm == null ) ? 0 : scm.hashCode() );
+        return result;
+    }
 }

Added: maven/release/trunk/maven-release-manager/src/test/java/org/apache/maven/shared/release/transform/jdom/JDomModelTest.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-manager/src/test/java/org/apache/maven/shared/release/transform/jdom/JDomModelTest.java?rev=1742579&view=auto
==============================================================================
--- maven/release/trunk/maven-release-manager/src/test/java/org/apache/maven/shared/release/transform/jdom/JDomModelTest.java (added)
+++ maven/release/trunk/maven-release-manager/src/test/java/org/apache/maven/shared/release/transform/jdom/JDomModelTest.java Fri May  6 18:24:43 2016
@@ -0,0 +1,72 @@
+package org.apache.maven.shared.release.transform.jdom;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import static org.junit.Assert.*;
+
+import java.io.StringReader;
+
+import org.apache.maven.model.Model;
+import org.apache.maven.model.Scm;
+import org.jdom.Document;
+import org.jdom.input.SAXBuilder;
+import org.junit.Test;
+
+public class JDomModelTest
+{
+    private SAXBuilder builder = new SAXBuilder();
+    
+    @Test
+    public void testGetScm() throws Exception
+    {
+        String content = "<project></project>";
+        Document document = builder.build( new StringReader( content ) );
+        assertNull( new JDomModel( document ).getScm() );
+    }
+    
+    @Test
+    public void testSetScm() throws Exception
+    {
+        String content = "<project></project>";
+        Document document = builder.build( new StringReader( content ) );
+        Model model = new JDomModel( document );
+        assertNull( model.getScm() );
+        
+        model.setScm( new Scm() );
+        assertNull( model.getScm().getConnection() );
+        assertNull( model.getScm().getDeveloperConnection() );
+        assertEquals( "HEAD", model.getScm().getTag() ); // legacy default
+        assertNull( model.getScm().getUrl() );
+        
+        model.getScm().setConnection( "CONNECTION" );
+        assertEquals( "CONNECTION", model.getScm().getConnection() );
+        model.getScm().setDeveloperConnection( "DEVELOPERCONNECTION" );
+        assertEquals(  "DEVELOPERCONNECTION", model.getScm().getDeveloperConnection() );
+        model.getScm().setTag( "TAG" );
+        assertEquals( "TAG", model.getScm().getTag() );
+        model.getScm().setUrl( "URL" );
+        assertEquals( "URL", model.getScm().getUrl() );
+        
+        model.setScm( null );
+        assertNull( model.getScm() );
+    }
+    
+
+}