ProjectUtilsTest

/*
 * 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.apache.maven.plugins.assembly.utils;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

import org.apache.maven.model.Model;
import org.apache.maven.project.MavenProject;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

public class ProjectUtilsTest {
    private final Logger logger = LoggerFactory.getLogger(getClass());

    private MavenProject createTestProject(final String artifactId, final String groupId, final String version) {
        final Model model = new Model();
        model.setArtifactId(artifactId);
        model.setGroupId(groupId);
        model.setVersion(version);

        return new MavenProject(model);
    }

    @Test
    public void testGetProjectModules_ShouldIncludeDirectModuleOfMasterProject() throws IOException {
        final MavenProject master = createTestProject("test", "testGroup", "1.0");

        master.setFile(new File("pom.xml"));

        master.getModel().addModule("module");

        final MavenProject module = createTestProject("module", "testGroup", "1.0");

        module.setFile(new File("module/pom.xml"));

        final List<MavenProject> projects = new ArrayList<>(2);

        projects.add(master);
        projects.add(module);

        final Set<MavenProject> result = ProjectUtils.getProjectModules(master, projects, true, logger);

        assertNotNull(result);
        assertEquals(1, result.size());
        assertEquals(module.getId(), result.iterator().next().getId());
    }

    @Test
    public void testGetProjectModules_ShouldNotIncludeMasterProject() throws IOException {
        final MavenProject master = createTestProject("test", "testGroup", "1.0");

        final Set<MavenProject> result =
                ProjectUtils.getProjectModules(master, Collections.singletonList(master), true, logger);

        assertNotNull(result);
        assertTrue(result.isEmpty());
    }

    @Test
    public void testGetProjectModules_ShouldIncludeInDirectModuleOfMasterWhenIncludeSubModulesIsTrue()
            throws IOException {
        final MavenProject master = createTestProject("test", "testGroup", "1.0");

        master.setFile(new File("project/pom.xml"));

        master.getModel().addModule("module");

        final MavenProject module = createTestProject("module", "testGroup", "1.0");

        module.getModel().addModule("submodule");

        module.setFile(new File("project/module/pom.xml"));

        final MavenProject subModule = createTestProject("sub-module", "testGroup", "1.0");

        subModule.setFile(new File("project/module/submodule/pom.xml"));

        final List<MavenProject> projects = new ArrayList<>(3);

        projects.add(master);
        projects.add(module);
        projects.add(subModule);

        final Set<MavenProject> result = ProjectUtils.getProjectModules(master, projects, true, logger);

        assertNotNull(result);
        assertEquals(2, result.size());

        final List<MavenProject> verify = new ArrayList<>(projects);
        verify.remove(master);

        verifyProjectsPresent(verify, result);
    }

    @Test
    public void testGetProjectModules_ShouldExcludeInDirectModuleOfMasterWhenIncludeSubModulesIsFalse()
            throws IOException {
        final MavenProject master = createTestProject("test", "testGroup", "1.0");

        master.setFile(new File("project/pom.xml"));

        master.getModel().addModule("module");

        final MavenProject module = createTestProject("module", "testGroup", "1.0");

        module.getModel().addModule("submodule");

        module.setFile(new File("project/module/pom.xml"));

        final MavenProject subModule = createTestProject("sub-module", "testGroup", "1.0");

        subModule.setFile(new File("project/module/submodule/pom.xml"));

        final List<MavenProject> projects = new ArrayList<>(3);

        projects.add(master);
        projects.add(module);
        projects.add(subModule);

        final Set<MavenProject> result = ProjectUtils.getProjectModules(master, projects, false, logger);

        assertNotNull(result);
        assertEquals(1, result.size());

        final List<MavenProject> verify = new ArrayList<>(projects);
        verify.remove(master);
        verify.remove(subModule);

        verifyProjectsPresent(verify, result);
    }

    @Test
    public void testGetProjectModules_ShouldExcludeNonModuleOfMasterProject() throws IOException {
        final MavenProject master = createTestProject("test", "testGroup", "1.0");

        master.setFile(new File("project/pom.xml"));

        final MavenProject other = createTestProject("other", "testGroup", "1.0");

        other.setFile(new File("other/pom.xml"));

        final List<MavenProject> projects = new ArrayList<>(3);

        projects.add(master);
        projects.add(other);

        final Set<MavenProject> result = ProjectUtils.getProjectModules(master, projects, true, logger);

        assertNotNull(result);
        assertTrue(result.isEmpty());
    }

    private void verifyProjectsPresent(final List<MavenProject> verify, final Set<MavenProject> result) {
        final List<MavenProject> verifyCopy = new ArrayList<>(verify);

        final List<MavenProject> unexpected = new ArrayList<>();

        for (final MavenProject project : result) {
            boolean removed = false;

            for (final Iterator<MavenProject> verifyIterator = verifyCopy.iterator(); verifyIterator.hasNext(); ) {
                final MavenProject verification = verifyIterator.next();

                if (verification.getId().equals(project.getId())) {
                    verifyIterator.remove();
                    removed = true;
                }
            }

            if (!removed) {
                unexpected.add(project);
            }
        }

        if (!verifyCopy.isEmpty()) {
            fail("Failed to verify presence of: " + verifyCopy);
        }

        if (!unexpected.isEmpty()) {
            fail("Found unexpected projects in result: " + unexpected);
        }
    }

    // private void verifyProjectsNotPresent( List verify, Set result )
    // {
    // List verifyCopy = new ArrayList( verify );
    //
    // for ( Iterator it = result.iterator(); it.hasNext(); )
    // {
    // MavenProject project = (MavenProject) it.next();
    //
    // for ( Iterator verifyIterator = verifyCopy.iterator(); verifyIterator.hasNext(); )
    // {
    // MavenProject verification = (MavenProject) verifyIterator.next();
    //
    // if ( verification.getId().equals( project.getId() ) )
    // {
    // verifyIterator.remove();
    // }
    // }
    // }
    //
    // if ( verifyCopy.size() != verify.size() )
    // {
    // List found = new ArrayList( verify );
    // found.removeAll( verifyCopy );
    //
    // fail( "Failed to verify absence of: " + found );
    // }
    // }

}