Introduce concept of 'test provided' scoped dependencies

'Test provided' dependencies are treated as 'provided' scoped
dependencies when building a test bundle. Other 'test' scoped
dependencies are bundled as 'compile'.

4 files changed, 161 insertions, 5 deletions

diff --git a/bundle-plugin/pom.xml b/bundle-plugin/pom.xml
index 611753528c3..4187071c1e1 100644
--- a/bundle-plugin/pom.xml
+++ b/bundle-plugin/pom.xml
@@ -39,6 +39,11 @@
             <scope>test</scope>
         </dependency>
         <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
         <groupId>org.hamcrest</groupId>
             <artifactId>hamcrest-library</artifactId>
             <scope>test</scope>
diff --git a/bundle-plugin/src/main/java/com/yahoo/container/plugin/mojo/Artifacts.java b/bundle-plugin/src/main/java/com/yahoo/container/plugin/mojo/Artifacts.java
index a0d0e143724..bc6a970140d 100644
--- a/bundle-plugin/src/main/java/com/yahoo/container/plugin/mojo/Artifacts.java
+++ b/bundle-plugin/src/main/java/com/yahoo/container/plugin/mojo/Artifacts.java
@@ -18,7 +18,10 @@ class Artifacts {
         private final List<Artifact> jarArtifactsProvided;
         private final List<Artifact> nonJarArtifacts;
 
-        private ArtifactSet(List<Artifact> jarArtifactsToInclude, List<Artifact> jarArtifactsProvided, List<Artifact> nonJarArtifacts) {
+        private ArtifactSet(
+                List<Artifact> jarArtifactsToInclude,
+                List<Artifact> jarArtifactsProvided,
+                List<Artifact> nonJarArtifacts) {
             this.jarArtifactsToInclude = jarArtifactsToInclude;
             this.jarArtifactsProvided = jarArtifactsProvided;
             this.nonJarArtifacts = nonJarArtifacts;
@@ -37,19 +40,24 @@ class Artifacts {
         }
     }
 
-    static ArtifactSet getArtifacts(MavenProject project) {
+    static ArtifactSet getArtifacts(MavenProject project) { return getArtifacts(project, false, null); }
 
+    static ArtifactSet getArtifacts(MavenProject project, boolean includeTestArtifacts, String testProvidedConfig) {
+        TestProvidedArtifacts testProvidedArtifacts = TestProvidedArtifacts.from(project.getArtifactMap(), testProvidedConfig);
         List<Artifact> jarArtifactsToInclude = new ArrayList<>();
         List<Artifact> jarArtifactsProvided = new ArrayList<>();
         List<Artifact> nonJarArtifactsToInclude = new ArrayList<>();
         List<Artifact> nonJarArtifactsProvided = new ArrayList<>();
-
         for (Artifact artifact : project.getArtifacts()) {
             if ("jar".equals(artifact.getType())) {
-                if (Artifact.SCOPE_COMPILE.equals(artifact.getScope())) {
+                if (includeTestArtifacts && testProvidedArtifacts.isTestProvided(artifact)) {
+                    jarArtifactsProvided.add(artifact);
+                } else if (Artifact.SCOPE_COMPILE.equals(artifact.getScope())) {
                     jarArtifactsToInclude.add(artifact);
                 } else if (Artifact.SCOPE_PROVIDED.equals(artifact.getScope())) {
                     jarArtifactsProvided.add(artifact);
+                } else if (includeTestArtifacts && Artifact.SCOPE_TEST.equals(artifact.getScope())) {
+                    jarArtifactsToInclude.add(artifact);
                 }
             } else {
                 if (Artifact.SCOPE_COMPILE.equals(artifact.getScope())) {
@@ -64,6 +72,6 @@ class Artifacts {
     }
 
     static Collection<Artifact> getArtifactsToInclude(MavenProject project) {
-        return getArtifacts(project).getJarArtifactsToInclude();
+        return getArtifacts(project, false, null).getJarArtifactsToInclude();
     }
 }
diff --git a/bundle-plugin/src/main/java/com/yahoo/container/plugin/mojo/TestProvidedArtifacts.java b/bundle-plugin/src/main/java/com/yahoo/container/plugin/mojo/TestProvidedArtifacts.java
new file mode 100644
index 00000000000..6f9e305f8d9
--- /dev/null
+++ b/bundle-plugin/src/main/java/com/yahoo/container/plugin/mojo/TestProvidedArtifacts.java
@@ -0,0 +1,73 @@
+// Copyright Verizon Media. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.container.plugin.mojo;
+
+import org.apache.maven.artifact.Artifact;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.stream.Stream;
+
+import static java.util.stream.Collectors.toList;
+
+/**
+ * Determines the test dependencies that are provided by the Vespa/JDisc test runtime based on the resolved dependency graph and a config string.
+ * "Test provided" dependencies are treated as "provided" scope dependencies when building a test bundle.
+ *
+ * @author bjorncs
+ */
+class TestProvidedArtifacts {
+
+    private final List<Artifact> artifacts;
+
+    private TestProvidedArtifacts(List<Artifact> artifacts) { this.artifacts = artifacts; }
+
+    boolean isTestProvided(Artifact artifact) { return artifacts.contains(artifact); }
+
+    static TestProvidedArtifacts from(Map<String, Artifact> artifacts, String configString) {
+        if (configString == null || configString.isBlank()) return new TestProvidedArtifacts(List.of());
+        return new TestProvidedArtifacts(getTestProvidedArtifacts(artifacts, configString));
+    }
+
+    private static List<Artifact> getTestProvidedArtifacts(Map<String, Artifact> artifacts, String configString) {
+        List<String> testProvidedArtifactStringIds = toTestProvidedArtifactStringIds(configString);
+        List<Artifact> testProvidedArtifacts = new ArrayList<>();
+        for (Artifact artifact : artifacts.values()) {
+            boolean hasTestProvidedArtifactAsParent =
+                    dependencyTrail(artifact, artifacts)
+                            .anyMatch(parent -> testProvidedArtifactStringIds.contains(toArtifactStringId(parent)));
+            boolean isBlacklisted = testProvidedArtifactStringIds.contains(toBlacklistedArtifactStringId(artifact));
+            if (hasTestProvidedArtifactAsParent && !isBlacklisted) {
+                testProvidedArtifacts.add(artifact);
+            }
+        }
+        return testProvidedArtifacts;
+    }
+
+    private static List<String> toTestProvidedArtifactStringIds(String commaSeparatedString) {
+        if (commaSeparatedString == null || commaSeparatedString.isBlank()) return List.of();
+        return Arrays.stream(commaSeparatedString.split(","))
+                .map(String::strip)
+                .filter(s -> !s.isBlank())
+                .collect(toList());
+    }
+
+    private static Stream<Artifact> dependencyTrail(Artifact artifact, Map<String, Artifact> otherArtifacts) {
+        return artifact.getDependencyTrail().stream()
+                .map(parentId -> otherArtifacts.get(stripVersionAndScope(parentId)))
+                .filter(Objects::nonNull);
+    }
+
+    private static String stripVersionAndScope(String fullArtifactIdentifier) {
+        int firstDelimiter = fullArtifactIdentifier.indexOf(':');
+        int secondDelimiter = fullArtifactIdentifier.indexOf(':', firstDelimiter + 1);
+        return fullArtifactIdentifier.substring(0, secondDelimiter);
+    }
+
+    private static String toArtifactStringId(Artifact artifact) { return artifact.getGroupId() + ":" + artifact.getArtifactId(); }
+
+    private static String toBlacklistedArtifactStringId(Artifact artifact) { return "!" + toArtifactStringId(artifact); }
+
+}
diff --git a/bundle-plugin/src/test/java/com/yahoo/container/plugin/mojo/TestProvidedArtifactsTest.java b/bundle-plugin/src/test/java/com/yahoo/container/plugin/mojo/TestProvidedArtifactsTest.java
new file mode 100644
index 00000000000..0c0bdffed6e
--- /dev/null
+++ b/bundle-plugin/src/test/java/com/yahoo/container/plugin/mojo/TestProvidedArtifactsTest.java
@@ -0,0 +1,70 @@
+// Copyright Verizon Media. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.container.plugin.mojo;
+
+
+import org.apache.maven.artifact.Artifact;
+import org.junit.Test;
+import org.mockito.Mockito;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.when;
+
+/**
+ * @author bjorncs
+ */
+public class TestProvidedArtifactsTest {
+
+    private static final String GROUP_ID = "com.test";
+
+    @Test
+    public void findsAllTestProvidedDependencies() {
+        Map<String, Artifact> artifacts = new TreeMap<>();
+        Artifact a = createArtifact(artifacts, "a");
+        Artifact aa = createArtifact(artifacts, "a-a", "a");
+        Artifact ab = createArtifact(artifacts, "a-b", "a");
+        Artifact aaa = createArtifact(artifacts, "a-a-a", "a", "a-a");
+        Artifact b = createArtifact(artifacts, "b");
+        Artifact ba = createArtifact(artifacts, "b-a", "b");
+        Artifact c = createArtifact(artifacts, "c");
+
+        String configString = "com.test:a,com.test:b-a,!com.test:a-b";
+        TestProvidedArtifacts testProvidedArtifacts = TestProvidedArtifacts.from(artifacts, configString);
+
+        assertTrue(testProvidedArtifacts.isTestProvided(a));
+        assertTrue(testProvidedArtifacts.isTestProvided(aa));
+        assertFalse(testProvidedArtifacts.isTestProvided(ab));
+        assertTrue(testProvidedArtifacts.isTestProvided(aaa));
+        assertFalse(testProvidedArtifacts.isTestProvided(b));
+        assertTrue(testProvidedArtifacts.isTestProvided(ba));
+        assertFalse(testProvidedArtifacts.isTestProvided(c));
+    }
+
+    private static Artifact createArtifact(Map<String, Artifact> artifacts, String artifactId, String... dependents) {
+        Artifact artifact = createArtifact(artifactId, dependents);
+        artifacts.put(simpleId(artifactId), artifact);
+        return artifact;
+    }
+
+    private static Artifact createArtifact(String artifactId, String... dependents) {
+        Artifact artifact = Mockito.mock(Artifact.class);
+        when(artifact.getArtifactId()).thenReturn(artifactId);
+        when(artifact.getGroupId()).thenReturn(GROUP_ID);
+        List<String> dependencyTrail = new ArrayList<>();
+        dependencyTrail.add(fullId("bundle-plugin"));
+        Arrays.stream(dependents).forEach(dependent -> dependencyTrail.add(fullId(dependent)));
+        dependencyTrail.add(fullId(artifactId));
+        when(artifact.getDependencyTrail()).thenReturn(dependencyTrail);
+        return artifact;
+    }
+
+    private static String fullId(String artifactId) { return simpleId(artifactId) + ":1.0:compile"; }
+    private static String simpleId(String artifactId) { return GROUP_ID + ":" + artifactId; }
+
+}
\ No newline at end of file