maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] michael-o closed pull request #28: Fix for SCM-695 : Mvn release plugin problems with too many - in name
Date Fri, 28 Dec 2018 13:10:07 GMT
michael-o closed pull request #28: Fix for SCM-695 : Mvn release plugin problems with too many
- in name
URL: https://github.com/apache/maven-scm/pull/28
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtils.java
b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtils.java
index 2599273d9..21243ba55 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtils.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtils.java
@@ -61,12 +61,19 @@ public static void addTarget( Commandline cl, List<File> files )
                 final String canonicalFile = file.getCanonicalPath();
                 if ( canonicalFile.startsWith( canonicalWorkingDirectory ) )
                 {
+                    // SCM-695 : the strippedPath could be wrong-->do not replace relativeFile
until it is tested.
                     // so we can omit the starting characters
-                    relativeFile = canonicalFile.substring( canonicalWorkingDirectory.length()
);
+                    String strippedPath = canonicalFile.substring( canonicalWorkingDirectory.length()
);
 
-                    if ( relativeFile.startsWith( File.separator ) )
+                    if ( strippedPath.startsWith( File.separator ) )
                     {
-                        relativeFile = relativeFile.substring( File.separator.length() );
+                        strippedPath = strippedPath.substring( File.separator.length() );
+                    }
+
+                    // SCM-695 : the stripped path MUST exist to replace relativeFile.
+                    if ( new File( workingDirectory, strippedPath ).exists() )
+                    {
+                        relativeFile = strippedPath;
                     }
                 }
 
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtilsAddTargetTest.java
b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtilsAddTargetTest.java
index 65749222b..ae6f434bf 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtilsAddTargetTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtilsAddTargetTest.java
@@ -25,12 +25,18 @@
 import static org.junit.Assume.assumeTrue;
 
 import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
 import java.text.MessageFormat;
 import java.util.Arrays;
 import java.util.List;
 
+import org.apache.commons.io.FileUtils;
 import org.codehaus.plexus.util.Os;
 import org.codehaus.plexus.util.cli.Commandline;
+import org.junit.After;
+import org.junit.Before;
 import org.junit.Test;
 
 /**
@@ -38,6 +44,19 @@
  */
 public class GitCommandLineUtilsAddTargetTest
 {
+	//SCM-695 we need to test that files exist, so the test must create a test file tree. We
will store the usefull file descriptors to avoid create File with hardcoded strings that must
deals with OS differences.
+	private static final String DIR_NAME__TEST_ROOT = "GitCommandLineUtilsAddTargetTest";
+	private static final String DIR_NAME__PARENT_PROJECT = "prj";
+	private static final String DIR_NAME__CHILD_PROJECT = "mod1";
+	private static final String DIR_NAME__CHILD_PROJECT__PREFIXED_WITH_PARENT_PROJECT_DIR_NAME
= "prj-mod1";
+	private static final String FILE_NAME__POM = "pom.xml";
+	
+	private File myParentProject ;
+	private File myPomFromParentProject ;
+	private File myPomFromChildProjectInSubfolder ;
+	private File myPomFromChildProjectInSiblingFolder ;
+	private File myPomFromChildProjectInSiblingFolderWithPrefixedName ;
+	private File myRootOfTestFiles ;
 
     /**
      * Test of addTarget method, of class GitCommandLineUtils on Non-Windows
@@ -47,12 +66,27 @@
     public void testAddTargetNonWindows()
     {
         assumeTrue( !runsOnWindows() );
-        final File workingDir = new File( "/prj" );
-        final List<File> filesToAdd = Arrays.asList( new File( "/prj/pom.xml" ), new
File( "/prj/mod1/pom.xml" ) );
+        final File workingDir = myParentProject;
+        final List<File> filesToAdd = Arrays.asList( myPomFromParentProject, myPomFromChildProjectInSubfolder
);
         final String expectedArguments = "[add, pom.xml, mod1/pom.xml]";
         check( workingDir, filesToAdd, expectedArguments );
     }
 
+    //SCM-695 test flat projects.
+    /**
+     * Test of addTarget method, of class GitCommandLineUtils
+     * systems, on flat project (parent and submodule are at the same location).
+     * @throws IOException if there is a problem that cannot be dealt with.
+     */
+    @Test
+    public void testAddTargetForFlatProject() throws IOException
+    {
+        final File workingDir = myParentProject ;
+        final List<File> filesToAdd = Arrays.asList( myPomFromParentProject, myPomFromChildProjectInSiblingFolder,
myPomFromChildProjectInSiblingFolderWithPrefixedName);
+        final String expectedArguments = "[add, pom.xml, "+myPomFromChildProjectInSiblingFolder.getCanonicalPath()+",
"+myPomFromChildProjectInSiblingFolderWithPrefixedName.getCanonicalPath()+"]";
+        check( workingDir, filesToAdd, expectedArguments );
+    }
+
     /**
      * Test of addTarget method, of class GitCommandLineUtils on Windows.
      */
@@ -60,11 +94,11 @@ public void testAddTargetNonWindows()
     public void testAddTargetWindows()
     {
         assumeTrue( runsOnWindows() );
-        final File workingDir = new File( "C:\\prj" );
+        final File workingDir = myParentProject;
         // Note that the second file has a lowercase drive letter, see
         // https://jira.codehaus.org/browse/SCM-667
-        final List<File> filesToAdd = Arrays.asList( new File( "C:\\prj\\pom.xml" ),
-            new File( "c:\\prj\\mod1\\pom.xml" ) );
+        final List<File> filesToAdd = Arrays.asList( myPomFromParentProject,
+            new File( myPomFromChildProjectInSubfolder.getAbsolutePath().toLowerCase() )
);
         final String expectedArguments = "[add, pom.xml, mod1\\pom.xml]";
         check( workingDir, filesToAdd, expectedArguments );
     }
@@ -74,7 +108,7 @@ private void check( final File workingDir, final List<File> filesToAdd,
final St
         final Commandline cl = GitCommandLineUtils.getBaseGitCommandLine( workingDir, "add"
);
         GitCommandLineUtils.addTarget( cl, filesToAdd );
         final String arguments = Arrays.toString( cl.getArguments() );
-        assertEquals( 3, cl.getArguments().length );
+        assertEquals( 1+filesToAdd.size(), cl.getArguments().length );
         assertEquals( expectedArguments, arguments );
     }
 
@@ -108,4 +142,69 @@ private boolean runsOnWindows()
     {
         return Os.isFamily( Os.FAMILY_WINDOWS );
     }
+    
+
+    /**
+     * Create a temp file tree because we need testing file existence.
+     * @throws IOException if there is a problem that cannot be dealt with.
+     */
+    @Before
+    public void createTestFileTree() throws IOException {
+    	//This implementation seems overkill but is OS agnostic.
+    	final File tempDir = new File(getSystemTempDir());
+		myRootOfTestFiles = makeSubdir(tempDir, DIR_NAME__TEST_ROOT);
+
+		myParentProject = makeSubdir(myRootOfTestFiles, DIR_NAME__PARENT_PROJECT) ;
+    	myPomFromParentProject = createDummyFile(myParentProject, FILE_NAME__POM);
+
+    	final File projectInsideParentFolder = makeSubdir(myParentProject, DIR_NAME__CHILD_PROJECT);
+    	myPomFromChildProjectInSubfolder = createDummyFile(projectInsideParentFolder, FILE_NAME__POM);
+
+    	final File projectInSiblingFolder = makeSubdir(myRootOfTestFiles, DIR_NAME__CHILD_PROJECT);
+    	myPomFromChildProjectInSiblingFolder = createDummyFile(projectInSiblingFolder, FILE_NAME__POM);
+    	
+    	final File projectInPrefixedSiblingFolder = makeSubdir(myRootOfTestFiles, DIR_NAME__CHILD_PROJECT__PREFIXED_WITH_PARENT_PROJECT_DIR_NAME);
+    	myPomFromChildProjectInSiblingFolderWithPrefixedName = createDummyFile(projectInPrefixedSiblingFolder,
FILE_NAME__POM);
+    }
+    
+    @After
+    public void deleteTestFileTree() throws IOException {
+    	FileUtils.deleteDirectory(myRootOfTestFiles);
+    }
+
+	/**
+	 * @param directory
+	 * @param fileName
+	 * @throws FileNotFoundException
+	 * @throws IOException
+	 */
+	private static File createDummyFile(final File directory, String fileName) throws FileNotFoundException,
IOException
+	{
+		File pom = new File(directory,fileName);
+    	FileOutputStream out = new FileOutputStream(pom);
+    	out.write(0);
+    	out.close();
+    	return pom ;
+	}
+
+	/**
+	 * @param parent directory into which the directory will be created.
+	 * @param name name of the directory to create.
+	 * @return the file descriptor.
+	 */
+	private static File makeSubdir(final File parent, final String name)
+	{
+		final File rootDir = new File(parent, name);
+    	rootDir.mkdir();
+		return rootDir;
+	}
+
+	/**
+	 * @return
+	 */
+	private static String getSystemTempDir()
+	{
+		return System.getProperty("java.io.tmpdir");
+	}
+
 }
\ No newline at end of file


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message