Skip to content

Commit 9a5de98

Browse files
authored
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]>
1 parent bb53b8a commit 9a5de98

File tree

35 files changed

+111
-102
lines changed

35 files changed

+111
-102
lines changed

api/envoy/api/v2/core/base.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ message BuildVersion {
9393
type.SemanticVersion version = 1;
9494

9595
// Free-form build information.
96-
// Envoy defines several well known keys in the source/common/common/version.h file
96+
// Envoy defines several well known keys in the source/common/version/version.h file
9797
google.protobuf.Struct metadata = 2;
9898
}
9999

api/envoy/config/core/v3/base.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ message BuildVersion {
9595
type.v3.SemanticVersion version = 1;
9696

9797
// Free-form build information.
98-
// Envoy defines several well known keys in the source/common/common/version.h file
98+
// Envoy defines several well known keys in the source/common/version/version.h file
9999
google.protobuf.Struct metadata = 2;
100100
}
101101

api/envoy/config/core/v4alpha/base.proto

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

generated_api_shadow/envoy/api/v2/core/base.proto

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

generated_api_shadow/envoy/config/core/v3/base.proto

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

generated_api_shadow/envoy/config/core/v4alpha/base.proto

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

source/common/common/BUILD

-66
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ load(
77
"envoy_cc_win32_library",
88
"envoy_include_prefix",
99
"envoy_package",
10-
"envoy_select_boringssl",
1110
)
1211

1312
licenses(["notice"]) # Apache 2
@@ -358,71 +357,6 @@ envoy_cc_library(
358357
],
359358
)
360359

361-
genrule(
362-
name = "generate_version_number",
363-
srcs = ["//:VERSION"],
364-
outs = ["version_number.h"],
365-
cmd = """echo "#define BUILD_VERSION_NUMBER \\"$$(cat $<)\\"" >$@""",
366-
)
367-
368-
genrule(
369-
name = "generate_version_linkstamp",
370-
outs = ["lib/version_linkstamp.h"],
371-
cmd = select({
372-
# Only iOS builds typically follow this logic, OS/X is built as a normal binary
373-
"//bazel:apple": "$(location :generate_version_linkstamp.sh) Library >> $@",
374-
"//conditions:default": "$(location :generate_version_linkstamp.sh) >> $@",
375-
}),
376-
# Undocumented attr to depend on workspace status files.
377-
# https://github.com/bazelbuild/bazel/issues/4942
378-
# Used here because generate_version_linkstamp.sh depends on the workspace status files.
379-
stamp = 1,
380-
tools = [":generate_version_linkstamp.sh"],
381-
)
382-
383-
genrule(
384-
name = "generate_version_linkstamp_empty",
385-
outs = ["empty/version_linkstamp.h"],
386-
cmd = """>$@""",
387-
)
388-
389-
envoy_cc_library(
390-
name = "version_includes",
391-
hdrs = [
392-
"version.h",
393-
":generate_version_number",
394-
],
395-
deps = [
396-
"//source/common/singleton:const_singleton",
397-
"@envoy_api//envoy/config/core/v3:pkg_cc_proto",
398-
],
399-
)
400-
401-
envoy_cc_library(
402-
name = "version_lib",
403-
srcs = ["version.cc"],
404-
hdrs = select({
405-
"//bazel:manual_stamp": [":generate_version_linkstamp"],
406-
# By default the header file is empty.
407-
# This is done so that the definitions linked via the linkstamp rule don't cause collisions.
408-
"//conditions:default": [":generate_version_linkstamp_empty"],
409-
}),
410-
copts = envoy_select_boringssl(
411-
["-DENVOY_SSL_VERSION=\\\"BoringSSL-FIPS\\\""],
412-
["-DENVOY_SSL_VERSION=\\\"BoringSSL\\\""],
413-
),
414-
linkstamp = "version_linkstamp.cc",
415-
strip_include_prefix = select({
416-
"//bazel:manual_stamp": "lib",
417-
"//conditions:default": "empty",
418-
}),
419-
deps = [
420-
":version_includes",
421-
"//source/common/common:macros",
422-
"//source/common/protobuf:utility_lib",
423-
],
424-
)
425-
426360
envoy_cc_library(
427361
name = "callback_impl_lib",
428362
hdrs = ["callback_impl.h"],

source/common/signal/signal_action.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#include <csignal>
66

77
#include "common/common/assert.h"
8-
#include "common/common/version.h"
8+
#include "common/version/version.h"
99

1010
namespace Envoy {
1111

source/common/version/BUILD

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
load(
2+
"//bazel:envoy_build_system.bzl",
3+
"envoy_cc_library",
4+
"envoy_package",
5+
"envoy_select_boringssl",
6+
)
7+
8+
licenses(["notice"]) # Apache 2
9+
10+
envoy_package()
11+
12+
genrule(
13+
name = "generate_version_number",
14+
srcs = ["//:VERSION"],
15+
outs = ["version_number.h"],
16+
cmd = """echo "#define BUILD_VERSION_NUMBER \\"$$(cat $<)\\"" >$@""",
17+
)
18+
19+
genrule(
20+
name = "generate_version_linkstamp",
21+
outs = ["lib/version_linkstamp.h"],
22+
cmd = select({
23+
# Only iOS builds typically follow this logic, OS/X is built as a normal binary
24+
"//bazel:apple": "$(location :generate_version_linkstamp.sh) Library >> $@",
25+
"//conditions:default": "$(location :generate_version_linkstamp.sh) >> $@",
26+
}),
27+
# Undocumented attr to depend on workspace status files.
28+
# https://github.com/bazelbuild/bazel/issues/4942
29+
# Used here because generate_version_linkstamp.sh depends on the workspace status files.
30+
stamp = 1,
31+
tools = [":generate_version_linkstamp.sh"],
32+
)
33+
34+
genrule(
35+
name = "generate_version_linkstamp_empty",
36+
outs = ["empty/version_linkstamp.h"],
37+
cmd = """>$@""",
38+
)
39+
40+
envoy_cc_library(
41+
name = "version_includes",
42+
hdrs = [
43+
"version.h",
44+
":generate_version_number",
45+
],
46+
deps = [
47+
"//source/common/singleton:const_singleton",
48+
"@envoy_api//envoy/config/core/v3:pkg_cc_proto",
49+
],
50+
)
51+
52+
envoy_cc_library(
53+
name = "version_lib",
54+
srcs = ["version.cc"],
55+
hdrs = select({
56+
"//bazel:manual_stamp": [":generate_version_linkstamp"],
57+
# By default the header file is empty.
58+
# This is done so that the definitions linked via the linkstamp rule don't cause collisions.
59+
"//conditions:default": [":generate_version_linkstamp_empty"],
60+
}),
61+
copts = envoy_select_boringssl(
62+
["-DENVOY_SSL_VERSION=\\\"BoringSSL-FIPS\\\""],
63+
["-DENVOY_SSL_VERSION=\\\"BoringSSL\\\""],
64+
),
65+
linkstamp = "version_linkstamp.cc",
66+
strip_include_prefix = select({
67+
"//bazel:manual_stamp": "lib",
68+
"//conditions:default": "empty",
69+
}),
70+
deps = [
71+
":version_includes",
72+
"//source/common/common:macros",
73+
"//source/common/protobuf:utility_lib",
74+
],
75+
)

source/common/common/version.cc source/common/version/version.cc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
#include "common/common/version.h"
1+
#include "common/version/version.h"
22

33
#include <map>
44
#include <regex>
55
#include <string>
66

77
#include "common/common/fmt.h"
88
#include "common/common/macros.h"
9-
#include "common/common/version_linkstamp.h"
109
#include "common/protobuf/utility.h"
10+
#include "common/version/version_linkstamp.h"
1111

1212
#include "absl/strings/numbers.h"
1313
#include "absl/strings/str_split.h"

source/common/common/version.h source/common/version/version.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
#include "envoy/config/core/v3/base.pb.h"
66

7-
#include "common/common/version_number.h"
87
#include "common/singleton/const_singleton.h"
8+
#include "common/version/version_number.h"
99

1010
namespace Envoy {
1111

source/extensions/tracers/datadog/BUILD

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ envoy_cc_library(
2121
],
2222
external_deps = ["dd_opentracing_cpp"],
2323
deps = [
24-
"//source/common/common:version_lib",
2524
"//source/common/config:utility_lib",
2625
"//source/common/http:async_client_utility_lib",
2726
"//source/common/tracing:http_tracer_lib",
2827
"//source/common/upstream:cluster_update_tracker_lib",
28+
"//source/common/version:version_lib",
2929
"//source/extensions/tracers:well_known_names",
3030
"//source/extensions/tracers/common/ot:opentracing_driver_lib",
3131
"@envoy_api//envoy/config/trace/v3:pkg_cc_proto",

source/extensions/tracers/datadog/datadog_tracer_impl.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
#include "common/common/enum_to_int.h"
66
#include "common/common/fmt.h"
77
#include "common/common/utility.h"
8-
#include "common/common/version.h"
98
#include "common/config/utility.h"
109
#include "common/http/message_impl.h"
1110
#include "common/http/utility.h"
1211
#include "common/tracing/http_tracer_impl.h"
12+
#include "common/version/version.h"
1313

1414
#include "extensions/tracers/well_known_names.h"
1515

source/server/BUILD

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ envoy_cc_library(
2121
tags = ["backtrace"],
2222
deps = [
2323
"//source/common/common:minimal_logger_lib",
24-
"//source/common/common:version_lib",
24+
"//source/common/version:version_lib",
2525
],
2626
)
2727

@@ -234,9 +234,9 @@ envoy_cc_library(
234234
"//source/common/api:os_sys_calls_lib",
235235
"//source/common/common:logger_lib",
236236
"//source/common/common:macros",
237-
"//source/common/common:version_lib",
238237
"//source/common/protobuf:utility_lib",
239238
"//source/common/stats:stats_lib",
239+
"//source/common/version:version_lib",
240240
"@envoy_api//envoy/config/bootstrap/v2:pkg_cc_proto",
241241
],
242242
)
@@ -420,7 +420,6 @@ envoy_cc_library(
420420
"//source/common/common:logger_lib",
421421
"//source/common/common:mutex_tracer_lib",
422422
"//source/common/common:utility_lib",
423-
"//source/common/common:version_lib",
424423
"//source/common/config:utility_lib",
425424
"//source/common/grpc:async_client_manager_lib",
426425
"//source/common/grpc:context_lib",
@@ -439,6 +438,7 @@ envoy_cc_library(
439438
"//source/common/stats:thread_local_store_lib",
440439
"//source/common/upstream:cluster_manager_lib",
441440
"//source/common/upstream:health_discovery_service_lib",
441+
"//source/common/version:version_lib",
442442
"//source/server:overload_manager_lib",
443443
"//source/server/admin:admin_lib",
444444
"@envoy_api//envoy/admin/v3:pkg_cc_proto",

source/server/admin/BUILD

+1-1
Original file line numberDiff line numberDiff line change
@@ -220,10 +220,10 @@ envoy_cc_library(
220220
"//include/envoy/server:admin_interface",
221221
"//include/envoy/server:instance_interface",
222222
"//source/common/buffer:buffer_lib",
223-
"//source/common/common:version_includes",
224223
"//source/common/http:codes_lib",
225224
"//source/common/http:header_map_lib",
226225
"//source/common/memory:stats_lib",
226+
"//source/common/version:version_includes",
227227
"@envoy_api//envoy/admin/v3:pkg_cc_proto",
228228
],
229229
)

source/server/admin/server_info_handler.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
#include "envoy/admin/v3/memory.pb.h"
44

5-
#include "common/common/version.h"
65
#include "common/memory/stats.h"
6+
#include "common/version/version.h"
77

88
#include "server/admin/utils.h"
99

source/server/backtrace.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#include <functional>
44

55
#include "common/common/logger.h"
6-
#include "common/common/version.h"
6+
#include "common/version/version.h"
77

88
#include "absl/debugging/stacktrace.h"
99
#include "absl/debugging/symbolize.h"

source/server/config_validation/BUILD

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ envoy_cc_library(
9797
"//source/common/access_log:access_log_manager_lib",
9898
"//source/common/common:assert_lib",
9999
"//source/common/common:utility_lib",
100-
"//source/common/common:version_lib",
101100
"//source/common/config:utility_lib",
102101
"//source/common/grpc:common_lib",
103102
"//source/common/local_info:local_info_lib",
@@ -106,6 +105,7 @@ envoy_cc_library(
106105
"//source/common/runtime:runtime_lib",
107106
"//source/common/stats:stats_lib",
108107
"//source/common/thread_local:thread_local_lib",
108+
"//source/common/version:version_lib",
109109
"//source/server:configuration_lib",
110110
"//source/server:server_lib",
111111
"//source/server/admin:admin_lib",

source/server/config_validation/server.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
#include "envoy/config/bootstrap/v3/bootstrap.pb.h"
66

77
#include "common/common/utility.h"
8-
#include "common/common/version.h"
98
#include "common/config/utility.h"
109
#include "common/event/real_time_system.h"
1110
#include "common/local_info/local_info_impl.h"
1211
#include "common/protobuf/utility.h"
1312
#include "common/singleton/manager_impl.h"
13+
#include "common/version/version.h"
1414

1515
#include "server/ssl_context_manager.h"
1616

source/server/options_impl.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
#include "common/common/fmt.h"
1111
#include "common/common/logger.h"
1212
#include "common/common/macros.h"
13-
#include "common/common/version.h"
1413
#include "common/protobuf/utility.h"
14+
#include "common/version/version.h"
1515

1616
#include "server/options_impl_platform.h"
1717

source/server/server.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
#include "common/common/enum_to_int.h"
2828
#include "common/common/mutex_tracer_impl.h"
2929
#include "common/common/utility.h"
30-
#include "common/common/version.h"
3130
#include "common/config/utility.h"
3231
#include "common/config/version_converter.h"
3332
#include "common/http/codes.h"
@@ -44,6 +43,7 @@
4443
#include "common/stats/thread_local_store.h"
4544
#include "common/stats/timespan_impl.h"
4645
#include "common/upstream/cluster_manager_impl.h"
46+
#include "common/version/version.h"
4747

4848
#include "server/admin/utils.h"
4949
#include "server/configuration_impl.h"

0 commit comments

Comments
 (0)