From 6345068235b780fca82dff59ecd3ec2ed00b09f5 Mon Sep 17 00:00:00 2001 From: Stephane Bailliez Date: Wed, 14 Nov 2001 22:19:39 +0000 Subject: [PATCH] Fixed the description bug reported by Gerhard Langs Description is now backslashed so that delimiters are backslashed correctly and do not confuse Oro. Based on a patch from Magesh Umasankar Added basic test case to ensure fix. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269914 13f79535-47bb-0310-9956-ffa450edef68 --- .../taskdefs/optional/perforce/P4Change.java | 25 +++++- .../optional/perforce/P4ChangeTest.java | 89 +++++++++++++++++++ 2 files changed, 112 insertions(+), 2 deletions(-) create mode 100644 src/testcases/org/apache/tools/ant/taskdefs/optional/perforce/P4ChangeTest.java diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java index 40cc38007..825571bcc 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java @@ -58,8 +58,6 @@ package org.apache.tools.ant.taskdefs.optional.perforce; - - import org.apache.tools.ant.BuildException; import org.apache.tools.ant.Project; @@ -120,6 +118,8 @@ public class P4Change extends P4Base { } else if(util.match("//",line)) { + // we need to escape the description in case there are / + description = backslash(description); line = util.substitute("s//" + description + "/", line); } else if(util.match("/\\/\\//", line)) { @@ -136,6 +136,27 @@ public class P4Change extends P4Base { return stringbuf.toString(); } + /** + * Ensure that a string is backslashing slashes so that it does not + * confuse them with Perl substitution delimiter in Oro. Backslashes are + * always backslashes in a string unless they escape the delimiter. + * @param value the string to backslash for slashes + * @return the backslashed string + * @see < a href="http://jakarta.apache.org/oro/api/org/apache/oro/text/perl/Perl5Util.html#substitute(java.lang.String,%20java.lang.String)">Oro + */ + protected String backslash(String value){ + final StringBuffer buf = new StringBuffer(value.length()); + final int len = value.length(); + for (int i = 0; i < len; i++){ + char c = value.charAt(i); + if (c == '/'){ + buf.append('\\'); + } + buf.append(c); + } + return buf.toString(); + } + /* Set Description Variable. */ public void setDescription(String desc){ this.description = desc; diff --git a/src/testcases/org/apache/tools/ant/taskdefs/optional/perforce/P4ChangeTest.java b/src/testcases/org/apache/tools/ant/taskdefs/optional/perforce/P4ChangeTest.java new file mode 100644 index 000000000..a9ff06422 --- /dev/null +++ b/src/testcases/org/apache/tools/ant/taskdefs/optional/perforce/P4ChangeTest.java @@ -0,0 +1,89 @@ +/* + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2000 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, if + * any, must include the following acknowlegement: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowlegement may appear in the software itself, + * if and wherever such third-party acknowlegements normally appear. + * + * 4. The names "The Jakarta Project", "Ant", and "Apache Software + * Foundation" must not be used to endorse or promote products derived + * from this software without prior written permission. For written + * permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache" + * nor may "Apache" appear in their names without prior written + * permission of the Apache Group. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ +package org.apache.tools.ant.taskdefs.optional.perforce; + +import junit.framework.TestCase; +import org.apache.oro.text.perl.Perl5Util; + +/** + * Basic testcase to ensure that backslashing is OK. + * @author Stephane Bailliez + */ +public class P4ChangeTest extends TestCase { + + protected P4Change p4change; + + public P4ChangeTest(String s) { + super(s); + } + + protected void setUp() throws Exception { + p4change = new P4Change(); + } + + public void testBackslash(){ + String input = "comment with a / inside"; + String output = p4change.backslash(input); + assertEquals("comment with a \\/ inside", output); + } + + public void testSubstitute(){ + Perl5Util util = new Perl5Util(); + String tosubstitute = "xxxx"; + String input = p4change.backslash("/a/b/c/"); + String output = util.substitute("s//" + input + "/", tosubstitute); + assertEquals("xx/a/b/c/xx", output); + } + +}