Merge pull request #5 from jupyterhub/add-minimal-tests

Add minimal tests

.travis.yml

@@ -0,0 +1,10 @@
+language: python
+python:
+  - 3.5
+  - 3.6
+  - 3.7
+install:
+  - pip install --upgrade setuptools pip
+  - pip install . -r dev-requirements.txt
+script:
+  - pytest

README.md

@@ -1,2 +1,27 @@
-# nativeauthenticator
-JupyterHub-native user authenticator
+# Native Authenticator
+
+[JupyterHub](http://github.com/jupyter/jupyterhub/) authenticator
+
+
+## Installation
+
+While this package is not on package manager, you can clone this repository and 
+install it with:
+
+`$ pip install -e .`
+
+You can then use this as your authenticator by adding the following line to your jupyterhub_config.py:
+
+`c.JupyterHub.authenticator_class = 'nativeauthenticator.NativeAuthenticator'`
+
+
+## Running tests
+
+To run the tests locally, you can install the development dependencies:
+
+`$ pip install dev-requirements.txt`
+
+Then run tests with pytest:
+
+`$ pytest`
+

dev-requirements.txt

@@ -0,0 +1,2 @@
+pytest
+pytest-asyncio

nativeauthenticator/nativeauthenticator.py

@@ -1,5 +1,10 @@
 from jupyterhub.auth import Authenticator
 
+from tornado import gen
+
 
 class NativeAuthenticator(Authenticator):
-    pass
+
+    @gen.coroutine
+    def authenticate(self, handler, data):
+        return data['username']

setup.py

@@ -9,7 +9,7 @@
     author_email='leportella@protonmail.com',
     license='3 Clause BSD',
     packages=find_packages(),
-    install_requires=['bcrypt'],
+    install_requires=['jupyterhub>=0.8'],
     package_data={
         '': ['*.html'],
     }

tests/test_authenticator.py

@@ -0,0 +1,23 @@
+import pytest
+from unittest.mock import Mock
+
+
+from nativeauthenticator import NativeAuthenticator
+
+
+@pytest.fixture
+def tmpcwd(tmpdir):
+    tmpdir.chdir()
+
+
+# use pytest-asyncio
+pytestmark = pytest.mark.asyncio
+# run each test in a temporary working directory
+pytestmark = pytestmark(pytest.mark.usefixtures("tmpcwd"))
+
+
+async def test_basic(tmpcwd):
+    auth = NativeAuthenticator()
+    response = await auth.authenticate(Mock(), {'username': 'name',
+                                          'password': '123'})
+    assert response == 'name'