/*

 * Copyright 2009 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

/*

 * @test

 * @bug 6838467

 * @summary JSR199 FileObjects don't obey general contract of equals.

 */

import java.io.*;

import java.util.*;

import java.util.zip.*;

import javax.tools.*;

import com.sun.tools.javac.file.JavacFileManager;

import com.sun.tools.javac.util.Context;

public class T6838467 {

    boolean fileSystemIsCaseSignificant = !new File("a").equals(new File("A"));

    enum FileKind {

        DIR("dir"),

        ZIP("zip"),

        ZIPFILEINDEX("zip");

        FileKind(String path) {

            file = new File(path);

        }

        final File file;

    };

    enum CompareKind {

        SAME {

            File other(File f) { return f; }

        },

        ABSOLUTE {

            File other(File f) { return f.getAbsoluteFile(); }

        },

        DIFFERENT {

            File other(File f) { return new File("not_" + f.getPath()); }

        },

        CASEEQUIV {

            File other(File f) { return new File(f.getPath().toUpperCase()); }

        };

        abstract File other(File f);

    };

    String[] paths = { "p/A.java", "p/B.java", "p/C.java" };

    public static void main(String... args) throws Exception {

        new T6838467().run();

    }

    void run() throws Exception {

        // on Windows, verify file system is not case significant

        if (System.getProperty("os.name").toLowerCase().startsWith("windows")

                && fileSystemIsCaseSignificant) {

            error("fileSystemIsCaseSignificant is set on Windows.");

        }

        // create a set of directories and zip files to compare

        createTestDir(new File("dir"), paths);

        createTestDir(new File("not_dir"), paths);

        createTestZip(new File("zip"), paths);

        createTestZip(new File("not_zip"), paths);

        if (fileSystemIsCaseSignificant) {

            createTestDir(new File("DIR"), paths);

            createTestZip(new File("ZIP"), paths);

        }

        // test the various sorts of file objects that can be obtained from

        // the file manager, and for various values that may or may not match.

        for (FileKind fk: FileKind.values()) {

            for (CompareKind ck: CompareKind.values()) {

                test(fk, ck);

            }

        }

        // verify that the various different types of file object were all

        // tested

        Set<String> expectClasses = new HashSet<String>(Arrays.asList(

                "RegularFileObject", "ZipFileObject", "ZipFileIndexFileObject" ));

        if (!foundClasses.equals(expectClasses)) {

            error("expected fileobject classes not found\n"

                    + "expected: " + expectClasses + "\n"

                    + "found: " + foundClasses);

        }

        if (errors > 0)

            throw new Exception(errors + " errors");

    }

    void test(FileKind fk, CompareKind ck) throws IOException {

        File f1 = fk.file;

        JavaFileManager fm1 = createFileManager(fk, f1);

        File f2 = ck.other(fk.file);

        JavaFileManager fm2 = createFileManager(fk, f2);

        try {

            // If the directories or zip files match, we expect "n" matches in

            // the "n-squared" comparisons to come, where "n" is the number of

            // entries in the the directories or zip files.

            // If the directories or zip files don't themselves match,

            // we obviously don't expect any of their contents to match either.

            int expect = (f1.getAbsoluteFile().equals(f2.getAbsoluteFile()) ? paths.length : 0);

            System.err.println("test " + (++count) + " " + fk + " " + ck + " " + f1 + " " + f2);

            test(fm1, fm2, expect);

        } finally {

            fm1.close();

            fm2.close();

        }

    }

    // For a pair of file managers that may or may not have similar entries

    // on the classpath, compare all files returned from one against all files

    // returned from the other.  For each pair of files, verify that if they

    // are equal, the hashcode is equal as well, and finally verify that the

    // expected number of matches was found.

    void test(JavaFileManager fm1, JavaFileManager fm2, int expectEqualCount) throws IOException {

        boolean foundFiles1 = false;

        boolean foundFiles2 = false;

        int foundEqualCount = 0;

        Set<JavaFileObject.Kind> kinds =  EnumSet.allOf(JavaFileObject.Kind.class);

        for (FileObject fo1: fm1.list(StandardLocation.CLASS_PATH, "p", kinds, false)) {

            foundFiles1 = true;

            foundClasses.add(fo1.getClass().getSimpleName());

            for (FileObject fo2: fm2.list(StandardLocation.CLASS_PATH, "p", kinds, false)) {

                foundFiles2 = true;

                foundClasses.add(fo1.getClass().getSimpleName());

                System.err.println("compare " + fo1 + " " + fo2);

                if (fo1.equals(fo2)) {

                    foundEqualCount++;

                    int hash1 = fo1.hashCode();

                    int hash2 = fo2.hashCode();

                    if (hash1 != hash2)

                        error("hashCode error: " + fo1 + " [" + hash1 + "] "

                                + fo2 + " [" + hash2 + "]");

                }

            }

        }

        if (!foundFiles1)

            error("no files found for file manager 1");

        if (!foundFiles2)

            error("no files found for file manager 2");

        // verify the expected number of matches were found

        if (foundEqualCount != expectEqualCount)

            error("expected matches not found: expected " + expectEqualCount + ", found " + foundEqualCount);

    }

    // create a file manager to test a FileKind, with a given directory

    // or zip file placed on the classpath

    JavaFileManager createFileManager(FileKind fk, File classpath) throws IOException {

        StandardJavaFileManager fm = createFileManager(fk == FileKind.ZIP);

        fm.setLocation(StandardLocation.CLASS_PATH, Arrays.asList(classpath));

        return fm;

    }

    JavacFileManager createFileManager(boolean useJavaUtilZip) {

        // javac should really not be using system properties like this

        // -- it should really be using (hidden) options -- but until then

        // take care to leave system properties as we find them, so as not

        // to adversely affect other tests that might follow.

        String prev = System.getProperty("useJavaUtilZip");

        boolean resetProperties = false;

        try {

            if (useJavaUtilZip) {

                System.setProperty("useJavaUtilZip", "true");

                resetProperties = true;

            } else if (System.getProperty("useJavaUtilZip") != null) {

                System.getProperties().remove("useJavaUtilZip");

                resetProperties = true;

            }

            Context c = new Context();

            return new JavacFileManager(c, false, null);

        } finally {

            if (resetProperties) {

                if (prev == null) {

                    System.getProperties().remove("useJavaUtilZip");

                } else {

                    System.setProperty("useJavaUtilZip", prev);

                }

            }

        }

    }

    // create a directory containing a given set of paths

    void createTestDir(File dir, String[] paths) throws IOException {

        for (String p: paths) {

            File file = new File(dir, p);

            file.getParentFile().mkdirs();

            FileWriter out = new FileWriter(file);

            try {

                out.write(p);

            } finally {

                out.close();

            }

        }

    }

    // create a sip file containing a given set of entries

    void createTestZip(File zip, String[] paths) throws IOException {

        if (zip.getParentFile() != null)

            zip.getParentFile().mkdirs();

        ZipOutputStream zos = new ZipOutputStream(new FileOutputStream(zip));

        try {

            for (String p: paths) {

                ZipEntry ze = new ZipEntry(p);

                zos.putNextEntry(ze);

                byte[] bytes = p.getBytes();

                zos.write(bytes, 0, bytes.length);

                zos.closeEntry();

            }

        } finally {

            zos.close();

        }

    }

    void error(String msg) {

        System.err.println("Error: " + msg);

        errors++;

    }

    int count;

    int errors;

    Set<String> foundClasses = new HashSet<String>();

}