add golden test files

Author: milaGGL

packages/firestore/src/remote/bloom_filter.ts

@@ -26,10 +26,10 @@ export class BloomFilter {
     padding: number,
     private readonly hashCount: number
   ) {
-    debugAssert(padding >= 0, 'Padding is negative.');
+    debugAssert(padding >= 0, 'Padding is negative or undefined.');
     this.bitSize = this.bitmap.length * 8 - padding;
     debugAssert(this.bitSize >= 0, 'Bitmap size is negative.');
-    debugAssert(this.hashCount >= 0, 'Hash count is negative.');
+    debugAssert(this.hashCount >= 0, 'Hash count is negative or undefined.');
   }
 
   getBitSize(): number {

packages/firestore/test/unit/remote/bloom_filter.test.ts

@@ -14,12 +14,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { readFileSync, readdirSync } from 'fs';
+import { parse, resolve } from 'path';
+
 import { expect } from 'chai';
 
 import { BloomFilter } from '../../../src/remote/bloom_filter';
 
-import testData from './bloom_filter_test_data.json';
-
 describe('BloomFilter', () => {
   it('can initiate an empty BloomFilter', () => {
     const bloomFilter = new BloomFilter(
@@ -95,35 +96,63 @@ describe('BloomFilter', () => {
     expect(nonEmptyBloomFilter.mightContain('')).to.be.false;
   });
 
+  /**
+   * Golden tests are generated by backend based on inserting n number of
+   * documents path into Bloom filter.
+   *
+   * Full documents path is generated by concating documentPrefix and n, ie,
+   * projects/project-1/databases/database-1/documents/coll/doc11
+   *
+   * The test result is generated by checking the membership of documents from
+   * documentPrefix+0 to documentPrefix+2n. The membership results from 0 to n
+   * is expected to be 1, and from n to 2n to be 0 with some false positive results.
+   *
+   * The test result of BloomFilter.mightContain() should match the backend result
+   * exactly.
+   */
   describe('BloomFilter membership test', () => {
-    const prefix = 'projects/project-1/databases/database-1/documents/coll/doc';
+    const documentPrefix =
+      'projects/project-1/databases/database-1/documents/coll/doc';
+    const testDataFolder = 'test/unit/remote/bloom_filter_golden_test_data';
 
     interface TestDataType {
-      // Bloom filter result created by backend based on documents: prefix+(0 ~i)
       bits: {
-        bitmap: number[];
+        bitmap: string;
         padding: number;
       };
       hashCount: number;
-      // Check membership of documents  prefix+(0 ~2i)
-      membershipCheckCount: number;
-      // Membership result on docs from 0~i are always postive, i~2i might have false positive
-      membershipTestResult: string;
+    }
+
+    function convertBase64ToUint8Array(base64: string = ''): Uint8Array {
+      return Uint8Array.from(atob(base64), item => item.charCodeAt(0));
     }
 
     it('mightContain result should match backend result', () => {
-      testData.forEach((data: TestDataType) => {
-        const { bits, hashCount, membershipCheckCount, membershipTestResult } =
-          data;
-        const bloomFilter = new BloomFilter(
-          Uint8Array.from(bits.bitmap),
-          bits.padding,
-          hashCount
-        );
-        for (let i = 0; i < membershipCheckCount; i++) {
-          const isMember = membershipTestResult[i] === '1' ? true : false;
-          const mightContain = bloomFilter.mightContain(prefix + i);
-          expect(mightContain).to.equal(isMember);
+      readdirSync(testDataFolder).forEach(filename => {
+        const ext = parse(filename).ext;
+
+        if (ext === '.json') {
+          const testDataPath = resolve(testDataFolder, filename);
+          const testResultPath = testDataPath.replace(
+            'bloom_filter_proto.json',
+            'membership_test_result.txt'
+          );
+          const testData: TestDataType = JSON.parse(
+            readFileSync(testDataPath, 'utf8')
+          );
+          const testResult: string = readFileSync(testResultPath, 'utf8');
+          const { bits = { bitmap: '', padding: 0 }, hashCount = 0 } = testData;
+          const bloomFilter = new BloomFilter(
+            convertBase64ToUint8Array(bits.bitmap),
+            bits.padding || 0,
+            hashCount || 0
+          );
+          for (let i = 0; i < testResult.length; i++) {
+            const backendMembershipResult =
+              testResult[i] === '1' ? true : false;
+            const mightContain = bloomFilter.mightContain(documentPrefix + i);
+            expect(mightContain).to.equal(backendMembershipResult);
+          }
         }
       });
     });

packages/firestore/test/unit/remote/bloom_filter_golden_test_data/Validation_BloomFilterTest_MD5_1_0001_bloom_filter_proto.json

@@ -0,0 +1 @@
+{ "bits": { "bitmap": "RswZ", "padding": 1 }, "hashCount": 16 }

packages/firestore/test/unit/remote/bloom_filter_golden_test_data/Validation_BloomFilterTest_MD5_1_0001_membership_test_result.txt

@@ -0,0 +1 @@
+10

packages/firestore/test/unit/remote/bloom_filter_golden_test_data/Validation_BloomFilterTest_MD5_1_01_bloom_filter_proto.json

@@ -0,0 +1 @@
+{"bits":{"bitmap":"mwE=","padding":5},"hashCount":8}

packages/firestore/test/unit/remote/bloom_filter_golden_test_data/Validation_BloomFilterTest_MD5_1_01_membership_test_result.txt

@@ -0,0 +1 @@
+10

packages/firestore/test/unit/remote/bloom_filter_golden_test_data/Validation_BloomFilterTest_MD5_1_1_bloom_filter_proto.json

@@ -0,0 +1 @@
+{"bits":{}}

packages/firestore/test/unit/remote/bloom_filter_golden_test_data/Validation_BloomFilterTest_MD5_1_1_membership_test_result.txt

@@ -0,0 +1 @@
+00