Skip to content

Commit de7e738

Browse files
trasktrask
committed
Refactor check-package-names.sh to validate both library and javaagent source sets
Extracts a check_source_set function and runs it for both library and javaagent source roots. Previously only library/ was validated. This adds enforcement for javaagent module/package naming and produces explicit allow-lists for the historical exceptions and the no-base-version common modules.
1 parent f9fab4f commit de7e738

1 file changed

Lines changed: 168 additions & 58 deletions

File tree

‎.github/scripts/check-package-names.sh‎

Lines changed: 168 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,180 @@
11
#!/bin/bash -e
22

3-
for dir in $(find instrumentation -name "*.java" | grep library/src/main/java | sed 's#/[^/]*$##' | sort -u); do
3+
check_source_set() {
4+
local source_set="$1"
5+
local expected_prefix="$2"
46

5-
module_name=$(echo "$dir" | sed 's#.*/\([^/]*\)/library/src/main/java[0-9]*/.*#\1#')
7+
for dir in $(find instrumentation -name "*.java" | grep "$source_set/src/main/java" | sed 's#/[^/]*$##' | sort -u); do
68

7-
if [[ "$module_name" =~ ^java- ]]; then
8-
continue
9-
fi
10-
if [[ "$module_name" == "jmx-metrics" ]]; then
11-
continue
12-
fi
13-
if [[ "$module_name" == "runtime-telemetry" ]]; then
14-
continue
15-
fi
16-
if [[ "$module_name" == "servlet-common" ]]; then
17-
continue
18-
fi
19-
if [[ "$module_name" == "graphql-java-common-12.0" ]]; then
20-
continue
21-
fi
9+
module_name=$(echo "$dir" | sed "s#.*/\([^/]*\)/$source_set/src/main/java[0-9]*/.*#\1#")
2210

23-
# these are possibly problematic
24-
if [[ "$dir" == "instrumentation/grpc-1.6/library/src/main/java/io/grpc/override" ]]; then
25-
continue
26-
fi
27-
if [[ "$dir" == "instrumentation/lettuce/lettuce-5.1/library/src/main/java/io/lettuce/core/protocol" ]]; then
28-
continue
29-
fi
30-
if [[ "$dir" == "instrumentation/nats/nats-2.17/library/src/main/java/io/nats/client/impl" ]]; then
31-
continue
32-
fi
33-
if [[ "$dir" == "instrumentation/rxjava/rxjava-1.0/library/src/main/java/rx" ]]; then
34-
continue
35-
fi
11+
if [[ "$module_name" =~ ^java- ]]; then
12+
continue
13+
fi
14+
if [[ "$module_name" == "jmx-metrics" ]]; then
15+
continue
16+
fi
17+
if [[ "$module_name" == "runtime-telemetry" ]]; then
18+
continue
19+
fi
20+
if [[ "$module_name" == "servlet-common" ]]; then
21+
continue
22+
fi
23+
if [[ "$module_name" == "graphql-java-common-12.0" ]]; then
24+
continue
25+
fi
3626

37-
# some common modules don't have any base version (might have a variant instead, ex: javax)
38-
# - jdbc
39-
# - lettuce-common
40-
# - netty-common
41-
# - oshi
42-
# - resources
43-
# - servlet-common-javax
44-
if [[ ! "$module_name" =~ [0-9]$ && "$module_name" != "jdbc" && "$module_name" != "lettuce-common" && "$module_name" != "netty-common" && "$module_name" != "oshi" && "$module_name" != "resources" && "$module_name" != "servlet-common-javax" ]]; then
45-
echo "module name doesn't have a base version: $dir"
46-
exit 1
47-
fi
27+
# these are possibly problematic
28+
if [[ "$source_set" == "library" ]]; then
29+
if [[ "$dir" == "instrumentation/grpc-1.6/library/src/main/java/io/grpc/override" ]]; then
30+
continue
31+
fi
32+
if [[ "$dir" == "instrumentation/lettuce/lettuce-5.1/library/src/main/java/io/lettuce/core/protocol" ]]; then
33+
continue
34+
fi
35+
if [[ "$dir" == "instrumentation/nats/nats-2.17/library/src/main/java/io/nats/client/impl" ]]; then
36+
continue
37+
fi
38+
if [[ "$dir" == "instrumentation/rxjava/rxjava-1.0/library/src/main/java/rx" ]]; then
39+
continue
40+
fi
41+
fi
4842

49-
# convention: if module ends with -java (followed by version), remove -java from the package name
50-
simple_module_name=$(echo "$module_name" | sed 's/-[0-9.]*$//' | sed 's/-java$//' | sed 's/-//g')
51-
base_version=$(echo "$module_name" | sed 's/.*-\([0-9.]*\)$/\1/' | sed 's/\./_/g')
43+
if [[ "$source_set" == "javaagent" ]]; then
44+
# advice packages that must live under the instrumented library's own namespace
45+
case "$dir" in
46+
instrumentation/clickhouse/clickhouse-client-v1-0.5/javaagent/src/main/java/com/clickhouse/client*) continue ;;
47+
instrumentation/finagle-http-23.11/javaagent/src/main/java/com/twitter/finagle*) continue ;;
48+
instrumentation/finagle-http-23.11/javaagent/src/main/java/io/netty/channel*) continue ;;
49+
instrumentation/reactor/reactor-netty/reactor-netty-1.0/javaagent/src/main/java/reactor/netty/http/client*) continue ;;
50+
instrumentation/spring/spring-webmvc/spring-webmvc-3.1/javaagent/src/main/java/org/springframework/web/servlet/v3_1*) continue ;;
51+
instrumentation/spring/spring-webmvc/spring-webmvc-6.0/javaagent/src/main/java/org/springframework/web/servlet/v6_0*) continue ;;
52+
instrumentation/vertx/vertx-redis-client-4.0/javaagent/src/main/java/io/vertx/redis/client/impl*) continue ;;
53+
instrumentation/vertx/vertx-sql-client/vertx-sql-client-common-4.0/javaagent/src/main/java/io/vertx/sqlclient/impl*) continue ;;
54+
esac
5255

53-
if [[ "$module_name" =~ [0-9]$ ]]; then
54-
expected_package_name="io/opentelemetry/instrumentation/$simple_module_name/v$base_version"
55-
else
56-
expected_package_name="io/opentelemetry/instrumentation/$simple_module_name"
57-
fi
56+
# historical javaagent modules that do not follow the module-name <-> package-name convention
57+
case "$dir" in
58+
instrumentation/akka/akka-actor-fork-join-2.5/javaagent/*) continue ;;
59+
instrumentation/akka/akka-http-10.0/javaagent/*) continue ;;
60+
instrumentation/aws-sdk/aws-sdk-1.11/javaagent/*) continue ;;
61+
instrumentation/aws-sdk/aws-sdk-2.2/javaagent/*) continue ;;
62+
instrumentation/camel-2.20/javaagent/*) continue ;;
63+
instrumentation/clickhouse/clickhouse-client-common/javaagent/*) continue ;;
64+
instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent/*) continue ;;
65+
instrumentation/elasticsearch/elasticsearch-rest-common-5.0/javaagent/*) continue ;;
66+
instrumentation/elasticsearch/elasticsearch-transport-common/javaagent/*) continue ;;
67+
instrumentation/external-annotations/javaagent/*) continue ;;
68+
instrumentation/hibernate/hibernate-procedure-call-4.3/javaagent/*) continue ;;
69+
instrumentation/internal/internal-application-logger/javaagent/*) continue ;;
70+
instrumentation/internal/internal-eclipse-osgi-3.6/javaagent/*) continue ;;
71+
instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-annotations/javaagent/*) continue ;;
72+
instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-common/javaagent/*) continue ;;
73+
instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-annotations/javaagent/*) continue ;;
74+
instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-common/javaagent/*) continue ;;
75+
instrumentation/jaxrs/jaxrs-common/javaagent/*) continue ;;
76+
instrumentation/jaxws/jaxws-jws-api-1.1/javaagent/*) continue ;;
77+
instrumentation/jsf/jsf-mojarra-1.2/javaagent/*) continue ;;
78+
instrumentation/jsf/jsf-mojarra-3.0/javaagent/*) continue ;;
79+
instrumentation/jsf/jsf-myfaces-1.2/javaagent/*) continue ;;
80+
instrumentation/jsf/jsf-myfaces-3.0/javaagent/*) continue ;;
81+
instrumentation/kotlinx-coroutines/kotlinx-coroutines-1.0/javaagent/*) continue ;;
82+
instrumentation/kotlinx-coroutines/kotlinx-coroutines-flow-1.3/javaagent/*) continue ;;
83+
instrumentation/liberty/liberty-dispatcher-20.0/javaagent/*) continue ;;
84+
instrumentation/opensearch/opensearch-rest-common/javaagent/*) continue ;;
85+
instrumentation/opentelemetry-api/opentelemetry-api-1.0/javaagent/*) continue ;;
86+
instrumentation/opentelemetry-extension-annotations-1.0/javaagent/*) continue ;;
87+
instrumentation/opentelemetry-extension-kotlin-1.0/javaagent/*) continue ;;
88+
instrumentation/opentelemetry-instrumentation-annotations-1.16/javaagent/*) continue ;;
89+
instrumentation/opentelemetry-instrumentation-api/javaagent/*) continue ;;
90+
instrumentation/play/play-mvc/play-mvc-2.4/javaagent/*) continue ;;
91+
instrumentation/play/play-mvc/play-mvc-2.6/javaagent/*) continue ;;
92+
instrumentation/play/play-ws/play-ws-common/javaagent/*) continue ;;
93+
instrumentation/scala-fork-join-2.8/javaagent/*) continue ;;
94+
instrumentation/spark-2.3/javaagent/*) continue ;;
95+
instrumentation/spring/spring-boot-actuator-autoconfigure-2.0/javaagent/*) continue ;;
96+
instrumentation/spring/spring-boot-resources/javaagent/*) continue ;;
97+
esac
98+
fi
5899

59-
package_name=$(echo "$dir" | sed 's#.*/src/main/java[0-9]*/##')
100+
# some common modules don't have any base version (might have a variant instead, ex: javax)
101+
if [[ ! "$module_name" =~ [0-9]$ ]]; then
102+
case "$source_set:$module_name" in
103+
# library:
104+
library:jdbc) ;;
105+
library:lettuce-common) ;;
106+
library:netty-common) ;;
107+
library:oshi) ;;
108+
library:resources) ;;
109+
library:servlet-common-javax) ;;
110+
# javaagent:
111+
javaagent:clickhouse-client-common) ;;
112+
javaagent:elasticsearch-transport-common) ;;
113+
javaagent:executors) ;;
114+
javaagent:external-annotations) ;;
115+
javaagent:http-url-connection) ;;
116+
javaagent:internal-application-logger) ;;
117+
javaagent:internal-class-loader) ;;
118+
javaagent:internal-lambda) ;;
119+
javaagent:internal-reflection) ;;
120+
javaagent:internal-url-class-loader) ;;
121+
javaagent:jaxrs-common) ;;
122+
javaagent:jaxws-common) ;;
123+
javaagent:jdbc) ;;
124+
javaagent:jetty-common) ;;
125+
javaagent:jsf-common-jakarta) ;;
126+
javaagent:jsf-common-javax) ;;
127+
javaagent:methods) ;;
128+
javaagent:opensearch-rest-common) ;;
129+
javaagent:opentelemetry-instrumentation-api) ;;
130+
javaagent:oshi) ;;
131+
javaagent:payara) ;;
132+
javaagent:play-ws-common) ;;
133+
javaagent:quarkus-resteasy-reactive) ;;
134+
javaagent:rmi) ;;
135+
javaagent:spring-boot-resources) ;;
136+
javaagent:spring-cloud-gateway-common) ;;
137+
javaagent:spring-webmvc-common) ;;
138+
javaagent:tomcat-common) ;;
139+
javaagent:tomcat-jdbc) ;;
140+
javaagent:xxl-job-common) ;;
141+
*)
142+
echo "module name doesn't have a base version: $dir"
143+
exit 1
144+
;;
145+
esac
146+
fi
60147

61-
# deal with differences like module name elasticsearch-rest and package name elasticsearch.rest
62-
expected_package_name_normalized=$(echo "$expected_package_name" | sed 's#/##g')
63-
package_name_normalized=$(echo "$package_name" | sed 's#/##g')
148+
# build expected package name by walking the module name's dash-separated tokens:
149+
# a version token (e.g. "3.0") becomes "/v3_0", any other token becomes "/<token>";
150+
# the literal token "java" is elided (e.g. graphql-java-20.0 -> graphql/v20_0).
151+
# this also handles multi-version modules like jaxrs-2.0-resteasy-3.1 -> jaxrs/v2_0/resteasy/v3_1.
152+
expected_package_name="$expected_prefix"
153+
IFS='-' read -ra module_parts <<< "$module_name"
154+
for part in "${module_parts[@]}"; do
155+
if [[ "$part" == "java" ]]; then
156+
continue
157+
fi
158+
if [[ "$part" =~ ^[0-9][0-9.]*$ ]]; then
159+
expected_package_name="$expected_package_name/v${part//./_}"
160+
else
161+
expected_package_name="$expected_package_name/$part"
162+
fi
163+
done
64164

65-
if [[ "$package_name_normalized" != "$expected_package_name_normalized"* ]]; then
66-
echo "ERROR: $dir"
67-
exit 1
68-
fi
165+
package_name=$(echo "$dir" | sed 's#.*/src/main/java[0-9]*/##')
69166

70-
done
167+
# deal with differences like module name elasticsearch-rest and package name elasticsearch.rest
168+
expected_package_name_normalized=$(echo "$expected_package_name" | sed 's#/##g')
169+
package_name_normalized=$(echo "$package_name" | sed 's#/##g')
170+
171+
if [[ "$package_name_normalized" != "$expected_package_name_normalized"* ]]; then
172+
echo "ERROR: $dir"
173+
exit 1
174+
fi
175+
176+
done
177+
}
178+
179+
check_source_set "library" "io/opentelemetry/instrumentation"
180+
check_source_set "javaagent" "io/opentelemetry/javaagent/instrumentation"

0 commit comments

Comments
 (0)