Adjust constants in rakefile

This PR renames: * protoc_binary/protoc_version -> protoc_legacy_binary/protoc_legacy_version * protoc_binary_2/protoc_version_2 -> protoc_binary/protoc_version For background, protobuf has two major versions: 2 and 3. The suffix for protoc_binary_2 implies that a 2.x series protobuf compiler is being used. But actually, protoc_binary_2 points to a 22.04 release, which is fairly new. Contrast with protoc_binary which is pointing to protoc 3.5.1 which has been deprecated for several years (it's not even listed as deprecated in the public list of [releases](https://protobuf.dev/support/version-support/)) This PR also initializes protoc_binary and protoc_legacy_binary to their ultimate values from the get go. Compare this to before where they were both being set to `protoc` and then getting updated in setup_proto This PR is purely a refactor, and does not change any generated code (this is proved by CI). After this PR, we should excise the legacy compiler, but that can be done in a separate PR. Make it clearer what's happening
DataDog · Sep 1, 2024 · 00b3937 · 00b3937
1 parent 5c5c89e
commit 00b3937
Showing 1 changed file with 31 additions and 31 deletions.
diff --git a/Rakefile b/Rakefile
@@ -2,50 +2,50 @@
 # Rakefile for agent-payload
 #
 
-protoc_binary="protoc"
-protoc_version="3.5.1"
+protoc_legacy_version="3.5.1"
+protoc_legacy_binary="/tmp/protoc#{protoc_legacy_version}"
+
+protoc_version="21.12"
+protoc_binary="/tmp/protoc#{protoc_version}"
+
 gogo_dir="/tmp/gogo"
-protoc_binary_2="protoc"
-protoc_version_2="21.12"
 protoc_gen_go_dir="/tmp/protoc-gen-go"
 protoc_jsonschema_version="73d5723"
 
 
 namespace :codegen do
 
   task :install_protoc do
-    if `bash -c "protoc --version"` != "libprotoc ${protoc_version}"
-      protoc_binary="/tmp/protoc#{protoc_version}"
+    if `bash -c "protoc --version"` != "libprotoc ${protoc_legacy_version}"
       sh <<-EOF
         /bin/bash <<BASH
-        if [ ! -f #{protoc_binary} ] ; then
-          echo "Downloading protoc #{protoc_version}"
+        if [ ! -f #{protoc_legacy_binary} ] ; then
+          echo "Downloading protoc #{protoc_legacy_version}"
           cd /tmp
           if [ "$(uname -s)" = "Darwin" ] ; then
-            curl -OL https://github.com/google/protobuf/releases/download/v#{protoc_version}/protoc-#{protoc_version}-osx-x86_64.zip
+            curl -OL https://github.com/google/protobuf/releases/download/v#{protoc_legacy_version}/protoc-#{protoc_legacy_version}-osx-x86_64.zip
           else
-            curl -OL https://github.com/google/protobuf/releases/download/v#{protoc_version}/protoc-#{protoc_version}-linux-x86_64.zip
+            curl -OL https://github.com/google/protobuf/releases/download/v#{protoc_legacy_version}/protoc-#{protoc_legacy_version}-linux-x86_64.zip
           fi
-          unzip protoc-#{protoc_version}*.zip
-          mv bin/protoc #{protoc_binary}
+          unzip protoc-#{protoc_legacy_version}*.zip
+          mv bin/protoc #{protoc_legacy_binary}
         fi
 BASH
       EOF
     end
-    if `bash -c "protoc --version"` != "libprotoc ${protoc_version_2}"
-      protoc_binary_2="/tmp/protoc#{protoc_version_2}"
+    if `bash -c "protoc --version"` != "libprotoc ${protoc_version}"
       sh <<-EOF
         /bin/bash <<BASH
-        if [ ! -f #{protoc_binary_2} ] ; then
-          echo "Downloading protoc #{protoc_version_2}"
+        if [ ! -f #{protoc_binary} ] ; then
+          echo "Downloading protoc #{protoc_version}"
           cd /tmp
           if [ "$(uname -s)" = "Darwin" ] ; then
-            curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v#{protoc_version_2}/protoc-#{protoc_version_2}-osx-x86_64.zip
+            curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v#{protoc_version}/protoc-#{protoc_version}-osx-x86_64.zip
           else
-            curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v#{protoc_version_2}/protoc-#{protoc_version_2}-linux-x86_64.zip
+            curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v#{protoc_version}/protoc-#{protoc_version}-linux-x86_64.zip
           fi
-          unzip protoc-#{protoc_version_2}*.zip
-          mv bin/protoc #{protoc_binary_2}
+          unzip protoc-#{protoc_version}*.zip
+          mv bin/protoc #{protoc_binary}
         fi
 BASH
       EOF
@@ -73,43 +73,43 @@ BASH
       popd
 
       echo "Generating logs proto"
-      PATH=/tmp/gogo-bin-v1.3.2 #{protoc_binary} --proto_path=$GOPATH/src:#{gogo_dir}/src:. --gogofast_out=$GOPATH/src --java_out=java proto/logs/agent_logs_payload.proto
+      PATH=/tmp/gogo-bin-v1.3.2 #{protoc_legacy_binary} --proto_path=$GOPATH/src:#{gogo_dir}/src:. --gogofast_out=$GOPATH/src --java_out=java proto/logs/agent_logs_payload.proto
 
       echo "Generating metrics proto (go)"
-      PATH=/tmp/gogo-bin-v1.3.2 #{protoc_binary} --proto_path=$GOPATH/src:#{gogo_dir}/src:. --gogofast_out=$GOPATH/src proto/metrics/agent_payload.proto
+      PATH=/tmp/gogo-bin-v1.3.2 #{protoc_legacy_binary} --proto_path=$GOPATH/src:#{gogo_dir}/src:. --gogofast_out=$GOPATH/src proto/metrics/agent_payload.proto
 
       echo "Generating metrics proto (python)"
-      #{protoc_binary} --proto_path=#{gogo_dir}/src:$GOPATH/src:./proto/metrics --python_out=python agent_payload.proto
+      #{protoc_legacy_binary} --proto_path=#{gogo_dir}/src:$GOPATH/src:./proto/metrics --python_out=python agent_payload.proto
 
       echo "Generating process proto (go)"
-      PATH=/tmp/gogo-bin-v1.3.2 #{protoc_binary} --proto_path=$GOPATH/src:#{gogo_dir}/src:. --gogofaster_out=$GOPATH/src proto/process/*.proto
+      PATH=/tmp/gogo-bin-v1.3.2 #{protoc_legacy_binary} --proto_path=$GOPATH/src:#{gogo_dir}/src:. --gogofaster_out=$GOPATH/src proto/process/*.proto
 
       GOPATH=#{protoc_gen_go_dir} go install github.com/leeavital/protoc-gen-gostreamer@v0.1.0
-      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary} --proto_path=$GOPATH/src:#{gogo_dir}/src:.  --gostreamer_out=$GOPATH/src proto/process/*.proto
+      PATH=#{protoc_gen_go_dir}/bin #{protoc_legacy_binary} --proto_path=$GOPATH/src:#{gogo_dir}/src:.  --gostreamer_out=$GOPATH/src proto/process/*.proto
       mv v5/process/proto/process/*.go process
 
       # Install protoc-gen-go
       GOPATH=#{protoc_gen_go_dir} go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.34.1
       GOPATH=#{protoc_gen_go_dir} go install github.com/chrusty/protoc-gen-jsonschema/cmd/protoc-gen-jsonschema@#{protoc_jsonschema_version}
 
       echo "Generating contlcycle proto"
-      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary_2} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src proto/contlcycle/contlcycle.proto
+      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src proto/contlcycle/contlcycle.proto
 
       echo "Generating kubernetes autoscaling proto"
-      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary_2} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src --jsonschema_out=type_names_with_no_package:jsonschema proto/autoscaling/kubernetes/autoscaling.proto
+      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src --jsonschema_out=type_names_with_no_package:jsonschema proto/autoscaling/kubernetes/autoscaling.proto
 
       echo "Generating contimage proto"
-      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary_2} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src proto/contimage/contimage.proto
+      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src proto/contimage/contimage.proto
 
       echo "Generating sbom proto"
-      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary_2} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src proto/deps/github.com/CycloneDX/specification/schema/bom-1.4.proto
-      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary_2} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src proto/sbom/sbom.proto
+      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src proto/deps/github.com/CycloneDX/specification/schema/bom-1.4.proto
+      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary} --proto_path=$GOPATH/src:. --go_out=$GOPATH/src proto/sbom/sbom.proto
 
       # Install protoc-gen-go-vtproto
       GOPATH=#{protoc_gen_go_dir} go install github.com/planetscale/vtprotobuf/cmd/protoc-gen-go-vtproto@v0.5.0
 
       echo "Generating CWS Activity Dumps v1"
-      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary_2} --proto_path=$GOPATH/src:. \
+      PATH=#{protoc_gen_go_dir}/bin #{protoc_binary} --proto_path=$GOPATH/src:. \
         --java_out=java \
         --go_out=$GOPATH/src \
         --go-vtproto_out=$GOPATH/src \