Add a test to check that all dependencies are shaded (#2320)

jack-edmonds-dd · web-flow · commit a5a75fec3469 · 2024-06-12T13:24:52.000-04:00
* Add a test to check that all dependencies are shaded

* Add test.

* Add comments.

* Run shading separately.

* Skip javadoc generation.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -93,6 +93,20 @@ jobs:
         run: mvn javadoc:javadoc
         shell: bash
 
+  shading:
+    runs-on: ubuntu-latest
+    if: (github.event.pull_request.draft == false && !contains(github.event.pull_request.labels.*.name, 'ci/skip') && !contains(github.event.pull_request.head.ref, 'datadog-api-spec/test/')) || github.event_name == 'schedule'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: "8"
+          distribution: "temurin"
+          cache: "maven"
+      - name: Check all dependencies shaded
+        run: ./shade-test.sh
+
   test:
     strategy:
       matrix:
diff --git a/shade-test.sh b/shade-test.sh
@@ -0,0 +1,11 @@
+# Create the package. Skip tests since this is just for testing the contents of the jar. We've already run the tests in another step.
+mvn package -DskipTests -Dmaven.javadoc.skip=true
+# List everything in the shaded jar. Anything in com/datadog is good since that's either shaded or our own code.
+# We intentionally avoid shading anything in META-INF in the pom.xml.
+# And there are some native libraries in other directories that we don't shade so we only want to check for .class files.
+if unzip -Z1 target/datadog-api-client-*-shaded-jar.jar | grep -v "^com/datadog" | grep -v "^META-INF" | grep "\.class$"; then
+  exit 1
+else
+  exit 0
+fi
+
