update endpoints and tests

Author: summerduck

conftest.py

@@ -4,7 +4,12 @@
 import requests
 import pytest
 import shutil
-from dotenv import load_dotenv, set_key, find_dotenv
+from typing import Generator
+from dotenv import (
+    load_dotenv,
+    set_key,
+    find_dotenv,
+)
 from endpoints import (
     GetMeme,
     PostMeme,
@@ -24,50 +29,40 @@
 
 
 def pytest_configure(config):
-    """
-    Pytest configuration setup
-    :param config:
-    :return:
-    """
+    """Pytest configuration setup"""
     __make_dir_for_logs()
 
 
 @pytest.fixture()
-def get_meme():
+def get_meme() -> GetMeme:
     """Initialize the GetMeme class"""
     return GetMeme()
 
 
 @pytest.fixture()
-def post_meme():
+def post_meme() -> PostMeme:
     """Initialize the PostMeme class"""
     return PostMeme()
 
 
 @pytest.fixture()
-def delete_meme():
+def delete_meme() -> DeleteMeme:
     """Initialize the DeleteMeme class"""
     return DeleteMeme()
 
 
 @pytest.fixture()
-def put_meme():
+def put_meme() -> PutMeme:
     """Initialize the PutMeme class"""
     return PutMeme()
 
 
-@pytest.fixture(scope="class")
-def start_testing(
-    request: pytest.FixtureRequest,
-):
-    """Fixture to start testing"""
-    logging.info(f"Start testing: {request.node.name}")
-    yield
-    logging.info(f"Testing completed: {request.node.name}")
-
-
 @pytest.fixture(scope="session")
-def generate_api_token():
+def generate_api_token() -> Generator[str, None, None]:
+    """
+    Generate an API token.
+    Check if the token is valid and update it if it is not.
+    """
     logger.info("Verifying API token")
 
     # Get the environment variables
@@ -101,7 +96,11 @@ def generate_api_token():
 
 
 @pytest.fixture(scope="function")
-def temporary_meme_cleanup(post_meme, delete_meme):
+def temporary_meme_cleanup(
+    post_meme,
+    delete_meme,
+) -> Generator[None, None, None]:
+    """Delete meme after the test is done."""
     yield
     id = post_meme.meme_id
     logger.info(
@@ -112,21 +111,22 @@ def temporary_meme_cleanup(post_meme, delete_meme):
 
 
 @pytest.fixture(scope="function")
-def temporary_meme_id(post_meme):
+def temporary_meme_id(
+    post_meme,
+) -> Generator[str, None, None]:
+    """Create a meme and return its id."""
     logger.info("------------ SetUp: Creating a new meme ------------")
     response = post_meme.post_new_meme()
     logger.info(
         "------------ SetUp: Created a new meme with id: %s ------------ ",
         response.json()["id"],
     )
+    assert response.status_code == 200
     yield response.json()["id"]
 
 
-def __make_dir_for_logs():
-    """
-    Create directory for logs. Delete exists
-    :return:
-    """
+def __make_dir_for_logs() -> None:
+    """Create directory for logs. Delete exists"""
     # Check if the directory exists before attempting to delete it
     if os.path.exists(LOG_DIR):
         # Delete the directory and its contents
@@ -137,7 +137,9 @@ def __make_dir_for_logs():
     os.makedirs(FAILED_LOG_DIR, exist_ok=True)
 
 
-def __sanitize_nodeid(node_id):
+def __sanitize_nodeid(
+    node_id: str,
+) -> str:
     """
     Cleans up and formats the test's nodeid
     (a unique identifier for each test in Pytest).
@@ -150,7 +152,9 @@ def __sanitize_nodeid(node_id):
     return node_id
 
 
-def __get_last_element(node_id):
+def __get_last_element(
+    node_id: str,
+) -> str:
     """
     Retrieves the last part of the sanitized nodeid,
     which represents the specific test name.
@@ -159,7 +163,9 @@ def __get_last_element(node_id):
 
 
 @pytest.hookimpl(tryfirst=True)
-def pytest_runtest_setup(item):
+def pytest_runtest_setup(
+    item: pytest.Item,
+) -> None:
     """Configures a unique logger for each test before it runs"""
     # Get test node ID for log naming
     test_name = __get_last_element(__sanitize_nodeid(item.nodeid))
@@ -178,7 +184,9 @@ def pytest_runtest_setup(item):
 
 
 @pytest.hookimpl(tryfirst=True)
-def pytest_runtest_logreport(report):
+def pytest_runtest_logreport(
+    report,
+) -> None:
     """Handles special processing for logs of failed tests"""
     if report.when == "call" and report.failed:
         test_name = __get_last_element(__sanitize_nodeid(report.nodeid))

data/base_meme.py

@@ -36,10 +36,6 @@ class BaseMemeData:
         # # Boundary conditions
         # "a" * XX,  # Assuming max length is XX
         # "a" * X,  # Assuming min length is X
-        # Edge cases
-        "\n",
-        "\t",
-        "\r",
     ]
 
     # "tags": ["string", "string"]
@@ -92,7 +88,7 @@ class BaseMemeData:
         {"a" * 10001: "value", "key": "b" * 10001},
         # Boundary conditions
         {f"key{i}": f"value{i}" for i in range(1000)},  # Assuming max keys = ???
-        {"a" * 51: "value", "key": "b" * 51},  # Assuming max length = ???
+        # {"a" * 51: "value", "key": "b" * 51},  # Assuming max length = ???
         # Edge cases
         {" key ": " value "},
         {"\nkey": "value", "key": "\tvalue"},

endpoints/base_endpoint.py

@@ -5,8 +5,7 @@
 from requests import Request
 from typing import Optional
 import rlogger
-
-# import requests
+import allure
 
 # Initialize logger
 logger = logging.getLogger(__name__)
@@ -102,6 +101,7 @@ def _default_headers_with_authorization(
     ) -> dict:
         return {"Authorization": f"{os.getenv('API_TOKEN')}"}
 
+    @allure.step("Verify response status code")
     def verify_response_status_code(
         self,
         status_code: int,
@@ -110,4 +110,3 @@ def verify_response_status_code(
             f"Expected status code {status_code},"
             f"but got {self.response.status_code}"
         )
-    

endpoints/delete_meme.py

@@ -12,7 +12,7 @@ class DeleteMeme(BaseEndpoint):
     def __init__(self):
         super().__init__()
 
-    @allure.step("Delete name")
+    @allure.step("Delete meme")
     def delete_meme_by_id(
         self,
         id: int,

endpoints/post_meme.py

@@ -12,7 +12,7 @@ class PostMeme(BaseEndpoint):
     def __init__(self):
         super().__init__()
 
-    @allure.step("Step name")
+    @allure.step("Post name")
     def post_new_meme(
         self,
         *,

endpoints/put_meme.py

@@ -12,7 +12,7 @@ class PutMeme(BaseEndpoint):
     def __init__(self):
         super().__init__()
 
-    @allure.step("Step name")
+    @allure.step("Put meme by ID")
     def put_meme_by_id(
         self,
         id: int,

pytest.ini

@@ -8,7 +8,8 @@ log_cli_level = INFO
 log_level = INFO
 markers =
     delete_meme
-    positive
-    negative
+    post_meme
+    get_meme
+    put_meme
 
 addopts = --alluredir=test-report

rlogger.py

@@ -1,8 +1,6 @@
 import logging
 import json
-import functools
-from requests import Request, RequestException, Response
-from urllib.parse import urlencode
+from requests import Request, Response
 
 # Initialize logger and Faker
 logger = logging.getLogger(__name__)

tests/test_delete_meme.py

@@ -2,14 +2,20 @@
 import pytest
 from data import BaseMemeData
 
-# from data import
-
 
 @allure.feature("Delete Meme")
 @pytest.mark.usefixtures("generate_api_token")
 @pytest.mark.delete_meme
 class DeleteMemeTest:
 
+    @allure.title("Delete meme successfully")
+    @allure.description(
+        """
+        Test that a meme can be successfully deleted
+        with a valid id and authorization header.
+        """
+    )
+    @allure.severity(allure.severity_level.CRITICAL)
     def test_delete_meme_successful_meme_deletion(
         self,
         delete_meme,
@@ -18,14 +24,32 @@ def test_delete_meme_successful_meme_deletion(
         delete_meme.delete_meme_by_id(temporary_meme_id)
         delete_meme.verify_response_status_code(200)
 
+    @allure.title("Delete meme created by another user")
+    @allure.description(
+        """
+        Test that a meme cannot be deleted by a user who did not create it.
+        """
+    )
+    @allure.severity(allure.severity_level.CRITICAL)
     def test_delete_meme_unsuccessful_meme_deletion_created_by_another_user(
         self,
         delete_meme,
         id=1,
     ):
+        """
+        Test that a meme cannot be deleted by a user who did not create it.
+        """
         delete_meme.delete_meme_by_id(id)
         delete_meme.verify_response_status_code(403)
 
+    @allure.title("Delete meme by not existing or invalid id")
+    @allure.description(
+        """
+        Test that a meme cannot be deleted
+        if the id is not valid or does not exist.
+        """
+    )
+    @allure.severity(allure.severity_level.CRITICAL)
     @pytest.mark.parametrize(
         "id",
         BaseMemeData.memes_not_existing_ids,
@@ -38,10 +62,17 @@ def test_delete_meme_by_not_existing_or_invalid_id(
         delete_meme.delete_meme_by_id(id)
         delete_meme.verify_response_status_code(404)
 
+    @allure.title("Delete meme without authorization header")
+    @allure.description(
+        """
+        Test that a meme cannot be deleted without an authorization header.
+        """
+    )
     @pytest.mark.parametrize(
         "headers, status_code",
         BaseMemeData.failed_auth,
     )
+    @allure.severity(allure.severity_level.CRITICAL)
     def test_delete_meme_missing_authorization_header(
         self,
         delete_meme,
@@ -50,12 +81,8 @@ def test_delete_meme_missing_authorization_header(
         temporary_meme_id,
         temporary_meme_cleanup,
     ):
+        """
+        Test that a meme cannot be deleted without an authorization header.
+        """
         delete_meme.delete_meme_by_id(temporary_meme_id, headers=headers)
         delete_meme.verify_response_status_code(status_code)
-
-    # def test_delete_all_memes_created_by_user(
-    #     self,
-    #     delete_meme,
-    # ):
-    #     for id in range(1, 1000):
-    #         delete_meme.delete_meme_by_id(id)