Refactor and clean-up Tests

- Spark to Webex Teams name changes.
- Remove unnecessary helper functions.
- Remove unnecessary classes.
- Add license headers.

Author: cmlccie

tests/api/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""WebexTeamsAPI tests.
+"""WebexTeamsAPI fixtures and tests.
 
 Copyright (c) 2016-2018 Cisco and/or its affiliates.
 
@@ -67,92 +67,111 @@ def api():
 
 # Tests
 
-class TestWebexTeamsAPI:
-    """Test the WebexTeamsAPI class code."""
+# Test creating WebexTeamsAPI objects
 
-    # Test creating WebexTeamsAPI objects
+@pytest.mark.usefixtures("unset_access_token")
+def test_create_without_an_access_token():
+    with pytest.raises(webexteamssdk.AccessTokenError):
+        webexteamssdk.WebexTeamsAPI()
 
-    @pytest.mark.usefixtures("unset_access_token")
-    def test_creating_a_new_webexteamssdk_object_without_an_access_token(self):
-        with pytest.raises(webexteamssdk.AccessTokenError):
-            webexteamssdk.WebexTeamsAPI()
 
-    @pytest.mark.usefixtures("unset_access_token")
-    def test_creating_a_new_webexteamssdk_object_via_access_token_argument(self, access_token):
-        connection_object = webexteamssdk.WebexTeamsAPI(access_token=access_token)
-        assert isinstance(connection_object, webexteamssdk.WebexTeamsAPI)
+def test_create_with_access_token_environment_variable():
+    connection_object = webexteamssdk.WebexTeamsAPI()
+    assert isinstance(connection_object, webexteamssdk.WebexTeamsAPI)
 
-    def test_creating_a_new_webexteamssdk_object_via_environment_varable(self):
-        connection_object = webexteamssdk.WebexTeamsAPI()
-        assert isinstance(connection_object, webexteamssdk.WebexTeamsAPI)
 
-    def test_default_base_url(self):
-        connection_object = webexteamssdk.WebexTeamsAPI()
-        assert connection_object.base_url == DEFAULT_BASE_URL
+@pytest.mark.usefixtures("unset_access_token")
+def test_create_with_access_token_argument(access_token):
+    connection_object = webexteamssdk.WebexTeamsAPI(
+        access_token=access_token
+    )
+    assert isinstance(connection_object, webexteamssdk.WebexTeamsAPI)
 
-    def test_custom_base_url(self):
-        custom_url = "https://custom.domain.com/v1/"
-        connection_object = webexteamssdk.WebexTeamsAPI(base_url=custom_url)
-        assert connection_object.base_url == custom_url
 
-    def test_default_single_request_timeout(self):
-        connection_object = webexteamssdk.WebexTeamsAPI()
-        assert connection_object.single_request_timeout == \
-               DEFAULT_SINGLE_REQUEST_TIMEOUT
+def test_default_base_url():
+    connection_object = webexteamssdk.WebexTeamsAPI()
+    assert connection_object.base_url == DEFAULT_BASE_URL
 
-    def test_custom_single_request_timeout(self):
-        custom_timeout = 10
-        connection_object = webexteamssdk.WebexTeamsAPI(
-                single_request_timeout=custom_timeout
-        )
-        assert connection_object.single_request_timeout == custom_timeout
 
-    def test_default_wait_on_rate_limit(self):
-        connection_object = webexteamssdk.WebexTeamsAPI()
-        assert connection_object.wait_on_rate_limit == \
-               DEFAULT_WAIT_ON_RATE_LIMIT
+def test_custom_base_url():
+    custom_url = "https://custom.domain.com/v1/"
+    connection_object = webexteamssdk.WebexTeamsAPI(base_url=custom_url)
+    assert connection_object.base_url == custom_url
 
-    def test_non_default_wait_on_rate_limit(self):
-        connection_object = webexteamssdk.WebexTeamsAPI(
-                wait_on_rate_limit=not DEFAULT_WAIT_ON_RATE_LIMIT
-        )
-        assert connection_object.wait_on_rate_limit != \
-               DEFAULT_WAIT_ON_RATE_LIMIT
 
-    # Test creation of component API objects
+def test_default_single_request_timeout():
+    connection_object = webexteamssdk.WebexTeamsAPI()
+    assert connection_object.single_request_timeout == \
+        DEFAULT_SINGLE_REQUEST_TIMEOUT
 
-    def test_access_tokens_api_object_creation(self, api):
-        assert isinstance(api.access_tokens, AccessTokensAPI)
 
-    def test_events_api_object_creation(self, api):
-        assert isinstance(api.events, EventsAPI)
+def test_custom_single_request_timeout():
+    custom_timeout = 10
+    connection_object = webexteamssdk.WebexTeamsAPI(
+        single_request_timeout=custom_timeout
+    )
+    assert connection_object.single_request_timeout == custom_timeout
 
-    def test_licenses_api_object_creation(self, api):
-        assert isinstance(api.licenses, LicensesAPI)
 
-    def test_memberships_api_object_creation(self, api):
-        assert isinstance(api.memberships, MembershipsAPI)
+def test_default_wait_on_rate_limit():
+    connection_object = webexteamssdk.WebexTeamsAPI()
+    assert connection_object.wait_on_rate_limit == \
+        DEFAULT_WAIT_ON_RATE_LIMIT
 
-    def test_messages_api_object_creation(self, api):
-        assert isinstance(api.messages, MessagesAPI)
 
-    def test_organizations_api_object_creation(self, api):
-        assert isinstance(api.organizations, OrganizationsAPI)
+def test_non_default_wait_on_rate_limit():
+    connection_object = webexteamssdk.WebexTeamsAPI(
+        wait_on_rate_limit=not DEFAULT_WAIT_ON_RATE_LIMIT
+    )
+    assert connection_object.wait_on_rate_limit != \
+        DEFAULT_WAIT_ON_RATE_LIMIT
 
-    def test_people_api_object_creation(self, api):
-        assert isinstance(api.people, PeopleAPI)
 
-    def test_roles_api_object_creation(self, api):
-        assert isinstance(api.roles, RolesAPI)
+# Test creation of component API objects
 
-    def test_rooms_api_object_creation(self, api):
-        assert isinstance(api.rooms, RoomsAPI)
+def test_access_tokens_api_object_creation(api):
+    assert isinstance(api.access_tokens, AccessTokensAPI)
 
-    def test_team_memberships_api_object_creation(self, api):
-        assert isinstance(api.team_memberships, TeamMembershipsAPI)
 
-    def test_teams_api_object_creation(self, api):
-        assert isinstance(api.teams, TeamsAPI)
+def test_events_api_object_creation(api):
+    assert isinstance(api.events, EventsAPI)
 
-    def test_webhooks_api_object_creation(self, api):
-        assert isinstance(api.webhooks, WebhooksAPI)
+
+def test_licenses_api_object_creation(api):
+    assert isinstance(api.licenses, LicensesAPI)
+
+
+def test_memberships_api_object_creation(api):
+    assert isinstance(api.memberships, MembershipsAPI)
+
+
+def test_messages_api_object_creation(api):
+    assert isinstance(api.messages, MessagesAPI)
+
+
+def test_organizations_api_object_creation(api):
+    assert isinstance(api.organizations, OrganizationsAPI)
+
+
+def test_people_api_object_creation(api):
+    assert isinstance(api.people, PeopleAPI)
+
+
+def test_roles_api_object_creation(api):
+    assert isinstance(api.roles, RolesAPI)
+
+
+def test_rooms_api_object_creation(api):
+    assert isinstance(api.rooms, RoomsAPI)
+
+
+def test_team_memberships_api_object_creation(api):
+    assert isinstance(api.team_memberships, TeamMembershipsAPI)
+
+
+def test_teams_api_object_creation(api):
+    assert isinstance(api.teams, TeamsAPI)
+
+
+def test_webhooks_api_object_creation(api):
+    assert isinstance(api.webhooks, WebhooksAPI)

tests/api/test_events.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""pytest Messages functions, fixtures and tests.
+"""WebexTeamsAPI Events API fixtures and tests.
 
 Copyright (c) 2016-2018 Cisco and/or its affiliates.
 
@@ -39,7 +39,8 @@ def are_valid_events(iterable):
     return all([is_valid_event(obj) for obj in iterable])
 
 
-# pytest Fixtures
+# Fixtures
+
 @pytest.fixture(scope="session")
 def events(api, group_room_messages, direct_messages):
     five_events = list(api.events.list()[:5])
@@ -49,56 +50,61 @@ def events(api, group_room_messages, direct_messages):
 
 # Tests
 
-class TestEventsAPI(object):
-    """Test EventsAPI methods."""
-
-    def test_list_events(self, api, events):
-        assert are_valid_events(events)
-
-    def test_list_message_events(self, api, events):
-        message_events = list(api.events.list(resource="messages")[:5])
-        assert are_valid_events(message_events)
-        assert all([event.resource == "messages" for event in message_events])
-
-    def test_list_membership_events(self, api, events):
-        membership_events = list(api.events.list(resource="memberships")[:5])
-        assert are_valid_events(membership_events)
-        assert all(
-            [event.resource == "memberships" for event in membership_events]
-        )
-
-    def test_list_events_by_type(self, api, events):
-        created_events = list(api.events.list(type="created")[:5])
-        assert are_valid_events(created_events)
-        assert all([event.type == "created" for event in created_events])
-
-    def test_list_events_by_actor_id(selfs, api, events):
-        actor_id = events[0].actorId
-        actor_events = list(api.events.list(actorId=actor_id)[:5])
-        assert are_valid_events(actor_events)
-        assert all([event.actorId == actor_id for event in actor_events])
-
-    def test_list_events_from(selfs, api, events):
-        datetime_string = min(event.created for event in events)
-        from_events = list(api.events.list(_from=datetime_string)[:5])
-        assert are_valid_events(from_events)
-
-    def test_list_events_to(selfs, api, events):
-        datetime_string = max(event.created for event in events)
-        to_events = list(api.events.list(to=datetime_string)[:5])
-        assert are_valid_events(to_events)
-
-    def test_list_events_with_paging(self, api, events):
-        page_size = 1
-        pages = 3
-        num_events = pages * page_size
-        assert len(events) >= num_events
-        events_gen = api.events.list(max=page_size)
-        events_list = list(itertools.islice(events_gen, num_events))
-        assert len(events_list) == num_events
-        assert are_valid_events(events_list)
-
-    def test_get_event_by_id(self, api, events):
-        event_id = events[0].id
-        event = api.events.get(event_id)
-        assert is_valid_event(event)
+def test_list_events(api, events):
+    assert are_valid_events(events)
+
+
+def test_list_message_events(api, events):
+    message_events = list(api.events.list(resource="messages")[:5])
+    assert are_valid_events(message_events)
+    assert all([event.resource == "messages" for event in message_events])
+
+
+def test_list_membership_events(api, events):
+    membership_events = list(api.events.list(resource="memberships")[:5])
+    assert are_valid_events(membership_events)
+    assert all(
+        [event.resource == "memberships" for event in membership_events]
+    )
+
+
+def test_list_events_by_type(api, events):
+    created_events = list(api.events.list(type="created")[:5])
+    assert are_valid_events(created_events)
+    assert all([event.type == "created" for event in created_events])
+
+
+def test_list_events_by_actor_id(api, events):
+    actor_id = events[0].actorId
+    actor_events = list(api.events.list(actorId=actor_id)[:5])
+    assert are_valid_events(actor_events)
+    assert all([event.actorId == actor_id for event in actor_events])
+
+
+def test_list_events_from(api, events):
+    datetime_string = min(event.created for event in events)
+    from_events = list(api.events.list(_from=datetime_string)[:5])
+    assert are_valid_events(from_events)
+
+
+def test_list_events_to(api, events):
+    datetime_string = max(event.created for event in events)
+    to_events = list(api.events.list(to=datetime_string)[:5])
+    assert are_valid_events(to_events)
+
+
+def test_list_events_with_paging(api, events):
+    page_size = 1
+    pages = 3
+    num_events = pages * page_size
+    assert len(events) >= num_events
+    events_gen = api.events.list(max=page_size)
+    events_list = list(itertools.islice(events_gen, num_events))
+    assert len(events_list) == num_events
+    assert are_valid_events(events_list)
+
+
+def test_get_event_by_id(api, events):
+    event_id = events[0].id
+    event = api.events.get(event_id)
+    assert is_valid_event(event)

tests/api/test_licenses.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""pytest Licenses API wrapper tests and fixtures.
+"""WebexTeamsAPI Licenses API fixtures and tests.
 
 Copyright (c) 2016-2018 Cisco and/or its affiliates.
 
@@ -29,14 +29,6 @@
 
 # Helper Functions
 
-def get_list_of_licenses(api, orgId=None, max=None):
-    return api.licenses.list(orgId=orgId, max=max)
-
-
-def get_license_by_id(api, licenseId):
-    return api.licenses.get(licenseId)
-
-
 def is_valid_license(obj):
     return isinstance(obj, webexteamssdk.License) and obj.id is not None
 
@@ -45,11 +37,11 @@ def are_valid_licenses(iterable):
     return all([is_valid_license(obj) for obj in iterable])
 
 
-# pytest Fixtures
+# Fixtures
 
 @pytest.fixture(scope="session")
-def licenses_list(api):
-    return list(get_list_of_licenses(api))
+def licenses_list(api, me):
+    return list(api.licenses.list(orgId=me.orgId))
 
 
 @pytest.fixture(scope="session")
@@ -59,24 +51,12 @@ def licenses_dict(licenses_list):
 
 # Tests
 
-class TestLicensesAPI(object):
-    """Test LicensesAPI methods."""
-
-    def test_list_licenses(self, licenses_list):
-        assert are_valid_licenses(licenses_list)
-
-    def test_list_licenses_with_paging(self, api):
-        paging_generator = get_list_of_licenses(api, max=1)
-        licenses = list(paging_generator)
-        assert len(licenses) > 1
-        assert are_valid_licenses(licenses)
+def test_list_licenses(licenses_list):
+    assert are_valid_licenses(licenses_list)
 
-    def test_get_licenses_for_organization(self, api, me):
-        licenses = list(get_list_of_licenses(api, orgId=me.orgId))
-        assert are_valid_licenses(licenses)
 
-    def test_get_license_by_id(self, api, licenses_list):
-        assert len(licenses_list) >= 1
-        license_id = licenses_list[0].id
-        license = get_license_by_id(api, licenseId=license_id)
-        assert is_valid_license(license)
+def test_get_license_details(api, licenses_list):
+    assert len(licenses_list) >= 1
+    license_id = licenses_list[0].id
+    details = api.licenses.get(license_id)
+    assert is_valid_license(details)