Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more tags to build scans #5

Merged
merged 1 commit into from
Feb 29, 2024
Merged

Add more tags to build scans #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@
<maven-core.version>3.9.6</maven-core.version>
<plexus-component.version>2.2.0</plexus-component.version>
<sisu-inject.version>0.3.5</sisu-inject.version>
<junit.version>5.10.2</junit.version>

<maven-compiler-plugin.version>3.12.1</maven-compiler-plugin.version>
<maven-surefire-plugin.version>3.2.5</maven-surefire-plugin.version>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.release>17</maven.compiler.release>
<maven.compiler.parameters>true</maven.compiler.parameters>
Expand All @@ -34,6 +36,18 @@
<ossrh.snapshots.repo.url>https://oss.sonatype.org/content/repositories/snapshots</ossrh.snapshots.repo.url>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.junit</groupId>
<artifactId>junit-bom</artifactId>
<version>${junit.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
Expand All @@ -53,6 +67,32 @@
<version>${gradle-enterprise-maven-extension.version}</version>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-suite-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-launcher</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-params</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand All @@ -71,6 +111,11 @@
</annotationProcessorPaths>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>${maven-surefire-plugin.version}</version>
</plugin>
<plugin>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-component-metadata</artifactId>
Expand Down
108 changes: 104 additions & 4 deletions src/main/java/org/hibernate/search/develocity/scan/BuildScanMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,27 @@

import static org.hibernate.search.develocity.util.Strings.isBlank;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Objects;
import java.util.function.Function;
import java.util.regex.Pattern;

import org.hibernate.search.develocity.Log;
import org.hibernate.search.develocity.util.JavaVersions;
import org.hibernate.search.develocity.util.Strings;

import com.gradle.maven.extension.api.scan.BuildScanApi;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.project.MavenProject;

public final class BuildScanMetadata {

private static final Pattern DOCKERFILE_FROM_PATTERN = Pattern.compile( "FROM (.+)" );
private static final Pattern CONTAINER_IMAGE_SHORT_PATTERN = Pattern.compile(
"^(?:.*/)?([^/]+:[^-.]+(?:[-.][^-.]+)?).*$" );

private BuildScanMetadata() {
}

Expand All @@ -25,15 +36,104 @@ public static void addMetadataToBuildScan(BuildScanApi buildScanApi, MavenSessio

buildScanApi.tag( "hibernate-search" );

recordExecutableVersion( buildScanApi, mavenSession, "java-version.main.compiler", JavaVersions::forJavacExecutable );
recordExecutableVersion( buildScanApi, mavenSession, "java-version.test.compiler", JavaVersions::forJavacExecutable );
recordExecutableVersion( buildScanApi, mavenSession, "java-version.test.launcher", JavaVersions::forJavaExecutable );
for ( MavenProject project : mavenSession.getProjects() ) {
tagIntegrations( buildScanApi, mavenSession, project );
}

recordExecutableVersion(
buildScanApi, mavenSession, "java-version.main.compiler", JavaVersions::forJavacExecutable );
recordExecutableVersion(
buildScanApi, mavenSession, "java-version.test.compiler", JavaVersions::forJavacExecutable );
recordExecutableVersion(
buildScanApi, mavenSession, "java-version.test.launcher", JavaVersions::forJavaExecutable );
}

private static void tagIntegrations(BuildScanApi buildScanApi, MavenSession mavenSession, MavenProject project) {
var dbKind = getStringProperty( project, "test.database.run.kind" );
if ( !Strings.isBlank( dbKind ) ) {
if ( dbKind.equals( "h2" ) ) {
// H2 doesn't use containers
buildScanApi.tag( "h2" );
}
else {
tagDockerfileShortImageRef( buildScanApi, mavenSession,
"database/%s.Dockerfile".formatted( dbKind ), null
);
}
}
if ( !getBooleanProperty( project, "test.lucene.skip" ) ) {
buildScanApi.tag( "lucene" );
}
if ( !getBooleanProperty( project, "test.elasticsearch.skip" )
&& getBooleanProperty( project, "test.elasticsearch.run.image.pull" ) ) {
var distribution = getStringProperty( mavenSession, "test.elasticsearch.distribution" );
tagDockerfileShortImageRef( buildScanApi, mavenSession,
"search-backend/%s.Dockerfile".formatted( distribution ),
getStringProperty( mavenSession, "test.elasticsearch.version" )
);
}
}

private static void tagDockerfileShortImageRef(BuildScanApi buildScanApi, MavenSession mavenSession,
String dockerfileRelativePath, String versionOverride) {
var path = Path.of( mavenSession.getExecutionRootDirectory(), "build/container", dockerfileRelativePath );
try {
String ref;
try ( var stream = Files.lines( path ) ) {
ref = stream.map( line -> {
var matcher = DOCKERFILE_FROM_PATTERN.matcher( line );
if ( matcher.matches() ) {
return matcher.group( 1 ).trim();
}
else {
return null;
}
} )
.filter( Objects::nonNull )
.findFirst()
.orElseThrow();
}
if ( !Strings.isBlank( versionOverride ) ) {
ref = ref.substring( 0, ref.lastIndexOf( ':' ) + 1 ) + versionOverride;
}
String shortImageRef = toShortImageRef( ref );
buildScanApi.tag( shortImageRef );
buildScanApi.value(
shortImageRef.substring( 0, shortImageRef.lastIndexOf( ':' ) ),
ref.substring( ref.lastIndexOf( ':' ) + 1 )
);
}
catch (RuntimeException | IOException e) {
Log.warn( "Unable to add tag from Dockerfile at %s: %s".formatted( path, e.getMessage() ) );
}
}

static String toShortImageRef(String ref) {
var matcher = CONTAINER_IMAGE_SHORT_PATTERN.matcher( ref );
if ( matcher.matches() ) {
return matcher.group( 1 );
}
else {
return ref;
}
}

private static void recordExecutableVersion(BuildScanApi buildScanApi, MavenSession mavenSession,
String propertyName, Function<String, String> executableToVersion) {
String javaExecutable = (String) mavenSession.getResult().getProject().getProperties().get( propertyName );
String javaExecutable = getStringProperty( mavenSession, propertyName );
String javaVersion = executableToVersion.apply( javaExecutable );
buildScanApi.value( propertyName, "Path: %s\nResolved version: %s".formatted( javaExecutable, javaVersion ) );
}

private static String getStringProperty(MavenSession mavenSession, String key) {
return getStringProperty( mavenSession.getResult().getProject(), key );
}

private static String getStringProperty(MavenProject project, String key) {
return (String) project.getProperties().get( key );
}

private static boolean getBooleanProperty(MavenProject project, String key) {
return Boolean.parseBoolean( getStringProperty( project, key ) );
}
}
30 changes: 30 additions & 0 deletions src/test/java/org/hibernate/search/develocity/scan/BuildScanMetadataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
*
* * Hibernate Search, full-text search for your domain model
* *
* * License: GNU Lesser General Public License (LGPL), version 2.1 or later
* * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*
*/
package org.hibernate.search.develocity.scan;

import static org.junit.jupiter.api.Assertions.assertEquals;

import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;

class BuildScanMetadataTest {

@ParameterizedTest
@CsvSource(textBlock = """
elasticsearch:7.10,docker.io/elastic/elasticsearch:7.10.1
elasticsearch:latest,docker.io/elastic/elasticsearch:latest
elasticsearch:7.10,elasticsearch:7.10.1
elasticsearch:latest,elasticsearch:latest
elasticsearch:7-foo,docker.io/elastic/elasticsearch:7-foo
""")
void toShortImageRef(String expected, String ref) {
assertEquals( expected, BuildScanMetadata.toShortImageRef( ref ) );
}

}