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.

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 arch test to detect usage of shared internal code #6978

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
64 changes: 46 additions & 18 deletions all/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,34 +1,19 @@
import java.util.stream.Collectors

plugins {
id("otel.java-conventions")
}

description = "OpenTelemetry All"
otelJava.moduleName.set("io.opentelemetry.all")

tasks {
// We don't compile much here, just some API boundary tests. This project is mostly for
// aggregating jacoco reports and it doesn't work if this isn't at least as high as the
// highest supported Java version in any of our projects. All of our
// projects target Java 8 except :exporters:http-sender:jdk, which targets
// Java 11
withType(JavaCompile::class) {
options.release.set(11)
}

val testJavaVersion: String? by project
if (testJavaVersion == "8") {
test {
enabled = false
}
}
}

// Skip OWASP dependencyCheck task on test module
dependencyCheck {
skip = true
}

val testTasks = mutableListOf<Task>()
val jarTasks = mutableListOf<Jar>()

dependencies {
rootProject.subprojects.forEach { subproject ->
Expand All @@ -41,13 +26,56 @@ dependencies {
subproject.tasks.withType<Test>().configureEach {
testTasks.add(this)
}
subproject.tasks.withType<Jar> {
if (this.archiveClassifier.get().isEmpty()) {
jarTasks.add(this)
}
}
}
}
}

testImplementation("com.tngtech.archunit:archunit-junit5")
}

val artifactsAndJarsFile = layout.buildDirectory.file("artifacts_and_jars.txt").get().asFile

var writeArtifactsAndJars = tasks.register("writeArtifactsAndJars") {
dependsOn(jarTasks)
artifactsAndJarsFile.createNewFile()
val content = jarTasks.stream()
.filter {
!it.archiveFile.get().toString().contains("jmh")
}
.map {
it.archiveBaseName.get() + ":" + it.archiveFile.get().toString()
}.collect(Collectors.joining("\n"))
artifactsAndJarsFile.writeText(content)
}

tasks {
// We don't compile much here, just some API boundary tests. This project is mostly for
// aggregating jacoco reports and it doesn't work if this isn't at least as high as the
// highest supported Java version in any of our projects. All of our
// projects target Java 8 except :exporters:http-sender:jdk, which targets
// Java 11
withType(JavaCompile::class) {
options.release.set(11)
}

val testJavaVersion: String? by project
if (testJavaVersion == "8") {
test {
enabled = false
}
} else {
test {
dependsOn(writeArtifactsAndJars)
environment("ARTIFACTS_AND_JARS", artifactsAndJarsFile.absolutePath)
}
}
}

// https://docs.gradle.org/current/samples/sample_jvm_multi_project_with_code_coverage.html

val sourcesPath by configurations.creating {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.all;

import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;

import com.tngtech.archunit.base.DescribedPredicate;
import com.tngtech.archunit.core.domain.JavaClass;
import com.tngtech.archunit.core.domain.JavaClasses;
import com.tngtech.archunit.core.importer.ClassFileImporter;
import com.tngtech.archunit.lang.syntax.elements.ClassesShouldConjunction;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Set;
import java.util.jar.JarFile;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

class NoSharedInternalCodeTest {

private static final String OTEL_BASE_PACKAGE = "io.opentelemetry";
private static final Logger logger = Logger.getLogger(NoSharedInternalCodeTest.class.getName());

@ParameterizedTest
@MethodSource("artifactsAndJars")
void noSharedInternalCode(String artifactId, String absolutePath) throws IOException {
JavaClasses artifactClasses =
new ClassFileImporter().importJar(new JarFile(new File(absolutePath)));

Set<String> artifactOtelPackages =
artifactClasses.stream()
.map(JavaClass::getPackageName)
.filter(packageName -> packageName.startsWith(OTEL_BASE_PACKAGE))
.collect(Collectors.toSet());

ClassesShouldConjunction noSharedInternalCodeRule =
noClasses()
.that()
.resideInAnyPackage(artifactOtelPackages.toArray(new String[0]))
.should()
.dependOnClassesThat(
new DescribedPredicate<>("are in internal modules of other opentelemetry artifacts") {
@Override
public boolean test(JavaClass javaClass) {
String packageName = javaClass.getPackageName();
return packageName.startsWith(OTEL_BASE_PACKAGE)
&& packageName.contains(".internal")
&& !artifactOtelPackages.contains(packageName);
}
});

// TODO: when all shared internal code is removed, remove the catch block and fail when detected
try {
noSharedInternalCodeRule.check(artifactClasses);
} catch (AssertionError e) {
logger.log(Level.WARNING, "Internal shared code detected for: " + artifactId + "\n" + e.getMessage() + "\n");
}
}

private static Stream<Arguments> artifactsAndJars() throws IOException {
List<String> lines = Files.readAllLines(Path.of(System.getenv("ARTIFACTS_AND_JARS")));
return lines.stream()
.map(line -> {
String[] parts = line.split(":");
return Arguments.of(parts[0], parts[1]);
});
}
}
Loading