From 4475efdffd6ef04cf1372a4d982ac8a94158f7c8 Mon Sep 17 00:00:00 2001 From: Dov Shlachter Date: Thu, 14 Oct 2021 09:27:23 -0700 Subject: [PATCH 1/4] feat: add fragment tests Fragment tests are defined by a small proto file describing an API surface with characteristics such that it is desirable to test the generated surface for correctness or to prevent regressions. As part of a fragment test, the generator is run on a fragment to create a GAPIC library for the fragment. The generated unit tests for the fragment are then executed to test the surface. --- .github/workflows/tests.yaml | 57 +- .../%sub/services/%service/client.py.j2 | 6 + .../%name_%version/%sub/test_%service.py.j2 | 20 +- noxfile.py | 118 ++- tests/fragments/google/api/client.proto | 99 ++ .../google/protobuf/descriptor.proto | 909 ++++++++++++++++++ tests/fragments/google/protobuf/struct.proto | 95 ++ tests/fragments/import.proto | 21 + tests/fragments/test_flattened_value.proto | 37 + tests/fragments/test_keyword_import.proto | 33 + tests/fragments/test_optional_signature.proto | 35 + tests/fragments/test_recursive_messages.proto | 34 + .../fragments/test_reserved_field_name.proto | 41 + 13 files changed, 1440 insertions(+), 65 deletions(-) create mode 100644 tests/fragments/google/api/client.proto create mode 100644 tests/fragments/google/protobuf/descriptor.proto create mode 100644 tests/fragments/google/protobuf/struct.proto create mode 100644 tests/fragments/import.proto create mode 100644 tests/fragments/test_flattened_value.proto create mode 100644 tests/fragments/test_keyword_import.proto create mode 100644 tests/fragments/test_optional_signature.proto create mode 100644 tests/fragments/test_recursive_messages.proto create mode 100644 tests/fragments/test_reserved_field_name.proto diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index 2ff05a9095..847e0dabc5 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -42,39 +42,6 @@ jobs: run: python -m pip install nox - name: Check type annotations. run: nox -s mypy - # publish_image: - # runs-on: ubuntu-latest - # container: docker - # steps: - # - uses: actions/checkout@v2 - # - setup_remote_docker - # - name: Build Docker image. - # run: docker build . -t gcr.io/gapic-images/gapic-generator-python:latest - # - name: Download curl - # run: apk add --no-cache curl - # - name: Download the GCR credential helper. - # run: | - # curl -fsSL https://github.com/GoogleCloudPlatform/docker-credential-gcr/releases/download/v1.5.0/docker-credential-gcr_linux_amd64-1.5.0.tar.gz \ - # | tar xz --to-stdout ./docker-credential-gcr \ - # > /usr/bin/docker-credential-gcr && chmod a+x /usr/bin/docker-credential-gcr - # - name: Set up authentication to Google Container Registry. - # run: | - # echo ${GCLOUD_SERVICE_KEY} > ${GOOGLE_APPLICATION_CREDENTIALS} - # docker-credential-gcr configure-docker - # - name: Tag the Docker image and push it to Google Container Registry. - # run: | - # if [ -n "$CIRCLE_TAG" ]; then - # export MAJOR=`echo $CIRCLE_TAG | awk -F '.' '{ print $1; }'` - # export MINOR=`echo $CIRCLE_TAG | awk -F '.' '{ print $2; }'` - # export PATCH=`echo $CIRCLE_TAG | awk -F '.' '{ print $3; }'` - # docker tag gcr.io/gapic-images/gapic-generator-python:latest gcr.io/gapic-images/gapic-generator-python:$MAJOR.$MINOR.$PATCH - # docker tag gcr.io/gapic-images/gapic-generator-python:latest gcr.io/gapic-images/gapic-generator-python:$MAJOR.$MINOR - # docker tag gcr.io/gapic-images/gapic-generator-python:latest gcr.io/gapic-images/gapic-generator-python:$MAJOR - # docker push gcr.io/gapic-images/gapic-generator-python:$MAJOR.$MINOR.$PATCH - # docker push gcr.io/gapic-images/gapic-generator-python:$MAJOR.$MINOR - # docker push gcr.io/gapic-images/gapic-generator-python:$MAJOR - # fi - # docker push gcr.io/gapic-images/gapic-generator-python:latest showcase: strategy: matrix: @@ -319,6 +286,30 @@ jobs: python -m pip install nox - name: Run unit tests. run: nox -s unit-${{ matrix.python }} + fragment: + strategy: + matrix: + python: [3.6, 3.7, 3.8, 3.9] + runs-on: ubuntu-latest + steps: + - name: Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.7.0 + with: + access_token: ${{ github.token }} + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python }} + - name: Install pandoc + run: | + sudo apt-get update + sudo apt-get install -y pandoc gcc git + - name: Install nox. + run: | + python -m pip install nox + - name: Run unit tests. + run: nox -s fragment-${{ matrix.python }} integration: runs-on: ubuntu-latest steps: diff --git a/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2 b/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2 index 809f728dd1..1e0ceecd1e 100644 --- a/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2 +++ b/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2 @@ -405,7 +405,13 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta): {% endif %} {% for key, field in method.flattened_fields.items() if not field.repeated or method.input.ident.package == method.ident.package %} if {{ field.name }} is not None: + {# Repeated values is a special case, because values can be lists. #} + {# In order to not confuse the marshalling logic, extend these fields instead of assigning #} + {% if field.ident.ident|string() == "struct_pb2.Value" and field.repeated %} + request.{{ key }}.extend({{ field.name }}) + {% else %} request.{{ key }} = {{ field.name }} + {% endif %}{# struct_pb2.Value #} {% endfor %} {# Map-y fields can be _updated_, however #} {% for key, field in method.flattened_fields.items() if field.repeated and method.input.ident.package != method.ident.package %} diff --git a/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2 b/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2 index ad2e82861c..865aabdd0c 100644 --- a/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2 +++ b/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2 @@ -788,7 +788,15 @@ def test_{{ method.name|snake_case }}_flattened(): {% elif field.ident|string() == 'duration_pb2.Duration' %} assert DurationRule().to_proto(args[0].{{ key }}) == {{ field.mock_value }} {% else %} - assert args[0].{{ key }} == {{ field.mock_value }} + arg = args[0].{{ key }} + mock_val = {{ field.mock_value }} + {% if field.ident|string() == "struct_pb2.Value" %} + from proto.marshal import Marshal + from proto.marshal.rules.struct import ValueRule + rule = ValueRule(marshal=Marshal(name="Test")) + mock_val = rule.to_python(mock_val) + {% endif %}{# struct_pb2.Value #} + assert arg == mock_val {% endif %} {% endif %}{% endfor %} {% for oneofs in method.flattened_oneof_fields().values() %} @@ -873,7 +881,15 @@ async def test_{{ method.name|snake_case }}_flattened_async(): {% elif field.ident|string() == 'duration_pb2.Duration' %} assert DurationRule().to_proto(args[0].{{ key }}) == {{ field.mock_value }} {% else %} - assert args[0].{{ key }} == {{ field.mock_value }} + arg = args[0].{{ key }} + mock_val = {{ field.mock_value }} + {% if field.ident|string() == "struct_pb2.Value" %} + from proto.marshal import Marshal + from proto.marshal.rules.struct import ValueRule + rule = ValueRule(marshal=Marshal(name="Test")) + mock_val = rule.to_python(mock_val) + {% endif %}{# struct_pb2.Value #} + assert arg == mock_val {% endif %} {% endif %}{% endfor %} {% for oneofs in method.flattened_oneof_fields().values() %} diff --git a/noxfile.py b/noxfile.py index c4e3f34f43..a33f0d78fd 100644 --- a/noxfile.py +++ b/noxfile.py @@ -29,7 +29,18 @@ ADS_TEMPLATES = path.join(path.dirname(__file__), "gapic", "ads-templates") -@nox.session(python=["3.6", "3.7", "3.8", "3.9", "3.10"]) +ALL_PYTHON = ( + "3.6", + "3.7", + "3.8", + "3.9", + "3.10", +) + +NEWEST_PYTHON = "3.9" + + +@nox.session(python=ALL_PYTHON) def unit(session): """Run the unit test suite.""" @@ -50,11 +61,64 @@ def unit(session): "--cov-report=term", "--cov-fail-under=100", path.join("tests", "unit"), - ] + ] ), ) +FRAG_DIR = Path("tests") / "fragments" +FRAGMENT_FILES = tuple( + Path(dirname).relative_to(FRAG_DIR) / f + for dirname, _, files in os.walk(FRAG_DIR) + for f in files + if os.path.splitext(f)[1] == ".proto" and f.startswith("test_") +) + + +# TODO(dovs): ads templates +@nox.session(python=ALL_PYTHON) +def fragment(session): + session.install( + "coverage", + "pytest", + "pytest-cov", + "pytest-xdist", + "asyncmock", + "pytest-asyncio", + "grpcio-tools", + ) + + session.install("-e", ".") + + for frag in FRAGMENT_FILES: + with tempfile.TemporaryDirectory() as tmp_dir: + # Generate the fragment GAPIC. + session.run( + "python", + "-m", + "grpc_tools.protoc", + f"--proto_path={str(FRAG_DIR)}", + f"--python_gapic_out={tmp_dir}", + "--python_gapic_opt=transport=grpc+rest", + str(frag), + external=True, + ) + + # Install the generated fragment library. + session.install(tmp_dir, "-e", ".") + + # Run the fragment's generated unit tests. + session.run( + "py.test", + "--quiet", + "-n=auto", + f"--cov-config={str(Path(tmp_dir) / '.coveragerc')}", + "--cov-report=term", + "--cov-fail-under=100", + str(Path(tmp_dir) / "tests" / "unit"), + ) + + # TODO(yon-mg): -add compute context manager that includes rest transport # -add compute unit tests # (to test against temporarily while rest transport is incomplete) @@ -114,8 +178,7 @@ def showcase_library( f"google/showcase/v1beta1/messaging.proto", ) session.run( - *cmd_tup, - external=True, + *cmd_tup, external=True, ) # Install the library. @@ -124,7 +187,7 @@ def showcase_library( yield tmp_dir -@nox.session(python="3.9") +@nox.session(python=NEWEST_PYTHON) def showcase( session, templates="DEFAULT", @@ -136,12 +199,14 @@ def showcase( with showcase_library(session, templates=templates, other_opts=other_opts): session.install("mock", "pytest", "pytest-asyncio") session.run( - "py.test", "--quiet", *(session.posargs or [path.join("tests", "system")]), + "py.test", + "--quiet", + *(session.posargs or [path.join("tests", "system")]), env=env, ) -@nox.session(python="3.9") +@nox.session(python=NEWEST_PYTHON) def showcase_mtls( session, templates="DEFAULT", @@ -161,7 +226,7 @@ def showcase_mtls( ) -@nox.session(python="3.9") +@nox.session(python=NEWEST_PYTHON) def showcase_alternative_templates(session): templates = path.join(path.dirname(__file__), "gapic", "ads-templates") showcase( @@ -172,7 +237,7 @@ def showcase_alternative_templates(session): ) -@nox.session(python="3.9") +@nox.session(python=NEWEST_PYTHON) def showcase_mtls_alternative_templates(session): templates = path.join(path.dirname(__file__), "gapic", "ads-templates") showcase_mtls( @@ -200,12 +265,12 @@ def run_showcase_unit_tests(session, fail_under=100): "--quiet", "--cov=google", "--cov-append", - f"--cov-fail-under={str(fail_under)}", + f"--cov-fail-under={str(fail_under)}", *(session.posargs or [path.join("tests", "unit")]), ) -@nox.session(python=["3.6", "3.7", "3.8", "3.9"]) +@nox.session(python=ALL_PYTHON) def showcase_unit( session, templates="DEFAULT", other_opts: typing.Iterable[str] = (), ): @@ -233,14 +298,16 @@ def showcase_unit( run_showcase_unit_tests(session, fail_under=100) -@nox.session(python=["3.7", "3.8", "3.9"]) +@nox.session(python=ALL_PYTHON[1:]) # Do not test 3.6 def showcase_unit_alternative_templates(session): - with showcase_library(session, templates=ADS_TEMPLATES, other_opts=("old-naming",)) as lib: + with showcase_library( + session, templates=ADS_TEMPLATES, other_opts=("old-naming",) + ) as lib: session.chdir(lib) run_showcase_unit_tests(session) -@nox.session(python=["3.9"]) +@nox.session(python=NEWEST_PYTHON) def showcase_unit_add_iam_methods(session): with showcase_library(session, other_opts=("add-iam-methods",)) as lib: session.chdir(lib) @@ -257,7 +324,7 @@ def showcase_unit_add_iam_methods(session): run_showcase_unit_tests(session, fail_under=100) -@nox.session(python="3.9") +@nox.session(python=NEWEST_PYTHON) def showcase_mypy( session, templates="DEFAULT", other_opts: typing.Iterable[str] = (), ): @@ -273,12 +340,12 @@ def showcase_mypy( session.run("mypy", "--explicit-package-bases", "google") -@nox.session(python="3.9") +@nox.session(python=NEWEST_PYTHON) def showcase_mypy_alternative_templates(session): showcase_mypy(session, templates=ADS_TEMPLATES, other_opts=("old-naming",)) -@nox.session(python="3.9") +@nox.session(python=NEWEST_PYTHON) def snippetgen(session): # Clone googleapis/api-common-protos which are referenced by the snippet # protos @@ -299,14 +366,10 @@ def snippetgen(session): session.install("grpcio-tools", "mock", "pytest", "pytest-asyncio") - session.run( - "py.test", - "-vv", - "tests/snippetgen" - ) + session.run("py.test", "-vv", "tests/snippetgen") -@nox.session(python="3.9") +@nox.session(python=NEWEST_PYTHON) def docs(session): """Build the docs.""" @@ -327,15 +390,10 @@ def docs(session): ) -@nox.session(python=["3.7", "3.8", "3.9"]) +@nox.session(python=NEWEST_PYTHON) def mypy(session): """Perform typecheck analysis.""" - session.install( - "mypy", - "types-protobuf", - "types-PyYAML", - "types-dataclasses" - ) + session.install("mypy", "types-protobuf", "types-PyYAML", "types-dataclasses") session.install(".") session.run("mypy", "gapic") diff --git a/tests/fragments/google/api/client.proto b/tests/fragments/google/api/client.proto new file mode 100644 index 0000000000..2102623d30 --- /dev/null +++ b/tests/fragments/google/api/client.proto @@ -0,0 +1,99 @@ +// Copyright 2020 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.api; + +import "google/protobuf/descriptor.proto"; + +option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations"; +option java_multiple_files = true; +option java_outer_classname = "ClientProto"; +option java_package = "com.google.api"; +option objc_class_prefix = "GAPI"; + +extend google.protobuf.MethodOptions { + // A definition of a client library method signature. + // + // In client libraries, each proto RPC corresponds to one or more methods + // which the end user is able to call, and calls the underlying RPC. + // Normally, this method receives a single argument (a struct or instance + // corresponding to the RPC request object). Defining this field will + // add one or more overloads providing flattened or simpler method signatures + // in some languages. + // + // The fields on the method signature are provided as a comma-separated + // string. + // + // For example, the proto RPC and annotation: + // + // rpc CreateSubscription(CreateSubscriptionRequest) + // returns (Subscription) { + // option (google.api.method_signature) = "name,topic"; + // } + // + // Would add the following Java overload (in addition to the method accepting + // the request object): + // + // public final Subscription createSubscription(String name, String topic) + // + // The following backwards-compatibility guidelines apply: + // + // * Adding this annotation to an unannotated method is backwards + // compatible. + // * Adding this annotation to a method which already has existing + // method signature annotations is backwards compatible if and only if + // the new method signature annotation is last in the sequence. + // * Modifying or removing an existing method signature annotation is + // a breaking change. + // * Re-ordering existing method signature annotations is a breaking + // change. + repeated string method_signature = 1051; +} + +extend google.protobuf.ServiceOptions { + // The hostname for this service. + // This should be specified with no prefix or protocol. + // + // Example: + // + // service Foo { + // option (google.api.default_host) = "foo.googleapi.com"; + // ... + // } + string default_host = 1049; + + // OAuth scopes needed for the client. + // + // Example: + // + // service Foo { + // option (google.api.oauth_scopes) = \ + // "https://www.googleapis.com/auth/cloud-platform"; + // ... + // } + // + // If there is more than one scope, use a comma-separated string: + // + // Example: + // + // service Foo { + // option (google.api.oauth_scopes) = \ + // "https://www.googleapis.com/auth/cloud-platform," + // "https://www.googleapis.com/auth/monitoring"; + // ... + // } + string oauth_scopes = 1050; +} diff --git a/tests/fragments/google/protobuf/descriptor.proto b/tests/fragments/google/protobuf/descriptor.proto new file mode 100644 index 0000000000..9f0ce6cde0 --- /dev/null +++ b/tests/fragments/google/protobuf/descriptor.proto @@ -0,0 +1,909 @@ +// Protocol Buffers - Google's data interchange format +// Copyright 2008 Google Inc. All rights reserved. +// https://developers.google.com/protocol-buffers/ +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +// Author: kenton@google.com (Kenton Varda) +// Based on original Protocol Buffers design by +// Sanjay Ghemawat, Jeff Dean, and others. +// +// The messages in this file describe the definitions found in .proto files. +// A valid .proto file can be translated directly to a FileDescriptorProto +// without any other information (e.g. without reading its imports). + + +syntax = "proto2"; + +package google.protobuf; + +option go_package = "google.golang.org/protobuf/types/descriptorpb"; +option java_package = "com.google.protobuf"; +option java_outer_classname = "DescriptorProtos"; +option csharp_namespace = "Google.Protobuf.Reflection"; +option objc_class_prefix = "GPB"; +option cc_enable_arenas = true; + +// descriptor.proto must be optimized for speed because reflection-based +// algorithms don't work during bootstrapping. +option optimize_for = SPEED; + +// The protocol compiler can output a FileDescriptorSet containing the .proto +// files it parses. +message FileDescriptorSet { + repeated FileDescriptorProto file = 1; +} + +// Describes a complete .proto file. +message FileDescriptorProto { + optional string name = 1; // file name, relative to root of source tree + optional string package = 2; // e.g. "foo", "foo.bar", etc. + + // Names of files imported by this file. + repeated string dependency = 3; + // Indexes of the public imported files in the dependency list above. + repeated int32 public_dependency = 10; + // Indexes of the weak imported files in the dependency list. + // For Google-internal migration only. Do not use. + repeated int32 weak_dependency = 11; + + // All top-level definitions in this file. + repeated DescriptorProto message_type = 4; + repeated EnumDescriptorProto enum_type = 5; + repeated ServiceDescriptorProto service = 6; + repeated FieldDescriptorProto extension = 7; + + optional FileOptions options = 8; + + // This field contains optional information about the original source code. + // You may safely remove this entire field without harming runtime + // functionality of the descriptors -- the information is needed only by + // development tools. + optional SourceCodeInfo source_code_info = 9; + + // The syntax of the proto file. + // The supported values are "proto2" and "proto3". + optional string syntax = 12; +} + +// Describes a message type. +message DescriptorProto { + optional string name = 1; + + repeated FieldDescriptorProto field = 2; + repeated FieldDescriptorProto extension = 6; + + repeated DescriptorProto nested_type = 3; + repeated EnumDescriptorProto enum_type = 4; + + message ExtensionRange { + optional int32 start = 1; // Inclusive. + optional int32 end = 2; // Exclusive. + + optional ExtensionRangeOptions options = 3; + } + repeated ExtensionRange extension_range = 5; + + repeated OneofDescriptorProto oneof_decl = 8; + + optional MessageOptions options = 7; + + // Range of reserved tag numbers. Reserved tag numbers may not be used by + // fields or extension ranges in the same message. Reserved ranges may + // not overlap. + message ReservedRange { + optional int32 start = 1; // Inclusive. + optional int32 end = 2; // Exclusive. + } + repeated ReservedRange reserved_range = 9; + // Reserved field names, which may not be used by fields in the same message. + // A given name may only be reserved once. + repeated string reserved_name = 10; +} + +message ExtensionRangeOptions { + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +// Describes a field within a message. +message FieldDescriptorProto { + enum Type { + // 0 is reserved for errors. + // Order is weird for historical reasons. + TYPE_DOUBLE = 1; + TYPE_FLOAT = 2; + // Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if + // negative values are likely. + TYPE_INT64 = 3; + TYPE_UINT64 = 4; + // Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if + // negative values are likely. + TYPE_INT32 = 5; + TYPE_FIXED64 = 6; + TYPE_FIXED32 = 7; + TYPE_BOOL = 8; + TYPE_STRING = 9; + // Tag-delimited aggregate. + // Group type is deprecated and not supported in proto3. However, Proto3 + // implementations should still be able to parse the group wire format and + // treat group fields as unknown fields. + TYPE_GROUP = 10; + TYPE_MESSAGE = 11; // Length-delimited aggregate. + + // New in version 2. + TYPE_BYTES = 12; + TYPE_UINT32 = 13; + TYPE_ENUM = 14; + TYPE_SFIXED32 = 15; + TYPE_SFIXED64 = 16; + TYPE_SINT32 = 17; // Uses ZigZag encoding. + TYPE_SINT64 = 18; // Uses ZigZag encoding. + } + + enum Label { + // 0 is reserved for errors + LABEL_OPTIONAL = 1; + LABEL_REQUIRED = 2; + LABEL_REPEATED = 3; + } + + optional string name = 1; + optional int32 number = 3; + optional Label label = 4; + + // If type_name is set, this need not be set. If both this and type_name + // are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. + optional Type type = 5; + + // For message and enum types, this is the name of the type. If the name + // starts with a '.', it is fully-qualified. Otherwise, C++-like scoping + // rules are used to find the type (i.e. first the nested types within this + // message are searched, then within the parent, on up to the root + // namespace). + optional string type_name = 6; + + // For extensions, this is the name of the type being extended. It is + // resolved in the same manner as type_name. + optional string extendee = 2; + + // For numeric types, contains the original text representation of the value. + // For booleans, "true" or "false". + // For strings, contains the default text contents (not escaped in any way). + // For bytes, contains the C escaped value. All bytes >= 128 are escaped. + // TODO(kenton): Base-64 encode? + optional string default_value = 7; + + // If set, gives the index of a oneof in the containing type's oneof_decl + // list. This field is a member of that oneof. + optional int32 oneof_index = 9; + + // JSON name of this field. The value is set by protocol compiler. If the + // user has set a "json_name" option on this field, that option's value + // will be used. Otherwise, it's deduced from the field's name by converting + // it to camelCase. + optional string json_name = 10; + + optional FieldOptions options = 8; + + // If true, this is a proto3 "optional". When a proto3 field is optional, it + // tracks presence regardless of field type. + // + // When proto3_optional is true, this field must be belong to a oneof to + // signal to old proto3 clients that presence is tracked for this field. This + // oneof is known as a "synthetic" oneof, and this field must be its sole + // member (each proto3 optional field gets its own synthetic oneof). Synthetic + // oneofs exist in the descriptor only, and do not generate any API. Synthetic + // oneofs must be ordered after all "real" oneofs. + // + // For message fields, proto3_optional doesn't create any semantic change, + // since non-repeated message fields always track presence. However it still + // indicates the semantic detail of whether the user wrote "optional" or not. + // This can be useful for round-tripping the .proto file. For consistency we + // give message fields a synthetic oneof also, even though it is not required + // to track presence. This is especially important because the parser can't + // tell if a field is a message or an enum, so it must always create a + // synthetic oneof. + // + // Proto2 optional fields do not set this flag, because they already indicate + // optional with `LABEL_OPTIONAL`. + optional bool proto3_optional = 17; +} + +// Describes a oneof. +message OneofDescriptorProto { + optional string name = 1; + optional OneofOptions options = 2; +} + +// Describes an enum type. +message EnumDescriptorProto { + optional string name = 1; + + repeated EnumValueDescriptorProto value = 2; + + optional EnumOptions options = 3; + + // Range of reserved numeric values. Reserved values may not be used by + // entries in the same enum. Reserved ranges may not overlap. + // + // Note that this is distinct from DescriptorProto.ReservedRange in that it + // is inclusive such that it can appropriately represent the entire int32 + // domain. + message EnumReservedRange { + optional int32 start = 1; // Inclusive. + optional int32 end = 2; // Inclusive. + } + + // Range of reserved numeric values. Reserved numeric values may not be used + // by enum values in the same enum declaration. Reserved ranges may not + // overlap. + repeated EnumReservedRange reserved_range = 4; + + // Reserved enum value names, which may not be reused. A given name may only + // be reserved once. + repeated string reserved_name = 5; +} + +// Describes a value within an enum. +message EnumValueDescriptorProto { + optional string name = 1; + optional int32 number = 2; + + optional EnumValueOptions options = 3; +} + +// Describes a service. +message ServiceDescriptorProto { + optional string name = 1; + repeated MethodDescriptorProto method = 2; + + optional ServiceOptions options = 3; +} + +// Describes a method of a service. +message MethodDescriptorProto { + optional string name = 1; + + // Input and output type names. These are resolved in the same way as + // FieldDescriptorProto.type_name, but must refer to a message type. + optional string input_type = 2; + optional string output_type = 3; + + optional MethodOptions options = 4; + + // Identifies if client streams multiple client messages + optional bool client_streaming = 5 [default = false]; + // Identifies if server streams multiple server messages + optional bool server_streaming = 6 [default = false]; +} + + +// =================================================================== +// Options + +// Each of the definitions above may have "options" attached. These are +// just annotations which may cause code to be generated slightly differently +// or may contain hints for code that manipulates protocol messages. +// +// Clients may define custom options as extensions of the *Options messages. +// These extensions may not yet be known at parsing time, so the parser cannot +// store the values in them. Instead it stores them in a field in the *Options +// message called uninterpreted_option. This field must have the same name +// across all *Options messages. We then use this field to populate the +// extensions when we build a descriptor, at which point all protos have been +// parsed and so all extensions are known. +// +// Extension numbers for custom options may be chosen as follows: +// * For options which will only be used within a single application or +// organization, or for experimental options, use field numbers 50000 +// through 99999. It is up to you to ensure that you do not use the +// same number for multiple options. +// * For options which will be published and used publicly by multiple +// independent entities, e-mail protobuf-global-extension-registry@google.com +// to reserve extension numbers. Simply provide your project name (e.g. +// Objective-C plugin) and your project website (if available) -- there's no +// need to explain how you intend to use them. Usually you only need one +// extension number. You can declare multiple options with only one extension +// number by putting them in a sub-message. See the Custom Options section of +// the docs for examples: +// https://developers.google.com/protocol-buffers/docs/proto#options +// If this turns out to be popular, a web service will be set up +// to automatically assign option numbers. + +message FileOptions { + + // Sets the Java package where classes generated from this .proto will be + // placed. By default, the proto package is used, but this is often + // inappropriate because proto packages do not normally start with backwards + // domain names. + optional string java_package = 1; + + + // If set, all the classes from the .proto file are wrapped in a single + // outer class with the given name. This applies to both Proto1 + // (equivalent to the old "--one_java_file" option) and Proto2 (where + // a .proto always translates to a single class, but you may want to + // explicitly choose the class name). + optional string java_outer_classname = 8; + + // If set true, then the Java code generator will generate a separate .java + // file for each top-level message, enum, and service defined in the .proto + // file. Thus, these types will *not* be nested inside the outer class + // named by java_outer_classname. However, the outer class will still be + // generated to contain the file's getDescriptor() method as well as any + // top-level extensions defined in the file. + optional bool java_multiple_files = 10 [default = false]; + + // This option does nothing. + optional bool java_generate_equals_and_hash = 20 [deprecated=true]; + + // If set true, then the Java2 code generator will generate code that + // throws an exception whenever an attempt is made to assign a non-UTF-8 + // byte sequence to a string field. + // Message reflection will do the same. + // However, an extension field still accepts non-UTF-8 byte sequences. + // This option has no effect on when used with the lite runtime. + optional bool java_string_check_utf8 = 27 [default = false]; + + + // Generated classes can be optimized for speed or code size. + enum OptimizeMode { + SPEED = 1; // Generate complete code for parsing, serialization, + // etc. + CODE_SIZE = 2; // Use ReflectionOps to implement these methods. + LITE_RUNTIME = 3; // Generate code using MessageLite and the lite runtime. + } + optional OptimizeMode optimize_for = 9 [default = SPEED]; + + // Sets the Go package where structs generated from this .proto will be + // placed. If omitted, the Go package will be derived from the following: + // - The basename of the package import path, if provided. + // - Otherwise, the package statement in the .proto file, if present. + // - Otherwise, the basename of the .proto file, without extension. + optional string go_package = 11; + + + + + // Should generic services be generated in each language? "Generic" services + // are not specific to any particular RPC system. They are generated by the + // main code generators in each language (without additional plugins). + // Generic services were the only kind of service generation supported by + // early versions of google.protobuf. + // + // Generic services are now considered deprecated in favor of using plugins + // that generate code specific to your particular RPC system. Therefore, + // these default to false. Old code which depends on generic services should + // explicitly set them to true. + optional bool cc_generic_services = 16 [default = false]; + optional bool java_generic_services = 17 [default = false]; + optional bool py_generic_services = 18 [default = false]; + optional bool php_generic_services = 42 [default = false]; + + // Is this file deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for everything in the file, or it will be completely ignored; in the very + // least, this is a formalization for deprecating files. + optional bool deprecated = 23 [default = false]; + + // Enables the use of arenas for the proto messages in this file. This applies + // only to generated classes for C++. + optional bool cc_enable_arenas = 31 [default = true]; + + + // Sets the objective c class prefix which is prepended to all objective c + // generated classes from this .proto. There is no default. + optional string objc_class_prefix = 36; + + // Namespace for generated classes; defaults to the package. + optional string csharp_namespace = 37; + + // By default Swift generators will take the proto package and CamelCase it + // replacing '.' with underscore and use that to prefix the types/symbols + // defined. When this options is provided, they will use this value instead + // to prefix the types/symbols defined. + optional string swift_prefix = 39; + + // Sets the php class prefix which is prepended to all php generated classes + // from this .proto. Default is empty. + optional string php_class_prefix = 40; + + // Use this option to change the namespace of php generated classes. Default + // is empty. When this option is empty, the package name will be used for + // determining the namespace. + optional string php_namespace = 41; + + // Use this option to change the namespace of php generated metadata classes. + // Default is empty. When this option is empty, the proto file name will be + // used for determining the namespace. + optional string php_metadata_namespace = 44; + + // Use this option to change the package of ruby generated classes. Default + // is empty. When this option is not set, the package name will be used for + // determining the ruby package. + optional string ruby_package = 45; + + + // The parser stores options it doesn't recognize here. + // See the documentation for the "Options" section above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. + // See the documentation for the "Options" section above. + extensions 1000 to max; + + reserved 38; +} + +message MessageOptions { + // Set true to use the old proto1 MessageSet wire format for extensions. + // This is provided for backwards-compatibility with the MessageSet wire + // format. You should not use this for any other reason: It's less + // efficient, has fewer features, and is more complicated. + // + // The message must be defined exactly as follows: + // message Foo { + // option message_set_wire_format = true; + // extensions 4 to max; + // } + // Note that the message cannot have any defined fields; MessageSets only + // have extensions. + // + // All extensions of your type must be singular messages; e.g. they cannot + // be int32s, enums, or repeated messages. + // + // Because this is an option, the above two restrictions are not enforced by + // the protocol compiler. + optional bool message_set_wire_format = 1 [default = false]; + + // Disables the generation of the standard "descriptor()" accessor, which can + // conflict with a field of the same name. This is meant to make migration + // from proto1 easier; new code should avoid fields named "descriptor". + optional bool no_standard_descriptor_accessor = 2 [default = false]; + + // Is this message deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the message, or it will be completely ignored; in the very least, + // this is a formalization for deprecating messages. + optional bool deprecated = 3 [default = false]; + + // Whether the message is an automatically generated map entry type for the + // maps field. + // + // For maps fields: + // map map_field = 1; + // The parsed descriptor looks like: + // message MapFieldEntry { + // option map_entry = true; + // optional KeyType key = 1; + // optional ValueType value = 2; + // } + // repeated MapFieldEntry map_field = 1; + // + // Implementations may choose not to generate the map_entry=true message, but + // use a native map in the target language to hold the keys and values. + // The reflection APIs in such implementations still need to work as + // if the field is a repeated message field. + // + // NOTE: Do not set the option in .proto files. Always use the maps syntax + // instead. The option should only be implicitly set by the proto compiler + // parser. + optional bool map_entry = 7; + + reserved 8; // javalite_serializable + reserved 9; // javanano_as_lite + + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message FieldOptions { + // The ctype option instructs the C++ code generator to use a different + // representation of the field than it normally would. See the specific + // options below. This option is not yet implemented in the open source + // release -- sorry, we'll try to include it in a future version! + optional CType ctype = 1 [default = STRING]; + enum CType { + // Default mode. + STRING = 0; + + CORD = 1; + + STRING_PIECE = 2; + } + // The packed option can be enabled for repeated primitive fields to enable + // a more efficient representation on the wire. Rather than repeatedly + // writing the tag and type for each element, the entire array is encoded as + // a single length-delimited blob. In proto3, only explicit setting it to + // false will avoid using packed encoding. + optional bool packed = 2; + + // The jstype option determines the JavaScript type used for values of the + // field. The option is permitted only for 64 bit integral and fixed types + // (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING + // is represented as JavaScript string, which avoids loss of precision that + // can happen when a large value is converted to a floating point JavaScript. + // Specifying JS_NUMBER for the jstype causes the generated JavaScript code to + // use the JavaScript "number" type. The behavior of the default option + // JS_NORMAL is implementation dependent. + // + // This option is an enum to permit additional types to be added, e.g. + // goog.math.Integer. + optional JSType jstype = 6 [default = JS_NORMAL]; + enum JSType { + // Use the default type. + JS_NORMAL = 0; + + // Use JavaScript strings. + JS_STRING = 1; + + // Use JavaScript numbers. + JS_NUMBER = 2; + } + + // Should this field be parsed lazily? Lazy applies only to message-type + // fields. It means that when the outer message is initially parsed, the + // inner message's contents will not be parsed but instead stored in encoded + // form. The inner message will actually be parsed when it is first accessed. + // + // This is only a hint. Implementations are free to choose whether to use + // eager or lazy parsing regardless of the value of this option. However, + // setting this option true suggests that the protocol author believes that + // using lazy parsing on this field is worth the additional bookkeeping + // overhead typically needed to implement it. + // + // This option does not affect the public interface of any generated code; + // all method signatures remain the same. Furthermore, thread-safety of the + // interface is not affected by this option; const methods remain safe to + // call from multiple threads concurrently, while non-const methods continue + // to require exclusive access. + // + // + // Note that implementations may choose not to check required fields within + // a lazy sub-message. That is, calling IsInitialized() on the outer message + // may return true even if the inner message has missing required fields. + // This is necessary because otherwise the inner message would have to be + // parsed in order to perform the check, defeating the purpose of lazy + // parsing. An implementation which chooses not to check required fields + // must be consistent about it. That is, for any particular sub-message, the + // implementation must either *always* check its required fields, or *never* + // check its required fields, regardless of whether or not the message has + // been parsed. + optional bool lazy = 5 [default = false]; + + // Is this field deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for accessors, or it will be completely ignored; in the very least, this + // is a formalization for deprecating fields. + optional bool deprecated = 3 [default = false]; + + // For Google-internal migration only. Do not use. + optional bool weak = 10 [default = false]; + + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; + + reserved 4; // removed jtype +} + +message OneofOptions { + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message EnumOptions { + + // Set this option to true to allow mapping different tag names to the same + // value. + optional bool allow_alias = 2; + + // Is this enum deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the enum, or it will be completely ignored; in the very least, this + // is a formalization for deprecating enums. + optional bool deprecated = 3 [default = false]; + + reserved 5; // javanano_as_lite + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message EnumValueOptions { + // Is this enum value deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the enum value, or it will be completely ignored; in the very least, + // this is a formalization for deprecating enum values. + optional bool deprecated = 1 [default = false]; + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message ServiceOptions { + + // Note: Field numbers 1 through 32 are reserved for Google's internal RPC + // framework. We apologize for hoarding these numbers to ourselves, but + // we were already using them long before we decided to release Protocol + // Buffers. + + // Is this service deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the service, or it will be completely ignored; in the very least, + // this is a formalization for deprecating services. + optional bool deprecated = 33 [default = false]; + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message MethodOptions { + + // Note: Field numbers 1 through 32 are reserved for Google's internal RPC + // framework. We apologize for hoarding these numbers to ourselves, but + // we were already using them long before we decided to release Protocol + // Buffers. + + // Is this method deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the method, or it will be completely ignored; in the very least, + // this is a formalization for deprecating methods. + optional bool deprecated = 33 [default = false]; + + // Is this method side-effect-free (or safe in HTTP parlance), or idempotent, + // or neither? HTTP based RPC implementation may choose GET verb for safe + // methods, and PUT verb for idempotent methods instead of the default POST. + enum IdempotencyLevel { + IDEMPOTENCY_UNKNOWN = 0; + NO_SIDE_EFFECTS = 1; // implies idempotent + IDEMPOTENT = 2; // idempotent, but may have side effects + } + optional IdempotencyLevel idempotency_level = 34 + [default = IDEMPOTENCY_UNKNOWN]; + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + + +// A message representing a option the parser does not recognize. This only +// appears in options protos created by the compiler::Parser class. +// DescriptorPool resolves these when building Descriptor objects. Therefore, +// options protos in descriptor objects (e.g. returned by Descriptor::options(), +// or produced by Descriptor::CopyTo()) will never have UninterpretedOptions +// in them. +message UninterpretedOption { + // The name of the uninterpreted option. Each string represents a segment in + // a dot-separated name. is_extension is true iff a segment represents an + // extension (denoted with parentheses in options specs in .proto files). + // E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents + // "foo.(bar.baz).qux". + message NamePart { + required string name_part = 1; + required bool is_extension = 2; + } + repeated NamePart name = 2; + + // The value of the uninterpreted option, in whatever type the tokenizer + // identified it as during parsing. Exactly one of these should be set. + optional string identifier_value = 3; + optional uint64 positive_int_value = 4; + optional int64 negative_int_value = 5; + optional double double_value = 6; + optional bytes string_value = 7; + optional string aggregate_value = 8; +} + +// =================================================================== +// Optional source code info + +// Encapsulates information about the original source file from which a +// FileDescriptorProto was generated. +message SourceCodeInfo { + // A Location identifies a piece of source code in a .proto file which + // corresponds to a particular definition. This information is intended + // to be useful to IDEs, code indexers, documentation generators, and similar + // tools. + // + // For example, say we have a file like: + // message Foo { + // optional string foo = 1; + // } + // Let's look at just the field definition: + // optional string foo = 1; + // ^ ^^ ^^ ^ ^^^ + // a bc de f ghi + // We have the following locations: + // span path represents + // [a,i) [ 4, 0, 2, 0 ] The whole field definition. + // [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). + // [c,d) [ 4, 0, 2, 0, 5 ] The type (string). + // [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). + // [g,h) [ 4, 0, 2, 0, 3 ] The number (1). + // + // Notes: + // - A location may refer to a repeated field itself (i.e. not to any + // particular index within it). This is used whenever a set of elements are + // logically enclosed in a single code segment. For example, an entire + // extend block (possibly containing multiple extension definitions) will + // have an outer location whose path refers to the "extensions" repeated + // field without an index. + // - Multiple locations may have the same path. This happens when a single + // logical declaration is spread out across multiple places. The most + // obvious example is the "extend" block again -- there may be multiple + // extend blocks in the same scope, each of which will have the same path. + // - A location's span is not always a subset of its parent's span. For + // example, the "extendee" of an extension declaration appears at the + // beginning of the "extend" block and is shared by all extensions within + // the block. + // - Just because a location's span is a subset of some other location's span + // does not mean that it is a descendant. For example, a "group" defines + // both a type and a field in a single declaration. Thus, the locations + // corresponding to the type and field and their components will overlap. + // - Code which tries to interpret locations should probably be designed to + // ignore those that it doesn't understand, as more types of locations could + // be recorded in the future. + repeated Location location = 1; + message Location { + // Identifies which part of the FileDescriptorProto was defined at this + // location. + // + // Each element is a field number or an index. They form a path from + // the root FileDescriptorProto to the place where the definition. For + // example, this path: + // [ 4, 3, 2, 7, 1 ] + // refers to: + // file.message_type(3) // 4, 3 + // .field(7) // 2, 7 + // .name() // 1 + // This is because FileDescriptorProto.message_type has field number 4: + // repeated DescriptorProto message_type = 4; + // and DescriptorProto.field has field number 2: + // repeated FieldDescriptorProto field = 2; + // and FieldDescriptorProto.name has field number 1: + // optional string name = 1; + // + // Thus, the above path gives the location of a field name. If we removed + // the last element: + // [ 4, 3, 2, 7 ] + // this path refers to the whole field declaration (from the beginning + // of the label to the terminating semicolon). + repeated int32 path = 1 [packed = true]; + + // Always has exactly three or four elements: start line, start column, + // end line (optional, otherwise assumed same as start line), end column. + // These are packed into a single field for efficiency. Note that line + // and column numbers are zero-based -- typically you will want to add + // 1 to each before displaying to a user. + repeated int32 span = 2 [packed = true]; + + // If this SourceCodeInfo represents a complete declaration, these are any + // comments appearing before and after the declaration which appear to be + // attached to the declaration. + // + // A series of line comments appearing on consecutive lines, with no other + // tokens appearing on those lines, will be treated as a single comment. + // + // leading_detached_comments will keep paragraphs of comments that appear + // before (but not connected to) the current element. Each paragraph, + // separated by empty lines, will be one comment element in the repeated + // field. + // + // Only the comment content is provided; comment markers (e.g. //) are + // stripped out. For block comments, leading whitespace and an asterisk + // will be stripped from the beginning of each line other than the first. + // Newlines are included in the output. + // + // Examples: + // + // optional int32 foo = 1; // Comment attached to foo. + // // Comment attached to bar. + // optional int32 bar = 2; + // + // optional string baz = 3; + // // Comment attached to baz. + // // Another line attached to baz. + // + // // Comment attached to qux. + // // + // // Another line attached to qux. + // optional double qux = 4; + // + // // Detached comment for corge. This is not leading or trailing comments + // // to qux or corge because there are blank lines separating it from + // // both. + // + // // Detached comment for corge paragraph 2. + // + // optional string corge = 5; + // /* Block comment attached + // * to corge. Leading asterisks + // * will be removed. */ + // /* Block comment attached to + // * grault. */ + // optional int32 grault = 6; + // + // // ignored detached comments. + optional string leading_comments = 3; + optional string trailing_comments = 4; + repeated string leading_detached_comments = 6; + } +} + +// Describes the relationship between generated code and its original source +// file. A GeneratedCodeInfo message is associated with only one generated +// source file, but may contain references to different source .proto files. +message GeneratedCodeInfo { + // An Annotation connects some span of text in generated code to an element + // of its generating .proto file. + repeated Annotation annotation = 1; + message Annotation { + // Identifies the element in the original source .proto file. This field + // is formatted the same as SourceCodeInfo.Location.path. + repeated int32 path = 1 [packed = true]; + + // Identifies the filesystem path to the original source .proto. + optional string source_file = 2; + + // Identifies the starting offset in bytes in the generated code + // that relates to the identified object. + optional int32 begin = 3; + + // Identifies the ending offset in bytes in the generated code that + // relates to the identified offset. The end offset should be one past + // the last relevant byte (so the length of the text = end - begin). + optional int32 end = 4; + } +} diff --git a/tests/fragments/google/protobuf/struct.proto b/tests/fragments/google/protobuf/struct.proto new file mode 100644 index 0000000000..545215c252 --- /dev/null +++ b/tests/fragments/google/protobuf/struct.proto @@ -0,0 +1,95 @@ +// Protocol Buffers - Google's data interchange format +// Copyright 2008 Google Inc. All rights reserved. +// https://developers.google.com/protocol-buffers/ +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +syntax = "proto3"; + +package google.protobuf; + +option csharp_namespace = "Google.Protobuf.WellKnownTypes"; +option cc_enable_arenas = true; +option go_package = "google.golang.org/protobuf/types/known/structpb"; +option java_package = "com.google.protobuf"; +option java_outer_classname = "StructProto"; +option java_multiple_files = true; +option objc_class_prefix = "GPB"; + +// `Struct` represents a structured data value, consisting of fields +// which map to dynamically typed values. In some languages, `Struct` +// might be supported by a native representation. For example, in +// scripting languages like JS a struct is represented as an +// object. The details of that representation are described together +// with the proto support for the language. +// +// The JSON representation for `Struct` is JSON object. +message Struct { + // Unordered map of dynamically typed values. + map fields = 1; +} + +// `Value` represents a dynamically typed value which can be either +// null, a number, a string, a boolean, a recursive struct value, or a +// list of values. A producer of value is expected to set one of that +// variants, absence of any variant indicates an error. +// +// The JSON representation for `Value` is JSON value. +message Value { + // The kind of value. + oneof kind { + // Represents a null value. + NullValue null_value = 1; + // Represents a double value. + double number_value = 2; + // Represents a string value. + string string_value = 3; + // Represents a boolean value. + bool bool_value = 4; + // Represents a structured value. + Struct struct_value = 5; + // Represents a repeated `Value`. + ListValue list_value = 6; + } +} + +// `NullValue` is a singleton enumeration to represent the null value for the +// `Value` type union. +// +// The JSON representation for `NullValue` is JSON `null`. +enum NullValue { + // Null value. + NULL_VALUE = 0; +} + +// `ListValue` is a wrapper around a repeated field of values. +// +// The JSON representation for `ListValue` is JSON array. +message ListValue { + // Repeated field of dynamically typed values. + repeated Value values = 1; +} diff --git a/tests/fragments/import.proto b/tests/fragments/import.proto new file mode 100644 index 0000000000..005989420c --- /dev/null +++ b/tests/fragments/import.proto @@ -0,0 +1,21 @@ +// Copyright (C) 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.fragment; + +message Import { + string path = 1; +} diff --git a/tests/fragments/test_flattened_value.proto b/tests/fragments/test_flattened_value.proto new file mode 100644 index 0000000000..8965b97d40 --- /dev/null +++ b/tests/fragments/test_flattened_value.proto @@ -0,0 +1,37 @@ +// Copyright (C) 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.fragment; + +import "google/protobuf/struct.proto"; +import "google/api/client.proto"; + +service MyService { + option (google.api.default_host) = "my.example.com"; + + rpc MyMethod(MethodRequest) returns (MethodResponse) { + option (google.api.method_signature) = "parameter,items"; + } +} + +message MethodRequest { + google.protobuf.Value parameter = 1; + repeated google.protobuf.Value items = 2; +} + +message MethodResponse { + string result = 1; +} diff --git a/tests/fragments/test_keyword_import.proto b/tests/fragments/test_keyword_import.proto new file mode 100644 index 0000000000..81ce44eda1 --- /dev/null +++ b/tests/fragments/test_keyword_import.proto @@ -0,0 +1,33 @@ +// Copyright (C) 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.fragment; + +import "google/api/client.proto"; +import "import.proto"; + +service MyService { + option (google.api.default_host) = "my.example.com"; + rpc MyMethod(MethodRequest) returns (MethodResponse) {} +} + +message MethodRequest { + Import import = 1; +} + +message MethodResponse { + string result = 1; +} diff --git a/tests/fragments/test_optional_signature.proto b/tests/fragments/test_optional_signature.proto new file mode 100644 index 0000000000..4789abd596 --- /dev/null +++ b/tests/fragments/test_optional_signature.proto @@ -0,0 +1,35 @@ +// Copyright (C) 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.fragment; + +import "google/api/client.proto"; + +service MyService { + option (google.api.default_host) = "my.example.com"; + rpc MyMethod(MethodRequest) returns (MethodResponse) { + option (google.api.method_signature) = "parameter"; + } + +} + +message MethodRequest { + optional string parameter = 1; +} + +message MethodResponse { + string result = 1; +} diff --git a/tests/fragments/test_recursive_messages.proto b/tests/fragments/test_recursive_messages.proto new file mode 100644 index 0000000000..efe2685877 --- /dev/null +++ b/tests/fragments/test_recursive_messages.proto @@ -0,0 +1,34 @@ +// Copyright (C) 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.fragment; + +import "google/api/client.proto"; + +service MyService { + option (google.api.default_host) = "my.example.com"; + + rpc MyMethod(MethodRequest) returns (MethodResponse) {} +} + +message MethodRequest { + int32 depth = 1; + MethodRequest child = 2; +} + +message MethodResponse { + string result = 1; +} diff --git a/tests/fragments/test_reserved_field_name.proto b/tests/fragments/test_reserved_field_name.proto new file mode 100644 index 0000000000..9fee7912c9 --- /dev/null +++ b/tests/fragments/test_reserved_field_name.proto @@ -0,0 +1,41 @@ +// Copyright (C) 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.fragment; + +import "google/api/client.proto"; + +service MyService { + option (google.api.default_host) = "my.example.com"; + + rpc MyMethod(MethodRequest) returns (MethodResponse) { + option (google.api.method_signature) = "from,class,import,any,license,type"; + } + +} + +message MethodRequest { + string from = 1; + string class = 2; + string import = 3; + string any = 4; + string license = 5; + string type = 6; +} + +message MethodResponse { + string result = 1; +} From 00330543e76da85727518d4942ecbb4db1e8958b Mon Sep 17 00:00:00 2001 From: Dov Shlachter Date: Fri, 29 Oct 2021 12:12:33 -0700 Subject: [PATCH 2/4] feat: fragment test is concurrent among fragments Within a session, e.g. Python 3.9, all fragment GAPICs are generated and tested concurrently. --- .github/workflows/tests.yaml | 2 +- noxfile.py | 81 +++++++++++++++++++++++------------- 2 files changed, 54 insertions(+), 29 deletions(-) diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index 847e0dabc5..33f2264da6 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -308,7 +308,7 @@ jobs: - name: Install nox. run: | python -m pip install nox - - name: Run unit tests. + - name: Run fragment tests. run: nox -s fragment-${{ matrix.python }} integration: runs-on: ubuntu-latest diff --git a/noxfile.py b/noxfile.py index a33f0d78fd..a656b2943d 100644 --- a/noxfile.py +++ b/noxfile.py @@ -13,6 +13,7 @@ # limitations under the License. from __future__ import absolute_import +from concurrent.futures import ThreadPoolExecutor from pathlib import Path import os import sys @@ -34,7 +35,6 @@ "3.7", "3.8", "3.9", - "3.10", ) NEWEST_PYTHON = "3.9" @@ -74,6 +74,54 @@ def unit(session): if os.path.splitext(f)[1] == ".proto" and f.startswith("test_") ) +# Note: this class lives outside 'fragment' +# so that, if necessary, it can be pickled for a ProcessPoolExecutor +# A callable class is necessary so that the session can be closed over +# instead of passed in, which simplifies the invocation via map. +class FragTester: + def __init__(self, session): + self.session = session + + def __call__(self, frag): + with tempfile.TemporaryDirectory() as tmp_dir: + # Generate the fragment GAPIC. + outputs = [] + outputs.append( + self.session.run( + "python", + "-m", + "grpc_tools.protoc", + f"--proto_path={str(FRAG_DIR)}", + f"--python_gapic_out={tmp_dir}", + "--python_gapic_opt=transport=grpc+rest", + str(frag), + external=True, + silent=True, + ) + ) + + # Install the generated fragment library. + # Note: install into the tempdir to prevent issues + # with running pip concurrently. + self.session.install(tmp_dir, "-e", ".", "-t", tmp_dir, "-qqq") + + # Run the fragment's generated unit tests. + # Don't bother parallelizing them: we already parallelize + # the fragments, and there usually aren't too many tests per fragment. + outputs.append( + self.session.run( + "py.test", + "--quiet", + f"--cov-config={str(Path(tmp_dir) / '.coveragerc')}", + "--cov-report=term", + "--cov-fail-under=100", + str(Path(tmp_dir) / "tests" / "unit"), + silent=True, + ) + ) + + return "".join(outputs) + # TODO(dovs): ads templates @nox.session(python=ALL_PYTHON) @@ -87,36 +135,13 @@ def fragment(session): "pytest-asyncio", "grpcio-tools", ) - session.install("-e", ".") - for frag in FRAGMENT_FILES: - with tempfile.TemporaryDirectory() as tmp_dir: - # Generate the fragment GAPIC. - session.run( - "python", - "-m", - "grpc_tools.protoc", - f"--proto_path={str(FRAG_DIR)}", - f"--python_gapic_out={tmp_dir}", - "--python_gapic_opt=transport=grpc+rest", - str(frag), - external=True, - ) - - # Install the generated fragment library. - session.install(tmp_dir, "-e", ".") + with ThreadPoolExecutor() as p: + all_outs = p.map(FragTester(session), FRAGMENT_FILES) - # Run the fragment's generated unit tests. - session.run( - "py.test", - "--quiet", - "-n=auto", - f"--cov-config={str(Path(tmp_dir) / '.coveragerc')}", - "--cov-report=term", - "--cov-fail-under=100", - str(Path(tmp_dir) / "tests" / "unit"), - ) + output = "".join(all_outs) + session.log(output) # TODO(yon-mg): -add compute context manager that includes rest transport From ab4bbc3784846a53b9b48dbb023f3bd234bc510c Mon Sep 17 00:00:00 2001 From: Dov Shlachter Date: Mon, 1 Nov 2021 10:48:15 -0700 Subject: [PATCH 3/4] Shaving the yak --- WORKSPACE | 4 ---- 1 file changed, 4 deletions(-) diff --git a/WORKSPACE b/WORKSPACE index 65b9832e7e..8bf6d5fb0d 100644 --- a/WORKSPACE +++ b/WORKSPACE @@ -13,10 +13,6 @@ http_archive( url = "https://github.com/bazelbuild/rules_python/archive/0.1.0.tar.gz", ) -load("@rules_python//python:pip.bzl", "pip_repositories") - -pip_repositories() - # # Import gapic-generator-python specific dependencies # From 0389afeb1b52907757050440aec5f2421cac7a2c Mon Sep 17 00:00:00 2001 From: Dov Shlachter Date: Mon, 1 Nov 2021 11:38:36 -0700 Subject: [PATCH 4/4] Update the golden files --- .../unit/gapic/asset_v1/test_asset_service.py | 88 ++++++++--- .../credentials_v1/test_iam_credentials.py | 104 +++++++++---- .../logging_v2/test_config_service_v2.py | 144 +++++++++++++----- .../logging_v2/test_logging_service_v2.py | 72 ++++++--- .../logging_v2/test_metrics_service_v2.py | 56 +++++-- .../unit/gapic/redis_v1/test_cloud_redis.py | 128 ++++++++++++---- 6 files changed, 444 insertions(+), 148 deletions(-) diff --git a/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py b/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py index 98379ffdce..ae6fd2a5e6 100644 --- a/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py +++ b/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py @@ -701,7 +701,9 @@ def test_list_assets_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_assets_flattened_error(): @@ -742,7 +744,9 @@ async def test_list_assets_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1277,7 +1281,9 @@ def test_create_feed_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_create_feed_flattened_error(): @@ -1318,7 +1324,9 @@ async def test_create_feed_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1520,7 +1528,9 @@ def test_get_feed_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val def test_get_feed_flattened_error(): @@ -1561,7 +1571,9 @@ async def test_get_feed_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1747,7 +1759,9 @@ def test_list_feeds_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_feeds_flattened_error(): @@ -1788,7 +1802,9 @@ async def test_list_feeds_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1990,7 +2006,9 @@ def test_update_feed_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].feed == asset_service.Feed(name='name_value') + arg = args[0].feed + mock_val = asset_service.Feed(name='name_value') + assert arg == mock_val def test_update_feed_flattened_error(): @@ -2031,7 +2049,9 @@ async def test_update_feed_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].feed == asset_service.Feed(name='name_value') + arg = args[0].feed + mock_val = asset_service.Feed(name='name_value') + assert arg == mock_val @pytest.mark.asyncio @@ -2215,7 +2235,9 @@ def test_delete_feed_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val def test_delete_feed_flattened_error(): @@ -2256,7 +2278,9 @@ async def test_delete_feed_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val @pytest.mark.asyncio @@ -2448,9 +2472,15 @@ def test_search_all_resources_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].scope == 'scope_value' - assert args[0].query == 'query_value' - assert args[0].asset_types == ['asset_types_value'] + arg = args[0].scope + mock_val = 'scope_value' + assert arg == mock_val + arg = args[0].query + mock_val = 'query_value' + assert arg == mock_val + arg = args[0].asset_types + mock_val = ['asset_types_value'] + assert arg == mock_val def test_search_all_resources_flattened_error(): @@ -2495,9 +2525,15 @@ async def test_search_all_resources_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].scope == 'scope_value' - assert args[0].query == 'query_value' - assert args[0].asset_types == ['asset_types_value'] + arg = args[0].scope + mock_val = 'scope_value' + assert arg == mock_val + arg = args[0].query + mock_val = 'query_value' + assert arg == mock_val + arg = args[0].asset_types + mock_val = ['asset_types_value'] + assert arg == mock_val @pytest.mark.asyncio @@ -2876,8 +2912,12 @@ def test_search_all_iam_policies_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].scope == 'scope_value' - assert args[0].query == 'query_value' + arg = args[0].scope + mock_val = 'scope_value' + assert arg == mock_val + arg = args[0].query + mock_val = 'query_value' + assert arg == mock_val def test_search_all_iam_policies_flattened_error(): @@ -2920,8 +2960,12 @@ async def test_search_all_iam_policies_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].scope == 'scope_value' - assert args[0].query == 'query_value' + arg = args[0].scope + mock_val = 'scope_value' + assert arg == mock_val + arg = args[0].query + mock_val = 'query_value' + assert arg == mock_val @pytest.mark.asyncio diff --git a/tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py b/tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py index 1ca68f9187..54bebbee75 100644 --- a/tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py +++ b/tests/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py @@ -549,9 +549,15 @@ def test_generate_access_token_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].delegates == ['delegates_value'] - assert args[0].scope == ['scope_value'] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].delegates + mock_val = ['delegates_value'] + assert arg == mock_val + arg = args[0].scope + mock_val = ['scope_value'] + assert arg == mock_val assert DurationRule().to_proto(args[0].lifetime) == duration_pb2.Duration(seconds=751) @@ -599,9 +605,15 @@ async def test_generate_access_token_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].delegates == ['delegates_value'] - assert args[0].scope == ['scope_value'] + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].delegates + mock_val = ['delegates_value'] + assert arg == mock_val + arg = args[0].scope + mock_val = ['scope_value'] + assert arg == mock_val assert DurationRule().to_proto(args[0].lifetime) == duration_pb2.Duration(seconds=751) @@ -798,10 +810,18 @@ def test_generate_id_token_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].delegates == ['delegates_value'] - assert args[0].audience == 'audience_value' - assert args[0].include_email == True + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].delegates + mock_val = ['delegates_value'] + assert arg == mock_val + arg = args[0].audience + mock_val = 'audience_value' + assert arg == mock_val + arg = args[0].include_email + mock_val = True + assert arg == mock_val def test_generate_id_token_flattened_error(): @@ -848,10 +868,18 @@ async def test_generate_id_token_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].delegates == ['delegates_value'] - assert args[0].audience == 'audience_value' - assert args[0].include_email == True + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].delegates + mock_val = ['delegates_value'] + assert arg == mock_val + arg = args[0].audience + mock_val = 'audience_value' + assert arg == mock_val + arg = args[0].include_email + mock_val = True + assert arg == mock_val @pytest.mark.asyncio @@ -1050,9 +1078,15 @@ def test_sign_blob_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].delegates == ['delegates_value'] - assert args[0].payload == b'payload_blob' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].delegates + mock_val = ['delegates_value'] + assert arg == mock_val + arg = args[0].payload + mock_val = b'payload_blob' + assert arg == mock_val def test_sign_blob_flattened_error(): @@ -1097,9 +1131,15 @@ async def test_sign_blob_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].delegates == ['delegates_value'] - assert args[0].payload == b'payload_blob' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].delegates + mock_val = ['delegates_value'] + assert arg == mock_val + arg = args[0].payload + mock_val = b'payload_blob' + assert arg == mock_val @pytest.mark.asyncio @@ -1297,9 +1337,15 @@ def test_sign_jwt_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].delegates == ['delegates_value'] - assert args[0].payload == 'payload_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].delegates + mock_val = ['delegates_value'] + assert arg == mock_val + arg = args[0].payload + mock_val = 'payload_value' + assert arg == mock_val def test_sign_jwt_flattened_error(): @@ -1344,9 +1390,15 @@ async def test_sign_jwt_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].delegates == ['delegates_value'] - assert args[0].payload == 'payload_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].delegates + mock_val = ['delegates_value'] + assert arg == mock_val + arg = args[0].payload + mock_val = 'payload_value' + assert arg == mock_val @pytest.mark.asyncio diff --git a/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py b/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py index 60e2621219..f8c963c4af 100644 --- a/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py +++ b/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py @@ -547,7 +547,9 @@ def test_list_buckets_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_buckets_flattened_error(): @@ -588,7 +590,9 @@ async def test_list_buckets_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1755,7 +1759,9 @@ def test_list_views_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_views_flattened_error(): @@ -1796,7 +1802,9 @@ async def test_list_views_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -2794,7 +2802,9 @@ def test_list_sinks_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_sinks_flattened_error(): @@ -2835,7 +2845,9 @@ async def test_list_sinks_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -3240,7 +3252,9 @@ def test_get_sink_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].sink_name == 'sink_name_value' + arg = args[0].sink_name + mock_val = 'sink_name_value' + assert arg == mock_val def test_get_sink_flattened_error(): @@ -3281,7 +3295,9 @@ async def test_get_sink_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].sink_name == 'sink_name_value' + arg = args[0].sink_name + mock_val = 'sink_name_value' + assert arg == mock_val @pytest.mark.asyncio @@ -3501,8 +3517,12 @@ def test_create_sink_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].sink == logging_config.LogSink(name='name_value') + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].sink + mock_val = logging_config.LogSink(name='name_value') + assert arg == mock_val def test_create_sink_flattened_error(): @@ -3545,8 +3565,12 @@ async def test_create_sink_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].sink == logging_config.LogSink(name='name_value') + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].sink + mock_val = logging_config.LogSink(name='name_value') + assert arg == mock_val @pytest.mark.asyncio @@ -3768,9 +3792,15 @@ def test_update_sink_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].sink_name == 'sink_name_value' - assert args[0].sink == logging_config.LogSink(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + arg = args[0].sink_name + mock_val = 'sink_name_value' + assert arg == mock_val + arg = args[0].sink + mock_val = logging_config.LogSink(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val def test_update_sink_flattened_error(): @@ -3815,9 +3845,15 @@ async def test_update_sink_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].sink_name == 'sink_name_value' - assert args[0].sink == logging_config.LogSink(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + arg = args[0].sink_name + mock_val = 'sink_name_value' + assert arg == mock_val + arg = args[0].sink + mock_val = logging_config.LogSink(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val @pytest.mark.asyncio @@ -4003,7 +4039,9 @@ def test_delete_sink_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].sink_name == 'sink_name_value' + arg = args[0].sink_name + mock_val = 'sink_name_value' + assert arg == mock_val def test_delete_sink_flattened_error(): @@ -4044,7 +4082,9 @@ async def test_delete_sink_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].sink_name == 'sink_name_value' + arg = args[0].sink_name + mock_val = 'sink_name_value' + assert arg == mock_val @pytest.mark.asyncio @@ -4234,7 +4274,9 @@ def test_list_exclusions_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_exclusions_flattened_error(): @@ -4275,7 +4317,9 @@ async def test_list_exclusions_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -4663,7 +4707,9 @@ def test_get_exclusion_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val def test_get_exclusion_flattened_error(): @@ -4704,7 +4750,9 @@ async def test_get_exclusion_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val @pytest.mark.asyncio @@ -4907,8 +4955,12 @@ def test_create_exclusion_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].exclusion == logging_config.LogExclusion(name='name_value') + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].exclusion + mock_val = logging_config.LogExclusion(name='name_value') + assert arg == mock_val def test_create_exclusion_flattened_error(): @@ -4951,8 +5003,12 @@ async def test_create_exclusion_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].exclusion == logging_config.LogExclusion(name='name_value') + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].exclusion + mock_val = logging_config.LogExclusion(name='name_value') + assert arg == mock_val @pytest.mark.asyncio @@ -5157,9 +5213,15 @@ def test_update_exclusion_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].exclusion == logging_config.LogExclusion(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].exclusion + mock_val = logging_config.LogExclusion(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val def test_update_exclusion_flattened_error(): @@ -5204,9 +5266,15 @@ async def test_update_exclusion_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].exclusion == logging_config.LogExclusion(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].exclusion + mock_val = logging_config.LogExclusion(name='name_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val @pytest.mark.asyncio @@ -5392,7 +5460,9 @@ def test_delete_exclusion_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val def test_delete_exclusion_flattened_error(): @@ -5433,7 +5503,9 @@ async def test_delete_exclusion_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val @pytest.mark.asyncio diff --git a/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py b/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py index ddf1b0c45d..47cc2177ef 100644 --- a/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py +++ b/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py @@ -547,7 +547,9 @@ def test_delete_log_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].log_name == 'log_name_value' + arg = args[0].log_name + mock_val = 'log_name_value' + assert arg == mock_val def test_delete_log_flattened_error(): @@ -588,7 +590,9 @@ async def test_delete_log_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].log_name == 'log_name_value' + arg = args[0].log_name + mock_val = 'log_name_value' + assert arg == mock_val @pytest.mark.asyncio @@ -714,10 +718,18 @@ def test_write_log_entries_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].log_name == 'log_name_value' - assert args[0].resource == monitored_resource_pb2.MonitoredResource(type_='type__value') - assert args[0].labels == {'key_value': 'value_value'} - assert args[0].entries == [log_entry.LogEntry(log_name='log_name_value')] + arg = args[0].log_name + mock_val = 'log_name_value' + assert arg == mock_val + arg = args[0].resource + mock_val = monitored_resource_pb2.MonitoredResource(type_='type__value') + assert arg == mock_val + arg = args[0].labels + mock_val = {'key_value': 'value_value'} + assert arg == mock_val + arg = args[0].entries + mock_val = [log_entry.LogEntry(log_name='log_name_value')] + assert arg == mock_val def test_write_log_entries_flattened_error(): @@ -764,10 +776,18 @@ async def test_write_log_entries_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].log_name == 'log_name_value' - assert args[0].resource == monitored_resource_pb2.MonitoredResource(type_='type__value') - assert args[0].labels == {'key_value': 'value_value'} - assert args[0].entries == [log_entry.LogEntry(log_name='log_name_value')] + arg = args[0].log_name + mock_val = 'log_name_value' + assert arg == mock_val + arg = args[0].resource + mock_val = monitored_resource_pb2.MonitoredResource(type_='type__value') + assert arg == mock_val + arg = args[0].labels + mock_val = {'key_value': 'value_value'} + assert arg == mock_val + arg = args[0].entries + mock_val = [log_entry.LogEntry(log_name='log_name_value')] + assert arg == mock_val @pytest.mark.asyncio @@ -899,9 +919,15 @@ def test_list_log_entries_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].resource_names == ['resource_names_value'] - assert args[0].filter == 'filter_value' - assert args[0].order_by == 'order_by_value' + arg = args[0].resource_names + mock_val = ['resource_names_value'] + assert arg == mock_val + arg = args[0].filter + mock_val = 'filter_value' + assert arg == mock_val + arg = args[0].order_by + mock_val = 'order_by_value' + assert arg == mock_val def test_list_log_entries_flattened_error(): @@ -946,9 +972,15 @@ async def test_list_log_entries_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].resource_names == ['resource_names_value'] - assert args[0].filter == 'filter_value' - assert args[0].order_by == 'order_by_value' + arg = args[0].resource_names + mock_val = ['resource_names_value'] + assert arg == mock_val + arg = args[0].filter + mock_val = 'filter_value' + assert arg == mock_val + arg = args[0].order_by + mock_val = 'order_by_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1594,7 +1626,9 @@ def test_list_logs_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_logs_flattened_error(): @@ -1635,7 +1669,9 @@ async def test_list_logs_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio diff --git a/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py b/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py index fc8a797366..7d8951e95a 100644 --- a/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py +++ b/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py @@ -551,7 +551,9 @@ def test_list_log_metrics_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_log_metrics_flattened_error(): @@ -592,7 +594,9 @@ async def test_list_log_metrics_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -984,7 +988,9 @@ def test_get_log_metric_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].metric_name == 'metric_name_value' + arg = args[0].metric_name + mock_val = 'metric_name_value' + assert arg == mock_val def test_get_log_metric_flattened_error(): @@ -1025,7 +1031,9 @@ async def test_get_log_metric_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].metric_name == 'metric_name_value' + arg = args[0].metric_name + mock_val = 'metric_name_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1232,8 +1240,12 @@ def test_create_log_metric_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].metric == logging_metrics.LogMetric(name='name_value') + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].metric + mock_val = logging_metrics.LogMetric(name='name_value') + assert arg == mock_val def test_create_log_metric_flattened_error(): @@ -1276,8 +1288,12 @@ async def test_create_log_metric_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].metric == logging_metrics.LogMetric(name='name_value') + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].metric + mock_val = logging_metrics.LogMetric(name='name_value') + assert arg == mock_val @pytest.mark.asyncio @@ -1485,8 +1501,12 @@ def test_update_log_metric_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].metric_name == 'metric_name_value' - assert args[0].metric == logging_metrics.LogMetric(name='name_value') + arg = args[0].metric_name + mock_val = 'metric_name_value' + assert arg == mock_val + arg = args[0].metric + mock_val = logging_metrics.LogMetric(name='name_value') + assert arg == mock_val def test_update_log_metric_flattened_error(): @@ -1529,8 +1549,12 @@ async def test_update_log_metric_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].metric_name == 'metric_name_value' - assert args[0].metric == logging_metrics.LogMetric(name='name_value') + arg = args[0].metric_name + mock_val = 'metric_name_value' + assert arg == mock_val + arg = args[0].metric + mock_val = logging_metrics.LogMetric(name='name_value') + assert arg == mock_val @pytest.mark.asyncio @@ -1715,7 +1739,9 @@ def test_delete_log_metric_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].metric_name == 'metric_name_value' + arg = args[0].metric_name + mock_val = 'metric_name_value' + assert arg == mock_val def test_delete_log_metric_flattened_error(): @@ -1756,7 +1782,9 @@ async def test_delete_log_metric_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].metric_name == 'metric_name_value' + arg = args[0].metric_name + mock_val = 'metric_name_value' + assert arg == mock_val @pytest.mark.asyncio diff --git a/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py b/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py index 2d55a27a4a..160dcfc35a 100644 --- a/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py +++ b/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py @@ -555,7 +555,9 @@ def test_list_instances_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val def test_list_instances_flattened_error(): @@ -596,7 +598,9 @@ async def test_list_instances_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1032,7 +1036,9 @@ def test_get_instance_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val def test_get_instance_flattened_error(): @@ -1073,7 +1079,9 @@ async def test_get_instance_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1261,9 +1269,15 @@ def test_create_instance_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].instance_id == 'instance_id_value' - assert args[0].instance == cloud_redis.Instance(name='name_value') + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].instance_id + mock_val = 'instance_id_value' + assert arg == mock_val + arg = args[0].instance + mock_val = cloud_redis.Instance(name='name_value') + assert arg == mock_val def test_create_instance_flattened_error(): @@ -1310,9 +1324,15 @@ async def test_create_instance_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].instance_id == 'instance_id_value' - assert args[0].instance == cloud_redis.Instance(name='name_value') + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].instance_id + mock_val = 'instance_id_value' + assert arg == mock_val + arg = args[0].instance + mock_val = cloud_redis.Instance(name='name_value') + assert arg == mock_val @pytest.mark.asyncio @@ -1501,8 +1521,12 @@ def test_update_instance_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - assert args[0].instance == cloud_redis.Instance(name='name_value') + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + arg = args[0].instance + mock_val = cloud_redis.Instance(name='name_value') + assert arg == mock_val def test_update_instance_flattened_error(): @@ -1547,8 +1571,12 @@ async def test_update_instance_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - assert args[0].instance == cloud_redis.Instance(name='name_value') + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + arg = args[0].instance + mock_val = cloud_redis.Instance(name='name_value') + assert arg == mock_val @pytest.mark.asyncio @@ -1736,8 +1764,12 @@ def test_upgrade_instance_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].redis_version == 'redis_version_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].redis_version + mock_val = 'redis_version_value' + assert arg == mock_val def test_upgrade_instance_flattened_error(): @@ -1782,8 +1814,12 @@ async def test_upgrade_instance_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].redis_version == 'redis_version_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].redis_version + mock_val = 'redis_version_value' + assert arg == mock_val @pytest.mark.asyncio @@ -1971,8 +2007,12 @@ def test_import_instance_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].input_config == cloud_redis.InputConfig(gcs_source=cloud_redis.GcsSource(uri='uri_value')) + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].input_config + mock_val = cloud_redis.InputConfig(gcs_source=cloud_redis.GcsSource(uri='uri_value')) + assert arg == mock_val def test_import_instance_flattened_error(): @@ -2017,8 +2057,12 @@ async def test_import_instance_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].input_config == cloud_redis.InputConfig(gcs_source=cloud_redis.GcsSource(uri='uri_value')) + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].input_config + mock_val = cloud_redis.InputConfig(gcs_source=cloud_redis.GcsSource(uri='uri_value')) + assert arg == mock_val @pytest.mark.asyncio @@ -2206,8 +2250,12 @@ def test_export_instance_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].output_config == cloud_redis.OutputConfig(gcs_destination=cloud_redis.GcsDestination(uri='uri_value')) + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].output_config + mock_val = cloud_redis.OutputConfig(gcs_destination=cloud_redis.GcsDestination(uri='uri_value')) + assert arg == mock_val def test_export_instance_flattened_error(): @@ -2252,8 +2300,12 @@ async def test_export_instance_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].output_config == cloud_redis.OutputConfig(gcs_destination=cloud_redis.GcsDestination(uri='uri_value')) + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].output_config + mock_val = cloud_redis.OutputConfig(gcs_destination=cloud_redis.GcsDestination(uri='uri_value')) + assert arg == mock_val @pytest.mark.asyncio @@ -2441,8 +2493,12 @@ def test_failover_instance_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].data_protection_mode == cloud_redis.FailoverInstanceRequest.DataProtectionMode.LIMITED_DATA_LOSS + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].data_protection_mode + mock_val = cloud_redis.FailoverInstanceRequest.DataProtectionMode.LIMITED_DATA_LOSS + assert arg == mock_val def test_failover_instance_flattened_error(): @@ -2487,8 +2543,12 @@ async def test_failover_instance_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' - assert args[0].data_protection_mode == cloud_redis.FailoverInstanceRequest.DataProtectionMode.LIMITED_DATA_LOSS + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].data_protection_mode + mock_val = cloud_redis.FailoverInstanceRequest.DataProtectionMode.LIMITED_DATA_LOSS + assert arg == mock_val @pytest.mark.asyncio @@ -2675,7 +2735,9 @@ def test_delete_instance_flattened(): # request object values. assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val def test_delete_instance_flattened_error(): @@ -2718,7 +2780,9 @@ async def test_delete_instance_flattened_async(): # request object values. assert len(call.mock_calls) _, args, _ = call.mock_calls[0] - assert args[0].name == 'name_value' + arg = args[0].name + mock_val = 'name_value' + assert arg == mock_val @pytest.mark.asyncio