Merge pull request #7 from uber/pytest

Fix test runner and instructions

Author: ascandella

.gitignore

@@ -0,0 +1,2 @@
+*.pyc
+*.egg-info

README.md

@@ -24,8 +24,15 @@ How To Use This
 Testing
 -------
 
-1. Install the dependencies with `pip install -r requirements.txt`
-2. Run the command `nosetests -v`
+1. Install the dependencies with:
+
+```bash
+pip install -r requirements.txt
+pip install -r requirements-test.txt
+python setup.py develop
+```
+
+2. Run the command `py.test test/`
 3. If you delete the fixtures, or decide to add some of your own, you’ll have to re-generate them, and the way this is done is by running the app, getting an auth_token from the main page of the app. Paste that token in place of the `test_auth_token` at the top of the `test_endpoints.py` file, then run the tests.
 
 
@@ -35,7 +42,7 @@ Development
 If you want to work on this application we’d love your pull requests and tickets on GitHub!
 
 1. If you open up a ticket, please make sure it describes the problem or feature request fully.
-2. If you send us a pull request, make sure you add a test for what you added, and make sure the full test suite runs with `nosetests -v`.
+2. If you send us a pull request, make sure you add a test for what you added, and make sure the full test suite runs with `py.test`.
 
 Deploy to Heroku
 ----------------

app.py

@@ -20,7 +20,7 @@
 
 
 def generate_oauth_service():
-    """Prepares the OAuth2Service that is used to make requests later."""
+    """Prepare the OAuth2Service that is used to make requests later."""
     return OAuth2Service(
         client_id=os.environ.get('UBER_CLIENT_ID'),
         client_secret=os.environ.get('UBER_CLIENT_SECRET'),
@@ -32,7 +32,7 @@ def generate_oauth_service():
 
 
 def generate_ride_headers(token):
-    """Generates the header object that is used to make api requests."""
+    """Generate the header object that is used to make api requests."""
     return {
         'Authorization': 'bearer %s' % token,
         'Content-Type': 'application/json',
@@ -41,7 +41,7 @@ def generate_ride_headers(token):
 
 @app.route('/health', methods=['GET'])
 def health():
-    """Used to check the status of this application."""
+    """Check the status of this application."""
     return ';-)'
 
 
@@ -96,10 +96,10 @@ def demo():
 
 @app.route('/products', methods=['GET'])
 def products():
-    '''Example call to the products endpoint.
+    """Example call to the products endpoint.
 
     Returns all the products currently available in San Francisco.
-    '''
+    """
     url = config.get('base_uber_url') + 'products'
     params = {
         'latitude': config.get('start_latitude'),
@@ -179,7 +179,7 @@ def price():
 
 @app.route('/history', methods=['GET'])
 def history():
-    """Returns the last 5 trips made by the logged in user."""
+    """Return the last 5 trips made by the logged in user."""
     url = config.get('base_uber_url') + 'history'
     params = {
         'offset': 0,
@@ -203,7 +203,7 @@ def history():
 
 @app.route('/me', methods=['GET'])
 def me():
-    """Returns user information including name, picture and email."""
+    """Return user information including name, picture and email."""
     url = config.get('base_uber_url') + 'me'
     response = app.requests_session.get(
         url,
@@ -218,8 +218,9 @@ def me():
         data=response.text,
     )
 
+
 def get_redirect_uri(request):
-    """Returns OAuth redirect URI."""
+    """Return OAuth redirect URI."""
     parsed_url = urlparse(request.url)
     if parsed_url.hostname == 'localhost':
         return 'http://{hostname}:{port}/submit'.format(hostname=parsed_url.hostname, port=parsed_url.port)

requirements-test.txt

@@ -0,0 +1,8 @@
+# Test harness
+pytest==2.5.2
+
+# Coverage
+pytest-cov==1.6
+
+# HTTP Fixtures
+betamax==0.4.0

requirements.txt

@@ -2,13 +2,11 @@ Flask==0.10.1
 Jinja2==2.7.3
 MarkupSafe==0.23
 Werkzeug==0.9.6
-betamax==0.4.0
 gnureadline==6.3.3
 itsdangerous==0.24
-nose==1.3.3
 rauth==0.7.0
 requests==2.3.0
 wsgiref==0.1.2
 
 gunicorn==18.0
-Flask-SSLify==0.1.4
+Flask-SSLify==0.1.4

setup.py

@@ -0,0 +1,10 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='Python-Sample-Application',
+    version='0.0.1',
+    author='Uber Engineering',
+    author_email='[email protected]',
+    packages=find_packages(),
+    description='Python sample application',
+)

test/test_endpoints.py

@@ -8,25 +8,28 @@
 
 test_auth_token = '42Kq726Vv6lzJ0TMhXWsgUulVjRsxh'
 
+
 class TestCases(unittest.TestCase):
     def setUp(self):
+        # Necessary to disable SSLify
+        app.debug = True
         self.test_app = app.test_client()
         self.session = app.requests_session
 
     def test_health_endpoint(self):
-        """Asserts that the health endpoint works."""
+        """Assert that the health endpoint works."""
         response = app.test_client().get('/health')
         self.assertEquals(response.data, ';-)')
 
     def test_root_endpoint(self):
-        """Asserts that the / endpoint correctly redirects to login.uber.com."""
+        """Assert that the / endpoint correctly redirects to login.uber.com."""
         response = app.test_client().get('/')
         self.assertIn('login.uber.com', response.data)
 
     def test_products_endpoint_returns_success(self):
-        """Asserts that the products endpoint returns success
+        """Assert that the products endpoint returns success.
 
-        when a valid key is passed in.
+        When a valid key is passed in.
         """
         with app.test_client() as client:
             with client.session_transaction() as session:
@@ -36,9 +39,9 @@ def test_products_endpoint_returns_success(self):
         self.assertEquals(response.status_code, 200)
 
     def test_products_endpoint_returns_failure(self):
-        """Asserts that the products endpoint returns failure
+        """Assert that the products endpoint returns failure.
 
-        when an invalid key is passed in.
+        When an invalid key is passed in.
         """
         with app.test_client() as client:
             with client.session_transaction() as session:
@@ -48,9 +51,9 @@ def test_products_endpoint_returns_failure(self):
         self.assertEquals(response.status_code, 401)
 
     def test_time_estimates_endpoint_returns_success(self):
-        """Asserts that the time estimates endpoint returns success
+        """Assert that the time estimates endpoint returns success.
 
-        when a valid key is passed in.
+        When a valid key is passed in.
         """
         with app.test_client() as client:
             with client.session_transaction() as session:
@@ -60,9 +63,9 @@ def test_time_estimates_endpoint_returns_success(self):
         self.assertEquals(response.status_code, 200)
 
     def test_time_estimates_endpoint_returns_failure(self):
-        """Asserts that the time estimates endpoint returns failure
+        """Assert that the time estimates endpoint returns failure.
 
-        when an invalid key is passed in.
+        When an invalid key is passed in.
         """
         with app.test_client() as client:
             with client.session_transaction() as session:
@@ -72,9 +75,9 @@ def test_time_estimates_endpoint_returns_failure(self):
         self.assertEquals(response.status_code, 401)
 
     def test_price_estimates_endpoint_returns_success(self):
-        """Asserts that the price estimates endpoint returns success
+        """Assert that the price estimates endpoint returns success.
 
-        when a valid key is passed in.
+        When a valid key is passed in.
         """
         with app.test_client() as client:
             with client.session_transaction() as session:
@@ -84,9 +87,9 @@ def test_price_estimates_endpoint_returns_success(self):
         self.assertEquals(response.status_code, 200)
 
     def test_price_estimates_endpoint_returns_failure(self):
-        """Asserts that the price estimates endpoint returns failure
+        """Assert that the price estimates endpoint returns failure.
 
-        when an invalid key is passed in.
+        When an invalid key is passed in.
         """
         with app.test_client() as client:
             with client.session_transaction() as session:
@@ -96,9 +99,9 @@ def test_price_estimates_endpoint_returns_failure(self):
         self.assertEquals(response.status_code, 401)
 
     def test_history_endpoint_returns_success(self):
-        """Asserts that the history endpoint returns success
+        """Assert that the history endpoint returns success.
 
-        when a valid key is passed in.
+        When a valid key is passed in.
         """
         with app.test_client() as client:
             with client.session_transaction() as session:
@@ -108,9 +111,9 @@ def test_history_endpoint_returns_success(self):
         self.assertEquals(response.status_code, 200)
 
     def test_history_endpoint_returns_failure(self):
-        """Asserts that the price estimates endpoint returns failure
+        """Assert that the price estimates endpoint returns failure.
 
-        when an invalid key is passed in.
+        When an invalid key is passed in.
         """
         with app.test_client() as client:
             with client.session_transaction() as session: