Added unit and integration tests

Author: jonathanedey

integration/test_firestore.py

@@ -17,6 +17,20 @@
 
 from firebase_admin import firestore
 
+_CITY = {
+        'name': u'Mountain View',
+        'country': u'USA',
+        'population': 77846,
+        'capital': False
+    }
+
+_MOVIE = {
+        'Name': u'Interstellar',
+        'Year': 2014,
+        'Runtime': u'2h 49m',
+        'Academy Award Winner': True
+    }
+
 
 def test_firestore():
     client = firestore.client()
@@ -35,6 +49,47 @@ def test_firestore():
     doc.delete()
     assert doc.get().exists is False
 
+def test_firestore_explicit_database_id():
+    client = firestore.client(database_id='testing-database')
+    expected = _CITY
+    doc = client.collection('cities').document()
+    doc.set(expected)
+
+    data = doc.get()
+    assert data.to_dict() == expected
+
+    doc.delete()
+    data = doc.get()
+    assert data.exists is False
+
+def test_firestore_multi_db():
+    city_client = firestore.client()
+    movie_client = firestore.client(database_id='testing-database')
+
+    expected_city = _CITY
+    expected_movie = _MOVIE
+
+    city_doc = city_client.collection('cities').document()
+    movie_doc = movie_client.collection('movies').document()
+
+    city_doc.set(expected_city)
+    movie_doc.set(expected_movie)
+
+    city_data = city_doc.get()
+    movie_data = movie_doc.get()
+
+    assert city_data.to_dict() == expected_city
+    assert movie_data.to_dict() == expected_movie
+
+    city_doc.delete()
+    movie_doc.delete()
+
+    city_data = city_doc.get()
+    movie_data = movie_doc.get()
+
+    assert city_data.exists is False
+    assert movie_data.exists is False
+
 def test_server_timestamp():
     client = firestore.client()
     expected = {

integration/test_firestore_async.py

@@ -13,20 +13,31 @@
 # limitations under the License.
 
 """Integration tests for firebase_admin.firestore_async module."""
+import asyncio
 import datetime
 import pytest
 
 from firebase_admin import firestore_async
 
-@pytest.mark.asyncio
-async def test_firestore_async():
-    client = firestore_async.client()
-    expected = {
+_CITY = {
         'name': u'Mountain View',
         'country': u'USA',
         'population': 77846,
         'capital': False
     }
+
+_MOVIE = {
+        'Name': u'Interstellar',
+        'Year': 2014,
+        'Runtime': u'2h 49m',
+        'Academy Award Winner': True
+    }
+
+
+@pytest.mark.asyncio
+async def test_firestore_async():
+    client = firestore_async.client()
+    expected = _CITY
     doc = client.collection('cities').document()
     await doc.set(expected)
 
@@ -37,6 +48,56 @@ async def test_firestore_async():
     data = await doc.get()
     assert data.exists is False
 
+@pytest.mark.asyncio
+async def test_firestore_async_explicit_database_id():
+    client = firestore_async.client(database_id='testing-database')
+    expected = _CITY
+    doc = client.collection('cities').document()
+    await doc.set(expected)
+
+    data = await doc.get()
+    assert data.to_dict() == expected
+
+    await doc.delete()
+    data = await doc.get()
+    assert data.exists is False
+
+@pytest.mark.asyncio
+async def test_firestore_async_multi_db():
+    city_client = firestore_async.client()
+    movie_client = firestore_async.client(database_id='testing-database')
+
+    expected_city = _CITY
+    expected_movie = _MOVIE
+
+    city_doc = city_client.collection('cities').document()
+    movie_doc = movie_client.collection('movies').document()
+
+    await asyncio.gather(
+        city_doc.set(expected_city),
+        movie_doc.set(expected_movie)
+    )
+
+    data = await asyncio.gather(
+        city_doc.get(),
+        movie_doc.get()
+    )
+
+    assert data[0].to_dict() == expected_city
+    assert data[1].to_dict() == expected_movie
+
+    await asyncio.gather(
+        city_doc.delete(),
+        movie_doc.delete()
+    )
+
+    data = await asyncio.gather(
+        city_doc.get(),
+        movie_doc.get()
+    )
+    assert data[0].exists is False
+    assert data[1].exists is False
+
 @pytest.mark.asyncio
 async def test_server_timestamp():
     client = firestore_async.client()

tests/test_firestore.py

@@ -50,27 +50,113 @@ def test_project_id(self):
         client = firestore.client()
         assert client is not None
         assert client.project == 'explicit-project-id'
+        assert client._database == '(default)'
 
     def test_project_id_with_explicit_app(self):
         cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
         app = firebase_admin.initialize_app(cred, {'projectId': 'explicit-project-id'})
         client = firestore.client(app=app)
         assert client is not None
         assert client.project == 'explicit-project-id'
+        assert client._database == '(default)'
 
     def test_service_account(self):
         cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
         firebase_admin.initialize_app(cred)
         client = firestore.client()
         assert client is not None
         assert client.project == 'mock-project-id'
+        assert client._database == '(default)'
 
     def test_service_account_with_explicit_app(self):
         cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
         app = firebase_admin.initialize_app(cred)
         client = firestore.client(app=app)
         assert client is not None
         assert client.project == 'mock-project-id'
+        assert client._database == '(default)'
+
+    @pytest.mark.parametrize('database_id', [123, False, True, {}, []])
+    def test_invalid_database_id(self, database_id):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        with pytest.raises(ValueError) as excinfo:
+            firestore.client(database_id=database_id)
+        assert str(excinfo.value) == f'database_id "{database_id}" must be a string or None.'
+
+    def test_database_id(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        database_id = 'mock-database-id'
+        client = firestore.client(database_id=database_id)
+        assert client is not None
+        assert client.project == 'mock-project-id'
+        assert client._database == 'mock-database-id'
+
+    @pytest.mark.parametrize('database_id', ['', '(default)', None])
+    def test_database_id_with_default_id(self, database_id):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        client = firestore.client(database_id=database_id)
+        assert client is not None
+        assert client.project == 'mock-project-id'
+        assert client._database == '(default)'
+
+    def test_database_id_with_explicit_app(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        app = firebase_admin.initialize_app(cred)
+        database_id = 'mock-database-id'
+        client = firestore.client(app, database_id)
+        assert client is not None
+        assert client.project == 'mock-project-id'
+        assert client._database == 'mock-database-id'
+
+    def test_database_id_with_multi_db(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        database_id_1 = 'mock-database-id-1'
+        database_id_2 = 'mock-database-id-2'
+        client_1 = firestore.client(database_id=database_id_1)
+        client_2 = firestore.client(database_id=database_id_2)
+        assert (client_1 is not None) and (client_2 is not None)
+        assert client_1 is not client_2
+        assert client_1.project == 'mock-project-id'
+        assert client_2.project == 'mock-project-id'
+        assert client_1._database == 'mock-database-id-1'
+        assert client_2._database == 'mock-database-id-2'
+
+    def test_database_id_with_multi_db_uses_cache(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        database_id = 'mock-database-id'
+        client_1 = firestore.client(database_id=database_id)
+        client_2 = firestore.client(database_id=database_id)
+        assert (client_1 is not None) and (client_2 is not None)
+        assert client_1 is client_2
+        assert client_1.project == 'mock-project-id'
+        assert client_2.project == 'mock-project-id'
+        assert client_1._database == 'mock-database-id'
+        assert client_2._database == 'mock-database-id'
+
+    def test_database_id_with_multi_db_uses_cache_default(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        database_id_1 = ''
+        database_id_2 = '(default)'
+        client_1 = firestore.client(database_id=database_id_1)
+        client_2 = firestore.client(database_id=database_id_2)
+        client_3 = firestore.client()
+        assert (client_1 is not None) and (client_2 is not None) and (client_3 is not None)
+        assert client_1 is client_2
+        assert client_1 is client_3
+        assert client_2 is client_3
+        assert client_1.project == 'mock-project-id'
+        assert client_2.project == 'mock-project-id'
+        assert client_3.project == 'mock-project-id'
+        assert client_1._database == '(default)'
+        assert client_2._database == '(default)'
+        assert client_3._database == '(default)'
+
 
     def test_geo_point(self):
         geo_point = firestore.GeoPoint(10, 20) # pylint: disable=no-member

tests/test_firestore_async.py

@@ -50,27 +50,113 @@ def test_project_id(self):
         client = firestore_async.client()
         assert client is not None
         assert client.project == 'explicit-project-id'
+        assert client._database == '(default)'
 
     def test_project_id_with_explicit_app(self):
         cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
         app = firebase_admin.initialize_app(cred, {'projectId': 'explicit-project-id'})
         client = firestore_async.client(app=app)
         assert client is not None
         assert client.project == 'explicit-project-id'
+        assert client._database == '(default)'
 
     def test_service_account(self):
         cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
         firebase_admin.initialize_app(cred)
         client = firestore_async.client()
         assert client is not None
         assert client.project == 'mock-project-id'
+        assert client._database == '(default)'
 
     def test_service_account_with_explicit_app(self):
         cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
         app = firebase_admin.initialize_app(cred)
         client = firestore_async.client(app=app)
         assert client is not None
         assert client.project == 'mock-project-id'
+        assert client._database == '(default)'
+
+    @pytest.mark.parametrize('database_id', [123, False, True, {}, []])
+    def test_invalid_database_id(self, database_id):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        with pytest.raises(ValueError) as excinfo:
+            firestore_async.client(database_id=database_id)
+        assert str(excinfo.value) == f'database_id "{database_id}" must be a string or None.'
+
+    def test_database_id(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        database_id = 'mock-database-id'
+        client = firestore_async.client(database_id=database_id)
+        assert client is not None
+        assert client.project == 'mock-project-id'
+        assert client._database == 'mock-database-id'
+
+    @pytest.mark.parametrize('database_id', ['', '(default)', None])
+    def test_database_id_with_default_id(self, database_id):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        client = firestore_async.client(database_id=database_id)
+        assert client is not None
+        assert client.project == 'mock-project-id'
+        assert client._database == '(default)'
+
+    def test_database_id_with_explicit_app(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        app = firebase_admin.initialize_app(cred)
+        database_id = 'mock-database-id'
+        client = firestore_async.client(app, database_id)
+        assert client is not None
+        assert client.project == 'mock-project-id'
+        assert client._database == 'mock-database-id'
+
+    def test_database_id_with_multi_db(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        database_id_1 = 'mock-database-id-1'
+        database_id_2 = 'mock-database-id-2'
+        client_1 = firestore_async.client(database_id=database_id_1)
+        client_2 = firestore_async.client(database_id=database_id_2)
+        assert (client_1 is not None) and (client_2 is not None)
+        assert client_1 is not client_2
+        assert client_1.project == 'mock-project-id'
+        assert client_2.project == 'mock-project-id'
+        assert client_1._database == 'mock-database-id-1'
+        assert client_2._database == 'mock-database-id-2'
+
+    def test_database_id_with_multi_db_uses_cache(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        database_id = 'mock-database-id'
+        client_1 = firestore_async.client(database_id=database_id)
+        client_2 = firestore_async.client(database_id=database_id)
+        assert (client_1 is not None) and (client_2 is not None)
+        assert client_1 is client_2
+        assert client_1.project == 'mock-project-id'
+        assert client_2.project == 'mock-project-id'
+        assert client_1._database == 'mock-database-id'
+        assert client_2._database == 'mock-database-id'
+
+    def test_database_id_with_multi_db_uses_cache_default(self):
+        cred = credentials.Certificate(testutils.resource_filename('service_account.json'))
+        firebase_admin.initialize_app(cred)
+        database_id_1 = ''
+        database_id_2 = '(default)'
+        client_1 = firestore_async.client(database_id=database_id_1)
+        client_2 = firestore_async.client(database_id=database_id_2)
+        client_3 = firestore_async.client()
+        assert (client_1 is not None) and (client_2 is not None) and (client_3 is not None)
+        assert client_1 is client_2
+        assert client_1 is client_3
+        assert client_2 is client_3
+        assert client_1.project == 'mock-project-id'
+        assert client_2.project == 'mock-project-id'
+        assert client_3.project == 'mock-project-id'
+        assert client_1._database == '(default)'
+        assert client_2._database == '(default)'
+        assert client_3._database == '(default)'
+
 
     def test_geo_point(self):
         geo_point = firestore_async.GeoPoint(10, 20) # pylint: disable=no-member