initial test configuration

Author: Gzing

.gitignore

@@ -54,3 +54,7 @@ constants_override.py
 static/.webassets-cache
 static/gen
 
+#pytest
+.pytest_cache
+app/test_project.db
+app.log

.travis.yml

@@ -0,0 +1,9 @@
+  language: python
+  python:
+    - "2.7"
+  script:
+    - pytest
+  addons:
+    postgresql: "9.4"
+  services:
+    - redis-server

README.md

@@ -47,6 +47,28 @@ open http://127.0.0.1:5000/
 
 **Problems?** Hit us up in the `engineering` channel on [Discord](https://www.originprotocol.com/discord) if you need help.
 
+## Run the Tests
+
+
+Throughout the development process and before committing or deploying, run:
+
+```bash
+pytest
+```
+
+Run individual test files simply as:
+
+```bash
+pytest path/to/test.py
+```
+
+Run a single test case, or an individual test, using:
+
+```bash
+pytest path/to/test.py::test_case_name
+```
+
+
 ## Localization
 See [translations](translations) directory. 
 

pytest.ini

@@ -0,0 +1,7 @@
+[pytest]
+env =
+  HOST = testhost.com
+  HTTPS = False
+  FLASK_SECRET_KEY=test-secret-key
+  REDIS_URL=redis://localhost:6379/0
+  SENDGRID_API_KEY = test-sendgrid-key

requirements.txt

@@ -11,6 +11,7 @@ click==6.7
 cryptography==2.1.4
 decorator==4.2.1
 enum34==1.1.6
+factory-boy==2.10.0
 Flask==0.12.2
 Flask-Babel==0.11.2
 Flask-Compress==1.4.0
@@ -26,6 +27,7 @@ ipython-genutils==0.2.0
 itsdangerous==0.24
 Jinja2==2.10
 MarkupSafe==1.0
+mock==2.0.0
 newrelic
 path.py==10.5
 pathlib2==2.3.0
@@ -40,6 +42,8 @@ pycparser==2.18
 pyflakes==1.6.0
 Pygments==2.2.0
 pyOpenSSL==17.5.0
+pytest==3.5.0
+pytest-env==0.6.2
 python-dateutil==2.6.1
 python-env==1.0.0
 python-http-client==3.0.0
@@ -53,6 +57,7 @@ service-identity==17.0.0
 simplegeneric==0.8.1
 six==1.11.0
 SQLAlchemy==1.2.1
+testing.postgresql==1.3.0
 traitlets==4.3.2
 urllib3==1.22
 wcwidth==0.1.7

testing/all_tests.py

@@ -0,0 +1,87 @@
+import pytest
+from testing.postgresql import Postgresql
+from mock import patch
+
+from app import app as flask_app
+from database import db as _db
+from config import constants
+
+# importing to register views
+from views import web_views # noqa
+
+
+class TestConfig(object):
+    SECRET_KEY = constants.FLASK_SECRET_KEY
+
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+    SQLALCHEMY_ECHO = False
+
+    RECAPTCHA_SITE_KEY = constants.RECAPTCHA_SITE_KEY
+    RECAPTCHA_SECRET_KEY = constants.RECAPTCHA_SECRET_KEY
+    RECAPTCHA_SIZE = constants.RECAPTCHA_SIZE
+    SERVER_NAME = 'localhost'
+
+
+@pytest.yield_fixture(scope='session')
+def app():
+    _app = flask_app
+    _app.config.from_object(__name__ + '.TestConfig')
+    with Postgresql() as postgresql:
+        _app.config['SQLALCHEMY_DATABASE_URI'] = postgresql.url()
+        ctx = _app.app_context()
+        ctx.push()
+
+        yield _app
+
+        ctx.pop()
+
+
+@pytest.yield_fixture
+def client(app):
+    """A Flask test client. An instance of :class:`flask.testing.TestClient`
+    by default.
+    """
+    with app.test_client() as client:
+        yield client
+
+
+@pytest.yield_fixture(scope='session')
+def db(app):
+    _db.app = app
+    _db.init_app(app)
+    _db.create_all()
+
+    yield _db
+
+    _db.drop_all()
+
+
+@pytest.fixture(scope='function', autouse=True)
+def session(db):
+    connection = db.engine.connect()
+    transaction = connection.begin()
+
+    options = dict(bind=connection, binds={})
+    session_ = db.create_scoped_session(options=options)
+
+    db.session = session_
+
+    yield session_
+
+    transaction.rollback()
+    connection.close()
+    session_.remove()
+
+
+@pytest.yield_fixture(scope='function')
+def mock_captcha(app):
+    patcher = patch('views.web_views.recaptcha', return_value=True)
+    yield patcher.start()
+    patcher.stop()
+
+
+@pytest.yield_fixture(scope='function')
+def mock_send_message(app):
+    patcher = patch('util.sendgrid_wrapper.send_message', return_value=True)
+    yield patcher.start()
+    patcher.stop()

tests/__init__.py

@@ -0,0 +1,42 @@
+from factory import alchemy, Faker
+
+from database import db
+from database.db_models import Interest, Presale, EmailList
+
+
+class PresaleFactory(alchemy.SQLAlchemyModelFactory):
+    class Meta(object):
+        model = Presale
+        sqlalchemy_session = db.session  # the SQLAlchemy session object
+
+    full_name = Faker('name')
+    email = Faker('safe_email')
+    accredited = True
+    entity_type = 'Individual'
+    desired_allocation = '30000'
+    desired_allocation_currency = "USD"
+    citizenship = "US"
+    sending_addr = "0x0000000000000000000000000000000000000000"
+    note = Faker('sentence', nb_words=8)
+    ip_addr = Faker('ipv4')
+
+
+class InterestFactory(alchemy.SQLAlchemyModelFactory):
+    class Meta(object):
+        model = Interest
+        sqlalchemy_session = db.session  # the SQLAlchemy session object
+
+    name = Faker('name')
+    company_name = Faker('company')
+    email = Faker('safe_email')
+    website = Faker('domain_name')
+    note = Faker('sentence', nb_words=8)
+
+
+class EmailListFactory(alchemy.SQLAlchemyModelFactory):
+    class Meta(object):
+        model = EmailList
+        sqlalchemy_session = db.session  # the SQLAlchemy session object
+
+    email = Faker('safe_email')
+    unsubscribed = False

tests/conftest.py

@@ -0,0 +1,66 @@
+# test_app.py
+import random
+from faker import Faker
+
+from flask import url_for
+
+from config.constants import LANGUAGES
+from database.db_models import EmailList, Presale, Interest
+
+from .factories import PresaleFactory, InterestFactory
+
+
+fake = Faker()
+
+
+def test_root_returns_302(client):
+    res = client.get(url_for('root'))
+    assert res.status_code == 302
+
+
+def test_index_returns_200(client):
+    res = client.get(url_for('index', lang_code=random.choice(LANGUAGES)))
+    assert res.status_code == 200
+
+
+def test_join_mailing_and_unsubscribe(mock_send_message, session, client):
+    data = {
+        "email": fake.safe_email(),
+        "ip_addr": fake.ipv4(),
+    }
+    res = client.post(url_for('join_mailing_list'),
+                      data=data)
+
+    assert res.status_code == 200
+    assert EmailList.query.filter_by(email=data['email']).first() is not None
+
+    # try to unsubscribe the created EmailList object above
+    res = client.get("{url}?email={param}".
+                     format(url=url_for('unsubscribe'),
+                            param=data['email']))
+
+    assert res.status_code == 302
+    assert EmailList.query.filter_by(email=data['email'],
+                                     unsubscribed=True).first() is not None
+
+
+def test_join_presale(mock_send_message, mock_captcha, session, client):
+    data = PresaleFactory.stub().__dict__
+    data['confirm'] = True
+
+    res = client.post(url_for('join_presale'), data=data)
+    created_obj = Presale.query.filter_by(email=data['email']).first()
+
+    assert created_obj.id is not None
+    assert res.status_code == 200
+
+
+def test_partners_interest(mock_send_message, mock_captcha, session, client):
+    data = InterestFactory.stub().__dict__
+    data['confirm'] = True
+
+    res = client.post(url_for('partners_interest'), data=data)
+    created_obj = Interest.query.filter_by(email=data['email']).first()
+
+    assert created_obj.id is not None
+    assert res.status_code == 200

tests/factories.py

@@ -0,0 +1,27 @@
+from .factories import InterestFactory, PresaleFactory, EmailListFactory
+
+
+def test_interest_model(session):
+    created_obj = InterestFactory.build()
+    session.add(created_obj)
+    session.commit()
+
+    assert created_obj.id is not None
+    assert created_obj.created_at is not None
+
+
+def test_presale_model(session):
+    created_obj = PresaleFactory.build()
+    session.add(created_obj)
+    session.commit()
+
+    assert created_obj.id is not None
+    assert created_obj.created_at is not None
+
+
+def test_email_list_model(session):
+    created_obj = EmailListFactory.build()
+    session.add(created_obj)
+    session.commit()
+
+    assert created_obj.created_at is not None