summaryrefslogtreecommitdiffstats
path: root/bundle-plugin/src/test/java/com/yahoo/container/plugin/util/TestBundleDependencyScopeTranslatorTest.java
blob: e01477eb22a6c1f56e6b379e82b4e68066e2b3f8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// Copyright Verizon Media. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.plugin.util;


import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.DefaultArtifact;
import org.apache.maven.artifact.handler.DefaultArtifactHandler;
import org.junit.Test;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

import static org.junit.Assert.assertEquals;

/**
 * @author bjorncs
 */
public class TestBundleDependencyScopeTranslatorTest {

    private static final String GROUP_ID = "com.test";

    @Test
    public void test_dependencies_are_translated_to_compile_scope_by_default() {
        Map<String, Artifact> artifacts = new TreeMap<>();
        Artifact a = createArtifact(artifacts, "a", "test", List.of());
        Artifact aa = createArtifact(artifacts, "a-a", "test", List.of("a"));
        Artifact ab = createArtifact(artifacts, "a-b", "test", List.of("a"));
        Artifact aba = createArtifact(artifacts, "a-b-a", "test", List.of("a", "a-b"));

        TestBundleDependencyScopeTranslator translator = TestBundleDependencyScopeTranslator.from(artifacts, null);
        assertScope(translator, a, "compile");
        assertScope(translator, aa, "compile");
        assertScope(translator, ab, "compile");
        assertScope(translator, aba, "compile");

    }

    @Test
    public void non_test_scope_dependencies_keep_original_scope() {
        Map<String, Artifact> artifacts = new TreeMap<>();
        Artifact a = createArtifact(artifacts, "a", "provided", List.of());
        Artifact aa = createArtifact(artifacts, "a-a", "provided", List.of("a"));
        Artifact ab = createArtifact(artifacts, "a-b", "provided", List.of("a"));
        Artifact b = createArtifact(artifacts, "b", "runtime", List.of());
        Artifact ba = createArtifact(artifacts, "b-a", "runtime", List.of("b"));
        Artifact c = createArtifact(artifacts, "c", "test", List.of());
        Artifact ca = createArtifact(artifacts, "c-a", "test", List.of("c"));

        TestBundleDependencyScopeTranslator translator = TestBundleDependencyScopeTranslator.from(artifacts, null);
        assertScope(translator, a, "provided");
        assertScope(translator, aa, "provided");
        assertScope(translator, ab, "provided");
        assertScope(translator, b, "runtime");
        assertScope(translator, ba, "runtime");
        assertScope(translator, c, "compile");
        assertScope(translator, ca, "compile");
    }

    @Test
    public void ordering_in_config_string_determines_translation() {
        Map<String, Artifact> artifacts = new TreeMap<>();
        Artifact a = createArtifact(artifacts, "a", "test", List.of());
        Artifact aa = createArtifact(artifacts, "a-a", "test", List.of("a"));
        {
            String configString =
                    "com.test:a-a:runtime," +
                    "com.test:a:test,";
            TestBundleDependencyScopeTranslator translator = TestBundleDependencyScopeTranslator.from(artifacts, configString);
            assertScope(translator, a, "test");
            assertScope(translator, aa, "runtime");
        }
        {
            String configString =
                    "com.test:a:test," +
                    "com.test:a-a:runtime";
            TestBundleDependencyScopeTranslator translator = TestBundleDependencyScopeTranslator.from(artifacts, configString);
            assertScope(translator, a, "test");
            assertScope(translator, aa, "test");
        }
    }

    @Test
    public void transitive_non_test_dependencies_of_test_dependencies_keep_original_scope() {
        Map<String, Artifact> artifacts = new TreeMap<>();
        Artifact a = createArtifact(artifacts, "a", "test", List.of());
        Artifact aa = createArtifact(artifacts, "a-a", "test", List.of("a"));
        Artifact ab = createArtifact(artifacts, "a-b", "test", List.of("a"));
        Artifact aba = createArtifact(artifacts, "a-b-a", "compile", List.of("a", "a-b"));
        Artifact ac = createArtifact(artifacts, "a-c", "runtime", List.of("a"));
        Artifact b = createArtifact(artifacts, "b", "test", List.of());
        Artifact ba = createArtifact(artifacts, "b-a", "test", List.of("b"));
        Artifact bb = createArtifact(artifacts, "b-b", "provided", List.of("b"));

        String configString = "com.test:a:provided";
        TestBundleDependencyScopeTranslator translator = TestBundleDependencyScopeTranslator.from(artifacts, configString);
        assertScope(translator, a, "provided");
        assertScope(translator, aa, "provided");
        assertScope(translator, ab, "provided");
        assertScope(translator, aba, "compile");
        assertScope(translator, ac, "runtime");
        assertScope(translator, b, "compile");
        assertScope(translator, ba, "compile");
        assertScope(translator, bb, "provided");
    }

    private static Artifact createArtifact(
            Map<String, Artifact> artifacts, String artifactId, String scope, List<String> transitiveDependents) {
        Artifact artifact = createArtifact(artifactId, scope, transitiveDependents);
        artifacts.put(simpleId(artifactId), artifact);
        return artifact;
    }

    private static Artifact createArtifact(String artifactId, String scope, List<String> transitiveDependents) {
        Artifact artifact = new DefaultArtifact(
                GROUP_ID, artifactId, "1.0", scope, "jar", /*classifier*/null, new DefaultArtifactHandler("jar"));
        List<String> dependencyTrail = new ArrayList<>();
        dependencyTrail.add(GROUP_ID + "my-project:container-plugin:1-SNAPSHOT");
        transitiveDependents.forEach(dependent -> dependencyTrail.add(fullId(dependent)));
        dependencyTrail.add(fullId(artifactId));
        artifact.setDependencyTrail(dependencyTrail);
        return artifact;
    }

    private static void assertScope(
            TestBundleDependencyScopeTranslator translator, Artifact artifact, String expectedScope) {
        assertEquals(expectedScope, translator.scopeOf(artifact));
    }

    private static String fullId(String artifactId) { return simpleId(artifactId) + ":jar:1.0"; }
    private static String simpleId(String artifactId) { return GROUP_ID + ":" + artifactId; }

}