Re-enable spotless formatting and checks for the project (#128)

Author: jbachorik

.github/workflows/ci.yml

@@ -42,9 +42,31 @@ jobs:
                 echo "skip=true" >> "$GITHUB_OUTPUT"
             fi
           fi
-  test-matrix:
+  check-formatting:
+    runs-on: ubuntu-latest
     needs: check-for-pr
     if: needs.check-for-pr.outputs.skip != 'true'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup OS
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y clang-format-11
+          # we need this to make sure we are actually using clang-format v. 11 
+          sudo mv /usr/bin/clang-format /usr/bin/clang-format-14
+          sudo mv /usr/bin/clang-format-11 /usr/bin/clang-format
+      - name: Prepare test JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: "21.0.3"
+      - name: Check
+        run: |
+          ./gradlew --no-daemon spotlessCheck
+
+  test-matrix:
+    needs: check-formatting
+    if: needs.check-for-pr.outputs.skip != 'true'
     uses: ./.github/workflows/test_workflow.yml
     with:
       configuration: '["debug"]'

README.md

@@ -15,7 +15,8 @@ If you need a full-fledged Java profiler head back to [async-profiler](https://g
 1. This project contains Java code and is built by gradle, as such, you need to install a JDK in order to build it. Run `brew install openjdk` to install it on MacOS.
    If building and testing on Apple Silicon (M1+), be sure to install an aarch64 OpenJDK distribution, otherwise the architecture used for compilation and the JVM based test suite will not match, which means the tests will not be able to load the dynamic library at runtime.
 2. The build requires make, which is included in XCode, but can also be installed by running `brew install make`
-4. The build supports googletest for unit testing. To install it, run `brew install googletest` or `sudo apt install libgtest-dev` or `apk add gtest-dev` depending on your platform.
+3. The build supports googletest for unit testing. To install it, run `brew install googletest` or `sudo apt install libgtest-dev` or `apk add gtest-dev` depending on your platform.
+4. The build is applying consistent formatting using 'spotless' Gradle plugin. For C/C++ files it will use `clang-format` version 11. To install it, run `brew install clang-format-11` or `sudo apt install clang-format-11` or `apk add clang-format-11` depending on your platform. If the installed version does not provide `/usr/bin/clang-format` executable create a link like `sudo ln -s /usr/bin/clang-format-11 /usr/bin/clang-format` in order for the 'spotles' pluging to function correctly.
 
 
 Once prerequisites have been installed simple as `./gradlew assembleAll`. The resulting artifact is located in `ddprof-lib/build/libs/ddprof-<version>.jar`

build.gradle

@@ -19,6 +19,14 @@ version = "1.14.0"
 apply plugin: "com.dipien.semantic-version"
 version = project.hasProperty("ddprof_version") ? project.ddprof_version : version
 
+allprojects {
+  repositories {
+    mavenCentral()
+    mavenCentral()
+    gradlePluginPortal()
+  }
+}
+
 repositories {
   mavenLocal()
   mavenCentral()
@@ -35,13 +43,12 @@ repositories {
   }
 }
 
-apply from: "$rootDir/gradle/spotless.gradle"
-
 allprojects {
   group = 'com.datadoghq'
 
   apply from: rootProject.file('common.gradle')
   apply from: rootProject.file('gradle/configurations.gradle')
+  apply from: "$rootDir/gradle/spotless.gradle"
 }
 
 subprojects {