<diffsummarize> and <list> subcommands for <svn> [Tigris #1213]

[markphip]

Description

This patch adds two subcommands to the <svn> task: <diffsummarize> and <list>.
They're not yet terribly useful as they're limited to displaying the output in
the way the svn command line client does.

They could be possibly improved, however, to make their data available to Ant as
resources, which would allow you to script some more development and
distribution logic (like branching and exporting differences) in Ant.

There's also a new Ant script called svnant.xml which is where I have some basic
smoke tests for changed tasks. It is not intended to last, merely a playground
to explore the svnClientAdapter API. I'm aware of the existing real test files
in the project, but at this point I prefer to keep test stuff separate.

Metadata Imported from Tigris (Issue 1213)

• Creation Date: 2010-11-15 14:21:24
• Reporter: lumi
• Subcomponent: svnant
• Version: unspecified
• Milestone: not determined
• Keywords:
• Cc:

Comments

2010-11-15 14:23:33 by lumi

Created an attachment (id=330)
see issue description

2010-12-30 04:17:34 by costamojan

I already filed a path for 'list' long ago:

   http://subclipse.tigris.org/issues/show_bug.cgi?id=862

Best regards

costamojan

2011-01-11 14:26:33 by costamojan

The 'diffSummarize' command has been included to the current codebase revision
4814. The 'list' command has not been incorporated since I've basically done the
same in the past. If you feel that the current implementation of the 'list'
command lacks some features I suggest to open another issue for this.
The 'svnant.xml' has also been ignored because a test should be implemented the
"usual" way. I'm aware that the current test setup isn't optimal and I will make
some changes in future but for now we should go with the running stuff.
You can find the current development release at the following location:

   http://www.kasisoft.com/hudson/job/svnant

In order to close this issue I expect at least a patch for the documentation of
'svnant'. An ideal case is an extension of the 'SvnTest' class which provides at
least one testcase for the 'diffSummarize' task.

Best regards

Daniel Kasmeroglu

2011-08-08 21:45:28 by shoelace

i get an error when using diffsummarize 

a stripped ant -v output..



      [svn] Using javahl
      [svn] <DiffSummarize> started ...
      [svn] # to outfile: C:\patch
      [svn] diff --summarize --ignoreAncestry <url1>@HEAD <url2>@HEAD
svn: In file '..\..\..\subversion\libsvn_delta\depth_filter_editor.c' line 125: 
internal malfunction


C:\>ant -version
Apache Ant(TM) version 1.8.2 compiled on December 20 2010

svnant version 1.3.1

i tried using teh cmdline version but it failed also with a 

org.tigris.subversion.svnclientadapter.SVNClientException: Not implemented yet
        at 
org.tigris.subversion.svnclientadapter.AbstractClientAdapter.notImplementedYet(A
bstractClientAdapter.java:268)
        at 
org.tigris.subversion.svnclientadapter.commandline.CmdLineClientAdapter.diffSumm
arize(CmdLineClientAdapter.java:1703)
        at org.tigris.subversion.svnant.commands.DiffSummarize.execute(Unknown 
Source)

Attachments

summlist.diff - see issue description

Posted 2010-11-15 14:23:33 by lumi

### Eclipse Workspace Patch 1.0
#P svnant
Index: src/main/org/tigris/subversion/svnant/SvnTask.java
===================================================================
--- src/main/org/tigris/subversion/svnant/SvnTask.java  (revision 4760)
+++ src/main/org/tigris/subversion/svnant/SvnTask.java  (working copy)
@@ -55,7 +55,7 @@
 package org.tigris.subversion.svnant;

 import java.util.ArrayList;
-import java.util.List;
+// java.util.List vs org...svnant.commands.List
 import java.util.TimeZone;

 import org.apache.tools.ant.BuildException;
@@ -71,6 +71,7 @@
 import org.tigris.subversion.svnant.commands.CreateRepository;
 import org.tigris.subversion.svnant.commands.Delete;
 import org.tigris.subversion.svnant.commands.Diff;
+import org.tigris.subversion.svnant.commands.DiffSummarize;
 import org.tigris.subversion.svnant.commands.Export;
 import org.tigris.subversion.svnant.commands.Feedback;
 import org.tigris.subversion.svnant.commands.Ignore;
@@ -79,6 +80,7 @@
 import org.tigris.subversion.svnant.commands.Keywordsadd;
 import org.tigris.subversion.svnant.commands.Keywordsremove;
 import org.tigris.subversion.svnant.commands.Keywordsset;
+import org.tigris.subversion.svnant.commands.List;
 import org.tigris.subversion.svnant.commands.Log;
 import org.tigris.subversion.svnant.commands.Mkdir;
 import org.tigris.subversion.svnant.commands.Move;
@@ -122,8 +124,8 @@
     private TimeZone dateTimeZone = null;
    private boolean failonerror = true;

-    private List commands = new ArrayList();
-    private List notifyListeners = new ArrayList();
+    private java.util.List commands = new ArrayList();
+    private java.util.List notifyListeners = new ArrayList();

    /* (non-Javadoc)
     * @see org.tigris.subversion.svnant.ISvnAntProjectComponent#getJavahl()
@@ -285,6 +287,14 @@
         addCommand(a);
     }

+    public void addDiffSummarize(DiffSummarize a) {
+       addCommand(a);
+   }
+
+    public void addList(List a) {
+       addCommand(a);
+   }
+
     public void addKeywordsSet(Keywordsset a) {
         addCommand(a);
     }
Index: svnant.xml
===================================================================
--- svnant.xml  (revision 0)
+++ svnant.xml  (revision 0)
@@ -0,0 +1,136 @@
+<!-- vim: set filetype=ant: -->
+<project name="svnant-selftest" default="what-is-this">
+
+   <typedef resource="org/tigris/subversion/svnant/svnantlib.xml"
+       classpath="build/lib/svnant.jar"/>
+
+   <!-- This script needs Javascript (included in JDK 1.6). -->
+   <property name="sun.js.engine"
+       value="com.sun.script.javascript.RhinoScriptEngine"/>
+   <fail message="${sun.js.engine} required (included in Sun JDK 1.6)">
+       <condition><not>
+       <available classname="${sun.js.engine}"/>
+       </not></condition>
+   </fail>
+
+   <!-- look in prop file for default values -->
+   <property file="svnant.properties"/>
+   <property name="svn.wc.dir" location="${user.dir}"/><!-- fallback -->
+   <!-- more properties from project -->
+   <property name="example.propfile" location="build.properties.example"/>
+
+   <target name="what-is-this">
+<echo>This is an SvnAnt self-smoke-test for current changes.
+Run with -p for the list of targets.
+There are existing test scripts in "test/*/build.xml".
+They're driven by subclasses of "org.tigris.subversion.svnant.SvnTest".
+They take quite some time to run, though.</echo>
+   </target>
+
+   <macrodef name="keep"><!-- stop when file present -->
+       <attribute name="file"/>
+       <sequential>
+           <fail message="keep existing @{file}">
+               <condition><resourceexists><file file="@{file}"/></resourceexists>
+               </condition></fail></sequential>
+   </macrodef>
+
+   <!-- ==== setup ====================================================== -->
+
+   <target name="init" unless="my.test.propfile">
+       <property name="my.test.propfile" location="svnant-selftest.properties"/>
+       <!-- copy and edit example prop file to use its properties -->
+       <keep file="${my.test.propfile}"/>
+       <copy file="${example.propfile}" tofile="${my.test.propfile}"/>
+       <echo>uncomment properties, read them from file, delete it</echo>
+       <!-- uncomment properties -->
+       <replaceregexp file="${my.test.propfile}" byline="true"
+           match="^#([a-zA-Z].*=.*)" replace="\1"/>
+       <!-- use it and delete it -->
+       <property file="${my.test.propfile}"/>
+       <delete file="${my.test.propfile}"/>
+       <!-- temporary test files -->
+       <property name="my.tmp.dir" location="svnant.tmp.d"/>
+       <mkdir dir="${my.tmp.dir}"/>
+       <property name="outfile.diff"     location="${my.tmp.dir}/patch.diff"/>
+       <property name="outfile.diff.2"   location="${my.tmp.dir}/patch2.diff"/>
+       <property name="outfile.diffsumm" location="${my.tmp.dir}/diffsumm.txt"/>
+   </target>
+
+   <target name="svn-init" unless="svn.info.url">
+       <!-- let info task set svn properties -->
+       <svn><info target="${svn.wc.dir}"/></svn>
+       <echoproperties prefix="svn.info"/>
+<script language="javascript"><![CDATA[
+importClass(org.tigris.subversion.svnclientadapter.SVNClientAdapterFactory);
+importClass(org.tigris.subversion.svnclientadapter.javahl.JhlClientAdapterFactory);
+var refid = "svn.client";
+var refid2 = "svnclient"; // valid Java identifier => var defined in Javascript
+self.log("set up svn client reference as " + refid);
+var svn = SVNClientAdapterFactory.createSVNClient(JhlClientAdapterFactory.JAVAHL_CLIENT);
+project.addReference(refid, svn); // make client available in project
+self.log("and also as " + refid2);
+project.addReference(refid2, svn);
+self.log(svn.getClass());
+]]></script>
+   </target>
+
+   <!-- ==== testing svn subtasks ======================================= -->
+
+   <target name="wcv" depends="init" description="test &lt;wcVersion>">
+       <svn>
+           <wcVersion path="${lib.dir}" prefix="svn.wcv" />
+           <wcVersion path="${lib.dir}"/>
+       </svn>
+       <echoproperties prefix="svn.wcv"/><!-- all props set by wcVersion -->
+       <echoproperties prefix="committed"/><!-- props reading "committed" -->
+   </target>
+
+   <target name="list" depends="init, svn-init" description="test &lt;list>">
+       <svn>
+           <!-- try various combinations -->
+           <list path="."/>
+           <list path="${src.doc.dir}" revision="99" />
+           <list path="${src.main.dir}" recurse="true" />
+           <list url="${svn.info.url}" />
+           <list url="${svn.info.url}" revision="99" />
+           <list url="${svn.info.url}/${src.doc.dir}" revision="3999" recurse="true" />
+       </svn>
+   </target>
+
+   <target name="clean" depends="init"
+       description="delete leftover test files">
+       <delete file="${outfile.diff}"/>
+       <delete file="${outfile.diff.2}"/>
+       <delete file="${outfile.diffsumm}"/>
+   </target>
+
+   <target name="diff" depends="init, svn-init"
+       description="test &lt;diff>">
+       <property name="my.path.1" value="${svn.info.path}/${src.doc.dir}"/>
+       <property name="my.path.2" value="${svn.info.path}/${lib.dir}"/>
+       <svn>
+           <!-- default outfile name outfile.diff = "patch" -->
+           <diff outFile="${outfile.diff}"
+               oldPath="${my.path.1}" oldTargetRevision="PREV"
+               newPath="${my.path.1}" newTargetRevision="${svn.info.rev}"/>
+           <diff outFile="${outfile.diff.2}"
+               oldPath="${my.path.2}" oldTargetRevision="PREV"
+               newPath="${my.path.2}" newTargetRevision="${svn.info.rev}"/>
+       </svn>
+   </target>
+
+   <target name="summ" depends="init, svn-init"
+       description="test &lt;diffsummarize>">
+       <svn>
+           <diffsummarize depth="3" ancestry="false"
+               oldUrl="${svn.info.url}" oldTargetRevision="${svn.r1}"
+               newUrl="${svn.info.url}" newTargetRevision="${svn.r2}"/>
+           <diffsummarize depth="333" ancestry="true"
+               outFile="${outfile.diffsumm}" encoding="latin1"
+               oldUrl="${svn.info.url}" oldTargetRevision="${svn.r1}"
+               newUrl="${svn.info.url}" newTargetRevision="${svn.r2}"/>
+       </svn>
+   </target>
+
+</project>
Index: src/main/org/tigris/subversion/svnant/commands/DiffSummarize.java
===================================================================
--- src/main/org/tigris/subversion/svnant/commands/DiffSummarize.java   (revision 0)
+++ src/main/org/tigris/subversion/svnant/commands/DiffSummarize.java   (revision 0)
@@ -0,0 +1,103 @@
+package org.tigris.subversion.svnant.commands;
+
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
+import org.apache.tools.ant.BuildException;
+import org.tigris.subversion.svnant.SvnAntException;
+import org.tigris.subversion.svnclientadapter.SVNClientException;
+import org.tigris.subversion.svnclientadapter.SVNDiffSummary;
+
+/**
+ * Diff summary (as in "svn diff --summarize"). The first version only displays
+ * the diff summary as the CLI client does. The objective is to make the
+ * resources available for manipulation by other tasks.
+ * 
+ * @author Michael Ludwig
+ */
+public class DiffSummarize extends Diff
+{
+   private int depth = 1000; // default depth of directory tree descent
+   private boolean ignoreAncestry = true;
+   private boolean logToFile = false;
+   private String encoding = "UTF-8";
+
+   public void setEncoding( String e )
+   {
+       this.encoding = e;
+   }
+
+   @Override
+   public void setOutFile( File f )
+   {
+       super.setOutFile(f);
+       this.logToFile = true;
+   }
+
+   /*
+    * ISVNClientAdapter#diffSummarize : parameter ignoreAncestry = false
+    * svn CLI : --notice-ancestry
+    * svnant : ancestry="true"
+    */
+   public void setAncestry( boolean b )
+   {
+       this.ignoreAncestry = ! b;
+   }
+
+   public void setDepth( int d )
+   {
+       this.depth = d;
+   }
+
+   @Override
+   public void execute() throws SvnAntException
+   {
+       BufferedWriter out = null;
+       if ( logToFile ) {
+           File f = this.getOutFile();
+           try {
+               log("output to file: " + f);
+               out = new BufferedWriter(new OutputStreamWriter(
+                       ( new FileOutputStream(f) ), encoding));
+           } catch ( Exception e ) {
+               throw new BuildException(e);
+           }
+       }
+       try {
+           logAction(true); // summarize only supported on repo, so on URLs
+           SVNDiffSummary[] summary = svnClient.diffSummarize(
+                   getOldUrl(), getOldTargetRevision(),
+                   getNewUrl(), getNewTargetRevision(),
+                   depth, ignoreAncestry);
+           for ( SVNDiffSummary s : summary ) {
+               StringBuilder sb = new StringBuilder(
+                       s.getDiffKind().toString().substring(0, 1).toUpperCase());
+               assert ( sb.equals("A") || sb.equals("M") || sb.equals("D") );
+               sb.append(s.propsChanged() ? "M" : " ");
+               // log(String.format("%s %s %s\n", status, propSt, s.getPath()));
+               sb.append(" ");
+               sb.append(s.getPath());
+               if ( logToFile ) {
+                   sb.append("\n");
+                   out.write(sb.toString());
+               } else
+                   log(sb.toString());
+               // [svn] AM Kram/ElsterMiLu71HH.pfx
+           }
+       } catch ( SVNClientException e ) {
+           throw new SvnAntException(e);
+       } catch ( IOException e ) {
+           throw new BuildException(e);
+       } finally {
+           if ( null != out ) {
+               try {
+                   out.close();
+               } catch ( IOException e ) {
+                   e.printStackTrace();
+               }
+           }
+       }
+   }
+}
Index: src/main/org/tigris/subversion/svnant/commands/Diff.java
===================================================================
--- src/main/org/tigris/subversion/svnant/commands/Diff.java    (revision 4760)
+++ src/main/org/tigris/subversion/svnant/commands/Diff.java    (working copy)
@@ -77,16 +77,28 @@
     private File newPath = null;
     private SVNRevision oldTargetRevision = null;
     private SVNRevision newTargetRevision = null;
-    private File outFile = new File("patch");
+    private File outFile;
     private boolean recurse = true; 

+    protected SVNUrl getOldUrl() { return oldUrl; }
+    protected SVNUrl getNewUrl() { return newUrl; }
+    protected File getOldPath() { return oldPath; }
+    protected File getNewPath() { return newPath; }
+    protected SVNRevision getOldTargetRevision() { return oldTargetRevision; }
+    protected SVNRevision getNewTargetRevision() { return newTargetRevision; }
+    protected File getOutFile() { return outFile; }
+
    /* (non-Javadoc)
     * @see org.tigris.subversion.svnant.SvnCommand#execute(org.tigris.subversion.svnclientadapter.SVNClientAdapter)
     */
    public void execute() throws SvnAntException {
+        if (null == outFile)
+            outFile = new File("patch"); // default outfile name
+        boolean gotUrl = null != oldUrl;
+        logAction(gotUrl);

         try {
-            if (oldUrl != null)
+            if (gotUrl)
                 svnClient.diff(oldUrl, oldTargetRevision,
                                newUrl, newTargetRevision,
                                outFile, recurse);
@@ -99,6 +111,23 @@
         }
    }

+   protected void logAction( boolean gotUrl )
+   {
+       StringBuilder sb = new StringBuilder("# diff ");
+       sb.append(gotUrl ? oldUrl : oldPath);
+       sb.append(" ");
+       sb.append(oldTargetRevision);
+       log(sb.toString());
+       sb.setLength(0);
+       sb.append("#      ");
+       sb.append(gotUrl ? newUrl : newPath);
+       sb.append(" ");
+       sb.append(newTargetRevision);
+       log(sb.toString());
+       if (null != outFile)
+           log("# to outfile: " + outFile.getAbsolutePath());
+   }
+
     /**
      * Ensure we have a consistent and legal set of attributes
      */
Index: src/main/org/tigris/subversion/svnant/commands/List.java
===================================================================
--- src/main/org/tigris/subversion/svnant/commands/List.java    (revision 0)
+++ src/main/org/tigris/subversion/svnant/commands/List.java    (revision 0)
@@ -0,0 +1,75 @@
+package org.tigris.subversion.svnant.commands;
+
+import java.io.File;
+import org.tigris.subversion.svnant.SvnAntException;
+import org.tigris.subversion.svnant.SvnAntValidationException;
+import org.tigris.subversion.svnclientadapter.ISVNDirEntry;
+import org.tigris.subversion.svnclientadapter.SVNClientException;
+import org.tigris.subversion.svnclientadapter.SVNRevision;
+import org.tigris.subversion.svnclientadapter.SVNUrl;
+
+/**
+ * List SVN resources as the CLI command "svn list" does. Looking into how this
+ * can be cast into a resource, which Ant knows how to manipulate.
+ * 
+ * @author Michael Ludwig
+ */
+public class List extends SvnCommand
+{
+   private File path;
+   private SVNUrl url;
+   private SVNRevision revision;
+   private boolean recurse;
+
+   public void setPath( File f )
+   {
+       this.path = f;
+   }
+
+   public void setUrl( SVNUrl u )
+   {
+       this.url = u;
+   }
+
+   public void setRevision( String r )
+   {
+       this.revision = this.getRevisionFrom(r);
+   }
+
+   public void setRecurse( boolean b )
+   {
+       this.recurse = b;
+   }
+
+   @Override
+   public void execute() throws SvnAntException
+   {
+       ISVNDirEntry[] entries = null;
+       StringBuilder sb = new StringBuilder("# list ");
+       try {
+           sb.append(null != path ? path : url);
+           sb.append(" ");
+           sb.append(revision);
+           if ( recurse )
+               sb.append(" (recursive)");
+           log(sb.toString());
+           if ( null != path )
+               entries = svnClient.getList(path, revision, recurse);
+           else
+               entries = svnClient.getList(url, revision, recurse);
+           for ( ISVNDirEntry e : entries )
+               log(e.getPath());
+       } catch ( SVNClientException e ) {
+           // requests for non-existing path/rev combinations trigger exceptions
+       }
+   }
+
+   @Override
+   protected void validateAttributes() throws SvnAntValidationException
+   {
+       if ( ! ( null == path ^ null == url ) )
+           throw new SvnAntValidationException("specify either file or url");
+       if ( null == revision )
+           revision = this.getRevisionFrom("HEAD");
+   }
+}
Index: svnant.properties.example
===================================================================
--- svnant.properties.example   (revision 0)
+++ svnant.properties.example   (revision 0)
@@ -0,0 +1,3 @@
+svn.r1 = 4100
+svn.r2 = 4200
+svn.wc.dir = ${basedir}