Starting tests (#43)

rnegron · jpadilla · commit 0b641bd67088 · 2019-04-11T08:31:02.000-04:00
* Add failing test suite

* Update tests and configurations

* Move pytest to dev dependency, add Dockerfile.file and test service
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -38,3 +38,6 @@ jobs:
       - run:
           name: Run flake8
           command: pipenv run flake8
+      - run:
+          name: Run tests
+          command: pipenv run pytest
diff --git a/.isort.cfg b/.isort.cfg
@@ -6,4 +6,4 @@ force_grid_wrap=0
 combine_as_imports=True
 line_length=88
 skip=.venv,migrations
-known_third_party=celery,configurations,coreapi,coreschema,debug_toolbar,django,django_extensions,django_filters,django_s3_storage,google,pytz,requests,rest_framework
+known_third_party=celery,configurations,coreapi,coreschema,debug_toolbar,django,django_extensions,django_filters,django_s3_storage,google,pytest,pytz,requests,rest_framework
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -87,13 +87,15 @@ If you want to go the usual route and run the project locally, though:
 - Install pre-commit hooks: `pipenv run pre-commit install`
 - Setup environment file: `cp example.env .env`
 - Install docker-compose: https://docs.docker.com/compose/install/
-- Build and start containers: `docker-compose up -d`
+- Build and start containers, including test container: `docker-compose up -d`
 - Create super user: `docker-compose exec web python manage.py createsuperuser`
 - Scrape some contracts: `docker-compose exec web python manage.py scrape_contracts --limit 100`
 - open http://localhost:8000
 
 And you should be ready to go!
 
+You can use this command to run tests on demand: `docker-compose up test`
+
 ## Contribute Documentation
 
 Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies. And it's how we tell others everything they need in order to be able to use this project -- or contribute to it. So thank you in advance.
@@ -133,6 +135,7 @@ To contribute code:
 * Write tests that verify that your contribution works as expected.
 * Write clear, concise commit message(s).
 * Dependency updates, additions, or removals must be in individual commits.
+* Ensure old tests are still passing.
 * Go to https://github.com/TheIndexingProject/contratospr-api/pulls and open a new pull request with your changes.
 * If your PR is connected to an open issue, add a line in your PR's description that says `Fixes: #123`, where `#123` is the number of the issue you're fixing.
 
diff --git a/Dockerfile.local b/Dockerfile.local
@@ -0,0 +1,15 @@
+FROM python:3.7
+
+ENV LANG en_US.utf8
+
+RUN pip install pipenv==2018.11.26
+
+WORKDIR /app/
+
+COPY Pipfile Pipfile.lock /app/
+
+# Install application requirements and dev requirements
+RUN pipenv install --dev
+
+# Bundle app source
+COPY . /app/
diff --git a/Pipfile b/Pipfile
@@ -9,6 +9,7 @@ isort = "==4.3.4"
 "flake8" = "*"
 pre-commit = "*"
 seed-isort-config = "*"
+pytest-django = "*"
 
 [packages]
 dj-database-url = "==0.5.0"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/bin/docker-entrypoint b/bin/docker-entrypoint
@@ -34,6 +34,10 @@ case "$1" in
     ./bin/worker --loglevel=DEBUG --concurrency=2
     ;;
 
+  "start-test")
+    pipenv run pytest
+    ;;
+
   *)
     exec "$@"
     ;;
diff --git a/contratospr/api/tests/__init__.py b/contratospr/api/tests/__init__.py
diff --git a/contratospr/api/tests/test_views.py b/contratospr/api/tests/test_views.py
@@ -0,0 +1,35 @@
+from rest_framework.reverse import reverse
+from rest_framework.test import APITestCase
+from rest_framework.views import status
+
+
+class TestViews(APITestCase):
+    def test_root_view_url(self):
+        url = reverse("v1:api-root")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+    def test_home_page_view_url(self):
+        response = self.client.get("/v1/pages/home/")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+    def test_home_page_view_response(self):
+        response = self.client.get("/v1/pages/home/")
+
+        for key in (
+            "fiscal_year",
+            "recent_contracts",
+            "contractors",
+            "entities",
+            "contracts_count",
+            "contracts_total",
+        ):
+            self.assertIn(key, response.data)
+
+    def test_trends_general_view_url(self):
+        response = self.client.get("/v1/pages/trends/general/")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+    def test_test_trends_services_view_url(self):
+        response = self.client.get("/v1/pages/trends/services/")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
diff --git a/contratospr/api/tests/test_viewsets.py b/contratospr/api/tests/test_viewsets.py
@@ -0,0 +1,65 @@
+from unittest import mock
+
+from django.core.files import File
+from rest_framework.reverse import reverse
+from rest_framework.test import APITestCase
+from rest_framework.views import status
+
+from contratospr.contracts import models
+
+
+class TestContractViewSet(APITestCase):
+    def test_viewset_list_url(self):
+        url = reverse("v1:contract-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+
+class TestContractorViewSet(APITestCase):
+    def test_viewset_list_url(self):
+        url = reverse("v1:contractor-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+
+class TestDocumentViewSet(APITestCase):
+    @classmethod
+    def setUpTestData(cls):
+        file_mock = mock.MagicMock(spec=File)
+        file_mock.name = "test_file.pdf"
+        cls.test_document = models.Document(file=file_mock, source_id=1)
+        cls.test_document.save()
+
+    def test_viewset_detail_url(self):
+        url = reverse("v1:document-detail", args=[self.test_document.pk])
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+
+class TestEntityViewSet(APITestCase):
+    def test_viewset_list_url(self):
+        url = reverse("v1:entity-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+    def test_can_obtain_instance(self):
+        entity = models.Entity(name="Test Entity", source_id=1)
+        entity.save()
+        url = reverse("v1:entity-detail", args=[entity.slug])
+        response = self.client.get(url)
+        for key in ("contracts_total", "contracts_count"):
+            self.assertIn(key, response.data)
+
+
+class TestServiceGroupViewSet(APITestCase):
+    def test_viewset_list_url(self):
+        url = reverse("v1:servicegroup-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+
+class TestServiceViewSet(APITestCase):
+    def test_viewset_list_url(self):
+        url = reverse("v1:service-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
diff --git a/contratospr/contracts/tests/__init__.py b/contratospr/contracts/tests/__init__.py
diff --git a/contratospr/contracts/tests/test_models.py b/contratospr/contracts/tests/test_models.py
@@ -0,0 +1,129 @@
+import pytest
+
+from ..models import (
+    Contract,
+    Contractor,
+    Document,
+    Entity,
+    Service,
+    ServiceGroup,
+    document_file_path,
+)
+
+
+@pytest.fixture
+def get_entity():
+    """Returns an Entity factory with defaults: name='Test Entity'"""
+
+    def _get_entity(name="Test Entity"):
+        entity_instance = Entity(name=name)
+        return entity_instance
+
+    return _get_entity
+
+
+@pytest.fixture
+def get_service_group():
+    """Returns a ServiceGroup factory with defaults: name='Test Service Group'"""
+
+    def _get_service_group(name="Test Service Group"):
+        service_group_instance = ServiceGroup(name=name)
+        return service_group_instance
+
+    return _get_service_group
+
+
+@pytest.fixture
+def get_service(get_service_group):
+    """Returns a Service factory with defaults: name='Test Service'"""
+
+    def _get_service(name="Test Service", group=1):
+        service_group = get_service_group(group)
+        service_instance = Service(name=name, group=service_group)
+        return service_instance
+
+    return _get_service
+
+
+@pytest.fixture
+def get_document():
+    """Returns a Document factory with defaults: file='test.txt', source_id=1"""
+
+    def _get_document(file="test.txt", source_id=1):
+        document_instance = Document(file=file, source_id=source_id)
+        return document_instance
+
+    return _get_document
+
+
+@pytest.fixture
+def get_contractor():
+    """Returns a Contractor factory with defaults: name='Test Contractor', source_id=1, entity_id=1"""
+
+    def _get_contractor(name="Test Contractor", source_id=1, entity_id=1):
+        contractor_instance = Contractor(
+            name=name, source_id=source_id, entity_id=entity_id
+        )
+        return contractor_instance
+
+    return _get_contractor
+
+
+@pytest.fixture
+def get_contract(get_entity):
+    """Returns a Contract factory with defaults: entity=1, source_id=1, number=T1"""
+
+    def _get_contract(entity=None, source_id=1, number="T1"):
+        if not entity:
+            entity = get_entity()
+        contract_instance = Contract(entity=entity, source_id=source_id, number=number)
+        return contract_instance
+
+    return _get_contract
+
+
+class TestModelHelpers:
+    def test_document_file_path(self, tmpdir, get_document):
+        document = get_document()
+        filename = "document"
+        assert (
+            document_file_path(document, filename)
+            == f"documents/{document.source_id}/{filename}"
+        )
+
+
+class TestEntity:
+    def test_instance_str(self, get_entity):
+        entity = get_entity()
+        assert str(entity) == "Test Entity"
+
+
+class TestServiceGroup:
+    def test_instance_str(self, get_service_group):
+        service_group = get_service_group()
+        assert str(service_group) == "Test Service Group"
+
+
+class TestService:
+    def test_instance_str(self, get_service):
+        service = get_service()
+        assert str(service) == "Test Service"
+
+
+class TestDocument:
+    def test_instance_str(self, get_document):
+        document = get_document()
+        assert str(document) == "1"
+
+
+class TestContractor:
+    def test_instance_str(self, get_contractor):
+        contractor = get_contractor()
+        assert str(contractor) == "Test Contractor"
+
+
+@pytest.mark.django_db
+class TestContract:
+    def test_instance_str(self, get_contract):
+        contract = get_contract()
+        assert str(contract) == "T1"
diff --git a/contratospr/contracts/tests/test_utils.py b/contratospr/contracts/tests/test_utils.py
@@ -0,0 +1,23 @@
+import datetime
+
+from django.utils import timezone
+
+from ..utils import get_current_fiscal_year, get_fiscal_year_range
+
+
+class TestUtils:
+    def test_get_current_fiscal_year(self):
+        now = timezone.now()
+        fiscal_year_end = timezone.make_aware(datetime.datetime(now.year, 6, 30))
+
+        current_fiscal_year = get_current_fiscal_year()
+
+        if now > fiscal_year_end:
+            assert current_fiscal_year == now.year + 1
+        else:
+            assert current_fiscal_year == now.year
+
+    def test_get_fiscal_year_range(self):
+        start, end = get_fiscal_year_range(2019)
+        assert start == timezone.make_aware(datetime.datetime(2018, 7, 1))
+        assert end == timezone.make_aware(datetime.datetime(2019, 6, 30))
diff --git a/contratospr/users/tests.py b/contratospr/users/tests.py
@@ -0,0 +1,7 @@
+from .models import User
+
+
+class CustomUserModelTest:
+    def test_user_str_repr(self):
+        user = User.objects.create(username="Test User", password="sUp3rP@as$w0rD123")
+        self.assertEqual(str(user), "Test User")
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -57,3 +57,19 @@ services:
       interval: 30s
       timeout: 10s
       retries: 3
+
+  test:
+    build:
+      context: .
+      dockerfile: Dockerfile.local
+    command: start-test
+    entrypoint: /app/bin/docker-entrypoint
+    env_file:
+      - .env
+    volumes:
+      - .:/app
+    ports:
+      - '8000:8000'
+    links:
+      - database:database
+      - redis:redis
