1 files changed, 223 insertions, 0 deletions
diff --git a/Firestore/Example/Tests/Integration/API/FIRFieldsTests.mm b/Firestore/Example/Tests/Integration/API/FIRFieldsTests.mm
new file mode 100644
index 0000000..34bd87e
--- /dev/null
+++ b/Firestore/Example/Tests/Integration/API/FIRFieldsTests.mm
@@ -0,0 +1,223 @@
+/*
+ * Copyright 2017 Google
+ *
+ * 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.
+ */
+
+#import <FirebaseFirestore/FirebaseFirestore.h>
+
+#import <XCTest/XCTest.h>
+
+#import "Firestore/Source/Core/FSTFirestoreClient.h"
+
+#import "Firestore/Example/Tests/Util/FSTIntegrationTestCase.h"
+
+@interface FIRFieldsTests : FSTIntegrationTestCase
+@end
+
+@implementation FIRFieldsTests
+
+- (NSDictionary<NSString *, id> *)testNestedDataNumbered:(int)number {
+  return @{
+    @"name" : [NSString stringWithFormat:@"room %d", number],
+    @"metadata" : @{
+      @"createdAt" : @(number),
+      @"deep" : @{@"field" : [NSString stringWithFormat:@"deep-field-%d", number]}
+    }
+  };
+}
+
+- (void)testNestedFieldsCanBeWrittenWithSet {
+  NSDictionary<NSString *, id> *testData = [self testNestedDataNumbered:1];
+
+  FIRDocumentReference *doc = [self documentRef];
+  [self writeDocumentRef:doc data:testData];
+
+  FIRDocumentSnapshot *result = [self readDocumentForRef:doc];
+  XCTAssertEqualObjects(result.data, testData);
+}
+
+- (void)testNestedFieldsCanBeReadDirectly {
+  NSDictionary<NSString *, id> *testData = [self testNestedDataNumbered:1];
+
+  FIRDocumentReference *doc = [self documentRef];
+  [self writeDocumentRef:doc data:testData];
+
+  FIRDocumentSnapshot *result = [self readDocumentForRef:doc];
+  XCTAssertEqualObjects(result[@"name"], testData[@"name"]);
+  XCTAssertEqualObjects(result[@"metadata"], testData[@"metadata"]);
+  XCTAssertEqualObjects(result[@"metadata.deep.field"], testData[@"metadata"][@"deep"][@"field"]);
+  XCTAssertNil(result[@"metadata.nofield"]);
+  XCTAssertNil(result[@"nometadata.nofield"]);
+}
+
+- (void)testNestedFieldsCanBeUpdated {
+  NSDictionary<NSString *, id> *testData = [self testNestedDataNumbered:1];
+
+  FIRDocumentReference *doc = [self documentRef];
+  [self writeDocumentRef:doc data:testData];
+  [self updateDocumentRef:doc data:@{ @"metadata.deep.field" : @100, @"metadata.added" : @200 }];
+
+  FIRDocumentSnapshot *result = [self readDocumentForRef:doc];
+  XCTAssertEqualObjects(
+      result.data, (@{
+        @"name" : @"room 1",
+        @"metadata" : @{@"createdAt" : @1, @"deep" : @{@"field" : @100}, @"added" : @200}
+      }));
+}
+
+- (void)testNestedFieldsCanBeUsedInQueryFilters {
+  NSDictionary<NSString *, NSDictionary<NSString *, id> *> *testDocs = @{
+    @"1" : [self testNestedDataNumbered:300],
+    @"2" : [self testNestedDataNumbered:100],
+    @"3" : [self testNestedDataNumbered:200]
+  };
+
+  // inequality adds implicit sort on field
+  NSArray<NSDictionary<NSString *, id> *> *expected =
+      @[ [self testNestedDataNumbered:200], [self testNestedDataNumbered:300] ];
+  FIRCollectionReference *coll = [self collectionRefWithDocuments:testDocs];
+
+  FIRQuery *q = [coll queryWhereField:@"metadata.createdAt" isGreaterThanOrEqualTo:@200];
+  FIRQuerySnapshot *results = [self readDocumentSetForRef:q];
+  XCTAssertEqualObjects(FIRQuerySnapshotGetData(results), (expected));
+}
+
+- (void)testNestedFieldsCanBeUsedInOrderBy {
+  NSDictionary<NSString *, NSDictionary<NSString *, id> *> *testDocs = @{
+    @"1" : [self testNestedDataNumbered:300],
+    @"2" : [self testNestedDataNumbered:100],
+    @"3" : [self testNestedDataNumbered:200]
+  };
+  FIRCollectionReference *coll = [self collectionRefWithDocuments:testDocs];
+
+  XCTestExpectation *queryCompletion = [self expectationWithDescription:@"query"];
+  FIRQuery *q = [coll queryOrderedByField:@"metadata.createdAt"];
+  [q getDocumentsWithCompletion:^(FIRQuerySnapshot *results, NSError *error) {
+    XCTAssertNil(error);
+    XCTAssertEqualObjects(FIRQuerySnapshotGetData(results), (@[
+                            [self testNestedDataNumbered:100], [self testNestedDataNumbered:200],
+                            [self testNestedDataNumbered:300]
+                          ]));
+    [queryCompletion fulfill];
+  }];
+  [self awaitExpectations];
+}
+
+/**
+ * Creates test data with special characters in field names. Datastore currently prohibits mixing
+ * nested data with special characters so tests that use this data must be separate.
+ */
+- (NSDictionary<NSString *, id> *)testDottedDataNumbered:(int)number {
+  return @{
+    @"a" : [NSString stringWithFormat:@"field %d", number],
+    @"b.dot" : @(number),
+    @"c\\slash" : @(number)
+  };
+}
+
+- (void)testFieldsWithSpecialCharsCanBeWrittenWithSet {
+  NSDictionary<NSString *, id> *testData = [self testDottedDataNumbered:1];
+
+  FIRDocumentReference *doc = [self documentRef];
+  [self writeDocumentRef:doc data:testData];
+
+  FIRDocumentSnapshot *result = [self readDocumentForRef:doc];
+  XCTAssertEqualObjects(result.data, testData);
+}
+
+- (void)testFieldsWithSpecialCharsCanBeReadDirectly {
+  NSDictionary<NSString *, id> *testData = [self testDottedDataNumbered:1];
+
+  FIRDocumentReference *doc = [self documentRef];
+  [self writeDocumentRef:doc data:testData];
+
+  FIRDocumentSnapshot *result = [self readDocumentForRef:doc];
+  XCTAssertEqualObjects(result[@"a"], testData[@"a"]);
+  XCTAssertEqualObjects(result[[[FIRFieldPath alloc] initWithFields:@[ @"b.dot" ]]],
+                        testData[@"b.dot"]);
+  XCTAssertEqualObjects(result[@"c\\slash"], testData[@"c\\slash"]);
+}
+
+- (void)testFieldsWithSpecialCharsCanBeUpdated {
+  NSDictionary<NSString *, id> *testData = [self testDottedDataNumbered:1];
+
+  FIRDocumentReference *doc = [self documentRef];
+  [self writeDocumentRef:doc data:testData];
+  [self updateDocumentRef:doc
+                     data:@{
+                       [[FIRFieldPath alloc] initWithFields:@[ @"b.dot" ]] : @100,
+                       @"c\\slash" : @200
+                     }];
+
+  FIRDocumentSnapshot *result = [self readDocumentForRef:doc];
+  XCTAssertEqualObjects(result.data, (@{ @"a" : @"field 1", @"b.dot" : @100, @"c\\slash" : @200 }));
+}
+
+- (void)testFieldsWithSpecialCharsCanBeUsedInQueryFilters {
+  NSDictionary<NSString *, NSDictionary<NSString *, id> *> *testDocs = @{
+    @"1" : [self testDottedDataNumbered:300],
+    @"2" : [self testDottedDataNumbered:100],
+    @"3" : [self testDottedDataNumbered:200]
+  };
+
+  // inequality adds implicit sort on field
+  NSArray<NSDictionary<NSString *, id> *> *expected =
+      @[ [self testDottedDataNumbered:200], [self testDottedDataNumbered:300] ];
+  FIRCollectionReference *coll = [self collectionRefWithDocuments:testDocs];
+
+  XCTestExpectation *queryCompletion = [self expectationWithDescription:@"query"];
+  FIRQuery *q = [coll queryWhereFieldPath:[[FIRFieldPath alloc] initWithFields:@[ @"b.dot" ]]
+                   isGreaterThanOrEqualTo:@200];
+  [q getDocumentsWithCompletion:^(FIRQuerySnapshot *results, NSError *error) {
+    XCTAssertNil(error);
+    XCTAssertEqualObjects(FIRQuerySnapshotGetData(results), expected);
+    [queryCompletion fulfill];
+  }];
+
+  [self awaitExpectations];
+}
+
+- (void)testFieldsWithSpecialCharsCanBeUsedInOrderBy {
+  NSDictionary<NSString *, NSDictionary<NSString *, id> *> *testDocs = @{
+    @"1" : [self testDottedDataNumbered:300],
+    @"2" : [self testDottedDataNumbered:100],
+    @"3" : [self testDottedDataNumbered:200]
+  };
+
+  NSArray<NSDictionary<NSString *, id> *> *expected = @[
+    [self testDottedDataNumbered:100], [self testDottedDataNumbered:200],
+    [self testDottedDataNumbered:300]
+  ];
+  FIRCollectionReference *coll = [self collectionRefWithDocuments:testDocs];
+
+  FIRQuery *q = [coll queryOrderedByFieldPath:[[FIRFieldPath alloc] initWithFields:@[ @"b.dot" ]]];
+  XCTestExpectation *queryDot = [self expectationWithDescription:@"query dot"];
+  [q getDocumentsWithCompletion:^(FIRQuerySnapshot *results, NSError *error) {
+    XCTAssertNil(error);
+    XCTAssertEqualObjects(FIRQuerySnapshotGetData(results), expected);
+    [queryDot fulfill];
+  }];
+  [self awaitExpectations];
+
+  XCTestExpectation *querySlash = [self expectationWithDescription:@"query slash"];
+  q = [coll queryOrderedByField:@"c\\slash"];
+  [q getDocumentsWithCompletion:^(FIRQuerySnapshot *results, NSError *error) {
+    XCTAssertNil(error);
+    XCTAssertEqualObjects(FIRQuerySnapshotGetData(results), expected);
+    [querySlash fulfill];
+  }];
+  [self awaitExpectations];
+}
+
+@end