Merge pull request #76 from ubclaunchpad/cheukyin699/#72-pytest-conds…

…kips

Pytest tests for dynamodb things is optional

README.md

@@ -42,6 +42,14 @@ this can be run with:
 ./scripts/build_check.sh
 ```
 
+The above tests would be run with the assumption that other applications, such
+as the local database, is also running. To run tests that explicitly do **not**
+involve the running of any database, run pytest with the following arguments:
+
+```bash
+pytest -m "not db"
+```
+
 You can also install it as a
 [pre-commit hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) for git:
 

db/facade.py

@@ -1,5 +1,4 @@
 """Database Facade."""
-from .dynamodb import DynamoDB
 
 
 class DBFacade:
@@ -10,7 +9,7 @@ class DBFacade:
     or Postgres are also being considered.
     """
 
-    def __init__(self, db=DynamoDB()):
+    def __init__(self, db):
         """Initialize facade using DynamoDB settings (for now)."""
         self.ddb = db
 

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+markers =
+    db: mark a test as involving use of a database

scripts/build_check.sh

@@ -3,4 +3,14 @@ set -euxo pipefail
 pipenv run pycodestyle .
 pipenv run pydocstyle .
 mdl .
-pipenv run pytest tests/
+
+# We use nmap to check if dynamodb is running locally
+# TODO: later should combine this with environmental variable checking (to see
+# if we can use a remote server instead).
+# XXX: Find a better way to check if dynamodb is running locally
+if nmap localhost | egrep "8000.*http-alt"; then
+    pipenv run pytest tests/
+else
+    printf "Warning: DynamoDB not detected. Running without the tests.\n"
+    pipenv run pytest tests/ -m "not db"
+fi

tests/db/dynamodb_test.py

@@ -2,13 +2,16 @@
 from db.dynamodb import DynamoDB
 from tests.util import create_test_user
 from model.user import User
+import pytest
 
 
+@pytest.mark.db
 def test_string_rep():
     """Test string representation of the DynamoDB class."""
     assert str(DynamoDB()) == "DynamoDB"
 
 
+@pytest.mark.db
 def test_store_invalid_user():
     """Test handling of invalid user."""
     ddb = DynamoDB()
@@ -17,6 +20,7 @@ def test_store_invalid_user():
     assert not success
 
 
+@pytest.mark.db
 def test_store_retrieve_user():
     """Test to see if we can store and retrieve the same user."""
     ddb = DynamoDB()
@@ -31,6 +35,7 @@ def test_store_retrieve_user():
     ddb.delete_user('abc_123')
 
 
+@pytest.mark.db
 def test_query_user():
     """Test to see if we can store and query the same user."""
     ddb = DynamoDB()

tests/db/facade_test.py

@@ -4,9 +4,10 @@
 from tests.util import create_test_user
 
 
-def test_string_rep():
+@mock.patch('db.dynamodb.DynamoDB', autospec=True)
+def test_string_rep(ddb):
     """Test string representation of the DBFacade class."""
-    assert str(DBFacade()) == "Database Facade"
+    assert str(DBFacade(ddb)) == "Database Facade"
 
 
 @mock.patch('db.dynamodb.DynamoDB', autospec=True)