Added api tests

knewkarma/_project.py

@@ -6,7 +6,7 @@
 
 author: str = "Richard Mwewa"
 about_author: str = "https://about.me/rly0nheart"
-version: str = "3.3.0.0"
+version: str = "3.3.1.0"
 
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "knewkarma"
-version = "3.3.0.0"
+version = "3.3.1.0"
 description = "A Reddit Data Analysis Toolkit."
 authors = ["Richard Mwewa <rly0nheart@duck.com>"]
 readme = "README.md"
@@ -30,5 +30,11 @@ aiohttp = "*"
 rich = "*"
 rich-argparse = "*"
 
+[tool.poetry.dev-dependencies]
+pytest = "*"
+pytest-asyncio = "*"
+pytest-html = "*"
+
+
 [tool.poetry.scripts]
 knewkarma = "knewkarma._cli:execute"

pytest.ini

@@ -0,0 +1,11 @@
+[pytest]
+minversion =
+    6.0.2
+testpaths =
+    tests/
+python_files =
+    *.py
+addopts =
+    -vvv
+    --html='reports/tests.html'
+    --self-contained-html

tests/conftest.py

@@ -0,0 +1,12 @@
+# +++++++++++++++++++++++++++++++++++++++++++++++++++++ #
+
+TEST_USERNAME: str = "AutoModerator"
+TEST_USER_ID: str = "6l4z3"
+TEST_USER_CREATED_TIMESTAMP: float = 1325741068.0
+
+TEST_SUBREDDIT: str = "AskReddit"
+TEST_SUBREDDIT_ID: str = "2qh1i"
+TEST_SUBREDDIT_CREATED_TIMESTAMP: float = 1201233135.0
+
+
+# +++++++++++++++++++++++++++++++++++++++++++++++++++++ #

tests/test_api.py

@@ -0,0 +1,129 @@
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #
+
+import aiohttp
+import pytest
+
+from conftest import (
+    TEST_USERNAME,
+    TEST_SUBREDDIT,
+    TEST_USER_ID,
+    TEST_USER_CREATED_TIMESTAMP,
+    TEST_SUBREDDIT_CREATED_TIMESTAMP,
+    TEST_SUBREDDIT_ID,
+)
+from knewkarma.api import get_profile, get_posts
+
+
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #
+
+
+@pytest.mark.asyncio
+async def test_get_profile():
+    async with aiohttp.ClientSession() as session:
+        # ------------------------------------------------------------- #
+
+        user_profile: dict = await get_profile(
+            profile_type="user_profile",
+            profile_source=TEST_USERNAME,
+            session=session,
+        )
+
+        assert user_profile.get("id") == TEST_USER_ID
+        assert user_profile.get("created") == TEST_USER_CREATED_TIMESTAMP
+
+        # ------------------------------------------------------------- #
+
+        subreddit_profile: dict = await get_profile(
+            profile_type="subreddit_profile",
+            profile_source=TEST_SUBREDDIT,
+            session=session,
+        )
+
+        assert subreddit_profile.get("id") == TEST_SUBREDDIT_ID
+        assert subreddit_profile.get("created") == TEST_SUBREDDIT_CREATED_TIMESTAMP
+
+
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #
+
+
+@pytest.mark.asyncio
+async def test_get_posts():
+    async with aiohttp.ClientSession() as session:
+        # ------------------------------------------------------------- #
+
+        user_posts: list = await get_posts(
+            posts_type="user_posts",
+            posts_source=TEST_USERNAME,
+            sort="all",
+            timeframe="all",
+            limit=100,
+            session=session,
+        )
+
+        assert isinstance(user_posts, list)
+        assert len(user_posts) == 100
+        assert user_posts[0].get("data").get("author") == TEST_USERNAME
+
+        # ------------------------------------------------------------- #
+
+        subreddit_posts: list = await get_posts(
+            posts_type="subreddit_posts",
+            posts_source=TEST_SUBREDDIT,
+            sort="top",
+            timeframe="week",
+            limit=200,
+            session=session,
+        )
+
+        assert isinstance(subreddit_posts, list)
+        assert len(subreddit_posts) == 200
+        assert subreddit_posts[0].get("data").get("subreddit") == TEST_SUBREDDIT
+
+        # ------------------------------------------------------------- #
+
+        listing_posts: list = await get_posts(
+            posts_type="listing_posts",
+            posts_source="best",
+            sort="hot",
+            timeframe="month",
+            limit=10,
+            session=session,
+        )
+
+        assert isinstance(listing_posts, list)
+        assert len(listing_posts) == 10
+        assert listing_posts[0].get("data").get("subreddit") == "best"
+
+        # ------------------------------------------------------------- #
+
+        search_posts: list = await get_posts(
+            posts_type="search_posts",
+            posts_source="covid-19",
+            sort="controversial",
+            timeframe="all",
+            limit=5,
+            session=session,
+        )
+
+        assert isinstance(search_posts, list)
+        assert len(search_posts) == 5
+        assert (
+            "covid-19" in search_posts[0].get("data").get("selftext").lower()
+            or search_posts[0].get("data").get("title").lower()
+        )
+
+        # ------------------------------------------------------------- #
+
+        front_page_posts: list = await get_posts(
+            posts_type="front_page_posts",
+            sort="top",
+            timeframe="hour",
+            limit=3,
+            session=session,
+        )
+
+        assert isinstance(front_page_posts, list)
+        assert len(front_page_posts) == 3
+
+
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #