src/tests/junit/org/apache/tools/ant/taskdefs/optional/unix/SymlinkTest.java - ant - Git at Google

 /*
  *  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
  *
  *      https://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.
  *
  */

 /*
  * Since the initial version of this file was developed on the clock on
  * an NSF grant I should say the following boilerplate:
  *
  * This material is based upon work supported by the National Science
  * Foundation under Grant No. EIA-0196404. Any opinions, findings, and
  * conclusions or recommendations expressed in this material are those
  * of the author and do not necessarily reflect the views of the
  * National Science Foundation.
  */

 package org.apache.tools.ant.taskdefs.optional.unix;

 import org.apache.tools.ant.BuildFileRule;
 import org.apache.tools.ant.taskdefs.condition.Os;

 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.util.SymbolicLinkUtils;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;

 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assume.assumeTrue;

 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;

 /**
  * Test cases for the Symlink task. Link creation, link deletion, recording
  * of links in multiple directories, and restoration of links recorded are
  * all tested. A separate test for the utility method Symlink.deleteSymlink
  * is not included because action="delete" only prints a message and calls
  * Symlink.deleteSymlink, making a separate test redundant.
  *
  */

 public class SymlinkTest {

     @Rule
     public BuildFileRule buildRule = new BuildFileRule();

     @Before
     public void setUp() {
         assumeTrue("Symlinks not supported on current operating system", Os.isFamily("unix"));
         buildRule.configureProject("src/etc/testcases/taskdefs/optional/unix/symlink.xml");
         buildRule.executeTarget("setUp");
     }

     @Test
     public void testSingle() {
         buildRule.executeTarget("test-single");
         Project p = buildRule.getProject();
         assertNotNull("Failed to create file",
                           p.getProperty("test.single.file.created"));
         assertNotNull("Failed to create link",
                           p.getProperty("test.single.link.created"));
     }

     @Test
     public void testDelete() {
         buildRule.executeTarget("test-delete");
         Project p = buildRule.getProject();
         assertNotNull("Actual file deleted by symlink",
                       p.getProperty("test.delete.file.still.there"));
         String linkDeleted = p.getProperty("test.delete.link.still.there");
         assertNull(linkDeleted, linkDeleted);
     }

     @Test
     public void testRecord() {
         buildRule.executeTarget("test-record");
         Project p = buildRule.getProject();

         assertNotNull("Failed to create dir1",
                       p.getProperty("test.record.dir1.created"));

         assertNotNull("Failed to create dir2",
                       p.getProperty("test.record.dir2.created"));

         assertNotNull("Failed to create file1",
                       p.getProperty("test.record.file1.created"));

         assertNotNull("Failed to create file2",
                       p.getProperty("test.record.file2.created"));

         assertNotNull("Failed to create fileA",
                       p.getProperty("test.record.fileA.created"));

         assertNotNull("Failed to create fileB",
                       p.getProperty("test.record.fileB.created"));

         assertNotNull("Failed to create fileC",
                       p.getProperty("test.record.fileC.created"));

         assertNotNull("Failed to create link1",
                       p.getProperty("test.record.link1.created"));

         assertNotNull("Failed to create link2",
                       p.getProperty("test.record.link2.created"));

         assertNotNull("Failed to create link3",
                       p.getProperty("test.record.link3.created"));

         assertNotNull("Failed to create dirlink",
                       p.getProperty("test.record.dirlink.created"));

         assertNotNull("Failed to create dirlink2",
                       p.getProperty("test.record.dirlink2.created"));

         assertNotNull("Couldn't record links in dir1",
                       p.getProperty("test.record.dir1.recorded"));

         assertNotNull("Couldn't record links in dir2",
                       p.getProperty("test.record.dir2.recorded"));

         String dir3rec = p.getProperty("test.record.dir3.recorded");
         assertNull(dir3rec, dir3rec);
     }

     @Test
     public void testRecreate() {
         buildRule.executeTarget("test-recreate");
         Project p = buildRule.getProject();
         String link1Rem = p.getProperty("test.recreate.link1.not.removed");
         String link2Rem = p.getProperty("test.recreate.link2.not.removed");
         String link3Rem = p.getProperty("test.recreate.link3.not.removed");
         String dirlinkRem = p.getProperty("test.recreate.dirlink.not.removed");

         assertNull(link1Rem, link1Rem);
         assertNull(link2Rem ,link2Rem);
         assertNull(link3Rem ,link3Rem);
         assertNull(dirlinkRem ,dirlinkRem);

         assertNotNull("Failed to recreate link1",
                       p.getProperty("test.recreate.link1.recreated"));
         assertNotNull("Failed to recreate link2",
                       p.getProperty("test.recreate.link2.recreated"));
         assertNotNull("Failed to recreate link3",
                       p.getProperty("test.recreate.link3.recreated"));
         assertNotNull("Failed to recreate dirlink",
                       p.getProperty("test.recreate.dirlink.recreated"));

         String doubleRecreate = p.getProperty("test.recreate.dirlink2.recreated.twice");
         assertNull(doubleRecreate, doubleRecreate);

         assertNotNull("Failed to alter dirlink3",
                       p.getProperty("test.recreate.dirlink3.was.altered"));
     }

     @Test
     public void testSymbolicLinkUtilsMethods() throws Exception {

         buildRule.executeTarget("test-fileutils");
         SymbolicLinkUtils su = SymbolicLinkUtils.getSymbolicLinkUtils();

         File f = new File(buildRule.getOutputDir(), "file1");
         assertTrue(f.exists());
         assertFalse(f.isDirectory());
         assertTrue(f.isFile());
         assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isSymbolicLink(f.getParentFile(),
                                       f.getName()));
         assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
                                               f.getName()));

         f = new File(buildRule.getOutputDir(), "dir1");
         assertTrue(f.exists());
         assertTrue(f.isDirectory());
         assertFalse(f.isFile());
         assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isSymbolicLink(f.getParentFile(),
                                       f.getName()));
         assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
                                               f.getName()));

         f = new File(buildRule.getOutputDir(), "file2");
         assertFalse(f.exists());
         assertFalse(f.isDirectory());
         assertFalse(f.isFile());
         assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isSymbolicLink(f.getParentFile(),
                                       f.getName()));
         assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
                                               f.getName()));

         f = new File(buildRule.getOutputDir(), "dir2");
         assertFalse(f.exists());
         assertFalse(f.isDirectory());
         assertFalse(f.isFile());
         assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isSymbolicLink(f.getParentFile(),
                                       f.getName()));
         assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
                                               f.getName()));


         f = new File(buildRule.getOutputDir(), "file.there");
         assertTrue(f.exists());
         assertFalse(f.isDirectory());
         assertTrue(f.isFile());
         assertTrue(su.isSymbolicLink(f.getAbsolutePath()));
         assertTrue(su.isSymbolicLink(f.getParentFile(),
                                      f.getName()));
         assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
                                               f.getName()));

         f = new File(buildRule.getOutputDir(), "dir.there");
         assertTrue(f.exists());
         assertTrue(f.isDirectory());
         assertFalse(f.isFile());
         assertTrue(su.isSymbolicLink(f.getAbsolutePath()));
         assertTrue(su.isSymbolicLink(f.getParentFile(),
                                      f.getName()));
         assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
                                               f.getName()));

         // it is not possible to find out that symbolic links pointing
         // to nonexistent files or directories are symbolic links
         // it used to be possible to detect this on Mac
         // this is not true under Snow Leopard and JDK 1.5
         // Removing special handling of MacOS until someone shouts
         // Antoine
         f = new File(buildRule.getOutputDir(), "file.notthere");
         assertFalse(f.exists());
         assertFalse(f.isDirectory());
         assertFalse(f.isFile());
         assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isSymbolicLink(f.getParentFile(), f.getName()));
         assertTrue(su.isDanglingSymbolicLink(f.getAbsolutePath()));
         assertTrue(su.isDanglingSymbolicLink(f.getParentFile(),
                                              f.getName()));

         f = new File(buildRule.getOutputDir(), "dir.notthere");
         assertFalse(f.exists());
         assertFalse(f.isDirectory());
         assertFalse(f.isFile());
         assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
         assertFalse(su.isSymbolicLink(f.getParentFile(), f.getName()));
         assertTrue(su.isDanglingSymbolicLink(f.getAbsolutePath()));
         assertTrue(su.isDanglingSymbolicLink(f.getParentFile(),
                                              f.getName()));

     }

     /**
      * Tests that when {@code symlink} task is used to create a symbolic link and {@code overwrite} option
      * is {@code false}, then any existing symbolic link at the {@code link} location (whose target is a directory)
      * doesn't end up create a new symbolic link within the target directory.
      *
      * @throws Exception if something goes wrong
      * @see <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=58683">BZ-58683</a> for more details
      */
     @Test
     public void testOverwriteExistingLink() throws Exception {
         buildRule.executeTarget("test-overwrite-link");
         final Project p = buildRule.getProject();
         final String linkTargetResource = p.getProperty("test.overwrite.link.target.dir");
         assertNotNull("Property test.overwrite.link.target.dir is not set", linkTargetResource);
         final Path targetResourcePath = Paths.get(linkTargetResource);
         assertTrue(targetResourcePath + " is not a directory", Files.isDirectory(targetResourcePath));
         assertEquals(targetResourcePath + " directory was expected to be empty", 0, Files.list(targetResourcePath).count());
     }

     @After
     public void tearDown() {
         if (buildRule.getProject() != null) {
             buildRule.executeTarget("tearDown");
         }
     }

 }
	/*
	* 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
	*
	* https://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.
	*
	*/

	/*
	* Since the initial version of this file was developed on the clock on
	* an NSF grant I should say the following boilerplate:
	*
	* This material is based upon work supported by the National Science
	* Foundation under Grant No. EIA-0196404. Any opinions, findings, and
	* conclusions or recommendations expressed in this material are those
	* of the author and do not necessarily reflect the views of the
	* National Science Foundation.
	*/

	package org.apache.tools.ant.taskdefs.optional.unix;

	import org.apache.tools.ant.BuildFileRule;
	import org.apache.tools.ant.taskdefs.condition.Os;

	import org.apache.tools.ant.Project;
	import org.apache.tools.ant.util.SymbolicLinkUtils;
	import org.junit.After;
	import org.junit.Before;
	import org.junit.Rule;
	import org.junit.Test;

	import static org.junit.Assert.assertEquals;
	import static org.junit.Assert.assertFalse;
	import static org.junit.Assert.assertNotNull;
	import static org.junit.Assert.assertNull;
	import static org.junit.Assert.assertTrue;
	import static org.junit.Assume.assumeTrue;

	import java.io.File;
	import java.nio.file.Files;
	import java.nio.file.Path;
	import java.nio.file.Paths;

	/**
	* Test cases for the Symlink task. Link creation, link deletion, recording
	* of links in multiple directories, and restoration of links recorded are
	* all tested. A separate test for the utility method Symlink.deleteSymlink
	* is not included because action="delete" only prints a message and calls
	* Symlink.deleteSymlink, making a separate test redundant.
	*
	*/

	public class SymlinkTest {

	@Rule
	public BuildFileRule buildRule = new BuildFileRule();

	@Before
	public void setUp() {
	assumeTrue("Symlinks not supported on current operating system", Os.isFamily("unix"));
	buildRule.configureProject("src/etc/testcases/taskdefs/optional/unix/symlink.xml");
	buildRule.executeTarget("setUp");
	}

	@Test
	public void testSingle() {
	buildRule.executeTarget("test-single");
	Project p = buildRule.getProject();
	assertNotNull("Failed to create file",
	p.getProperty("test.single.file.created"));
	assertNotNull("Failed to create link",
	p.getProperty("test.single.link.created"));
	}

	@Test
	public void testDelete() {
	buildRule.executeTarget("test-delete");
	Project p = buildRule.getProject();
	assertNotNull("Actual file deleted by symlink",
	p.getProperty("test.delete.file.still.there"));
	String linkDeleted = p.getProperty("test.delete.link.still.there");
	assertNull(linkDeleted, linkDeleted);
	}

	@Test
	public void testRecord() {
	buildRule.executeTarget("test-record");
	Project p = buildRule.getProject();

	assertNotNull("Failed to create dir1",
	p.getProperty("test.record.dir1.created"));

	assertNotNull("Failed to create dir2",
	p.getProperty("test.record.dir2.created"));

	assertNotNull("Failed to create file1",
	p.getProperty("test.record.file1.created"));

	assertNotNull("Failed to create file2",
	p.getProperty("test.record.file2.created"));

	assertNotNull("Failed to create fileA",
	p.getProperty("test.record.fileA.created"));

	assertNotNull("Failed to create fileB",
	p.getProperty("test.record.fileB.created"));

	assertNotNull("Failed to create fileC",
	p.getProperty("test.record.fileC.created"));

	assertNotNull("Failed to create link1",
	p.getProperty("test.record.link1.created"));

	assertNotNull("Failed to create link2",
	p.getProperty("test.record.link2.created"));

	assertNotNull("Failed to create link3",
	p.getProperty("test.record.link3.created"));

	assertNotNull("Failed to create dirlink",
	p.getProperty("test.record.dirlink.created"));

	assertNotNull("Failed to create dirlink2",
	p.getProperty("test.record.dirlink2.created"));

	assertNotNull("Couldn't record links in dir1",
	p.getProperty("test.record.dir1.recorded"));

	assertNotNull("Couldn't record links in dir2",
	p.getProperty("test.record.dir2.recorded"));

	String dir3rec = p.getProperty("test.record.dir3.recorded");
	assertNull(dir3rec, dir3rec);
	}

	@Test
	public void testRecreate() {
	buildRule.executeTarget("test-recreate");
	Project p = buildRule.getProject();
	String link1Rem = p.getProperty("test.recreate.link1.not.removed");
	String link2Rem = p.getProperty("test.recreate.link2.not.removed");
	String link3Rem = p.getProperty("test.recreate.link3.not.removed");
	String dirlinkRem = p.getProperty("test.recreate.dirlink.not.removed");

	assertNull(link1Rem, link1Rem);
	assertNull(link2Rem ,link2Rem);
	assertNull(link3Rem ,link3Rem);
	assertNull(dirlinkRem ,dirlinkRem);

	assertNotNull("Failed to recreate link1",
	p.getProperty("test.recreate.link1.recreated"));
	assertNotNull("Failed to recreate link2",
	p.getProperty("test.recreate.link2.recreated"));
	assertNotNull("Failed to recreate link3",
	p.getProperty("test.recreate.link3.recreated"));
	assertNotNull("Failed to recreate dirlink",
	p.getProperty("test.recreate.dirlink.recreated"));

	String doubleRecreate = p.getProperty("test.recreate.dirlink2.recreated.twice");
	assertNull(doubleRecreate, doubleRecreate);

	assertNotNull("Failed to alter dirlink3",
	p.getProperty("test.recreate.dirlink3.was.altered"));
	}

	@Test
	public void testSymbolicLinkUtilsMethods() throws Exception {

	buildRule.executeTarget("test-fileutils");
	SymbolicLinkUtils su = SymbolicLinkUtils.getSymbolicLinkUtils();

	File f = new File(buildRule.getOutputDir(), "file1");
	assertTrue(f.exists());
	assertFalse(f.isDirectory());
	assertTrue(f.isFile());
	assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isSymbolicLink(f.getParentFile(),
	f.getName()));
	assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
	f.getName()));

	f = new File(buildRule.getOutputDir(), "dir1");
	assertTrue(f.exists());
	assertTrue(f.isDirectory());
	assertFalse(f.isFile());
	assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isSymbolicLink(f.getParentFile(),
	f.getName()));
	assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
	f.getName()));

	f = new File(buildRule.getOutputDir(), "file2");
	assertFalse(f.exists());
	assertFalse(f.isDirectory());
	assertFalse(f.isFile());
	assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isSymbolicLink(f.getParentFile(),
	f.getName()));
	assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
	f.getName()));

	f = new File(buildRule.getOutputDir(), "dir2");
	assertFalse(f.exists());
	assertFalse(f.isDirectory());
	assertFalse(f.isFile());
	assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isSymbolicLink(f.getParentFile(),
	f.getName()));
	assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
	f.getName()));


	f = new File(buildRule.getOutputDir(), "file.there");
	assertTrue(f.exists());
	assertFalse(f.isDirectory());
	assertTrue(f.isFile());
	assertTrue(su.isSymbolicLink(f.getAbsolutePath()));
	assertTrue(su.isSymbolicLink(f.getParentFile(),
	f.getName()));
	assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
	f.getName()));

	f = new File(buildRule.getOutputDir(), "dir.there");
	assertTrue(f.exists());
	assertTrue(f.isDirectory());
	assertFalse(f.isFile());
	assertTrue(su.isSymbolicLink(f.getAbsolutePath()));
	assertTrue(su.isSymbolicLink(f.getParentFile(),
	f.getName()));
	assertFalse(su.isDanglingSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isDanglingSymbolicLink(f.getParentFile(),
	f.getName()));

	// it is not possible to find out that symbolic links pointing
	// to nonexistent files or directories are symbolic links
	// it used to be possible to detect this on Mac
	// this is not true under Snow Leopard and JDK 1.5
	// Removing special handling of MacOS until someone shouts
	// Antoine
	f = new File(buildRule.getOutputDir(), "file.notthere");
	assertFalse(f.exists());
	assertFalse(f.isDirectory());
	assertFalse(f.isFile());
	assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isSymbolicLink(f.getParentFile(), f.getName()));
	assertTrue(su.isDanglingSymbolicLink(f.getAbsolutePath()));
	assertTrue(su.isDanglingSymbolicLink(f.getParentFile(),
	f.getName()));

	f = new File(buildRule.getOutputDir(), "dir.notthere");
	assertFalse(f.exists());
	assertFalse(f.isDirectory());
	assertFalse(f.isFile());
	assertFalse(su.isSymbolicLink(f.getAbsolutePath()));
	assertFalse(su.isSymbolicLink(f.getParentFile(), f.getName()));
	assertTrue(su.isDanglingSymbolicLink(f.getAbsolutePath()));
	assertTrue(su.isDanglingSymbolicLink(f.getParentFile(),
	f.getName()));

	}

	/**
	* Tests that when {@code symlink} task is used to create a symbolic link and {@code overwrite} option
	* is {@code false}, then any existing symbolic link at the {@code link} location (whose target is a directory)
	* doesn't end up create a new symbolic link within the target directory.
	*
	* @throws Exception if something goes wrong
	* @see <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=58683">BZ-58683</a> for more details
	*/
	@Test
	public void testOverwriteExistingLink() throws Exception {
	buildRule.executeTarget("test-overwrite-link");
	final Project p = buildRule.getProject();
	final String linkTargetResource = p.getProperty("test.overwrite.link.target.dir");
	assertNotNull("Property test.overwrite.link.target.dir is not set", linkTargetResource);
	final Path targetResourcePath = Paths.get(linkTargetResource);
	assertTrue(targetResourcePath + " is not a directory", Files.isDirectory(targetResourcePath));
	assertEquals(targetResourcePath + " directory was expected to be empty", 0, Files.list(targetResourcePath).count());
	}

	@After
	public void tearDown() {
	if (buildRule.getProject() != null) {
	buildRule.executeTarget("tearDown");
	}
	}

	}