elasticsearch/build-tools/build.gradle
Jack Conradson f7a7f0b923
Generate a test dependencies file to support unit tests in entitlements (#127486)
Generates a test file with the following information and format:

{
    "component": "<component name>",
    "locations": [
        {
            "representative_class": <class name with package>,
            "module": "<module name>"
        },
        ...
    ]
}

For painless:

{
    "component": "lang-painless",
    "locations": [
        {
            "representative_class": "org/objectweb/asm/tree/analysis/Analyzer.class",
            "module": "org.objectweb.asm.tree.analysis"
        },
        ...
    ]
}

Then it copies the following files into the jar for consumption by unit tests:

* META-INF/plugin-test-build-info.json
* META-INF/es-plugins/<plugin name>/plugin-descriptor.properties
* META-INF/es-plugins/<plugin name>/entitlement-policy.yaml

For server, the files in the jar become the following:

* META-INF/server-test-build-info.json

This should provide enough information for BootstrapForTesting to be 
able to build a mapping of caller class to policy file using the class file 
to look up the jar or directory within the class path and then associating 
that with it's specified module and finally using the specified module to 
look up the appropriate entitlement policy. 

caller class -> specified module -> entitlement policy


---------

Co-authored-by: Patrick Doyle <patrick.doyle@elastic.co>
2025-05-21 16:21:28 -07:00

192 lines
6.2 KiB
Groovy

/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the "Elastic License
* 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
* Public License v 1"; you may not use this file except in compliance with, at
* your election, the "Elastic License 2.0", the "GNU Affero General Public
* License v3.0 only", or the "Server Side Public License, v 1".
*/
buildscript {
repositories {
mavenCentral()
}
}
plugins {
id 'java-gradle-plugin'
id 'groovy'
id 'java-test-fixtures'
id 'elasticsearch.publish'
id 'elasticsearch.build-tools'
id 'elasticsearch.eclipse'
id 'elasticsearch.versions'
id 'elasticsearch.formatting'
}
description = "The elasticsearch build tools"
group = "org.elasticsearch.gradle"
version = versions.getProperty("elasticsearch")
java {
targetCompatibility = versions.get("minimumRuntimeJava")
sourceCompatibility = versions.get("minimumRuntimeJava")
}
gradlePlugin {
// We already configure publication and we don't need or want the one that comes
// with the java-gradle-plugin
automatedPublishing = false
plugins {
distributionDownload {
id = 'elasticsearch.distribution-download'
implementationClass = 'org.elasticsearch.gradle.DistributionDownloadPlugin'
}
esPlugin {
id = 'elasticsearch.esplugin'
implementationClass = 'org.elasticsearch.gradle.plugin.PluginBuildPlugin'
}
stableEsPlugin {
id = 'elasticsearch.stable-esplugin'
implementationClass = 'org.elasticsearch.gradle.plugin.StablePluginBuildPlugin'
}
testBuildInfo {
id = 'elasticsearch.test-build-info'
implementationClass = 'org.elasticsearch.gradle.test.TestBuildInfoPlugin'
}
javaRestTest {
id = 'elasticsearch.java-rest-test'
implementationClass = 'org.elasticsearch.gradle.test.JavaRestTestPlugin'
}
testclusters {
id = 'elasticsearch.testclusters'
implementationClass = 'org.elasticsearch.gradle.testclusters.TestClustersPlugin'
}
reaper {
id = 'elasticsearch.reaper'
implementationClass = 'org.elasticsearch.gradle.ReaperPlugin'
}
testpermissions {
id = 'elasticsearch.test-gradle-policy'
implementationClass = 'org.elasticsearch.gradle.test.GradleTestPolicySetupPlugin'
}
yamlTests {
id = 'elasticsearch.yaml-rest-test'
implementationClass = 'org.elasticsearch.gradle.test.YamlRestTestPlugin'
}
}
}
// we update the version property to reflect if we are building a snapshot or a release build
// we write this back out below to load it in the Build.java which will be shown in rest main action
// to indicate this being a snapshot build or a release build.
def generateVersionProperties = tasks.register("generateVersionProperties", WriteProperties) {
destinationFile = new File(buildDir, "version.properties");
comment = 'Generated version properties'
properties(versions)
}
tasks.named("processResources").configure {
from(generateVersionProperties)
into('META-INF') {
from configurations.reaper
}
}
sourceSets {
integTest {
compileClasspath += sourceSets["main"].output + configurations["testRuntimeClasspath"]
runtimeClasspath += output + compileClasspath
}
}
// we do not publish the test fixtures of build-tools
components.java.withVariantsFromConfiguration(configurations.testFixturesApiElements) { skip() }
components.java.withVariantsFromConfiguration(configurations.testFixturesRuntimeElements) { skip() }
publishing.publications.named("elastic").configure {
suppressPomMetadataWarningsFor("testFixturesApiElements")
suppressPomMetadataWarningsFor("testFixturesRuntimeElements")
}
configurations {
integTestImplementation.extendsFrom(testFixturesApi)
integTestImplementation.extendsFrom(testImplementation)
integTestRuntimeOnly.extendsFrom(testRuntimeOnly)
register("reaper")
}
repositories {
mavenCentral()
gradlePluginPortal()
}
dependencies {
constraints {
// ensuring brought asm version brought in by spock is up-to-date
testFixturesApi buildLibs.asm
integTestImplementation buildLibs.asm
}
reaper project('reaper')
api localGroovy()
api gradleApi()
api buildLibs.apache.compress
api buildLibs.ant
api buildLibs.commmons.io
implementation buildLibs.asm.tree
implementation buildLibs.asm
implementation buildLibs.jackson.core
implementation buildLibs.jackson.databind
testFixturesApi gradleApi()
testFixturesApi gradleTestKit()
testFixturesApi buildLibs.junit
testFixturesApi buildLibs.wiremock
testFixturesApi platform(buildLibs.spock.platform)
testFixturesApi(buildLibs.spock.core) {
exclude module: "groovy"
}
testFixturesApi(buildLibs.bytebuddy) {
because 'Generating dynamic plugin apis'
}
testImplementation(buildLibs.spock.junit4) {
because 'required as we rely on junit4 rules'
}
testImplementation(platform(buildLibs.junit5.platform))
testImplementation(buildLibs.junit5.jupiter) {
because 'allows to write and run Jupiter tests'
}
testRuntimeOnly(buildLibs.junit5.vintage) {
because 'allows JUnit 3 and JUnit 4 tests to run'
}
testRuntimeOnly(buildLibs.junit5.platform.launcher) {
because 'allows tests to run from IDEs that bundle older version of launcher'
}
}
tasks.withType(JavaCompile).configureEach {
options.incremental = System.getenv("JENKINS_URL") == null && System.getenv("BUILDKITE_BUILD_URL") == null && System.getProperty("isCI") == null
}
tasks.named('test').configure {
useJUnitPlatform()
}
tasks.register("integTest", Test) {
testClassesDirs = sourceSets.integTest.output.classesDirs
classpath = sourceSets.integTest.runtimeClasspath
useJUnitPlatform()
}
normalization {
runtimeClasspath {
// We already include the reaper jar as part of our runtime classpath. Ignore the copy in META-INF.
ignore('META-INF/reaper.jar')
}
}
tasks.named("check").configure { dependsOn("integTest") }