java/maven/test/unit/src/org/netbeans/modules/maven/queries/RepositoryForBinaryQueryImplTest.java

/*
 * 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
 *
 *   http://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.netbeans.modules.maven.queries;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.Arrays;
import org.junit.Test;
import static org.junit.Assert.*;
import org.netbeans.api.java.queries.JavadocForBinaryQuery;
import org.netbeans.api.java.queries.SourceForBinaryQuery;
import org.netbeans.api.project.ProjectManager;
import org.netbeans.junit.NbTestCase;
import org.netbeans.modules.maven.NbMavenProjectImpl;
import org.netbeans.modules.maven.embedder.EmbedderFactory;
import org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation2.Result;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.util.Exceptions;
import org.openide.util.test.TestFileUtils;

/**
 *
 * @author mkleint
 */
public class RepositoryForBinaryQueryImplTest extends NbTestCase{
    
    public RepositoryForBinaryQueryImplTest(String name) {
        super(name);
    }

    @Override
    protected void setUp() throws Exception {
        super.setUp(); 
        //synchronous reload of maven project asserts sanoty in some tests..
        System.setProperty("test.reload.sync", "true");
        
    }

    @Override
    protected void tearDown() throws Exception {
        super.tearDown(); 
        File prj10 = new File(getWorkDir(), "prj10");
        org.codehaus.plexus.util.FileUtils.deleteDirectory(prj10);
        
        File repo = EmbedderFactory.getProjectEmbedder().getLocalRepositoryFile();
        File nbtest = new File(repo, "nbtest");
        org.codehaus.plexus.util.FileUtils.deleteDirectory(nbtest);
    }
    
    
    /**
     * Test of findSourceRoots2 method, of class RepositoryForBinaryQueryImpl.
     */
    @Test
    public void testResultChanging() throws IOException {
        RepositoryForBinaryQueryImpl query = new RepositoryForBinaryQueryImpl();
        File repo = EmbedderFactory.getProjectEmbedder().getLocalRepositoryFile();
        File art10 = new File(repo, "nbtest/testprj/1.0/testprj-1.0.jar");
        org.codehaus.plexus.util.FileUtils.deleteDirectory(art10.getParentFile());
        URL url = FileUtil.getArchiveRoot(art10.toURI().toURL());
        TestFileUtils.writeZipFile(art10, "META-INF/MANIFEST.MF:Version:1.0");
        Result result = query.findSourceRoots2(url);
        assertNotNull(result);
        assertEquals(0, result.getRoots().length);
        

        // now create source jar
        File repoSourceJar = new File(art10.getParentFile(), "testprj-1.0-sources.jar");
        org.codehaus.plexus.util.FileUtils.copyFile(art10, repoSourceJar);
        assertEquals(1, result.getRoots().length);
        assertEquals(FileUtil.getArchiveRoot(FileUtil.toFileObject(repoSourceJar)), result.getRoots()[0]);
        
        
        
        //now create project
        File prj10 = new File(getWorkDir(), "prj10");
        TestFileUtils.writeFile(new File(prj10, "pom.xml"), "<project><modelVersion>4.0.0</modelVersion>"
                + "<groupId>nbtest</groupId><artifactId>testprj</artifactId>"
                + "<packaging>jar</packaging><version>1.0</version></project>");
        //create main source root.
        File prjroot = new File(new File(new File(prj10, "src"), "main"), "java");
        prjroot.mkdirs();
        
        NbMavenProjectImpl p10 = (NbMavenProjectImpl) ProjectManager.getDefault().findProject(FileUtil.toFileObject(prj10));
        assertNotNull(p10);
        MavenFileOwnerQueryImpl.getInstance().registerProject(p10, true);
        try {
            //preferences changes get fired in different thread, need to wait for it.. 
            Thread.sleep(2000);
        } catch (InterruptedException ex) {
            Exceptions.printStackTrace(ex);
        }
        assertEquals(1, result.getRoots().length);
        assertEquals(FileUtil.toFileObject(prjroot), result.getRoots()[0]);
        
        //overwrite the pom file to point to different 
        TestFileUtils.writeFile(new File(prj10, "pom.xml"), "<project><modelVersion>4.0.0</modelVersion>"
                + "<groupId>nbtest</groupId><artifactId>testprj</artifactId>"
                + "<packaging>jar</packaging><version>1.0</version>"
                + "<build><sourceDirectory>src/main2/java</sourceDirectory></build>"
                + "</project>");
        //manually reload the project, only opened projects listen on pom.xml changes.
        p10.fireProjectReload();
        
        FileObject[] res = result.getRoots();
        assertEquals(Arrays.toString(res), 0, res.length);
        prjroot = new File(new File(new File(prj10, "src"), "main2"), "java");
        prjroot.mkdirs();
        
        assertEquals(1, result.getRoots().length);
        assertEquals(FileUtil.toFileObject(prjroot), result.getRoots()[0]);
        
        
        
    }
    
    @Test
    public void testFindJavadoc() throws IOException {
        File repo = EmbedderFactory.getProjectEmbedder().getLocalRepositoryFile();
        File parent = new File(repo, "nbtest/testprj/1.0");
        RepositoryForBinaryQueryImpl query = new RepositoryForBinaryQueryImpl();
        
        // find nothing
        File artifact = new File(parent, "testprj-1.0.jar");
        TestFileUtils.writeZipFile(artifact, "META-INF/MANIFEST.MF:Version:1.0");
        URL artifactRoot = FileUtil.getArchiveRoot(artifact.toURI().toURL());
        JavadocForBinaryQuery.Result result = query.findJavadoc(artifactRoot);
        assertNotNull(result);
        assertEquals(0, result.getRoots().length);
        
        // find regular javadoc
        File javadoc = new File(parent, "testprj-1.0-javadoc.jar");
        TestFileUtils.writeZipFile(javadoc, "META-INF/MANIFEST.MF:Version:1.0");
        URL javadocRoot = FileUtil.getArchiveRoot(javadoc.toURI().toURL());
        result = query.findJavadoc(artifactRoot);
        assertEquals(1, result.getRoots().length);
        assertEquals(javadocRoot, result.getRoots()[0]);
        
        // classifier attachments should fall back to the regular javadoc
        File attachment = new File(parent, "testprj-1.0-attachment.jar");
        TestFileUtils.writeZipFile(attachment, "META-INF/MANIFEST.MF:Version:1.0");
        URL attachmentRoot = FileUtil.getArchiveRoot(attachment.toURI().toURL());
        result = query.findJavadoc(attachmentRoot);
        assertEquals(1, result.getRoots().length);
        assertEquals(javadocRoot, result.getRoots()[0]);
        
        // classifier attachments should find their own javadoc
        File attachmentJavadoc = new File(parent, "testprj-1.0-attachment-javadoc.jar");
        TestFileUtils.writeZipFile(attachmentJavadoc, "META-INF/MANIFEST.MF:Version:1.0");
        URL attachmentJavadocRoot = FileUtil.getArchiveRoot(attachmentJavadoc.toURI().toURL());
        result = query.findJavadoc(attachmentRoot);
        assertEquals(1, result.getRoots().length);
        assertEquals(attachmentJavadocRoot, result.getRoots()[0]);
        
        // result reacts to filesystem changes
        org.codehaus.plexus.util.FileUtils.forceDelete(attachmentJavadoc);
        assertEquals(1, result.getRoots().length);
        assertEquals(javadocRoot, result.getRoots()[0]);
        
        org.codehaus.plexus.util.FileUtils.forceDelete(javadoc);
        assertEquals(0, result.getRoots().length);
        
        TestFileUtils.writeZipFile(javadoc, "META-INF/MANIFEST.MF:Version:1.0");
        assertEquals(1, result.getRoots().length);
        assertEquals(javadocRoot, result.getRoots()[0]);
    }
    
    @Test
    public void testFindSources() throws IOException {
        File repo = EmbedderFactory.getProjectEmbedder().getLocalRepositoryFile();
        File parent = new File(repo, "nbtest/testprj/1.0");
        RepositoryForBinaryQueryImpl query = new RepositoryForBinaryQueryImpl();
        
        // find nothing
        File artifact = new File(parent, "testprj-1.0.jar");
        TestFileUtils.writeZipFile(artifact, "META-INF/MANIFEST.MF:Version:1.0");
        URL artifactRoot = FileUtil.getArchiveRoot(artifact.toURI().toURL());
        SourceForBinaryQuery.Result result = query.findSourceRoots(artifactRoot);
        assertNotNull(result);
        assertEquals(0, result.getRoots().length);
        
        // find regular sources
        File sources = new File(parent, "testprj-1.0-sources.jar");
        TestFileUtils.writeZipFile(sources, "META-INF/MANIFEST.MF:Version:1.0");
        URL sourcesRoot = FileUtil.getArchiveRoot(sources.toURI().toURL());
        result = query.findSourceRoots(artifactRoot);
        assertEquals(1, result.getRoots().length);
        assertEquals(sourcesRoot, result.getRoots()[0].toURL());
        
        // classifier attachments should fall back to the regular sources
        File attachment = new File(parent, "testprj-1.0-attachment.jar");
        TestFileUtils.writeZipFile(attachment, "META-INF/MANIFEST.MF:Version:1.0");
        URL attachmentRoot = FileUtil.getArchiveRoot(attachment.toURI().toURL());
        result = query.findSourceRoots(attachmentRoot);
        assertEquals(1, result.getRoots().length);
        assertEquals(sourcesRoot, result.getRoots()[0].toURL());
        
        // classifier attachments should find their own sources
        File attachmentSources = new File(parent, "testprj-1.0-attachment-sources.jar");
        TestFileUtils.writeZipFile(attachmentSources, "META-INF/MANIFEST.MF:Version:1.0");
        URL attachmentSourcesRoot = FileUtil.getArchiveRoot(attachmentSources.toURI().toURL());
        result = query.findSourceRoots(attachmentRoot);
        assertEquals(1, result.getRoots().length);
        assertEquals(attachmentSourcesRoot, result.getRoots()[0].toURL());
        
        // result reacts to filesystem changes
        org.codehaus.plexus.util.FileUtils.forceDelete(attachmentSources);
        assertEquals(1, result.getRoots().length);
        assertEquals(sourcesRoot, result.getRoots()[0].toURL());
        
        org.codehaus.plexus.util.FileUtils.forceDelete(sources);
        assertEquals(0, result.getRoots().length);
        
        TestFileUtils.writeZipFile(sources, "META-INF/MANIFEST.MF:Version:1.0");
        assertEquals(1, result.getRoots().length);
        assertEquals(sourcesRoot, result.getRoots()[0].toURL());
    }

}