MavenPomPropertiesAdvisorTest.java

/**
 * Copyright (c) 2010, 2013 Darmstadt University of Technology.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Olav Lenz - initial API and implementation
 */
package org.eclipse.recommenders.coordinates.maven;

import static com.google.common.collect.ImmutableMap.of;
import static org.eclipse.recommenders.coordinates.DependencyType.*;
import static org.eclipse.recommenders.coordinates.maven.MavenPomPropertiesAdvisor.*;
import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;

import java.io.File;
import java.util.Collection;
import java.util.LinkedList;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;

import org.eclipse.recommenders.coordinates.DependencyInfo;
import org.eclipse.recommenders.coordinates.IProjectCoordinateAdvisor;
import org.eclipse.recommenders.coordinates.ProjectCoordinate;
import org.eclipse.recommenders.utils.Zips.IFileToJarFileConverter;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;

import com.google.common.base.Optional;
import com.google.common.collect.Lists;

@RunWith(Parameterized.class)
public class MavenPomPropertiesAdvisorTest {

    private static final DependencyInfo EXAMPLE_JAR = new DependencyInfo(new File("example.jar").getAbsoluteFile(),
            JAR);
    private static final DependencyInfo EXAMPLE_PROJECT = new DependencyInfo(new File("example").getAbsoluteFile(),
            PROJECT);

    private static final Properties ORG_EXAMPLE_PROPS = gavProperties("org.example", "example", "1.0.0");
    private static final Properties COM_EXAMPLE_PROPS = gavProperties("com.example", "example", "1.0.0");
    private static final ProjectCoordinate COORDINATE = new ProjectCoordinate("org.example", "example", "1.0.0");

    private final DependencyInfo dependency;
    private final IFileToJarFileConverter fileToJarFileConverter;
    private final Optional<ProjectCoordinate> expectedCoordinate;

    public MavenPomPropertiesAdvisorTest(String description, DependencyInfo dependency,
            IFileToJarFileConverter fileToJarFileConverter, Optional<ProjectCoordinate> expectedCoordinate) {
        this.dependency = dependency;
        this.fileToJarFileConverter = fileToJarFileConverter;
        this.expectedCoordinate = expectedCoordinate;
    }

    @Parameters(name = "{index}: {0}")
    public static Collection<Object[]> scenarios() {
        LinkedList<Object[]> scenarios = Lists.newLinkedList();

        scenarios.add(scenario("Valid pom.properties, correct directory structure", EXAMPLE_JAR,
                of("META-INF/maven/org.example/example/pom.properties", ORG_EXAMPLE_PROPS), COORDINATE));

        scenarios.add(scenario("Wrong directory structure: pom.properties in root directory", EXAMPLE_JAR,
                of("pom.properties", ORG_EXAMPLE_PROPS), null));

        scenarios.add(scenario("Wrong directory structure: META-INF directory missing", EXAMPLE_JAR,
                of("maven/org.example/example/pom.properties", ORG_EXAMPLE_PROPS), null));

        scenarios.add(scenario("Wrong directory structure: maven directory missing", EXAMPLE_JAR,
                of("META-INF/org.example/example/pom.properties", ORG_EXAMPLE_PROPS), null));

        scenarios.add(scenario("Wrong directory structure: invalid file extension", EXAMPLE_JAR,
                of("META-INF/maven/org.example/example/pom.invalid", ORG_EXAMPLE_PROPS), null));

        scenarios.add(scenario("Invalid pom.properties: groupId mismatch", EXAMPLE_JAR,
                of("META-INF/maven/invalid/example/pom.properties", ORG_EXAMPLE_PROPS), null));

        scenarios.add(scenario("Invalid pom.properties: artifactId mismatch", EXAMPLE_JAR,
                of("META-INF/maven/org.example/invalid/pom.properties", ORG_EXAMPLE_PROPS), null));

        scenarios.add(scenario("Invalid pom.properties: no groupId", EXAMPLE_JAR,
                of("META-INF/maven/org.example/example/pom.properties", gavProperties(null, "example", "1.0.0")),
                null));

        scenarios.add(scenario("Invalid pom.properties: no artifactId", EXAMPLE_JAR,
                of("META-INF/maven/org.example/example/pom.properties", gavProperties("org.example", null, "1.0.0")),
                null));

        scenarios.add(scenario("Invalid pom.properties: no version", EXAMPLE_JAR,
                of("META-INF/maven/org.example/example/pom.properties",
                        gavProperties("org.example", "example", null)),
                null));

        scenarios.add(scenario("Wrong dependency type", EXAMPLE_PROJECT,
                of("META-INF/maven/org.example/example/pom.properties", ORG_EXAMPLE_PROPS), null));

        scenarios.add(scenario("Multiple pom.properties, only one valid", EXAMPLE_JAR,
                of("META-INF/maven/invalid/example/pom.properties", ORG_EXAMPLE_PROPS,
                        "META-INF/maven/org.example/example/pom.properties", ORG_EXAMPLE_PROPS),
                COORDINATE));
        scenarios.add(scenario("Multiple pom.properties, only one valid", EXAMPLE_JAR,
                of("META-INF/maven/org.example/example/pom.properties", ORG_EXAMPLE_PROPS,
                        "META-INF/maven/invalid/example/pom.properties", ORG_EXAMPLE_PROPS),
                COORDINATE));

        scenarios.add(scenario("Multiple pom.properties, all valid", EXAMPLE_JAR,
                of("META-INF/maven/org.example/example/pom.properties", ORG_EXAMPLE_PROPS,
                        "META-INF/maven/com.example/example/pom.properties", COM_EXAMPLE_PROPS),
                null));
        scenarios.add(scenario("Multiple pom.properties, all valid", EXAMPLE_JAR,
                of("META-INF/maven/com.example/example/pom.properties", COM_EXAMPLE_PROPS,
                        "META-INF/maven/org.example/example/pom.properties", ORG_EXAMPLE_PROPS),
                null));

        return scenarios;
    }

    @Test
    public void testScenario() {
        IProjectCoordinateAdvisor sut = new MavenPomPropertiesAdvisor(fileToJarFileConverter);

        Optional<ProjectCoordinate> result = sut.suggest(dependency);

        assertThat(result, is(expectedCoordinate));
    }

    private static Object[] scenario(String description, DependencyInfo dependency,
            Map<String, Properties> propertyFiles, ProjectCoordinate expectedProjectCoordinate) {
        return new Object[] { description, dependency, createIFileToJarFileConverter(propertyFiles),
                Optional.fromNullable(expectedProjectCoordinate) };
    }

    private static Properties gavProperties(String groupId, String artifactId, String version) {
        Properties properties = new Properties();
        putIfNonNull(properties, GROUP_ID, groupId);
        putIfNonNull(properties, ARTIFACT_ID, artifactId);
        putIfNonNull(properties, VERSION, version);
        return properties;
    }

    private static void putIfNonNull(Properties properties, String key, String value) {
        if (value != null) {
            properties.put(key, value);
        }
    }

    private static IFileToJarFileConverter createIFileToJarFileConverter(Map<String, Properties> propertyFiles) {
        IFileToJarFileConverterMockBuilder builder = new IFileToJarFileConverterMockBuilder();
        for (Entry<String, Properties> propertyFile : propertyFiles.entrySet()) {
            builder.put(propertyFile.getKey(), propertyFile.getValue());
        }
        return builder.build();
    }
}