Unit-test the conformance test environment flags in their own test.
test_environment_flags.{h,cc} (the --testee_binary, --testee_args, --failure_list, --enforce_recommended, --maximum_edition, --performance, --fix and --fix_output_file flags, the MaximumEdition flag type and OptionsFromFlags()) had seven tests at the end of test_environment_test.cc. This CL moves them into a dedicated test_environment_flags_test.cc next to the library and widens them to cover everything the library does:
* MaximumEdition: the runner's short form ("2023", "PROTO3"), full enum names ("EDITION_UNSTABLE"), the empty default, no clamping (the environment owns that), the exact error message for unknown editions, unparsing to the short form, unparse-then-parse and SetFlag/GetFlag round trips.
* OptionsFromFlags(): the defaults (including the non-flag fields it leaves alone: runner, owned_runner, check_unseen_expected_failures), every flag forwarded, positional arguments appended to --testee_args (with and without --testee_args), and that --fix / --fix_output_file are forwarded as given, since defaulting the output file to the single failure list is the environment's job.
* The command lines the conformance_test() macro (conformance.bzl) generates, parsed with absl::ParseAbseilFlagsOnly(), i.e. the same absl parser the main relies on: the macro's flags, --performance/--fix, comma-separated --failure_list and --testee_args, positional arguments after "--", and that a repeated --failure_list replaces rather than accumulates (absl vector flags), which is why the flag's help asks for a comma-separated list.
All assertions live in the TEST bodies; the two helpers only build values (an absl::StatusOr<Edition> from AbslParseFlag(), and the positional arguments left by the absl parser). Malformed command lines (an unknown edition on the command line) make the absl parser exit the process, so they are covered through AbslParseFlag() rather than through the parser. test_environment_test.cc loses the moved section and its flag-only includes and deps; test_environment_flags_test joins :conformance_framework_tests.
PiperOrigin-RevId: 984371516
Copyright 2008 Google LLC
Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can learn more about it in protobuf's documentation.
This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.
Most users will find working from supported releases to be the easiest path.
If you choose to work from the head revision of the main branch your build will occasionally be broken by source-incompatible changes and insufficiently-tested (and therefore broken) behavior.
If you are using C++ or otherwise need to build protobuf from source as a part of your project, you should pin to a release commit on a release branch.
This is because even release branches can experience some instability in between release commits.
Protobuf supports Bzlmod with Bazel 8 +. Users should specify a dependency on protobuf in their MODULE.bazel file as follows.
bazel_dep(name = "protobuf", version = <VERSION>)
Users can optionally override the repo name, such as for compatibility with WORKSPACE.
bazel_dep(name = "protobuf", version = <VERSION>, repo_name = "com_google_protobuf")
Users can also add the following to their legacy WORKSPACE file.
Note that with the release of 30.x there are a few more load statements to properly set up rules_java and rules_python.
http_archive(
name = "com_google_protobuf",
strip_prefix = "protobuf-VERSION",
sha256 = ...,
url = ...,
)
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
protobuf_deps()
load("@rules_java//java:rules_java_deps.bzl", "rules_java_dependencies")
rules_java_dependencies()
load("@rules_java//java:repositories.bzl", "rules_java_toolchains")
rules_java_toolchains()
load("@rules_python//python:repositories.bzl", "py_repositories")
py_repositories()
The protobuf compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.
For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our GitHub release page.
In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.
If you are looking for an old version that is not available in the release page, check out the Maven repository.
These pre-built binaries are only provided for released versions. If you want to use the github main version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.
If you would like to build protoc binary from source, see the C++ Installation Instructions.
Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:
| Language | Source |
|---|---|
| C++ (include C++ runtime and protoc) | src |
| Java | java |
| Python | python |
| Objective-C | objectivec |
| C# | csharp |
| Ruby | ruby |
| Go | protocolbuffers/protobuf-go |
| PHP | php |
| Dart | dart-lang/protobuf |
| JavaScript | protocolbuffers/protobuf-javascript |
The best way to learn how to use protobuf is to follow the tutorials in our developer guide.
If you want to learn from code examples, take a look at the examples in the examples directory.
The complete documentation is available at the Protocol Buffers doc site.
Read about our version support policy to stay current on support timeframes for the language libraries.
To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users, join the Google Group.