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

package org.apache.tools.ant.util;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.attribute.PosixFileAttributeView;
import java.nio.file.attribute.PosixFilePermission;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.Locale;
import java.util.Optional;
import java.util.Set;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.MagicTestNames;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.taskdefs.condition.Os;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.TemporaryFolder;

import static org.apache.tools.ant.util.FileUtils.getFileUtils;
import static org.apache.tools.ant.util.FileUtils.isCaseSensitiveFileSystem;
import static org.apache.tools.ant.util.FileUtils.isContextRelativePath;
import static org.hamcrest.Matchers.containsInAnyOrder;
import static org.hamcrest.Matchers.endsWith;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.startsWith;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeFalse;
import static org.junit.Assume.assumeTrue;

/**
 * Tests for org.apache.tools.ant.util.FileUtils.
 *
 */
public class FileUtilsTest {

    @Rule
    public ExpectedException thrown = ExpectedException.none();

    @Rule
    public TemporaryFolder folder = new TemporaryFolder();

    private static final String ROOT = System.getProperty(MagicTestNames.TEST_ROOT_DIRECTORY);
    private String root;

    @Before
    public void setUp() {
        // Windows adds the drive letter in uppercase, unless you run Cygwin
        root = new File(File.separator).getAbsolutePath().toUpperCase();
    }

    /**
     * test modification.
     * Since Ant1.7, the method being tested no longer uses
     * reflection to provide backwards support to Java1.1, so this
     * test is not so critical. But it does explore file system
     * behaviour and will help catch any regression in Java itself,
     * so is worth retaining.
     * @see FileUtils#setFileLastModified(java.io.File, long)
     * @throws IOException if something goes wrong
     */
    @Test
    public void testSetLastModified() throws IOException {
        File removeThis = folder.newFile("dummy");
        try (FileOutputStream fos = new FileOutputStream(removeThis)) {
            fos.write(new byte[0]);
        }
        assumeTrue("Could not change file modified time",
                removeThis.setLastModified(removeThis.lastModified() - 2000));
        long modTime = removeThis.lastModified();
        assertNotEquals(0, modTime);

        getFileUtils().setFileLastModified(removeThis, -1);
        long secondModTime = removeThis.lastModified();
        assertTrue(secondModTime > modTime);

        // number of milliseconds in a day
        final int millisperday = 24 * 3600 * 1000;
        // in a previous version, the date of the file was set to 123456
        // milliseconds since 01.01.1970
        // it did not work on a computer running JDK 1.4.1_02 + Windows 2000
        getFileUtils().setFileLastModified(removeThis, secondModTime + millisperday);
        long thirdModTime = removeThis.lastModified();
        /*
         * I would love to compare this with 123456, but depending on
         * the filesystems granularity it can take an arbitrary value.
         *
         * Just assert the time has changed.
         */
        assertNotEquals(thirdModTime, secondModTime);
    }

    /**
     * test file permissions for FileUtils#rename.
     * Since Ant1.10.7, ant uses FileUtils#rename for various tasks (eg. ReplaceRegExp).
     * Test that file permission set stays the same.
     * @see FileUtils#rename(java.io.File, java.io.File, boolean)
     * @throws IOException if something goes wrong
     */
    @Test
    public void testFilePermissions() throws IOException {
        assumeFalse("Test doesn't run on DOS", Os.isFamily("dos"));
        File removeThis = getFileUtils().createTempFile("permis", "sion", folder.getRoot(), true, true);
        File toBeMoved1 = getFileUtils().createTempFile("permis", "sion", folder.getRoot(), true, true);
        File toBeMoved2 = getFileUtils().createTempFile("permis", "sion", folder.getRoot(), true, true);
        try (FileOutputStream fos = new FileOutputStream(removeThis)) {
            fos.write(new byte[0]);
        }
        try (FileOutputStream fos = new FileOutputStream(toBeMoved1)) {
            fos.write(new byte[0]);
        }
        try (FileOutputStream fos = new FileOutputStream(toBeMoved2)) {
            fos.write(new byte[0]);
        }
        Set<PosixFilePermission> allAllowed = PosixFilePermissions.fromString("rwxrwxrwx");
        Files.setPosixFilePermissions(removeThis.toPath(), allAllowed);

        getFileUtils().rename(toBeMoved1, removeThis, true);
        assertEquals(allAllowed,Files.getPosixFilePermissions(removeThis.toPath()));

        Set<PosixFilePermission> tempAllowed = Files.getPosixFilePermissions(toBeMoved2.toPath());
        getFileUtils().rename(toBeMoved2, removeThis);
        assertEquals(tempAllowed,Files.getPosixFilePermissions(removeThis.toPath()));
    }

    @Test
    public void testResolveFilePosix() {
        assumeTrue("DOS or NetWare", !Os.isFamily("dos") && !Os.isFamily("netware"));
        /*
         * Start with simple absolute file names.
         */
        assertEquals(File.separator, getFileUtils().resolveFile(null, "/").getPath());
        assertEquals(File.separator, getFileUtils().resolveFile(null, "\\").getPath());
    }

    @Test
    public void testResolveFileDosOrNetware() {
        assumeTrue("Not DOS or Netware", Os.isFamily("dos") || Os.isFamily("netware"));
        assertEqualsIgnoreDriveCase(localize(File.separator),
                getFileUtils().resolveFile(null, "/").getPath());
        assertEqualsIgnoreDriveCase(localize(File.separator),
                getFileUtils().resolveFile(null, "\\").getPath());
        /*
         * throw in drive letters
         */
        String driveSpec = "C:";
        assertEquals(driveSpec + "\\",
                getFileUtils().resolveFile(null, driveSpec + "/").getPath());
        assertEquals(driveSpec + "\\",
                getFileUtils().resolveFile(null, driveSpec + "\\").getPath());
        String driveSpecLower = "c:";
        assertEquals(driveSpecLower + "\\",
                getFileUtils().resolveFile(null, driveSpecLower + "/").getPath());
        assertEquals(driveSpecLower + "\\",
                getFileUtils().resolveFile(null, driveSpecLower + "\\").getPath());
        /*
         * promised to eliminate consecutive slashes after drive letter.
         */
        assertEquals(driveSpec + "\\",
                getFileUtils().resolveFile(null, driveSpec + "/////").getPath());
        assertEquals(driveSpec + "\\",
                getFileUtils().resolveFile(null, driveSpec + "\\\\\\\\\\\\").getPath());

        if (Os.isFamily("netware")) {
            /*
             * throw in NetWare volume names
             */
            driveSpec = "SYS:";
            assertEquals(driveSpec,
                    getFileUtils().resolveFile(null, driveSpec + "/").getPath());
            assertEquals(driveSpec,
                    getFileUtils().resolveFile(null, driveSpec + "\\").getPath());
            driveSpecLower = "sys:";
            assertEquals(driveSpec,
                    getFileUtils().resolveFile(null, driveSpecLower + "/").getPath());
            assertEquals(driveSpec,
                    getFileUtils().resolveFile(null, driveSpecLower + "\\").getPath());
            /*
             * promised to eliminate consecutive slashes after drive letter.
             */
            assertEquals(driveSpec,
                    getFileUtils().resolveFile(null, driveSpec + "/////").getPath());
            assertEquals(driveSpec,
                    getFileUtils().resolveFile(null, driveSpec + "\\\\\\\\\\\\").getPath());
        }
    }
    @Test
    public void testResolveFileNotDos() {
        assumeFalse("is DOS", Os.isFamily("dos"));
        /*
         * drive letters must be considered just normal filenames.
         */
        String driveSpec = "C:";
        String udir = System.getProperty("user.dir");
        assertEquals(udir + File.separator + driveSpec,
                getFileUtils().resolveFile(null, driveSpec + "/").getPath());
        assertEquals(udir + File.separator + driveSpec,
                getFileUtils().resolveFile(null, driveSpec + "\\").getPath());
        String driveSpecLower = "c:";
        assertEquals(udir + File.separator + driveSpecLower,
                getFileUtils().resolveFile(null, driveSpecLower + "/").getPath());
        assertEquals(udir + File.separator + driveSpecLower,
                getFileUtils().resolveFile(null, driveSpecLower + "\\").getPath());
    }

    /*
     * Test some relative file name magic.
     */
    @Test
    public void testResolveRelativeFile() {
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().resolveFile(new File(localize("/1/2/3")), "4").getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().resolveFile(new File(localize("/1/2/3")), "./4").getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().resolveFile(new File(localize("/1/2/3")), ".\\4").getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().resolveFile(new File(localize("/1/2/3")), "./.\\4").getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().resolveFile(new File(localize("/1/2/3")), "../3/4").getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().resolveFile(new File(localize("/1/2/3")), "..\\3\\4").getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().resolveFile(new File(localize("/1/2/3")), "../../5/.././2/./3/6/../4").getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().resolveFile(new File(localize("/1/2/3")), "..\\../5/..\\./2/./3/6\\../4").getPath());

        assertEquals("meaningless result but no exception",
                new File(localize("/1/../../b")),
                getFileUtils().resolveFile(new File(localize("/1")), "../../b"));

    }

    @Test
    public void testNormalizePosix() {
        assumeTrue("DOS or NetWare", !Os.isFamily("dos") && !Os.isFamily("netware"));
        /*
         * Start with simple absolute file names.
         */
        assertEquals(File.separator, getFileUtils().normalize("/").getPath());
        assertEquals(File.separator, getFileUtils().normalize("\\").getPath());

        // Expected exception caught
        thrown.expect(BuildException.class);
        String driveSpec = "C:";
        assertEquals(driveSpec, getFileUtils().normalize(driveSpec).getPath());
    }

    @Test
    public void testNormalizeSlashDosOrNetware() {
        assumeTrue("Not DOS or Netware", Os.isFamily("dos") || Os.isFamily("netware"));
        thrown.expect(BuildException.class);
        getFileUtils().normalize("/").getPath();
    }

    @Test
    public void testNormalizeBackSlashDosOrNetware() {
        assumeTrue("Not DOS or Netware", Os.isFamily("dos") || Os.isFamily("netware"));
        thrown.expect(BuildException.class);
        getFileUtils().normalize("\\").getPath();
    }

    @Test
    public void testNormalizeDosOrNetware() {
        assumeTrue("Not DOS or Netware", Os.isFamily("dos") || Os.isFamily("netware"));
        if (Os.isFamily("dos")) {
            /*
             * throw in drive letters
             */
            String driveSpec = "C:";
            assertEquals(driveSpec + "\\",
                    getFileUtils().normalize(driveSpec + "/").getPath());
            assertEquals(driveSpec + "\\",
                    getFileUtils().normalize(driveSpec + "\\").getPath());
            String driveSpecLower = "c:";
            assertEquals(driveSpecLower + "\\",
                    getFileUtils().normalize(driveSpecLower + "/").getPath());
            assertEquals(driveSpecLower + "\\",
                    getFileUtils().normalize(driveSpecLower + "\\").getPath());
            /*
             * promised to eliminate consecutive slashes after drive letter.
             */
            assertEquals(driveSpec + "\\",
                    getFileUtils().normalize(driveSpec + "/////").getPath());
            assertEquals(driveSpec + "\\",
                    getFileUtils().normalize(driveSpec + "\\\\\\\\\\\\").getPath());

            // Expected exception caught
            thrown.expect(BuildException.class);
            getFileUtils().normalize(driveSpec).getPath();
        } else if (Os.isFamily("netware")) {
            /*
             * throw in NetWare volume names
             */
            String driveSpec = "SYS:";
            assertEquals(driveSpec,
                    getFileUtils().normalize(driveSpec).getPath());
            assertEquals(driveSpec,
                    getFileUtils().normalize(driveSpec + "/").getPath());
            assertEquals(driveSpec,
                    getFileUtils().normalize(driveSpec + "\\").getPath());
            String driveSpecLower = "sys:";
            assertEquals(driveSpec,
                    getFileUtils().normalize(driveSpecLower).getPath());
            assertEquals(driveSpec,
                    getFileUtils().normalize(driveSpecLower + "/").getPath());
            assertEquals(driveSpec,
                    getFileUtils().normalize(driveSpecLower + "\\").getPath());
            assertEquals(driveSpec + "\\junk",
                    getFileUtils().normalize(driveSpecLower + "\\junk").getPath());
            /*
             * promised to eliminate consecutive slashes after drive letter.
             */
            assertEquals(driveSpec,
                    getFileUtils().normalize(driveSpec + "/////").getPath());
            assertEquals(driveSpec,
                    getFileUtils().normalize(driveSpec + "\\\\\\\\\\\\").getPath());
        }
    }

    /**
     * Test some relative file name magic.
     */
    @Test
    public void testNormalizeRelativeFile() {
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().normalize(localize("/1/2/3/4")).getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().normalize(localize("/1/2/3/./4")).getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().normalize(localize("/1/2/3/.\\4")).getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().normalize(localize("/1/2/3/./.\\4")).getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().normalize(localize("/1/2/3/../3/4")).getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().normalize(localize("/1/2/3/..\\3\\4")).getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().normalize(localize("/1/2/3/../../5/.././2/./3/6/../4")).getPath());
        assertEquals(localize("/1/2/3/4"),
                     getFileUtils().normalize(localize("/1/2/3/..\\../5/..\\./2/./3/6\\../4")).getPath());

        assertEquals("will not go outside FS root (but will not throw an exception either)",
                new File(localize("/1/../../b")),
                getFileUtils().normalize(localize("/1/../../b")));

        // Expected exception caught
        thrown.expect(BuildException.class);
        getFileUtils().normalize("foo");
    }

    /**
     * Test handling of null arguments.
     */
    @Test
    public void testNullArgs() {
        File f = getFileUtils().resolveFile(null, "a");
        assertEquals(f, new File("a").getAbsoluteFile());

        // Expected exception caught
        thrown.expect(NullPointerException.class);
        getFileUtils().normalize(null);
    }

    /**
     * Test createTempFile
     */
    @Test
    public void testCreateTempFile() throws IOException {
        final String tmploc = System.getProperty("java.io.tmpdir");
        final Project projectWithoutTempDir = new Project();
        final Project projectWithTempDir = new Project();
        final File projectTmpDir = folder.newFolder("subdir");
        projectWithTempDir.setProperty("ant.tmpdir", projectTmpDir.getAbsolutePath());

        // null parent dir, null project
        File tmp1 = getFileUtils().createTempFile(null, "pre", ".suf", null, false, true);
        String name = tmp1.getName();
        assertThat("starts with pre", name, startsWith("pre"));
        assertThat("ends with .suf", name, endsWith(".suf"));
        assertTrue("File was created", tmp1.exists());
        assertEquals((new File(tmploc, tmp1.getName())).getAbsolutePath(),
                tmp1.getAbsolutePath());
        final PosixFileAttributeView attributes =
            Files.getFileAttributeView(tmp1.toPath(), PosixFileAttributeView.class);
        if (attributes != null) {
            final Set<PosixFilePermission> perm = attributes.readAttributes().permissions();
            assertThat(perm,
                containsInAnyOrder(PosixFilePermission.OWNER_READ, PosixFilePermission.OWNER_WRITE));
            assertThat(perm, hasSize(2));
        }
        tmp1.delete();

        // null parent dir, project without magic property
        tmp1 = getFileUtils().createTempFile(projectWithoutTempDir, "pre", ".suf", null, false, true);
        name = tmp1.getName();
        assertTrue("starts with pre", name.startsWith("pre"));
        assertTrue("ends with .suf", name.endsWith(".suf"));
        assertTrue("File was created", tmp1.exists());
        assertEquals((new File(tmploc, tmp1.getName())).getAbsolutePath(), tmp1
                .getAbsolutePath());
        tmp1.delete();

        // null parent dir, project with magic property
        tmp1 = getFileUtils().createTempFile(projectWithTempDir, "pre", ".suf", null, false, true);
        name = tmp1.getName();
        assertTrue("starts with pre", name.startsWith("pre"));
        assertTrue("ends with .suf", name.endsWith(".suf"));
        assertTrue("File was created", tmp1.exists());
        assertEquals((new File(projectTmpDir, tmp1.getName())).getAbsolutePath(), tmp1
                .getAbsolutePath());
        tmp1.delete();

        File dir2 = folder.newFolder("ant-test");

        File tmp2 = getFileUtils().createTempFile(null, "pre", ".suf", dir2, true, true);
        String name2 = tmp2.getName();
        assertThat("starts with pre", name2, startsWith("pre"));
        assertThat("ends with .suf", name2, endsWith(".suf"));
        assertTrue("File was created", tmp2.exists());
        assertEquals((new File(dir2, tmp2.getName())).getAbsolutePath(),
                tmp2.getAbsolutePath());
        tmp2.delete();

        tmp2 = getFileUtils().createTempFile(projectWithoutTempDir, "pre", ".suf", dir2, true, true);
        name2 = tmp2.getName();
        assertTrue("starts with pre", name2.startsWith("pre"));
        assertTrue("ends with .suf", name2.endsWith(".suf"));
        assertTrue("File was created", tmp2.exists());
        assertEquals((new File(dir2, tmp2.getName())).getAbsolutePath(), tmp2
                .getAbsolutePath());
        tmp2.delete();

        tmp2 = getFileUtils().createTempFile(projectWithTempDir, "pre", ".suf", dir2, true, true);
        name2 = tmp2.getName();
        assertTrue("starts with pre", name2.startsWith("pre"));
        assertTrue("ends with .suf", name2.endsWith(".suf"));
        assertTrue("File was created", tmp2.exists());
        assertEquals((new File(dir2, tmp2.getName())).getAbsolutePath(), tmp2
                .getAbsolutePath());
        tmp2.delete();
        dir2.delete();

        File parent = new File((new File("/tmp")).getAbsolutePath());
        tmp1 = getFileUtils().createTempFile("pre", ".suf", parent, false);
        assertFalse("new file", tmp1.exists());

        name = tmp1.getName();
        assertThat("starts with pre", name, startsWith("pre"));
        assertThat("ends with .suf", name, endsWith(".suf"));
        assertEquals("is inside parent dir", parent.getAbsolutePath(), tmp1
                .getParent());

        tmp2 = getFileUtils().createTempFile("pre", ".suf", parent, false);
        assertNotEquals("files are different", tmp1.getAbsolutePath(), tmp2.getAbsolutePath());
    }

    @Test
    public void createTempFileUsesAntTmpDirIfSetAndDeleteOnExitIsTrue() throws IOException {
        final Project project = new Project();
        final File projectTmpDir = folder.newFolder("subdir");
        project.setProperty("ant.tmpdir", projectTmpDir.getAbsolutePath());
        final File tmpFile = getFileUtils().createTempFile(project, null, null, null, true, true);
        assertTrue(tmpFile + " must be child of " + projectTmpDir,
                   tmpFile.getAbsolutePath().startsWith(projectTmpDir.getAbsolutePath()));
    }

    @Test
    public void createTempFileUsesAntTmpDirIfSetAndDeleteOnExitIsFalse() throws IOException {
        final Project project = new Project();
        final File projectTmpDir = folder.newFolder("subdir");
        project.setProperty("ant.tmpdir", projectTmpDir.getAbsolutePath());
        final File tmpFile = getFileUtils().createTempFile(project, null, null, null, false, true);
        assertTrue(tmpFile + " must be child of " + projectTmpDir,
                   tmpFile.getAbsolutePath().startsWith(projectTmpDir.getAbsolutePath()));
    }

    @Test
    public void createTempFileCreatesAutoTmpDirIfDeleteOnExitIsTrueOnUnix() throws IOException {
        assumeFalse("Test doesn't run on DOS", Os.isFamily("dos"));
        final Project project = new Project();
        final File tmpFile = getFileUtils().createTempFile(project, null, null, null, true, true);
        final String autoTempDir = project.getProperty("ant.auto.tmpdir");
        assertNotNull(autoTempDir);
        assertTrue(tmpFile + " must be child of " + autoTempDir,
                   tmpFile.getAbsolutePath().startsWith(autoTempDir));
    }

    @Test
    public void createTempFileDoesntCreateAutoTmpDirIfDeleteOnExitIsFalse() throws IOException {
        final Project project = new Project();
        final File tmpFile = getFileUtils().createTempFile(project, null, null, null, false, true);
        assertNull(project.getProperty("ant.auto.tmpdir"));
    }

    @Test
    public void createTempFileReusesAutoTmpDirIfDeleteOnExitIsTrueOnUnix() throws IOException {
        assumeFalse("Test doesn't run on DOS", Os.isFamily("dos"));
        final Project project = new Project();
        final File tmpFile = getFileUtils().createTempFile(project, null, null, null, true, true);
        final String autoTempDir = project.getProperty("ant.auto.tmpdir");
        assertNotNull(autoTempDir);
        final File tmpFile2 = getFileUtils().createTempFile(project, null, null, null, true, true);
        assertTrue(tmpFile2 + " must be child of " + autoTempDir,
                   tmpFile2.getAbsolutePath().startsWith(autoTempDir));
    }

    @Test
    public void createTempFileDoesntReusesAutoTmpDirIfDeleteOnExitIsFalse() throws IOException {
        assumeFalse("Test doesn't run on DOS", Os.isFamily("dos"));
        final Project project = new Project();
        final File tmpFile = getFileUtils().createTempFile(project, null, null, null, true, true);
        final String autoTempDir = project.getProperty("ant.auto.tmpdir");
        assertNotNull(autoTempDir);
        final File tmpFile2 = getFileUtils().createTempFile(project, null, null, null, false, true);
        assertFalse(tmpFile2 + " must not be child of " + autoTempDir,
                    tmpFile2.getAbsolutePath().startsWith(autoTempDir));
    }

    /**
     * Test contentEquals
     */
    @Test
    public void testContentEquals() throws IOException {
        assertTrue("Non existing files",
                getFileUtils().contentEquals(new File(ROOT, "foo"),
                        new File(ROOT, "bar")));
        assertFalse("One exists, the other one doesn't",
                getFileUtils().contentEquals(new File(ROOT, "foo"),
                        new File(ROOT, "build.xml")));
        assertFalse("Don't compare directories",
                getFileUtils().contentEquals(new File(ROOT, "src"),
                        new File(ROOT, "src")));
        assertTrue("File equals itself",
                getFileUtils().contentEquals(new File(ROOT, "build.xml"),
                        new File(ROOT, "build.xml")));
        assertFalse("Files are different",
                getFileUtils().contentEquals(new File(ROOT, "build.xml"),
                        new File(ROOT, "docs.xml")));
    }

    /**
     * Test createNewFile
     */
    @Test
    public void testCreateNewFile() throws IOException {
        File removeThis = new File("dummy");
        removeThis.deleteOnExit();
        assertFalse(removeThis.exists());
        getFileUtils().createNewFile(removeThis);
        assertTrue(removeThis.exists());
    }

    /**
     * Test removeLeadingPath.
     */
    @Test
    public void testRemoveLeadingPath() {
        assertEquals("bar", getFileUtils().removeLeadingPath(new File("/foo"),
                                                 new File("/foo/bar")));
        assertEquals("bar", getFileUtils().removeLeadingPath(new File("/foo/"),
                                                 new File("/foo/bar")));
        assertEquals("bar", getFileUtils().removeLeadingPath(new File("\\foo"),
                                                 new File("\\foo\\bar")));
        assertEquals("bar", getFileUtils().removeLeadingPath(new File("\\foo\\"),
                                                 new File("\\foo\\bar")));
        assertEquals("bar", getFileUtils().removeLeadingPath(new File("c:/foo"),
                                                 new File("c:/foo/bar")));
        assertEquals("bar", getFileUtils().removeLeadingPath(new File("c:/foo/"),
                                                 new File("c:/foo/bar")));
        assertEquals("bar", getFileUtils().removeLeadingPath(new File("c:\\foo"),
                                                 new File("c:\\foo\\bar")));
        assertEquals("bar", getFileUtils().removeLeadingPath(new File("c:\\foo\\"),
                                                 new File("c:\\foo\\bar")));
        if (!Os.isFamily("dos") && !Os.isFamily("netware")) {
            assertEquals(getFileUtils().normalize("/bar").getAbsolutePath(),
                         getFileUtils().removeLeadingPath(new File("/foo"), new File("/bar")));
            assertEquals(getFileUtils().normalize("/foobar").getAbsolutePath(),
                         getFileUtils().removeLeadingPath(new File("/foo"), new File("/foobar")));
        }
        // bugzilla report 19979
        assertEquals("", getFileUtils().removeLeadingPath(new File("/foo/bar"),
                                              new File("/foo/bar")));
        assertEquals("", getFileUtils().removeLeadingPath(new File("/foo/bar"),
                                              new File("/foo/bar/")));
        assertEquals("", getFileUtils().removeLeadingPath(new File("/foo/bar/"),
                                              new File("/foo/bar/")));
        assertEquals("", getFileUtils().removeLeadingPath(new File("/foo/bar/"),
                                              new File("/foo/bar")));

        String expected = "foo/bar".replace('\\', File.separatorChar)
            .replace('/', File.separatorChar);
        assertEquals(expected, getFileUtils().removeLeadingPath(new File("/"),
                                                    new File("/foo/bar")));
        assertEquals(expected, getFileUtils().removeLeadingPath(new File("c:/"),
                                                    new File("c:/foo/bar")));
        assertEquals(expected, getFileUtils().removeLeadingPath(new File("c:\\"),
                                                    new File("c:\\foo\\bar")));
    }

    /**
     * test toUri
     */
    @Test
    public void testToURI() {
        String dosRoot;
        if (Os.isFamily("dos") || Os.isFamily("netware")) {
            dosRoot = System.getProperty("user.dir")
                .substring(0, 3).replace(File.separatorChar, '/');
        } else {
            dosRoot = "";
        }
        if (Os.isFamily("dos")) {
            assertEquals("file:/c:/foo", removeExtraneousAuthority(getFileUtils().toURI("c:\\foo")));
        }
        if (Os.isFamily("netware")) {
            assertEquals("file:/SYS:/foo", removeExtraneousAuthority(getFileUtils().toURI("sys:\\foo")));
        }
        if (File.pathSeparatorChar == '/') {
            assertEquals("file:/foo", removeExtraneousAuthority(getFileUtils().toURI("/foo")));
            assertThat("file: URIs must name absolute paths", getFileUtils().toURI("./foo"), startsWith("file:/"));
            assertThat(getFileUtils().toURI("./foo"), endsWith("/foo"));
            assertEquals("file:/" + dosRoot + "foo%20bar", removeExtraneousAuthority(getFileUtils().toURI("/foo bar")));
            assertEquals("file:/" + dosRoot + "foo%23bar", removeExtraneousAuthority(getFileUtils().toURI("/foo#bar")));
        } else if (File.pathSeparatorChar == '\\') {
            assertEquals("file:/" + dosRoot + "foo", removeExtraneousAuthority(getFileUtils().toURI("\\foo")));
            assertThat("file: URIs must name absolute paths", getFileUtils().toURI(".\\foo"), startsWith("file:/"));
            assertThat(getFileUtils().toURI(".\\foo"), endsWith("/foo"));
            assertEquals("file:/" + dosRoot + "foo%20bar", removeExtraneousAuthority(getFileUtils().toURI("\\foo bar")));
            assertEquals("file:/" + dosRoot + "foo%23bar", removeExtraneousAuthority(getFileUtils().toURI("\\foo#bar")));
        }
        // a test with ant for germans
        // the escaped character used for the test is the "a umlaut"
        // this is the fix for the bug 37348
        assertEquals("file:/" + dosRoot + "%C3%A4nt", removeExtraneousAuthority(getFileUtils().toURI("/\u00E4nt")));
    }

    /**
     * Authority field is unnecessary, but harmless, in file: URIs.
     * Java 1.4 does not produce it when using File.toURI.
     */
    private static String removeExtraneousAuthority(String uri) {
        String prefix = "file:///";
        if (uri.startsWith(prefix)) {
            return "file:/" + uri.substring(prefix.length());
        } else {
            return uri;
        }
    }

    @Test
    public void testIsContextRelativePath() {
        assumeTrue("Test only runs on DOS", Os.isFamily("dos"));
        assertTrue(isContextRelativePath("/\u00E4nt"));
        assertTrue(isContextRelativePath("\\foo"));
    }

    /**
     * test fromUri
     */
    @Test
    public void testFromURI() {
        String dosRoot;
        if (Os.isFamily("dos") || Os.isFamily("netware")) {
            dosRoot = System.getProperty("user.dir").substring(0, 2);
        } else {
            dosRoot = "";
        }
        if (Os.isFamily("netware")) {
            assertEqualsIgnoreDriveCase("SYS:\\foo", getFileUtils().fromURI("file:///sys:/foo"));
        }
        if (Os.isFamily("dos")) {
            assertEqualsIgnoreDriveCase("C:\\foo", getFileUtils().fromURI("file:///c:/foo"));
        }
        assertEqualsIgnoreDriveCase(dosRoot + File.separator + "foo", getFileUtils().fromURI("file:///foo"));
        assertEquals("." + File.separator + "foo",
                     getFileUtils().fromURI("file:./foo"));
        assertEquals(dosRoot + File.separator + "foo bar", getFileUtils().fromURI("file:///foo%20bar"));
        assertEquals(dosRoot + File.separator + "foo#bar", getFileUtils().fromURI("file:///foo%23bar"));
    }

    @Test
    public void testModificationTests() {

        //get a time
        long firstTime = System.currentTimeMillis();
        //add some time. We assume no OS has a granularity this bad
        long secondTime = firstTime + 60000;
        /*
        assertTrue("same timestamp is up to date",
                fu.isUpToDate(firstTime, firstTime));
         */

        //check that older is up to date with a newer dest
        assertTrue("older source files are up to date",
                getFileUtils().isUpToDate(firstTime,secondTime));
        //check that older is up to date with a newer dest
        assertFalse("newer source files are no up to date",
                getFileUtils().isUpToDate(secondTime, firstTime));

        assertFalse("-1 dest timestamp implies nonexistence",
                getFileUtils().isUpToDate(firstTime, -1L));
    }

    @Test
    public void testHasErrorInCase() {
        File tempFolder = new File(System.getProperty("java.io.tmpdir"));
        File wellcased = getFileUtils().createTempFile("alpha", "beta", tempFolder,
                                                   true, true);
        String s = wellcased.getName().toUpperCase();
        File wrongcased = new File(tempFolder, s);
        if (Os.isFamily("mac") && Os.isFamily("unix")) {
            //no guarantees on filesystem case-sensitivity
        } else if (Os.isFamily("dos")) {
            assertTrue(getFileUtils().hasErrorInCase(wrongcased));
            assertFalse(getFileUtils().hasErrorInCase(wellcased));
        } else {
            assertFalse(getFileUtils().hasErrorInCase(wrongcased));
            assertFalse(getFileUtils().hasErrorInCase(wellcased));
        }

    }

    @Test
    public void testGetDefaultEncoding() {
        // This just tests that the function does not blow up
        getFileUtils().getDefaultEncoding();
    }

    /**
     * @see "https://bz.apache.org/bugzilla/show_bug.cgi?id=62502"
     */
    @Test
    public void isLeadingPathCannotBeFooledByTooManyDoubleDots() {
        assertFalse(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/../../bar")));
        assertFalse(getFileUtils().isLeadingPath(new File("c:\\foo"), new File("c:\\foo\\..\\..\\bar")));
        assertFalse(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/../..")));
    }

    /**
     * @see "https://bz.apache.org/bugzilla/show_bug.cgi?id=62502"
     */
    @Test
    public void isLeadingPathCanonicalVersionCannotBeFooledByTooManyDoubleDots() throws IOException {
        assertFalse(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/../../bar"), true));
        assertFalse(getFileUtils().isLeadingPath(new File("c:\\foo"), new File("c:\\foo\\..\\..\\bar"), true));
        assertFalse(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/../.."), true));
    }

    @Test
    public void isLeadingPathCanonicalVersionWorksAsExpectedOnUnix() throws IOException {
        assumeFalse("Test doesn't run on DOS", Os.isFamily("dos"));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/bar"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/baz/../bar"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/../foo/bar"), true));
        assertFalse(getFileUtils().isLeadingPath(new File("/foo"), new File("/foobar"), true));
        assertFalse(getFileUtils().isLeadingPath(new File("/foo"), new File("/bar"), true));
    }

    @Test
    public void isLeadingPathAndTrailingSlashesOnUnix() throws IOException {
        assumeFalse("Test doesn't run on DOS", Os.isFamily("dos"));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo/"), new File("/foo/bar"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo/"), new File("/foo/bar/"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo/"), new File("/foo/"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo/"), new File("/foo"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/"), true));

        assertTrue(getFileUtils().isLeadingPath(new File("/foo/"), new File("/foo/bar"), false));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo/"), new File("/foo/bar/"), false));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo/"), new File("/foo/"), false));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo/"), new File("/foo"), false));
        assertTrue(getFileUtils().isLeadingPath(new File("/foo"), new File("/foo/"), false));
    }

    @Test
    public void isLeadingPathCanonicalVersionWorksAsExpectedOnDos() throws IOException {
        assumeTrue("Test only runs on DOS", Os.isFamily("dos"));
        assertTrue(getFileUtils().isLeadingPath(new File("C:\\foo"), new File("C:\\foo\\bar"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("C:\\foo"), new File("C:\\foo\\baz\\..\\bar"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("C:\\foo"), new File("C:\\foo\\..\\foo\\bar"), true));
        assertFalse(getFileUtils().isLeadingPath(new File("C:\\foo"), new File("C:\\foobar"), true));
        assertFalse(getFileUtils().isLeadingPath(new File("C:\\foo"), new File("C:\\bar"), true));
    }

    @Test
    public void isLeadingPathAndTrailingSlashesOnDos() throws IOException {
        assumeTrue("Test only runs on DOS", Os.isFamily("dos"));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo\\"), new File("c:\\foo\\bar"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo\\"), new File("c:\\foo\\bar\\"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo\\"), new File("c:\\foo\\"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo\\"), new File("c:\\foo"), true));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo"), new File("c:\\foo\\"), true));

        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo\\"), new File("c:\\foo\\bar"), false));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo\\"), new File("c:\\foo\\bar\\"), false));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo\\"), new File("c:\\foo\\"), false));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo\\"), new File("c:\\foo"), false));
        assertTrue(getFileUtils().isLeadingPath(new File("c:\\foo"), new File("c:\\foo\\"), false));
    }

    /**
     * Tests {@link FileUtils#isCaseSensitiveFileSystem(Path)} method
     *
     * @throws Exception
     */
    @Test
    public void testCaseSensitiveFileSystem() throws Exception {
        // create a temp file in a fresh directory
        final Path tmpDir = Files.createTempDirectory(null);
        final Path tmpFile = Files.createTempFile(tmpDir, null, null);
        tmpFile.toFile().deleteOnExit();
        tmpDir.toFile().deleteOnExit();
        // now check if a file with that same name but different case is considered to exist
        final boolean existsAsLowerCase = Files.exists(Paths.get(tmpDir.toString(), tmpFile.getFileName().toString().toLowerCase(Locale.US)));
        final boolean existsAsUpperCase = Files.exists(Paths.get(tmpDir.toString(), tmpFile.getFileName().toString().toUpperCase(Locale.US)));
        // if the temp file that we created is found to not exist in a particular "case", then
        // the filesystem is case sensitive
        final Boolean expectedCaseSensitivity = !existsAsLowerCase || !existsAsUpperCase;

        // call the method and pass it a directory
        Optional<Boolean> actualCaseSensitivity = isCaseSensitiveFileSystem(tmpDir);
        assertTrue("Filesystem case sensitivity was expected to be determined", actualCaseSensitivity.isPresent());
        assertEquals("Filesystem was expected to be case " + (expectedCaseSensitivity
                ? "sensitive" : "insensitive"), expectedCaseSensitivity, actualCaseSensitivity.get());

        // now test it out by passing it a file
        actualCaseSensitivity = isCaseSensitiveFileSystem(tmpFile);
        assertTrue("Filesystem case sensitivity was expected to be determined", actualCaseSensitivity.isPresent());
        assertEquals("Filesystem was expected to be case " + (expectedCaseSensitivity
                ? "sensitive" : "insensitive"), expectedCaseSensitivity, actualCaseSensitivity.get());
    }

    @Test
    public void testStartsWithPathSeparator() {
        assertTrue(getFileUtils().startsWithPathSeparator("/foo"));
        assertTrue(getFileUtils().startsWithPathSeparator("\\foo"));
        assertFalse(getFileUtils().startsWithPathSeparator("c:\\foo"));
        assertFalse(getFileUtils().startsWithPathSeparator("foo"));
        assertFalse(getFileUtils().startsWithPathSeparator("file:/foo"));
    }

    @Test
    public void testStripLeadingPathSeparator() {
        assertEquals("foo", getFileUtils().stripLeadingPathSeparator("/foo"));
        assertEquals("foo", getFileUtils().stripLeadingPathSeparator("\\foo"));
        assertEquals("c:\\foo", getFileUtils().stripLeadingPathSeparator("c:\\foo"));
        assertEquals("foo", getFileUtils().stripLeadingPathSeparator("foo"));
        assertEquals("file:/foo", getFileUtils().stripLeadingPathSeparator("file:/foo"));
    }

    /**
     * adapt file separators to local conventions
     */
    private String localize(String path) {
        path = root + path.substring(1);
        return path.replace('\\', File.separatorChar).replace('/', File.separatorChar);
    }

    /**
     * convenience method
     * normalize brings the drive in uppercase
     * the drive letter is in lower case under cygwin
     * calling this method allows tests where normalize is called to pass under cygwin
     */
    private void assertEqualsIgnoreDriveCase(String s1, String s2) {
        assumeTrue("Not DOS or Netware", Os.isFamily("dos") || Os.isFamily("netware"));
        if (!s1.isEmpty() && !s2.isEmpty()) {
            StringBuilder sb1 = new StringBuilder(s1);
            StringBuilder sb2 = new StringBuilder(s2);
            sb1.setCharAt(0, Character.toUpperCase(s1.charAt(0)));
            sb2.setCharAt(0, Character.toUpperCase(s2.charAt(0)));
            assertEquals(sb1.toString(), sb2.toString());
        } else {
            assertEquals(s1, s2);
        }
    }
}
