dd-trace-java/buildSrc/src/test/kotlin/datadog/gradle/plugin/muzzle/MuzzleVersionSubstitutionSupportTest.kt at 23240d2cb31cbafb2d8ca9a06c4b60c9289cc744 · DataDog/dd-trace-java · GitHub

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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
package datadog.gradle.plugin.muzzle

import org.assertj.core.api.Assertions.assertThat
import org.gradle.testfixtures.ProjectBuilder
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.io.TempDir
import java.nio.file.Path
import java.util.zip.ZipOutputStream
import kotlin.io.path.createDirectories
import kotlin.io.path.outputStream
import kotlin.io.path.readText
import kotlin.io.path.writeText

class MuzzleVersionSubstitutionSupportTest {

  @TempDir
  lateinit var tempDir: Path

  @Test
  fun `substituteVersion rewrites missing module version during resolution`() {
    val project = ProjectBuilder.builder()
      .withProjectDir(tempDir.resolve("project").toFile())
      .withName("test-project")
      .build()

    val repoDir = tempDir.resolve("repo")
    writeModule(repoDir, "org.example", "demo", "1.0")

    project.repositories.maven {
      url = repoDir.toUri()
    }

    val directive = MuzzleDirective().apply {
      substituteVersion("org.example:demo:2.0", "org.example:demo:1.0")
    }

    val configuration = project.configurations.create("muzzleTest") {
      isCanBeResolved = true
      isCanBeConsumed = false
      MuzzleVersionSubstitutionSupport.applyTo(project, this, directive)
    }
    project.dependencies.add(configuration.name, "org.example:demo:2.0")

    val resolved = configuration.resolvedConfiguration.resolvedArtifacts.single()
    assertThat(resolved.moduleVersion.id.group).isEqualTo("org.example")
    assertThat(resolved.name).isEqualTo("demo")
    assertThat(resolved.moduleVersion.id.version).isEqualTo("1.0")
  }

  @Test
  fun `substituteVersion supports multiple substitutions per directive`() {
    val project = ProjectBuilder.builder()
      .withProjectDir(tempDir.resolve("project").toFile())
      .withName("test-project")
      .build()

    val repoDir = tempDir.resolve("repo")
    writeModule(repoDir, "org.example", "alpha", "1.0")
    writeModule(repoDir, "org.example", "beta", "1.0")

    project.repositories.maven {
      url = repoDir.toUri()
    }

    val directive = MuzzleDirective().apply {
      substituteVersion("org.example:alpha:2.0", "org.example:alpha:1.0")
      substituteVersion("org.example:beta:2.0", "org.example:beta:1.0")
    }

    val alphaConfig = project.configurations.create("muzzleTestAlpha") {
      isCanBeResolved = true
      isCanBeConsumed = false
      MuzzleVersionSubstitutionSupport.applyTo(project, this, directive)
    }
    project.dependencies.add(alphaConfig.name, "org.example:alpha:2.0")
    val alphaResolved = alphaConfig.resolvedConfiguration.resolvedArtifacts.single()
    assertThat(alphaResolved.moduleVersion.id.version).isEqualTo("1.0")

    val betaConfig = project.configurations.create("muzzleTestBeta") {
      isCanBeResolved = true
      isCanBeConsumed = false
      MuzzleVersionSubstitutionSupport.applyTo(project, this, directive)
    }
    project.dependencies.add(betaConfig.name, "org.example:beta:2.0")
    val betaResolved = betaConfig.resolvedConfiguration.resolvedArtifacts.single()
    assertThat(betaResolved.moduleVersion.id.version).isEqualTo("1.0")
  }

  @Test
  fun `substituteVersion preserves rewritten pom for pom-only module`() {
    val project = ProjectBuilder.builder()
      .withProjectDir(tempDir.resolve("project").toFile())
      .withName("test-project")
      .build()

    val repoDir = tempDir.resolve("repo")
    writeModule(repoDir, "org.example", "bom", "1.0", true)

    project.repositories.maven {
      url = repoDir.toUri()
    }

    val directive = MuzzleDirective().apply {
      substituteVersion("org.example:bom:2.0", "org.example:bom:1.0")
    }

    project.configurations.create("muzzleTestPomOnly") {
      isCanBeResolved = true
      isCanBeConsumed = false
      MuzzleVersionSubstitutionSupport.applyTo(project, this, directive)
    }

    val generatedPom = tempDir.resolve(
      "project/build/generated/muzzle-version-substitutions/" +
        "muzzleTestPomOnly/org/example/bom/2.0/bom-2.0.pom"
    )
    assertThat(generatedPom.readText()).contains("<version>2.0</version>")
  }

  @Test
  fun `substituteVersion validates coordinate format`() {
    val directive = MuzzleDirective()

    org.junit.jupiter.api.assertThrows<IllegalArgumentException> {
      directive.substituteVersion("org.example:demo", "org.example:demo:1.0")
    }
  }

  private fun writeModule(
    repoDir: Path,
    group: String,
    module: String,
    version: String,
    pomModule: Boolean = false
  ) {
    val moduleDir = repoDir.resolve(group.replace('.', '/')).resolve(module).resolve(version).createDirectories()
    moduleDir.resolve("$module-$version.pom").writeText(
      """
      <project xmlns="http://maven.apache.org/POM/4.0.0">
        <modelVersion>4.0.0</modelVersion>
        <groupId>$group</groupId>
        <artifactId>$module</artifactId>
        <version>$version</version>
        ${if (pomModule) "<packaging>pom</packaging>" else ""}
      </project>
      """.trimIndent()
    )

    if (!pomModule) {
      ZipOutputStream(moduleDir.resolve("$module-$version.jar").outputStream()).use { }
    }
  }
}