WIP: Comsume proto files from git submodule and build them in a separate module

.circleci/config.yml

@@ -1,11 +1,14 @@
 version: 2
 
+init_task: &init_task
+  name: Init git submodules
+  command: make init-git-submodules
 build_task: &build_task
   name: Build
-  command: ./gradlew clean assemble check --stacktrace
+  command: make test
 verify_task: &verify_task
   name: Verify Google Java Format
-  command: ./gradlew verGJF
+  command: make verify-format
 
 jobs:
   build:
@@ -16,6 +19,8 @@ jobs:
       - restore_cache:
           keys:
             - gradle-{{ checksum "build.gradle" }}
+      - run:
+          <<: *init_task
       - run:
           <<: *verify_task
       - run:
@@ -38,6 +43,10 @@ jobs:
       - restore_cache:
           keys:
             - java9-gradle-{{ checksum "build.gradle" }}
+#     make in missing in openjdk:9-jdk image
+      - run: sudo apt-get update && sudo apt-get install -y make
+      - run:
+          <<: *init_task
       - run:
           <<: *verify_task
       - run:

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "proto/src/main/proto"]
+	path = proto/src/main/proto
+	url = https://github.com/pavolloffay/opentelemetry-proto.git

CONTRIBUTING.md

@@ -70,6 +70,8 @@ $ git commit -m "Update javadoc for API."
 Continuous integration builds the project, runs the tests, and runs multiple
 types of static analysis.
 
+Before running the build init repository dependencies by running `make init`.
+
 Run the following commands to build, run tests and most static analysis, and
 check formatting:
 

Makefile

@@ -0,0 +1,14 @@
+.DEFAULT_GOAL := test
+
+.PHONY: test
+test:
+	./gradlew clean assemble check --stacktrace
+
+.PHONY: init-git-submodules
+init-git-submodules:
+	git submodule init
+	git submodule update
+
+.PHONY: verify-format
+verify-format:
+	./gradlew verGJF

build.gradle

@@ -108,6 +108,8 @@ subprojects {
         grpcVersion = '1.20.0'
         autoValueVersion = '1.6.2'
         opentracingVersion = '0.33.0'
+        protobufVersion = '3.7.1'
+        protocVersion = '3.7.1'
         guavaVersion = '26.0-android'
 
         libraries = [
@@ -119,6 +121,8 @@ subprojects {
                 grpc_context: "io.grpc:grpc-context:${grpcVersion}",
                 guava: "com.google.guava:guava:${guavaVersion}",
                 jsr305: "com.google.code.findbugs:jsr305:${findBugsJsr305Version}",
+                protobuf: "com.google.protobuf:protobuf-java:${protobufVersion}",
+                protobuf_util: "com.google.protobuf:protobuf-java-util:${protobufVersion}",
 
                 // Compatibility layer
                 opentracing: "io.opentracing:opentracing-api:${opentracingVersion}",

exporters/jaeger/build.gradle

@@ -2,8 +2,6 @@ description = 'OpenTelemetry - Jaeger Exporter'
 
 apply plugin: 'com.google.protobuf'
 
-def protobufVersion = '3.7.1'
-def protocVersion = '3.7.1'
 
 buildscript {
     repositories {
@@ -15,14 +13,13 @@ buildscript {
 }
 
 dependencies {
-    api project(':opentelemetry-sdk')
+    api project(':opentelemetry-sdk'),
+            libraries.protobuf,
+            libraries.protobuf_util
 
     implementation "io.grpc:grpc-protobuf:${grpcVersion}"
     implementation "io.grpc:grpc-stub:${grpcVersion}"
 
-    implementation "com.google.protobuf:protobuf-java:${protobufVersion}",
-            "com.google.protobuf:protobuf-java-util:${protobufVersion}"
-
     annotationProcessor libraries.auto_value
 
     testImplementation "io.grpc:grpc-testing:${grpcVersion}"
@@ -59,4 +56,4 @@ idea {
         sourceDirs += file("build/generated/source/proto/main/java");
         // If you have additional sourceSets and/or codegen plugins, add all of them
     }
-}
+}

opentracing_shim/build.gradle

@@ -7,7 +7,7 @@ dependencies {
             libraries.opentracing
 
     testImplementation project(':opentelemetry-sdk'),
-            "com.google.protobuf:protobuf-java:${protobufVersion}",
+            libraries.protobuf,
             libraries.junit,
             libraries.assertj,
             libraries.slf4jsimple,

proto/build.gradle

@@ -0,0 +1,43 @@
+description = 'OpenTelemetry Proto'
+
+apply plugin: 'com.google.protobuf'
+
+buildscript {
+    repositories {
+        maven { url "https://plugins.gradle.org/m2/" }
+    }
+    dependencies {
+        classpath "com.google.protobuf:protobuf-gradle-plugin:0.8.8"
+    }
+}
+
+dependencies {
+    api project(':opentelemetry-api'),
+            libraries.protobuf
+
+    signature "org.codehaus.mojo.signature:java17:1.0@signature"
+    signature "net.sf.androidscents.signature:android-api-level-14:4.0_r4@signature"
+}
+
+animalsniffer {
+    // Don't check sourceSets.jmh and sourceSets.test
+    sourceSets = [
+            sourceSets.main
+    ]
+}
+
+protobuf {
+    protoc {
+        // The artifact spec for the Protobuf Compiler
+        artifact = "com.google.protobuf:protoc:${protocVersion}"
+    }
+}
+
+// IntelliJ complains that the generated classes are not found, ask IntelliJ to include the
+// generated Java directories as source folders.
+idea {
+    module {
+        sourceDirs += file("build/generated/source/proto/main/java");
+        // If you have additional sourceSets and/or codegen plugins, add all of them
+    }
+}

sdk/build.gradle

@@ -1,24 +1,10 @@
 description = 'OpenTelemetry SDK'
 
-apply plugin: 'com.google.protobuf'
-
-def protobufVersion = '3.7.1'
-def protocVersion = '3.7.1'
-
-buildscript {
-    repositories {
-        maven { url "https://plugins.gradle.org/m2/" }
-    }
-    dependencies {
-        classpath "com.google.protobuf:protobuf-gradle-plugin:0.8.8"
-    }
-}
-
 dependencies {
-    api project(':opentelemetry-api')
-
-    implementation "com.google.protobuf:protobuf-java:${protobufVersion}",
-            "com.google.protobuf:protobuf-java-util:${protobufVersion}"
+    api project(':opentelemetry-api'),
+            libraries.protobuf,
+            libraries.protobuf_util
+    api project(':opentelemetry-proto')
 
     annotationProcessor libraries.auto_value
 
@@ -32,19 +18,3 @@ animalsniffer {
             sourceSets.main
     ]
 }
-
-protobuf {
-    protoc {
-        // The artifact spec for the Protobuf Compiler
-        artifact = "com.google.protobuf:protoc:${protocVersion}"
-    }
-}
-
-// IntelliJ complains that the generated classes are not found, ask IntelliJ to include the
-// generated Java directories as source folders.
-idea {
-    module {
-        sourceDirs += file("build/generated/source/proto/main/java");
-        // If you have additional sourceSets and/or codegen plugins, add all of them
-    }
-}