Adding Conference tests. (Netflix#267)

* `yield_fixture` is deprecated after pytest 3.0.

Plain old `fixture` is fine.

* [WIP] Adding Conference model and service tests.

* Use four spaces per indent in Python files.

* Add assertions and stub functions.

* Fix naming convention for conference tests.
* Remove 'name', as it's not present in the Conference model.

* Return a List of Conferences.

When asking for all the Conferences of a given resource type, it doesn't
make sense to ask for only one, or None (and throw an exception). It
seems more sensible to request the whole list, or even a paginated list.
Since this method isn't used anywhere in the code yet, we'll
just return all().

* Black formatting.

* Ensure our stub functions have args.

* Test retrieval of a List of Conferences.

* Add a test fixture to create multiple conferences.

* Class Meta above instance vars

* Incorporating suggested change

* Lowercase as suggested

* Implements test_conference_get_by_conference_id

* get_by_incident_id fails

* Implements test_conference_get_all

* Ensure we're testing the created Conference.

* Move ConferenceFactory later.

This way an IncidentFactory has been defined and is available.

* Give mocked Incident objects a fake ID.

* This test works fine now.

Author: forestmonster

.editorconfig

@@ -8,6 +8,9 @@ indent_style=space
 indent_size=2
 trim_trailing_whitespace=true
 
+[*.py]
+indent_size=4
+
 [{*.ng,*.sht,*.html,*.shtm,*.shtml,*.htm}]
 indent_style=space
 indent_size=2

src/dispatch/conference/service.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, List
 
 from .models import Conference, ConferenceCreate
 
@@ -11,10 +11,10 @@ def get_by_resource_id(*, db_session, resource_id: str) -> Optional[Conference]:
     return db_session.query(Conference).filter(Conference.resource_id == resource_id).one_or_none()
 
 
-def get_by_resource_type(*, db_session, resource_type: str) -> Optional[Conference]:
-    return (
-        db_session.query(Conference).filter(Conference.resource_type == resource_type).one_or_none()
-    )
+def get_by_resource_type(*, db_session, resource_type: str) -> List[Optional[Conference]]:
+    """Return a list of all conferences matching a given resource type.
+       May return an empty list if no conferences are available."""
+    return db_session.query(Conference).filter(Conference.resource_type == resource_type).all()
 
 
 def get_by_conference_id(db_session, conference_id: str) -> Optional[Conference]:
@@ -24,11 +24,7 @@ def get_by_conference_id(db_session, conference_id: str) -> Optional[Conference]
 
 
 def get_by_incident_id(*, db_session, incident_id: str) -> Optional[Conference]:
-    return (
-        db_session.query(Conference)
-        .filter(Conference.incident_id == incident_id)
-        .one()
-    )
+    return db_session.query(Conference).filter(Conference.incident_id == incident_id).one()
 
 
 def get_all(*, db_session):

tests/conference/test_conference_service.py

@@ -0,0 +1,85 @@
+import pytest
+
+
+def test_conference_create(session):
+    from dispatch.conference.service import create
+    from dispatch.conference.models import ConferenceCreate
+
+    resource_id = "000000"
+    resource_type = "resourcetype"
+    weblink = "https://www.example.com"
+    conference_id = "12345"
+    conference_challenge = "a0v0a0v9a"
+
+    conference_in = ConferenceCreate(
+        resource_id=resource_id,
+        resource_type=resource_type,
+        weblink=weblink,
+        conference_id=conference_id,
+        conference_challenge=conference_challenge,
+    )
+    conference = create(db_session=session, conference_in=conference_in)
+    assert conference
+    assert conference.resource_id == "000000"
+    assert conference.resource_type == "resourcetype"
+    assert conference.weblink == "https://www.example.com"
+    assert conference.conference_id == "12345"
+    assert conference.conference_challenge == "a0v0a0v9a"
+
+
+def test_conference_get(session, conference):
+    from dispatch.conference.service import get
+
+    test_conference = get(db_session=session, conference_id=conference.id)
+    assert test_conference.id == conference.id
+    assert test_conference.conference_challenge == conference.conference_challenge
+
+
+def test_conference_get_by_resource_id(session, conference):
+    from dispatch.conference.service import get_by_resource_id
+
+    test_conference = get_by_resource_id(db_session=session, resource_id=conference.resource_id)
+
+    assert test_conference.resource_id == conference.resource_id
+    assert test_conference.conference_challenge == conference.conference_challenge
+
+
+def test_conference_get_by_resource_type(session, conference):
+    """The service method returns a list of conferences that match a given resource type. We'll test
+    to ensure that the first and last items returned match the desired resource type."""
+    from dispatch.conference.service import get_by_resource_type
+
+    conferences = get_by_resource_type(db_session=session, resource_type=conference.resource_type)
+
+    assert conferences[0].resource_type == conference.resource_type
+    assert conferences[-1].resource_type == conference.resource_type
+
+
+def test_conference_get_by_conference_id(session, conference):
+    from dispatch.conference.service import get_by_conference_id
+
+    test_conference = get_by_conference_id(session, conference.conference_id)
+
+    assert test_conference.conference_id == conference.conference_id
+    assert test_conference.conference_challenge == conference.conference_challenge
+
+
+def test_conference_get_by_incident_id(session, conference):
+    from dispatch.conference.service import get_by_incident_id
+
+    test_conference = get_by_incident_id(db_session=session, incident_id=conference.incident.id)
+
+    assert test_conference.incident.id == conference.incident.id
+    assert test_conference.conference_challenge == conference.conference_challenge
+
+
+def test_conference_get_all(session, conferences):
+    """The test should not rely on the conferences created earlier, to pass.
+    Therefore, we pass "conferences" as an argument, to manually create several in the DB.
+    """
+
+    from dispatch.conference.service import get_all
+
+    test_conferences = get_all(db_session=session).all()
+
+    assert len(test_conferences) > 1

tests/conftest.py

@@ -28,6 +28,7 @@
 from dispatch.database import Base, engine, SessionLocal
 
 from .factories import (
+    ConferenceFactory,
     ConversationFactory,
     DefinitionFactory,
     DocumentFactory,
@@ -70,7 +71,7 @@ def pytest_runtest_makereport(item, call):
             parent._previousfailed = item
 
 
-@pytest.yield_fixture(scope="session")
+@pytest.fixture(scope="session")
 def testapp():
     # we only want to use test plugins so unregister everybody else
     from dispatch.plugins.base import unregister, plugins
@@ -82,7 +83,7 @@ def testapp():
     yield app
 
 
-@pytest.yield_fixture(scope="session", autouse=True)
+@pytest.fixture(scope="session", autouse=True)
 def db():
     if database_exists(str(config.SQLALCHEMY_DATABASE_URI)):
         drop_database(str(config.SQLALCHEMY_DATABASE_URI))
@@ -94,7 +95,7 @@ def db():
     drop_database(str(config.SQLALCHEMY_DATABASE_URI))
 
 
-@pytest.yield_fixture(scope="function")
+@pytest.fixture(scope="function")
 def session(db):
     """
     Creates a new database session with (with working transaction)
@@ -105,7 +106,7 @@ def session(db):
     db.rollback()
 
 
-@pytest.yield_fixture(scope="function")
+@pytest.fixture(scope="function")
 def client(testapp, session, client):
     yield TestClient(testapp)
 
@@ -232,6 +233,16 @@ def Tag(session):
     return TagFactory()
 
 
+@pytest.fixture
+def conference(session):
+    return ConferenceFactory()
+
+
+@pytest.fixture
+def conferences(session):
+    return [ConferenceFactory(), ConferenceFactory(), ConferenceFactory()]
+
+
 @pytest.fixture
 def conversation(session):
     return ConversationFactory()

tests/factories.py

@@ -10,6 +10,7 @@
 from dispatch.database import SessionLocal
 
 from dispatch.team.models import TeamContact
+from dispatch.conference.models import Conference
 from dispatch.conversation.models import Conversation
 from dispatch.definition.models import Definition
 from dispatch.document.models import Document
@@ -621,6 +622,7 @@ class Meta:
 class IncidentFactory(BaseFactory):
     """Incident Factory."""
 
+    id = Sequence(lambda n: f'1{n}')
     title = FuzzyText()
     description = FuzzyText()
     status = FuzzyChoice(["Active", "Stable", "Closed"])
@@ -669,3 +671,14 @@ def individual_contact(self, create, extracted, **kwargs):
 
         if extracted:
             self.individual_contact_id = extracted.id
+
+
+class ConferenceFactory(ResourceBaseFactory):
+    """Conference Factory."""
+
+    class Meta:
+        model = Conference
+
+    conference_id = Sequence(lambda n: f"conference{n}")
+    conference_challenge = FuzzyText()
+    incident = SubFactory(IncidentFactory)