pylint-cp-st

Author: Ritesh-Microsoft

tests/e2e-test/base/base.py

@@ -1,10 +1,38 @@
+"""
+Base page module providing common functionality for all page objects.
+"""
+
+
 class BasePage:
+    """Base class for all page objects with common methods."""
+
     def __init__(self, page):
+        """
+        Initialize the BasePage with a Playwright page instance.
+
+        Args:
+            page: Playwright page object
+        """
         self.page = page
 
     def scroll_into_view(self, locator):
+        """
+        Scroll the last element matching the locator into view.
+
+        Args:
+            locator: Playwright locator object
+        """
         reference_list = locator
         locator.nth(reference_list.count() - 1).scroll_into_view_if_needed()
 
     def is_visible(self, locator):
-        locator.is_visible()
+        """
+        Check if an element is visible on the page.
+
+        Args:
+            locator: Playwright locator object
+
+        Returns:
+            bool: True if visible, False otherwise
+        """
+        return locator.is_visible()

tests/e2e-test/config/constants.py

@@ -1,8 +1,12 @@
+"""
+Configuration constants module for test environment settings.
+"""
+
 import os
 
 from dotenv import load_dotenv
 
 load_dotenv()
 URL = os.getenv("url")
-if URL.endswith("/"):
+if URL and URL.endswith("/"):
     URL = URL[:-1]

tests/e2e-test/pages/HomePage.py

@@ -1,3 +1,7 @@
+"""
+Home page module for Content Processing Solution Accelerator.
+"""
+
 import os.path
 import logging
 
@@ -8,7 +12,11 @@
 
 
 class HomePage(BasePage):
-    #HOMEPAGE
+    """
+    Home page object containing all locators and methods for interacting
+    with the Content Processing home page.
+    """
+    # HOMEPAGE
     PROCESSING_QUEUE = "//span[normalize-space()='Processing Queue']"
     OUTPUT_REVIEW = "//span[normalize-space()='Output Review']"
     SOURCE_DOC = "//span[normalize-space()='Source Document']"
@@ -114,6 +122,13 @@ class HomePage(BasePage):
     )
 
     def __init__(self, page):
+        """
+        Initialize the HomePage.
+
+        Args:
+            page: Playwright page object
+        """
+        super().__init__(page)
         self.page = page
 
     def validate_home_page(self):

tests/e2e-test/pages/loginPage.py

@@ -1,7 +1,12 @@
+"""
+Login page module for authentication functionality.
+"""
+
 from base.base import BasePage
 
 
 class LoginPage(BasePage):
+    """Login page object with authentication methods."""
 
     EMAIL_TEXT_BOX = "//input[@type='email']"
     NEXT_BUTTON = "//input[@type='submit']"
@@ -11,9 +16,23 @@ class LoginPage(BasePage):
     PERMISSION_ACCEPT_BUTTON = "//input[@type='submit']"
 
     def __init__(self, page):
+        """
+        Initialize the LoginPage.
+
+        Args:
+            page: Playwright page object
+        """
+        super().__init__(page)
         self.page = page
 
     def authenticate(self, username, password):
+        """
+        Authenticate user with username and password.
+
+        Args:
+            username: User email address
+            password: User password
+        """
         # login with username and password in web url
         self.page.locator(self.EMAIL_TEXT_BOX).fill(username)
         self.page.locator(self.NEXT_BUTTON).click()

tests/e2e-test/tests/conftest.py

@@ -6,7 +6,6 @@
 import atexit
 import logging
 from pathlib import Path
-from venv import logger
 
 import pytest
 from bs4 import BeautifulSoup
@@ -17,6 +16,9 @@
 # Global dictionary to store log streams for each test
 LOG_STREAMS = {}
 
+# Get logger for this module
+logger = logging.getLogger(__name__)
+
 
 @pytest.fixture(scope="session")
 def login_logout():
@@ -115,9 +117,10 @@ def rename_duration_column():
     for th in headers:
         if th.text.strip() == "Duration":
             th.string = "Execution Time"
+            logger.info("Renamed 'Duration' column to 'Execution Time'")
             break
     else:
-        print("'Duration' column not found in report.")
+        logger.info("'Duration' column not found in report.")
 
     with report_path.open("w", encoding="utf-8") as file:
         file.write(str(soup))

tests/e2e-test/tests/test_contentProcessing_gp_tc.py

@@ -1,19 +1,14 @@
+"""
+Test module for Content Processing Solution Accelerator end-to-end tests.
+"""
+
 import logging
-import time
 import pytest
 from pages.HomePage import HomePage
 
 logger = logging.getLogger(__name__)
 
 
-def _timed_refresh(home):
-    """Refresh and wait for processing to complete with timing."""
-    start = time.time()
-    home.refresh()
-    end = time.time()
-    logger.info(f"Refresh process took {end - start:.2f} seconds")
-
-
 def test_content_processing_golden_path(login_logout, request):
     """
     Content Processing - Validate Golden path works as expected
@@ -48,7 +43,7 @@ def test_content_processing_golden_path(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -69,7 +64,7 @@ def test_content_processing_sections_display(login_logout, request):
     try:
         home.validate_home_page()
         logger.info("Test passed: All sections displayed properly")
-    except Exception:
+    except Exception:  # pylint: disable=broad-exception-caught
         logger.error("Test failed: All sections display validation", exc_info=True)
         raise
 
@@ -99,7 +94,7 @@ def test_content_processing_file_upload(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -128,7 +123,7 @@ def test_content_processing_refresh_screen(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -163,7 +158,7 @@ def test_content_processing_schema_validation(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -192,7 +187,7 @@ def test_content_processing_import_without_schema(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -221,7 +216,7 @@ def test_content_processing_delete_file(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -253,7 +248,7 @@ def test_content_processing_search_functionality(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -282,7 +277,7 @@ def test_content_processing_collapsible_panels(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -311,7 +306,7 @@ def test_content_processing_api_documentation(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise
 
@@ -343,7 +338,7 @@ def test_content_processing_expandable_process_steps(login_logout, request):
         try:
             action()
             logger.info(f"Step passed: {description}")
-        except Exception:
+        except Exception:  # pylint: disable=broad-exception-caught
             logger.error(f"Step failed: {description}", exc_info=True)
             raise