Adding code coverage (firebase#9)

hiranya911 · web-flow · commit e2edf79a331f · 2017-03-29T10:12:54.000-07:00
* Adding code coverage

* Formatting changes; New test case for invalid cert

* Minor doc update

* Added pypy to the list of tested environments; Updated docs on using pyenv for testing

* Removing some redundant empty lines

* Updated doc
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -134,6 +134,12 @@ pytest
 Refer to the pytest [usage and invocations guide](http://doc.pytest.org/en/latest/usage.html)
 to learn how to run a subset of all test cases.
 
+You can also get a code coverage report by launching pytest as follows:
+
+```
+pytest --cov=firebase_admin --cov=tests
+```
+
 ### Testing in Different Environments
 
 Sometimes we want to run unit tests in multiple environments (e.g. different Python versions), and
@@ -149,20 +155,40 @@ configuration file such as `.bash_profile`. Once pyenv is installed, you can ins
 versions of Python as follows:
 
 ```
-pyenv install 2.7.6  # install Python 2.7.6
-pyenv install 3.3.0  # install Python 3.3.0
+pyenv install 2.7.6        # install Python 2.7.6
+pyenv install 3.3.0        # install Python 3.3.0
+pyenv install pypy2-5.6.0  # install pypy2
 ```
 
 Refer to the [`tox.ini`](../tox.ini) file for a list of target environments that we usually test.
-Use pyenv to install all the required Python versions on your workstation. When your system is
-fully set up, you can execute the following command from the root of the repository to launch tox:
+Use pyenv to install all the required Python versions on your workstation. Verify that they are
+installed by running the following command:
+
+```
+pyenv versions
+```
+
+To make all the required Python versions available to tox for testing, run the `pyenv local` command
+with all the Python versions as arguments. The following example shows how to make Python versions
+2.7.6, 3.3.0 and pypy2 available to tox.
+
+```
+pyenv local 2.7.6 3.3.0 pypy2-5.6.0
+```
+
+Once your system is fully set up, you can execute the following command from the root of the
+repository to launch tox:
 
 ```
 tox
 ```
 
 This command will read the list of target environments from `tox.ini`, and execute tests in each of
-those environments.
+those environments. It will also generate a code coverage report at the end of the execution.
+
+```
+pyenv local 2.7.6 3.3.0 pypy2-5.6.0
+```
 
 ### Repo Organization
 
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.coverage
 *.pyc
 .python-version
 .cache/
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,6 @@
 pylint >= 1.6.4
 pytest >= 3.0.6
+pytest-cov >= 2.4.0
 tox >= 2.6.0
 
 oauth2client >= 4.0.0
diff --git a/tests/data/malformed_key.json b/tests/data/malformed_key.json
@@ -0,0 +1,12 @@
+{
+  "type": "service_account",
+  "project_id": "mock-project-id",
+  "private_key_id": "mock-key-id-1",
+  "private_key": "-----INVALID PRIVATE KEY-----",
+  "client_email": "mock-email@mock-project.iam.gserviceaccount.com",
+  "client_id": "1234567890",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://accounts.google.com/o/oauth2/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/mock-project-id.iam.gserviceaccount.com"
+}
diff --git a/tests/data/no_client_id_service_account.json b/tests/data/no_client_id_service_account.json
@@ -0,0 +1,11 @@
+{
+	"type": "service_account",
+	"project_id": "mock-project-id",
+	"private_key_id": "mock-key-id-1",
+        "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAwJENcRev+eXZKvhhWLiV3Lz2MvO+naQRHo59g3vaNQnbgyduN/L4krlr\nJ5c6FiikXdtJNb/QrsAHSyJWCu8j3T9CruiwbidGAk2W0RuViTVspjHUTsIHExx9euWM0Uom\nGvYkoqXahdhPL/zViVSJt+Rt8bHLsMvpb8RquTIb9iKY3SMV2tCofNmyCSgVbghq/y7lKORt\nV/IRguWs6R22fbkb0r2MCYoNAbZ9dqnbRIFNZBC7itYtUoTEresRWcyFMh0zfAIJycWOJlVL\nDLqkY2SmIx8u7fuysCg1wcoSZoStuDq02nZEMw1dx8HGzE0hynpHlloRLByuIuOAfMCCYwID\nAQABAoIBADFtihu7TspAO0wSUTpqttzgC/nsIsNn95T2UjVLtyjiDNxPZLUrwq42tdCFur0x\nVW9Z+CK5x6DzXWvltlw8IeKKeF1ZEOBVaFzy+YFXKTz835SROcO1fgdjyrme7lRSShGlmKW/\nGKY+baUNquoDLw5qreXaE0SgMp0jt5ktyYuVxvhLDeV4omw2u6waoGkifsGm8lYivg5l3VR7\nw2IVOvYZTt4BuSYVwOM+qjwaS1vtL7gv0SUjrj85Ja6zERRdFiITDhZw6nsvacr9/+/aut9E\naL/koSSb62g5fntQMEwoT4hRnjPnAedmorM9Rhddh2TB3ZKTBbMN1tUk3fJxOuECgYEA+z6l\neSaAcZ3qvwpntcXSpwwJ0SSmzLTH2RJNf+Ld3eBHiSvLTG53dWB7lJtF4R1KcIwf+KGcOFJv\nsnepzcZBylRvT8RrAAkV0s9OiVm1lXZyaepbLg4GGFJBPi8A6VIAj7zYknToRApdW0s1x/XX\nChewfJDckqsevTMovdbg8YkCgYEAxDYX+3mfvv/opo6HNNY3SfVunM+4vVJL+n8gWZ2w9kz3\nQ9Ub9YbRmI7iQaiVkO5xNuoG1n9bM+3Mnm84aQ1YeNT01YqeyQsipP5Wi+um0PzYTaBw9RO+\n8Gh6992OwlJiRtFk5WjalNWOxY4MU0ImnJwIfKQlUODvLmcixm68NYsCgYEAuAqI3jkk55Vd\nKvotREsX5wP7gPePM+7NYiZ1HNQL4Ab1f/bTojZdTV8Sx6YCR0fUiqMqnE+OBvfkGGBtw22S\nLesx6sWf99Ov58+x4Q0U5dpxL0Lb7d2Z+2Dtp+Z4jXFjNeeI4ae/qG/LOR/b0pE0J5F415ap\n7Mpq5v89vepUtrkCgYAjMXytu4v+q1Ikhc4UmRPDrUUQ1WVSd+9u19yKlnFGTFnRjej86hiw\nH3jPxBhHra0a53EgiilmsBGSnWpl1WH4EmJz5vBCKUAmjgQiBrueIqv9iHiaTNdjsanUyaWw\njyxXfXl2eI80QPXh02+8g1H/pzESgjK7Rg1AqnkfVH9nrwKBgQDJVxKBPTw9pigYMVt9iHrR\niCl9zQVjRMbWiPOc0J56+/5FZYm/AOGl9rfhQ9vGxXZYZiOP5FsNkwt05Y1UoAAH4B4VQwbL\nqod71qOcI0ywgZiIR87CYw40gzRfjWnN+YEEW1qfyoNLilEwJB8iB/T+ZePHGmJ4MmQ/cTn9\nxpdLXA==\n-----END RSA PRIVATE KEY-----",
+	"client_email": "mock-email@mock-project.iam.gserviceaccount.com",
+	"auth_uri": "https://accounts.google.com/o/oauth2/auth",
+	"token_uri": "https://accounts.google.com/o/oauth2/token",
+	"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+	"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/mock-project-id.iam.gserviceaccount.com"
+}
diff --git a/tests/test_credentials.py b/tests/test_credentials.py
@@ -13,6 +13,13 @@
 
 class TestCertificate(object):
 
+    invalid_certs = {
+        'NonExistingFile': ('non_existing.json', IOError),
+        'RefreskToken': ('refresh_token.json', ValueError),
+        'MalformedPrivateKey': ('malformed_key.json', ValueError),
+        'MissingClientId': ('no_client_id_service_account.json', ValueError),
+    }
+
     def test_init_from_file(self):
         credential = credentials.Certificate(
             testutils.resource_filename('service_account.json'))
@@ -30,15 +37,10 @@ def test_init_from_file(self):
         assert isinstance(access_token.access_token, six.string_types)
         assert isinstance(access_token.expires_in, int)
 
-    def test_init_from_nonexisting_file(self):
-        with pytest.raises(IOError):
-            credentials.Certificate(
-                testutils.resource_filename('non_existing.json'))
-
-    def test_init_from_invalid_file(self):
-        with pytest.raises(ValueError):
-            credentials.Certificate(
-                testutils.resource_filename('refresh_token.json'))
+    @pytest.mark.parametrize('file_name,error', invalid_certs.values(), ids=list(invalid_certs))
+    def test_init_from_invalid_certificate(self, file_name, error):
+        with pytest.raises(error):
+            credentials.Certificate(testutils.resource_filename(file_name))
 
 
 @pytest.fixture
diff --git a/tox.ini b/tox.ini
@@ -4,11 +4,29 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py27,py33
+envlist = py27,py33,pypy,cover
 
 [testenv]
 commands = pytest
 deps =
     pytest
     oauth2client
     six
+
+[coverbase]
+basepython = python2.7
+commands =
+    pytest \
+      --cov=firebase_admin \
+      --cov=tests
+deps = {[testenv]deps}
+    coverage
+    pytest-cov
+
+[testenv:cover]
+basepython = {[coverbase]basepython}
+commands =
+    {[coverbase]commands}
+    coverage report --show-missing
+deps =
+    {[coverbase]deps}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.coverage`
`1`	`2`	`*.pyc`
`2`	`3`	`.python-version`
`3`	`4`	`.cache/`