test: update conf tests (#291)

* test: update conf tests

* test: use relative directories, not hardcoded, in conf test makefile

* test: add format at end of generation

* test: remove unused var

* Updated Makefile to make less assumptions about project structure

Co-authored-by: Craig Labenz <craig.labenz@gmail.com>

Author: crwilcox

packages/google-cloud-firestore/.gitignore

@@ -60,3 +60,4 @@ system_tests/local_test_setup
 # Make sure a generated file isn't accidentally committed.
 pylintrc
 pylintrc.test
+.make/**

packages/google-cloud-firestore/CONTRIBUTING.rst

@@ -146,11 +146,21 @@ Running System Tests
     `docs <https://cloud.google.com/storage/docs/authentication#generating-a-private-key>`__
     for more details.
 
-- Once you have downloaded your json keys, set the environment variable 
+- Once you have downloaded your json keys, set the environment variable
   ``GOOGLE_APPLICATION_CREDENTIALS`` to the absolute path of the json file::
 
    $ export GOOGLE_APPLICATION_CREDENTIALS="/Users/<your_username>/path/to/app_credentials.json"
 
+**************************
+Updating Conformance Tests
+**************************
+
+The firestore client libraries use a shared set of conformance tests, the source of which can be found at https://github.com/googleapis/conformance-tests.
+
+To update the copy of these conformance tests used by this repository, run the provided Makefile:
+
+   $ make -f Makefile_v1
+
 
 *************
 Test Coverage

packages/google-cloud-firestore/Makefile_v1

@@ -5,23 +5,32 @@
 PROTOC = protoc
 
 # Dependent repos.
-REPO_DIR=$(HOME)/git-repos
-PROTOBUF_REPO = $(REPO_DIR)/protobuf
-GOOGLEAPIS_REPO = $(REPO_DIR)/googleapis
-TESTS_REPO = $(REPO_DIR)/conformance-tests
+REPO_DIR = $(shell pwd)
+BUILD_DIR = $(shell pwd)/.make
+# This requires a few other repositories, assumed to be in the same root
+# of this repository.
+# => git clone git@github.com:protocolbuffers/protobuf
+PROTOBUF_REPO = $(BUILD_DIR)/protobuf
+# => git clone git@github.com:googleapis/googleapis.git
+GOOGLEAPIS_REPO = $(BUILD_DIR)/googleapis
+# => git clone git@github.com:googleapis/conformance-tests.git
+TESTS_REPO = $(BUILD_DIR)/conformance-tests
+
 TEST_PROTO_DIR = $(TESTS_REPO)/firestore/v1
 TEST_PROTO_SRC = $(TEST_PROTO_DIR)/proto/google/cloud/conformance/firestore/v1/tests.proto
-TESTDATA_DIR = `pwd`/tests/unit/v1/testdata/
+TESTDATA_DIR = $(REPO_DIR)/tests/unit/v1/testdata/
 
-TMPDIR = /tmp/python-fs-proto
+TMPDIR = $(BUILD_DIR)/python-fs-proto
 TMPDIR_FS = $(TMPDIR)/google/cloud/firestore_v1/types
 TEST_PROTO_COPY = $(TMPDIR_FS)/tests.proto
 TEST_GEN_OUT = tests/unit/v1/conformance_tests.py
-OUTDIR = /tmp/python-fs-gen
+OUTDIR = $(BUILD_DIR)/python-fs-gen
+
+.PHONY: sync gen-protos docker-pull all format clean
 
-.PHONY: sync-protos gen-protos docker-pull
+all: gen-protos copy-testdata clean
 
-gen-protos: sync-protos tweak-protos docker-pull gen-protos-raw
+gen-protos: sync tweak-protos docker-pull gen-protos-raw format
 
 gen-protos-raw:
 	mkdir -p $(OUTDIR)
@@ -48,14 +57,23 @@ tweak-protos:
 	sed -i -e 's@google\.firestore\.v1@google.cloud.firestore_v1@' $(TEST_PROTO_COPY)
 	sed -i -e 's@Cursor@Cursor_@' $(TEST_PROTO_COPY)
 
-sync-protos:
-	cd $(PROTOBUF_REPO); git pull
-	cd $(GOOGLEAPIS_REPO); git pull
-	cd $(TESTS_REPO); git pull
+sync: clean
+	mkdir -p $(PROTOBUF_REPO)
+	git clone --depth 1 git@github.com:protocolbuffers/protobuf $(PROTOBUF_REPO)
+	mkdir -p $(GOOGLEAPIS_REPO)
+	git clone --depth 1 git@github.com:googleapis/googleapis.git $(GOOGLEAPIS_REPO)
+	mkdir -p $(TESTS_REPO)
+	git clone --depth 1 git@github.com:googleapis/conformance-tests.git $(TESTS_REPO)
 
 docker-pull:
 	docker pull gcr.io/gapic-images/gapic-generator-python:latest
 
 copy-testdata:
 	rm $(TESTDATA_DIR)/*.json
 	cp $(TEST_PROTO_DIR)/*.json $(TESTDATA_DIR)/
+
+format:
+	nox -s blacken
+
+clean:
+	rm -rf $(BUILD_DIR)

packages/google-cloud-firestore/tests/unit/v1/conformance_tests.py

@@ -56,7 +56,7 @@ class TestFile(proto.Message):
     r"""A collection of tests.
 
     Attributes:
-        tests (Sequence[~.gcf_tests.Test]):
+        tests (Sequence[google.cloud.firestore_v1.types.Test]):
 
     """
 
@@ -73,21 +73,21 @@ class Test(proto.Message):
         comment (str):
             a comment describing the behavior being
             tested
-        get (~.gcf_tests.GetTest):
+        get (google.cloud.firestore_v1.types.GetTest):
 
-        create (~.gcf_tests.CreateTest):
+        create (google.cloud.firestore_v1.types.CreateTest):
 
-        set_ (~.gcf_tests.SetTest):
+        set_ (google.cloud.firestore_v1.types.SetTest):
 
-        update (~.gcf_tests.UpdateTest):
+        update (google.cloud.firestore_v1.types.UpdateTest):
 
-        update_paths (~.gcf_tests.UpdatePathsTest):
+        update_paths (google.cloud.firestore_v1.types.UpdatePathsTest):
 
-        delete (~.gcf_tests.DeleteTest):
+        delete (google.cloud.firestore_v1.types.DeleteTest):
 
-        query (~.gcf_tests.QueryTest):
+        query (google.cloud.firestore_v1.types.QueryTest):
 
-        listen (~.gcf_tests.ListenTest):
+        listen (google.cloud.firestore_v1.types.ListenTest):
 
     """
 
@@ -121,7 +121,7 @@ class GetTest(proto.Message):
         doc_ref_path (str):
             The path of the doc, e.g.
             "projects/projectID/databases/(default)/documents/C/d".
-        request (~.firestore.GetDocumentRequest):
+        request (google.cloud.firestore_v1.types.GetDocumentRequest):
             The request that the call should send to the
             Firestore service.
     """
@@ -146,7 +146,7 @@ class CreateTest(proto.Message):
             the two special sentinel values. Values that
             could be interpreted as integers (i.e. digit
             strings) should be treated as integers.
-        request (~.firestore.CommitRequest):
+        request (google.cloud.firestore_v1.types.CommitRequest):
             The request that the call should generate.
         is_error (bool):
             If true, the call should result in an error
@@ -169,11 +169,11 @@ class SetTest(proto.Message):
     Attributes:
         doc_ref_path (str):
             path of doc
-        option (~.gcf_tests.SetOption):
+        option (google.cloud.firestore_v1.types.SetOption):
             option to the Set call, if any
         json_data (str):
             data (see CreateTest.json_data)
-        request (~.firestore.CommitRequest):
+        request (google.cloud.firestore_v1.types.CommitRequest):
             expected request
         is_error (bool):
             call signals an error
@@ -197,11 +197,11 @@ class UpdateTest(proto.Message):
     Attributes:
         doc_ref_path (str):
             path of doc
-        precondition (~.common.Precondition):
+        precondition (google.cloud.firestore_v1.types.Precondition):
             precondition in call, if any
         json_data (str):
             data (see CreateTest.json_data)
-        request (~.firestore.CommitRequest):
+        request (google.cloud.firestore_v1.types.CommitRequest):
             expected request
         is_error (bool):
             call signals an error
@@ -225,14 +225,14 @@ class UpdatePathsTest(proto.Message):
     Attributes:
         doc_ref_path (str):
             path of doc
-        precondition (~.common.Precondition):
+        precondition (google.cloud.firestore_v1.types.Precondition):
             precondition in call, if any
-        field_paths (Sequence[~.gcf_tests.FieldPath]):
+        field_paths (Sequence[google.cloud.firestore_v1.types.FieldPath]):
             parallel sequences: field_paths[i] corresponds to
             json_values[i]
         json_values (Sequence[str]):
             the argument values, as JSON
-        request (~.firestore.CommitRequest):
+        request (google.cloud.firestore_v1.types.CommitRequest):
             expected rquest
         is_error (bool):
             call signals an error
@@ -257,9 +257,9 @@ class DeleteTest(proto.Message):
     Attributes:
         doc_ref_path (str):
             path of doc
-        precondition (~.common.Precondition):
+        precondition (google.cloud.firestore_v1.types.Precondition):
 
-        request (~.firestore.CommitRequest):
+        request (google.cloud.firestore_v1.types.CommitRequest):
             expected rquest
         is_error (bool):
             call signals an error
@@ -281,7 +281,7 @@ class SetOption(proto.Message):
         all_ (bool):
             if true, merge all fields ("fields" is
             ignored).
-        fields (Sequence[~.gcf_tests.FieldPath]):
+        fields (Sequence[google.cloud.firestore_v1.types.FieldPath]):
             field paths for a Merge option
     """
 
@@ -297,9 +297,9 @@ class QueryTest(proto.Message):
         coll_path (str):
             path of collection, e.g.
             "projects/projectID/databases/(default)/documents/C".
-        clauses (Sequence[~.gcf_tests.Clause]):
+        clauses (Sequence[google.cloud.firestore_v1.types.Clause]):
 
-        query (~.gcf_query.StructuredQuery):
+        query (google.cloud.firestore_v1.types.StructuredQuery):
 
         is_error (bool):
 
@@ -318,23 +318,23 @@ class Clause(proto.Message):
     r"""
 
     Attributes:
-        select (~.gcf_tests.Select):
+        select (google.cloud.firestore_v1.types.Select):
 
-        where (~.gcf_tests.Where):
+        where (google.cloud.firestore_v1.types.Where):
 
-        order_by (~.gcf_tests.OrderBy):
+        order_by (google.cloud.firestore_v1.types.OrderBy):
 
         offset (int):
 
         limit (int):
 
-        start_at (~.gcf_tests.Cursor_):
+        start_at (google.cloud.firestore_v1.types.Cursor_):
 
-        start_after (~.gcf_tests.Cursor_):
+        start_after (google.cloud.firestore_v1.types.Cursor_):
 
-        end_at (~.gcf_tests.Cursor_):
+        end_at (google.cloud.firestore_v1.types.Cursor_):
 
-        end_before (~.gcf_tests.Cursor_):
+        end_before (google.cloud.firestore_v1.types.Cursor_):
 
     """
 
@@ -365,7 +365,7 @@ class Select(proto.Message):
     r"""
 
     Attributes:
-        fields (Sequence[~.gcf_tests.FieldPath]):
+        fields (Sequence[google.cloud.firestore_v1.types.FieldPath]):
 
     """
 
@@ -376,7 +376,7 @@ class Where(proto.Message):
     r"""
 
     Attributes:
-        path (~.gcf_tests.FieldPath):
+        path (google.cloud.firestore_v1.types.FieldPath):
 
         op (str):
 
@@ -395,7 +395,7 @@ class OrderBy(proto.Message):
     r"""
 
     Attributes:
-        path (~.gcf_tests.FieldPath):
+        path (google.cloud.firestore_v1.types.FieldPath):
 
         direction (str):
             "asc" or "desc".
@@ -410,7 +410,7 @@ class Cursor_(proto.Message):
     r"""
 
     Attributes:
-        doc_snapshot (~.gcf_tests.DocSnapshot):
+        doc_snapshot (google.cloud.firestore_v1.types.DocSnapshot):
             one of:
         json_values (Sequence[str]):
 
@@ -462,9 +462,9 @@ class ListenTest(proto.Message):
     in the tests before running them.
 
     Attributes:
-        responses (Sequence[~.firestore.ListenResponse]):
+        responses (Sequence[google.cloud.firestore_v1.types.ListenResponse]):
 
-        snapshots (Sequence[~.gcf_tests.Snapshot]):
+        snapshots (Sequence[google.cloud.firestore_v1.types.Snapshot]):
 
         is_error (bool):
 
@@ -483,11 +483,11 @@ class Snapshot(proto.Message):
     r"""
 
     Attributes:
-        docs (Sequence[~.document.Document]):
+        docs (Sequence[google.cloud.firestore_v1.types.Document]):
 
-        changes (Sequence[~.gcf_tests.DocChange]):
+        changes (Sequence[google.cloud.firestore_v1.types.DocChange]):
 
-        read_time (~.timestamp.Timestamp):
+        read_time (google.protobuf.timestamp_pb2.Timestamp):
 
     """
 
@@ -502,9 +502,9 @@ class DocChange(proto.Message):
     r"""
 
     Attributes:
-        kind (~.gcf_tests.DocChange.Kind):
+        kind (google.cloud.firestore_v1.types.DocChange.Kind):
 
-        doc (~.document.Document):
+        doc (google.cloud.firestore_v1.types.Document):
 
         old_index (int):
 

packages/google-cloud-firestore/tests/unit/v1/testdata/query-invalid-operator.json

@@ -2,7 +2,7 @@
   "tests": [
     {
       "description": "query: invalid operator in Where clause",
-      "comment": "The |~|  operator is not supported.",
+      "comment": "The |~| operator is not supported.",
       "query": {
         "collPath": "projects/projectID/databases/(default)/documents/C",
         "clauses": [

packages/google-cloud-firestore/tests/unit/v1/testdata/set-arrayunion-merge.json

@@ -0,0 +1,48 @@
+{
+  "tests": [
+    {
+      "description": "set: merge ArrayUnion field",
+      "comment": "An ArrayUnion value can occur at any depth. In this case,\nthe transform applies to the field path \"b.c\". \"a\" is left alone and remains in the object.",
+      "set": {
+        "option": {
+          "all": true
+        },
+        "docRefPath": "projects/projectID/databases/(default)/documents/C/d",
+        "jsonData": "{\"a\": 1, \"b\": {\"c\": [\"ArrayUnion\", \"foo\", \"bar\"]}}",
+        "request": {
+          "database": "projects/projectID/databases/(default)",
+          "writes": [
+            {
+              "update": {
+                "name": "projects/projectID/databases/(default)/documents/C/d",
+                "fields": {
+                  "a": {
+                    "integerValue": "1"
+                  }
+                }
+              },
+              "updateMask": {
+                "fieldPaths": ["a"]
+              },
+              "updateTransforms": [
+                {
+                  "fieldPath": "b.c",
+                  "appendMissingElements": {
+                    "values": [
+                      {
+                        "stringValue": "foo"
+                      },
+                      {
+                        "stringValue": "bar"
+                      }
+                    ]
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      }
+    }
+  ]
+}