Implemented a util for getting project ID from the credential or the environment (#69)

* Implemented a util for getting project ID from the credential or the environment

* Moved project ID lookup logic to initialize_app()

* Removing an unused method

Author: hiranya911

firebase_admin/__init__.py

@@ -14,6 +14,7 @@
 
 """Firebase Admin SDK for Python."""
 import datetime
+import os
 import threading
 
 import six
@@ -183,6 +184,15 @@ def __init__(self, name, credential, options):
         self._options = _AppOptions(options)
         self._lock = threading.RLock()
         self._services = {}
+        pid = self._options.get('projectId')
+        if not pid:
+            try:
+                pid = self._credential.project_id
+            except AttributeError:
+                pass
+        if not pid:
+            pid = os.environ.get('GCLOUD_PROJECT')
+        self._project_id = pid
 
     @property
     def name(self):
@@ -196,6 +206,10 @@ def credential(self):
     def options(self):
         return self._options
 
+    @property
+    def project_id(self):
+        return self._project_id
+
     def _get_service(self, name, initializer):
         """Returns the service instance identified by the given name.
 

firebase_admin/utils.py renamed to firebase_admin/_utils.py

@@ -16,6 +16,7 @@
 
 import firebase_admin
 
+
 def _get_initialized_app(app):
     if app is None:
         return firebase_admin.get_app()

firebase_admin/auth.py

@@ -19,7 +19,6 @@
 creating and managing user accounts in Firebase projects.
 """
 
-import os
 import time
 
 from google.auth import jwt
@@ -28,15 +27,14 @@
 import six
 
 from firebase_admin import credentials
-from firebase_admin import utils
 from firebase_admin import _user_mgt
+from firebase_admin import _utils
 
 
 # Provided for overriding during tests.
 _request = transport.requests.Request()
 
 _AUTH_ATTRIBUTE = '_auth'
-GCLOUD_PROJECT_ENV_VAR = 'GCLOUD_PROJECT'
 
 
 def _get_auth_service(app):
@@ -55,7 +53,7 @@ def _get_auth_service(app):
     Raises:
       ValueError: If the app argument is invalid.
     """
-    return utils.get_app_service(app, _AUTH_ATTRIBUTE, _AuthService)
+    return _utils.get_app_service(app, _AUTH_ATTRIBUTE, _AuthService)
 
 
 def create_custom_token(uid, developer_claims=None, app=None):
@@ -250,14 +248,6 @@ def delete_user(uid, app=None):
         raise AuthError(error.code, str(error), error.detail)
 
 
-def _handle_http_error(code, msg, error):
-    if error.response is not None:
-        msg += '\nServer response: {0}'.format(error.response.content.decode())
-    else:
-        msg += '\nReason: {0}'.format(error)
-    raise AuthError(code, msg, error)
-
-
 class UserInfo(object):
     """A collection of standard profile information for a user.
 
@@ -576,18 +566,13 @@ def verify_id_token(self, id_token):
             raise ValueError('Illegal ID token provided: {0}. ID token must be a non-empty '
                              'string.'.format(id_token))
 
-        try:
-            project_id = self._app.credential.project_id
-            if project_id is None:
-                project_id = os.environ.get(GCLOUD_PROJECT_ENV_VAR)
-        except AttributeError:
-            project_id = os.environ.get(GCLOUD_PROJECT_ENV_VAR)
-
+        project_id = self._app.project_id
         if not project_id:
             raise ValueError('Failed to ascertain project ID from the credential or the '
-                             'environment. Must initialize app with a credentials.Certificate or '
-                             'set your Firebase project ID as the GCLOUD_PROJECT environment '
-                             'variable to call verify_id_token().')
+                             'environment. Project ID is required to call verify_id_token(). '
+                             'Initialize the app with a credentials.Certificate or set '
+                             'your Firebase project ID as an app option. Alternatively '
+                             'set the GCLOUD_PROJECT environment variable.')
 
         header = jwt.decode_header(id_token)
         payload = jwt.decode(id_token, verify=False)

firebase_admin/db.py

@@ -30,8 +30,8 @@
 from six.moves import urllib
 
 import firebase_admin
-from firebase_admin import utils
 from firebase_admin import _http_client
+from firebase_admin import _utils
 
 
 _DB_ATTRIBUTE = '_database'
@@ -57,7 +57,7 @@ def reference(path='/', app=None):
     Raises:
       ValueError: If the specified path or app is invalid.
     """
-    client = utils.get_app_service(app, _DB_ATTRIBUTE, _Client.from_app)
+    client = _utils.get_app_service(app, _DB_ATTRIBUTE, _Client.from_app)
     return Reference(client=client, path=path)
 
 def _parse_path(path):

firebase_admin/storage.py

@@ -27,7 +27,7 @@
 
 import six
 
-from firebase_admin import utils
+from firebase_admin import _utils
 
 
 _STORAGE_ATTRIBUTE = '_storage'
@@ -50,7 +50,7 @@ def bucket(name=None, app=None):
       ValueError: If a bucket name is not specified either via options or method arguments,
           or if the specified bucket name is not a valid string.
     """
-    client = utils.get_app_service(app, _STORAGE_ATTRIBUTE, _StorageClient.from_app)
+    client = _utils.get_app_service(app, _STORAGE_ATTRIBUTE, _StorageClient.from_app)
     return client.bucket(name)
 
 

tests/test_app.py

@@ -19,12 +19,13 @@
 
 import firebase_admin
 from firebase_admin import credentials
-from firebase_admin import utils
+from firebase_admin import _utils
 from tests import testutils
 
 
 CREDENTIAL = credentials.Certificate(
     testutils.resource_filename('service_account.json'))
+GCLOUD_PROJECT = 'GCLOUD_PROJECT'
 
 class CredentialProvider(object):
     def init(self):
@@ -139,6 +140,38 @@ def test_app_init_with_invalid_name(self, name):
         with pytest.raises(ValueError):
             firebase_admin.initialize_app(CREDENTIAL, name=name)
 
+    def test_project_id_from_options(self, app_credential):
+        app = firebase_admin.initialize_app(
+            app_credential, options={'projectId': 'test-project'}, name='myApp')
+        assert app.project_id == 'test-project'
+
+    def test_project_id_from_credentials(self):
+        app = firebase_admin.initialize_app(CREDENTIAL, name='myApp')
+        assert app.project_id == 'mock-project-id'
+
+    def test_project_id_from_environment(self):
+        project_id = os.environ.get(GCLOUD_PROJECT)
+        os.environ[GCLOUD_PROJECT] = 'env-project'
+        try:
+            app = firebase_admin.initialize_app(testutils.MockCredential(), name='myApp')
+            assert app.project_id == 'env-project'
+        finally:
+            if project_id:
+                os.environ[GCLOUD_PROJECT] = project_id
+            else:
+                del os.environ[GCLOUD_PROJECT]
+
+    def test_no_project_id(self):
+        project_id = os.environ.get(GCLOUD_PROJECT)
+        if project_id:
+            del os.environ[GCLOUD_PROJECT]
+        try:
+            app = firebase_admin.initialize_app(testutils.MockCredential(), name='myApp')
+            assert app.project_id is None
+        finally:
+            if project_id:
+                os.environ[GCLOUD_PROJECT] = project_id
+
     def test_app_get(self, init_app):
         assert init_app is firebase_admin.get_app(init_app.name)
 
@@ -167,10 +200,10 @@ def test_app_delete(self, init_app):
             firebase_admin.delete_app(init_app)
 
     def test_app_services(self, init_app):
-        service = utils.get_app_service(init_app, 'test.service', AppService)
+        service = _utils.get_app_service(init_app, 'test.service', AppService)
         assert isinstance(service, AppService)
-        service2 = utils.get_app_service(init_app, 'test.service', AppService)
+        service2 = _utils.get_app_service(init_app, 'test.service', AppService)
         assert service is service2
         firebase_admin.delete_app(init_app)
         with pytest.raises(ValueError):
-            utils.get_app_service(init_app, 'test.service', AppService)
+            _utils.get_app_service(init_app, 'test.service', AppService)

tests/test_auth.py

@@ -33,6 +33,7 @@
 
 FIREBASE_AUDIENCE = ('https://identitytoolkit.googleapis.com/'
                      'google.identity.identitytoolkit.v1.IdentityToolkit')
+GCLOUD_PROJECT_ENV_VAR = 'GCLOUD_PROJECT'
 
 MOCK_UID = 'user1'
 MOCK_CREDENTIAL = credentials.Certificate(
@@ -98,6 +99,21 @@ def non_cert_app():
     yield app
     firebase_admin.delete_app(app)
 
+@pytest.fixture
+def env_var_app(request):
+    """Returns an App instance initialized with the given set of environment variables.
+
+    The lines of code following the yield statement are guaranteed to run after each test case
+    that depends on this fixture. This ensures that the environment is left intact after the
+    tests.
+    """
+    environ = os.environ
+    os.environ = request.param
+    app = firebase_admin.initialize_app(testutils.MockCredential(), name='env-var-app')
+    yield app
+    os.environ = environ
+    firebase_admin.delete_app(app)
+
 def verify_custom_token(custom_token, expected_claims):
     assert isinstance(custom_token, six.binary_type)
     token = google.oauth2.id_token.verify_token(
@@ -232,28 +248,25 @@ def test_invalid_token(self, authtest, id_token):
         with pytest.raises(ValueError):
             authtest.verify_id_token(id_token)
 
-    def test_project_id_env_var(self, non_cert_app):
-        gcloud_project = os.environ.get(auth.GCLOUD_PROJECT_ENV_VAR)
+    def test_project_id_option(self):
+        app = firebase_admin.initialize_app(
+            testutils.MockCredential(), options={'projectId': 'mock-project-id'}, name='myApp')
         try:
-            os.environ[auth.GCLOUD_PROJECT_ENV_VAR] = MOCK_CREDENTIAL.project_id
-            claims = auth.verify_id_token(TEST_ID_TOKEN, non_cert_app)
+            claims = auth.verify_id_token(TEST_ID_TOKEN, app)
             assert claims['admin'] is True
+            assert claims['uid'] == claims['sub']
         finally:
-            if gcloud_project:
-                os.environ[auth.GCLOUD_PROJECT_ENV_VAR] = gcloud_project
-            else:
-                del os.environ[auth.GCLOUD_PROJECT_ENV_VAR]
-
-    def test_no_project_id(self, non_cert_app):
-        gcloud_project = os.environ.get(auth.GCLOUD_PROJECT_ENV_VAR)
-        if gcloud_project:
-            del os.environ[auth.GCLOUD_PROJECT_ENV_VAR]
-        try:
-            with pytest.raises(ValueError):
-                auth.verify_id_token(TEST_ID_TOKEN, non_cert_app)
-        finally:
-            if gcloud_project:
-                os.environ[auth.GCLOUD_PROJECT_ENV_VAR] = gcloud_project
+            firebase_admin.delete_app(app)
+
+    @pytest.mark.parametrize('env_var_app', [{'GCLOUD_PROJECT': 'mock-project-id'}], indirect=True)
+    def test_project_id_env_var(self, env_var_app):
+        claims = auth.verify_id_token(TEST_ID_TOKEN, env_var_app)
+        assert claims['admin'] is True
+
+    @pytest.mark.parametrize('env_var_app', [{}], indirect=True)
+    def test_no_project_id(self, env_var_app):
+        with pytest.raises(ValueError):
+            auth.verify_id_token(TEST_ID_TOKEN, env_var_app)
 
     def test_custom_token(self, authtest):
         id_token = authtest.create_custom_token(MOCK_UID)