refactor version to source/common/version (envoyproxy#12141)

Pulling out version to a separate package Risk Level: Low Signed-off-by: Lizan Zhou <[email protected]> Signed-off-by: Kevin Baichoo <[email protected]>
KBaichoo · Jul 30, 2020 · bce4bad · bce4bad
1 parent d9a913e
commit bce4bad
Show file tree

Hide file tree

Showing 35 changed files with 111 additions and 102 deletions.
diff --git a/api/envoy/api/v2/core/base.proto b/api/envoy/api/v2/core/base.proto
@@ -93,7 +93,7 @@ message BuildVersion {
   type.SemanticVersion version = 1;
 
   // Free-form build information.
-  // Envoy defines several well known keys in the source/common/common/version.h file
+  // Envoy defines several well known keys in the source/common/version/version.h file
   google.protobuf.Struct metadata = 2;
 }
 

diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto
@@ -95,7 +95,7 @@ message BuildVersion {
   type.v3.SemanticVersion version = 1;
 
   // Free-form build information.
-  // Envoy defines several well known keys in the source/common/common/version.h file
+  // Envoy defines several well known keys in the source/common/version/version.h file
   google.protobuf.Struct metadata = 2;
 }
 

diff --git a/api/envoy/config/core/v4alpha/base.proto b/api/envoy/config/core/v4alpha/base.proto
diff --git a/generated_api_shadow/envoy/api/v2/core/base.proto b/generated_api_shadow/envoy/api/v2/core/base.proto
diff --git a/generated_api_shadow/envoy/config/core/v3/base.proto b/generated_api_shadow/envoy/config/core/v3/base.proto
diff --git a/generated_api_shadow/envoy/config/core/v4alpha/base.proto b/generated_api_shadow/envoy/config/core/v4alpha/base.proto
diff --git a/source/common/common/BUILD b/source/common/common/BUILD
@@ -7,7 +7,6 @@ load(
     "envoy_cc_win32_library",
     "envoy_include_prefix",
     "envoy_package",
-    "envoy_select_boringssl",
 )
 
 licenses(["notice"])  # Apache 2
@@ -358,71 +357,6 @@ envoy_cc_library(
     ],
 )
 
-genrule(
-    name = "generate_version_number",
-    srcs = ["//:VERSION"],
-    outs = ["version_number.h"],
-    cmd = """echo "#define BUILD_VERSION_NUMBER \\"$$(cat $<)\\"" >$@""",
-)
-
-genrule(
-    name = "generate_version_linkstamp",
-    outs = ["lib/version_linkstamp.h"],
-    cmd = select({
-        # Only iOS builds typically follow this logic, OS/X is built as a normal binary
-        "//bazel:apple": "$(location :generate_version_linkstamp.sh) Library >> $@",
-        "//conditions:default": "$(location :generate_version_linkstamp.sh) >> $@",
-    }),
-    # Undocumented attr to depend on workspace status files.
-    # https://github.com/bazelbuild/bazel/issues/4942
-    # Used here because generate_version_linkstamp.sh depends on the workspace status files.
-    stamp = 1,
-    tools = [":generate_version_linkstamp.sh"],
-)
-
-genrule(
-    name = "generate_version_linkstamp_empty",
-    outs = ["empty/version_linkstamp.h"],
-    cmd = """>$@""",
-)
-
-envoy_cc_library(
-    name = "version_includes",
-    hdrs = [
-        "version.h",
-        ":generate_version_number",
-    ],
-    deps = [
-        "//source/common/singleton:const_singleton",
-        "@envoy_api//envoy/config/core/v3:pkg_cc_proto",
-    ],
-)
-
-envoy_cc_library(
-    name = "version_lib",
-    srcs = ["version.cc"],
-    hdrs = select({
-        "//bazel:manual_stamp": [":generate_version_linkstamp"],
-        # By default the header file is empty.
-        # This is done so that the definitions linked via the linkstamp rule don't cause collisions.
-        "//conditions:default": [":generate_version_linkstamp_empty"],
-    }),
-    copts = envoy_select_boringssl(
-        ["-DENVOY_SSL_VERSION=\\\"BoringSSL-FIPS\\\""],
-        ["-DENVOY_SSL_VERSION=\\\"BoringSSL\\\""],
-    ),
-    linkstamp = "version_linkstamp.cc",
-    strip_include_prefix = select({
-        "//bazel:manual_stamp": "lib",
-        "//conditions:default": "empty",
-    }),
-    deps = [
-        ":version_includes",
-        "//source/common/common:macros",
-        "//source/common/protobuf:utility_lib",
-    ],
-)
-
 envoy_cc_library(
     name = "callback_impl_lib",
     hdrs = ["callback_impl.h"],

diff --git a/source/common/signal/signal_action.cc b/source/common/signal/signal_action.cc
@@ -5,7 +5,7 @@
 #include <csignal>
 
 #include "common/common/assert.h"
-#include "common/common/version.h"
+#include "common/version/version.h"
 
 namespace Envoy {
 

diff --git a/source/common/version/BUILD b/source/common/version/BUILD
@@ -0,0 +1,75 @@
+load(
+    "//bazel:envoy_build_system.bzl",
+    "envoy_cc_library",
+    "envoy_package",
+    "envoy_select_boringssl",
+)
+
+licenses(["notice"])  # Apache 2
+
+envoy_package()
+
+genrule(
+    name = "generate_version_number",
+    srcs = ["//:VERSION"],
+    outs = ["version_number.h"],
+    cmd = """echo "#define BUILD_VERSION_NUMBER \\"$$(cat $<)\\"" >$@""",
+)
+
+genrule(
+    name = "generate_version_linkstamp",
+    outs = ["lib/version_linkstamp.h"],
+    cmd = select({
+        # Only iOS builds typically follow this logic, OS/X is built as a normal binary
+        "//bazel:apple": "$(location :generate_version_linkstamp.sh) Library >> $@",
+        "//conditions:default": "$(location :generate_version_linkstamp.sh) >> $@",
+    }),
+    # Undocumented attr to depend on workspace status files.
+    # https://github.com/bazelbuild/bazel/issues/4942
+    # Used here because generate_version_linkstamp.sh depends on the workspace status files.
+    stamp = 1,
+    tools = [":generate_version_linkstamp.sh"],
+)
+
+genrule(
+    name = "generate_version_linkstamp_empty",
+    outs = ["empty/version_linkstamp.h"],
+    cmd = """>$@""",
+)
+
+envoy_cc_library(
+    name = "version_includes",
+    hdrs = [
+        "version.h",
+        ":generate_version_number",
+    ],
+    deps = [
+        "//source/common/singleton:const_singleton",
+        "@envoy_api//envoy/config/core/v3:pkg_cc_proto",
+    ],
+)
+
+envoy_cc_library(
+    name = "version_lib",
+    srcs = ["version.cc"],
+    hdrs = select({
+        "//bazel:manual_stamp": [":generate_version_linkstamp"],
+        # By default the header file is empty.
+        # This is done so that the definitions linked via the linkstamp rule don't cause collisions.
+        "//conditions:default": [":generate_version_linkstamp_empty"],
+    }),
+    copts = envoy_select_boringssl(
+        ["-DENVOY_SSL_VERSION=\\\"BoringSSL-FIPS\\\""],
+        ["-DENVOY_SSL_VERSION=\\\"BoringSSL\\\""],
+    ),
+    linkstamp = "version_linkstamp.cc",
+    strip_include_prefix = select({
+        "//bazel:manual_stamp": "lib",
+        "//conditions:default": "empty",
+    }),
+    deps = [
+        ":version_includes",
+        "//source/common/common:macros",
+        "//source/common/protobuf:utility_lib",
+    ],
+)
diff --git a/...mmon/common/generate_version_linkstamp.sh → ...mon/version/generate_version_linkstamp.sh b/...mmon/common/generate_version_linkstamp.sh → ...mon/version/generate_version_linkstamp.sh
diff --git a/source/common/common/version.cc → source/common/version/version.cc b/source/common/common/version.cc → source/common/version/version.cc
@@ -1,13 +1,13 @@
-#include "common/common/version.h"
+#include "common/version/version.h"
 
 #include <map>
 #include <regex>
 #include <string>
 
 #include "common/common/fmt.h"
 #include "common/common/macros.h"
-#include "common/common/version_linkstamp.h"
 #include "common/protobuf/utility.h"
+#include "common/version/version_linkstamp.h"
 
 #include "absl/strings/numbers.h"
 #include "absl/strings/str_split.h"

diff --git a/source/common/common/version.h → source/common/version/version.h b/source/common/common/version.h → source/common/version/version.h
@@ -4,8 +4,8 @@
 
 #include "envoy/config/core/v3/base.pb.h"
 
-#include "common/common/version_number.h"
 #include "common/singleton/const_singleton.h"
+#include "common/version/version_number.h"
 
 namespace Envoy {
 

diff --git a/source/common/common/version_linkstamp.cc → source/common/version/version_linkstamp.cc b/source/common/common/version_linkstamp.cc → source/common/version/version_linkstamp.cc
diff --git a/source/extensions/tracers/datadog/BUILD b/source/extensions/tracers/datadog/BUILD
@@ -21,11 +21,11 @@ envoy_cc_library(
     ],
     external_deps = ["dd_opentracing_cpp"],
     deps = [
-        "//source/common/common:version_lib",
         "//source/common/config:utility_lib",
         "//source/common/http:async_client_utility_lib",
         "//source/common/tracing:http_tracer_lib",
         "//source/common/upstream:cluster_update_tracker_lib",
+        "//source/common/version:version_lib",
         "//source/extensions/tracers:well_known_names",
         "//source/extensions/tracers/common/ot:opentracing_driver_lib",
         "@envoy_api//envoy/config/trace/v3:pkg_cc_proto",

diff --git a/source/extensions/tracers/datadog/datadog_tracer_impl.cc b/source/extensions/tracers/datadog/datadog_tracer_impl.cc
@@ -5,11 +5,11 @@
 #include "common/common/enum_to_int.h"
 #include "common/common/fmt.h"
 #include "common/common/utility.h"
-#include "common/common/version.h"
 #include "common/config/utility.h"
 #include "common/http/message_impl.h"
 #include "common/http/utility.h"
 #include "common/tracing/http_tracer_impl.h"
+#include "common/version/version.h"
 
 #include "extensions/tracers/well_known_names.h"
 

diff --git a/source/server/BUILD b/source/server/BUILD
@@ -21,7 +21,7 @@ envoy_cc_library(
     tags = ["backtrace"],
     deps = [
         "//source/common/common:minimal_logger_lib",
-        "//source/common/common:version_lib",
+        "//source/common/version:version_lib",
     ],
 )
 
@@ -234,9 +234,9 @@ envoy_cc_library(
         "//source/common/api:os_sys_calls_lib",
         "//source/common/common:logger_lib",
         "//source/common/common:macros",
-        "//source/common/common:version_lib",
         "//source/common/protobuf:utility_lib",
         "//source/common/stats:stats_lib",
+        "//source/common/version:version_lib",
         "@envoy_api//envoy/config/bootstrap/v2:pkg_cc_proto",
     ],
 )
@@ -420,7 +420,6 @@ envoy_cc_library(
         "//source/common/common:logger_lib",
         "//source/common/common:mutex_tracer_lib",
         "//source/common/common:utility_lib",
-        "//source/common/common:version_lib",
         "//source/common/config:utility_lib",
         "//source/common/grpc:async_client_manager_lib",
         "//source/common/grpc:context_lib",
@@ -439,6 +438,7 @@ envoy_cc_library(
         "//source/common/stats:thread_local_store_lib",
         "//source/common/upstream:cluster_manager_lib",
         "//source/common/upstream:health_discovery_service_lib",
+        "//source/common/version:version_lib",
         "//source/server:overload_manager_lib",
         "//source/server/admin:admin_lib",
         "@envoy_api//envoy/admin/v3:pkg_cc_proto",

diff --git a/source/server/admin/BUILD b/source/server/admin/BUILD
@@ -220,10 +220,10 @@ envoy_cc_library(
         "//include/envoy/server:admin_interface",
         "//include/envoy/server:instance_interface",
         "//source/common/buffer:buffer_lib",
-        "//source/common/common:version_includes",
         "//source/common/http:codes_lib",
         "//source/common/http:header_map_lib",
         "//source/common/memory:stats_lib",
+        "//source/common/version:version_includes",
         "@envoy_api//envoy/admin/v3:pkg_cc_proto",
     ],
 )

diff --git a/source/server/admin/server_info_handler.cc b/source/server/admin/server_info_handler.cc
@@ -2,8 +2,8 @@
 
 #include "envoy/admin/v3/memory.pb.h"
 
-#include "common/common/version.h"
 #include "common/memory/stats.h"
+#include "common/version/version.h"
 
 #include "server/admin/utils.h"
 

diff --git a/source/server/backtrace.h b/source/server/backtrace.h
@@ -3,7 +3,7 @@
 #include <functional>
 
 #include "common/common/logger.h"
-#include "common/common/version.h"
+#include "common/version/version.h"
 
 #include "absl/debugging/stacktrace.h"
 #include "absl/debugging/symbolize.h"

diff --git a/source/server/config_validation/BUILD b/source/server/config_validation/BUILD
@@ -97,7 +97,6 @@ envoy_cc_library(
         "//source/common/access_log:access_log_manager_lib",
         "//source/common/common:assert_lib",
         "//source/common/common:utility_lib",
-        "//source/common/common:version_lib",
         "//source/common/config:utility_lib",
         "//source/common/grpc:common_lib",
         "//source/common/local_info:local_info_lib",
@@ -106,6 +105,7 @@ envoy_cc_library(
         "//source/common/runtime:runtime_lib",
         "//source/common/stats:stats_lib",
         "//source/common/thread_local:thread_local_lib",
+        "//source/common/version:version_lib",
         "//source/server:configuration_lib",
         "//source/server:server_lib",
         "//source/server/admin:admin_lib",

diff --git a/source/server/config_validation/server.cc b/source/server/config_validation/server.cc
@@ -5,12 +5,12 @@
 #include "envoy/config/bootstrap/v3/bootstrap.pb.h"
 
 #include "common/common/utility.h"
-#include "common/common/version.h"
 #include "common/config/utility.h"
 #include "common/event/real_time_system.h"
 #include "common/local_info/local_info_impl.h"
 #include "common/protobuf/utility.h"
 #include "common/singleton/manager_impl.h"
+#include "common/version/version.h"
 
 #include "server/ssl_context_manager.h"
 

diff --git a/source/server/options_impl.cc b/source/server/options_impl.cc
@@ -10,8 +10,8 @@
 #include "common/common/fmt.h"
 #include "common/common/logger.h"
 #include "common/common/macros.h"
-#include "common/common/version.h"
 #include "common/protobuf/utility.h"
+#include "common/version/version.h"
 
 #include "server/options_impl_platform.h"
 

diff --git a/source/server/server.cc b/source/server/server.cc
@@ -27,7 +27,6 @@
 #include "common/common/enum_to_int.h"
 #include "common/common/mutex_tracer_impl.h"
 #include "common/common/utility.h"
-#include "common/common/version.h"
 #include "common/config/utility.h"
 #include "common/config/version_converter.h"
 #include "common/http/codes.h"
@@ -44,6 +43,7 @@
 #include "common/stats/thread_local_store.h"
 #include "common/stats/timespan_impl.h"
 #include "common/upstream/cluster_manager_impl.h"
+#include "common/version/version.h"
 
 #include "server/admin/utils.h"
 #include "server/configuration_impl.h"