aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/Example/Tests/Local/FSTRemoteDocumentCacheTests.mm
blob: d240604446943704d0b88fa6dc81f4630a5bf4ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 * 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 "Firestore/Example/Tests/Local/FSTRemoteDocumentCacheTests.h"

#import "Firestore/Source/Core/FSTQuery.h"
#import "Firestore/Source/Local/FSTPersistence.h"
#import "Firestore/Source/Local/FSTWriteGroup.h"
#import "Firestore/Source/Model/FSTDocument.h"
#import "Firestore/Source/Model/FSTDocumentKey.h"
#import "Firestore/Source/Model/FSTDocumentSet.h"

#import "Firestore/Example/Tests/Util/FSTHelpers.h"

NS_ASSUME_NONNULL_BEGIN

static NSString *const kDocPath = @"a/b";
static NSString *const kLongDocPath = @"a/b/c/d/e/f";
static const int kVersion = 42;

@implementation FSTRemoteDocumentCacheTests {
  NSDictionary<NSString *, id> *_kDocData;
}

- (void)setUp {
  [super setUp];

  // essentially a constant, but can't be a compile-time one.
  _kDocData = @{ @"a" : @1, @"b" : @2 };
}

- (void)testReadDocumentNotInCache {
  if (!self.remoteDocumentCache) return;

  XCTAssertNil([self readEntryAtPath:kDocPath]);
}

// Helper for next two tests.
- (void)setAndReadADocumentAtPath:(NSString *)path {
  FSTDocument *written = [self setTestDocumentAtPath:path];
  FSTMaybeDocument *read = [self readEntryAtPath:path];
  XCTAssertEqualObjects(read, written);
}

- (void)testSetAndReadADocument {
  if (!self.remoteDocumentCache) return;

  [self setAndReadADocumentAtPath:kDocPath];
}

- (void)testSetAndReadADocumentAtDeepPath {
  if (!self.remoteDocumentCache) return;

  [self setAndReadADocumentAtPath:kLongDocPath];
}

- (void)testSetAndReadDeletedDocument {
  if (!self.remoteDocumentCache) return;

  FSTDeletedDocument *deletedDoc = FSTTestDeletedDoc(kDocPath, kVersion);
  [self addEntry:deletedDoc];

  XCTAssertEqualObjects([self readEntryAtPath:kDocPath], deletedDoc);
}

- (void)testSetDocumentToNewValue {
  if (!self.remoteDocumentCache) return;

  [self setTestDocumentAtPath:kDocPath];
  FSTDocument *newDoc = FSTTestDoc(kDocPath, kVersion, @{ @"data" : @2 }, NO);
  [self addEntry:newDoc];
  XCTAssertEqualObjects([self readEntryAtPath:kDocPath], newDoc);
}

- (void)testRemoveDocument {
  if (!self.remoteDocumentCache) return;

  [self setTestDocumentAtPath:kDocPath];
  [self removeEntryAtPath:kDocPath];

  XCTAssertNil([self readEntryAtPath:kDocPath]);
}

- (void)testRemoveNonExistentDocument {
  if (!self.remoteDocumentCache) return;

  // no-op, but make sure it doesn't throw.
  XCTAssertNoThrow([self removeEntryAtPath:kDocPath]);
}

// TODO(mikelehen): Write more elaborate tests once we have more elaborate implementations.
- (void)testDocumentsMatchingQuery {
  if (!self.remoteDocumentCache) return;

  // TODO(rsgowman): This just verifies that we do a prefix scan against the
  // query path. We'll need more tests once we add index support.
  [self setTestDocumentAtPath:@"a/1"];
  [self setTestDocumentAtPath:@"b/1"];
  [self setTestDocumentAtPath:@"b/2"];
  [self setTestDocumentAtPath:@"c/1"];

  FSTQuery *query = FSTTestQuery(@"b");
  FSTDocumentDictionary *results = [self.remoteDocumentCache documentsMatchingQuery:query];
  NSArray *expected =
      @[ FSTTestDoc(@"b/1", kVersion, _kDocData, NO), FSTTestDoc(@"b/2", kVersion, _kDocData, NO) ];
  XCTAssertEqual([results count], [expected count]);
  for (FSTDocument *doc in expected) {
    XCTAssertEqualObjects([results objectForKey:doc.key], doc);
  }
}

#pragma mark - Helpers

- (FSTDocument *)setTestDocumentAtPath:(NSString *)path {
  FSTDocument *doc = FSTTestDoc(path, kVersion, _kDocData, NO);
  [self addEntry:doc];
  return doc;
}

- (void)addEntry:(FSTMaybeDocument *)maybeDoc {
  FSTWriteGroup *group = [self.persistence startGroupWithAction:@"addEntry"];
  [self.remoteDocumentCache addEntry:maybeDoc group:group];
  [self.persistence commitGroup:group];
}

- (FSTMaybeDocument *_Nullable)readEntryAtPath:(NSString *)path {
  return [self.remoteDocumentCache entryForKey:FSTTestDocKey(path)];
}

- (void)removeEntryAtPath:(NSString *)path {
  FSTWriteGroup *group = [self.persistence startGroupWithAction:@"removeEntryAtPath"];
  [self.remoteDocumentCache removeEntryForKey:FSTTestDocKey(path) group:group];
  [self.persistence commitGroup:group];
}

@end

NS_ASSUME_NONNULL_END