Refactor test modules

Author: Kirandawadi

sde_collections/tests/frontend/base.py

@@ -1,135 +1,50 @@
 import shutil
-import subprocess
 
 import pytest
-from django.contrib.auth import get_user_model
 from django.contrib.staticfiles.testing import StaticLiveServerTestCase
 from selenium import webdriver
 from selenium.webdriver.chrome.options import Options
 from selenium.webdriver.chrome.service import Service
-from selenium.webdriver.common.by import By
-from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.support.ui import WebDriverWait
 
+from .mixins import AuthenticationMixin
 
-class BaseTestCase(StaticLiveServerTestCase):
+
+class BaseTestCase(StaticLiveServerTestCase, AuthenticationMixin):
     """Base class for all frontend tests using Selenium."""
 
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
 
-        # Verify ChromeDriver is available
+        # Verify ChromeDriver and Chromium are available
         chromedriver_path = shutil.which("chromedriver")
+        chromium_path = shutil.which("chromium")
+
         if not chromedriver_path:
             pytest.fail("ChromeDriver not found. Please ensure chromium-driver is installed.")
+        if not chromium_path:
+            pytest.fail("Chromium not found. Please ensure chromium is installed.")
 
-        # # Set up Chrome options
+        # Set up Chrome options
         chrome_options = Options()
         chrome_options.add_argument("--headless")
         chrome_options.add_argument("--no-sandbox")
         chrome_options.add_argument("--disable-dev-shm-usage")
-        chrome_options.binary_location = "/usr/bin/chromium"
+        chrome_options.binary_location = chromium_path
 
         try:
-            # Create service with explicit path
-            service = Service(executable_path=chromedriver_path, log_path="/tmp/chromedriver.log")
-
-            # Initialize WebDriver with service and options
+            service = Service(executable_path=chromedriver_path)
             cls.driver = webdriver.Chrome(service=service, options=chrome_options)
-
             cls.driver.set_window_size(1920, 1080)
             cls.driver.implicitly_wait(10)
             cls.wait = WebDriverWait(cls.driver, 10)
 
         except Exception as e:
-            # Print debugging information
-            subprocess.run(["which", "chromium"])
-            subprocess.run(["which", "chromedriver"])
-            subprocess.run(["chromium", "--version"])
-            subprocess.run(["chromedriver", "--version"])
             pytest.fail(f"Failed to initialize ChromeDriver: {str(e)}")
 
     @classmethod
     def tearDownClass(cls):
         if hasattr(cls, "driver"):
             cls.driver.quit()
         super().tearDownClass()
-
-    def setUp(self):
-        """Set up test case."""
-        super().setUp()
-        # Add any additional setup here
-
-    def create_test_user(self, username="test_user", password="test_password123", **kwargs):
-        """Create a test user for login testing."""
-        User = get_user_model()
-
-        # Delete user if it already exists
-        User.objects.filter(username=username).delete()
-
-        user_data = {
-            "username": username,
-            "is_active": True,
-            "is_staff": True,  # Ensure user is staff
-            "is_superuser": False,  # Ensure user is superuser
-        }
-        user_data.update(kwargs)
-
-        user = User.objects.create_user(**user_data)
-        user.set_password(password)
-        user.save()
-
-        # Verify user was created correctly
-        print(f"\nCreated user: {username}")
-        print(f"Is active: {user.is_active}")
-        print(f"Is staff: {user.is_staff}")
-        print(f"Is superuser: {user.is_superuser}")
-
-        return user, password
-
-    def login(self, username="test_user", password="test_password123"):
-        """
-        Login helper method.
-        Returns True if login successful, False otherwise.
-        """
-        # Navigate to login page
-        self.driver.get(f"{self.live_server_url}/accounts/login/")
-
-        try:
-            # Wait for and fill username
-            username_input = self.wait.until(EC.presence_of_element_located((By.NAME, "login")))
-            username_input.send_keys(username)
-
-            # Fill password
-            password_input = self.driver.find_element(By.NAME, "password")
-            password_input.send_keys(password)
-
-            # Find and click the login button
-            login_button = self.driver.find_element(By.CSS_SELECTOR, "button[type='submit']")
-            login_button.click()
-
-            # Wait for successful login by checking for redirect
-            self.wait.until(EC.url_changes("/accounts/login/"))
-
-            # Print debug information
-            print(f"Current URL after login: {self.driver.current_url}")
-            return True
-
-        except Exception as e:
-            print(f"Login failed: {str(e)}")
-            return False
-
-    def logout(self):
-        """Logout helper method."""
-        try:
-            # Click logout link/button (adjust selector based on your UI)
-            logout_link = self.driver.find_element(By.CSS_SELECTOR, "a[href*='logout']")
-            logout_link.click()
-
-            # Wait for redirect to login page
-            self.wait.until(EC.presence_of_element_located((By.NAME, "username")))
-            return True
-        except Exception as e:
-            print(f"Logout failed: {str(e)}")
-            return False

sde_collections/tests/frontend/mixins.py

@@ -0,0 +1,55 @@
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support import expected_conditions as EC
+
+from ..factories import UserFactory
+
+
+class AuthenticationMixin:
+    """Mixin for authentication-related test methods."""
+
+    def create_test_user(self, username="test_user", password="test_password123", **kwargs):
+        """Create a test user using UserFactory."""
+        # Delete user if it already exists
+        UserFactory._meta.model.objects.filter(username=username).delete()
+
+        user = UserFactory(username=username, is_active=True, **kwargs)
+        user.set_password(password)
+        user.save()
+
+        return user, password
+
+    def login(self, username="test_user", password="test_password123"):
+        """
+        Login helper method.
+        Returns True if login successful, False otherwise.
+        """
+        self.driver.get(f"{self.live_server_url}/accounts/login/")
+
+        try:
+            username_input = self.wait.until(EC.presence_of_element_located((By.NAME, "login")))
+            username_input.send_keys(username)
+
+            password_input = self.driver.find_element(By.NAME, "password")
+            password_input.send_keys(password)
+
+            login_button = self.driver.find_element(By.CSS_SELECTOR, "button[type='submit']")
+            login_button.click()
+
+            self.wait.until(EC.title_is("Collections | COSMOS"))
+            return True
+
+        except Exception as e:
+            print(f"Login failed: {str(e)}")
+            return False
+
+    def logout(self):
+        """Logout helper method."""
+        try:
+            logout_link = self.driver.find_element(By.CSS_SELECTOR, "a[href='/accounts/logout/']")
+            self.driver.execute_script("arguments[0].click();", logout_link)
+
+            self.wait.until(EC.presence_of_element_located((By.NAME, "login")))
+            return True
+        except Exception as e:
+            print(f"Logout failed: {str(e)}")
+            return False

sde_collections/tests/frontend/test_auth.py

@@ -1,3 +1,5 @@
+from selenium.webdriver.common.by import By
+
 from .base import BaseTestCase
 
 
@@ -6,52 +8,49 @@ class TestAuthentication(BaseTestCase):
 
     def setUp(self):
         super().setUp()
-        self.test_username = "test_user"
-        self.test_password = "test_password123"
-        self.user, _ = self.create_test_user(username=self.test_username, password=self.test_password)
+        # Create test user with factory
+        self.user, self.password = self.create_test_user(
+            username="test_user", password="test_password123", is_staff=True
+        )
 
     def test_successful_login(self):
         """Test successful login process."""
         # Attempt login
-        login_success = self.login(self.test_username, self.test_password)
-        assert login_success, "Login should be successful"
+        login_success = self.login(self.user.username, self.password)
+        assert login_success, "Login Failed"
 
-        # Verify we're on the dashboard or home page
-        assert "Welcome back!" in self.driver.page_source
+        # Verify successful login by checking welcome message
+        assert "Welcome back!" in self.driver.page_source, "Welcome message not found"
 
-        # print(self.driver.page_source)
+    def test_failed_login(self):
+        """Test login failure with incorrect credentials."""
+        # Attempt login with wrong password
+        login_success = self.login(self.user.username, "wrong_password")
+        assert not login_success, "Login should fail with incorrect password"
 
-        # # Verify user menu is present
-        # user_menu = self.wait.until(
-        #     EC.presence_of_element_located((By.CLASS_NAME, "user-menu"))
-        # )
-        # assert self.test_username in user_menu.text
+        # Verify we're still on login page
+        assert "/accounts/login/" in self.driver.current_url, "Should remain on login page"
 
-    # def test_failed_login(self):
-    #     """Test login failure with incorrect credentials."""
-    #     login_success = self.login(self.test_username, "wrong_password")
-    #     assert not login_success, "Login should fail with incorrect password"
+        # Verify error message is displayed
+        error_message = (self.driver.find_element(By.CLASS_NAME, "alert")).text
+        assert "The username and/or password you specified are not correct" in error_message, "Error message not found"
 
-    #     # Verify error message
-    #     error_message = self.wait.until(
-    #         EC.presence_of_element_located((By.CLASS_NAME, "alert-error"))
-    #     )
-    #     assert "Please enter a correct username and password" in error_message.text
+    def test_logout(self):
+        """Test logout functionality."""
+        # First login
+        login_success = self.login(self.user.username, self.password)
+        assert login_success, "Initial login failed"
 
-    # def test_logout(self):
-    #     """Test logout functionality."""
-    #     # First login
-    #     login_success = self.login(self.test_username, self.test_password)
-    #     assert login_success, "Login should be successful"
+        # Verify we're logged in
+        assert "Welcome back!" in self.driver.page_source, "Not properly logged in"
 
-    #     # Then logout
-    #     logout_success = self.logout()
-    #     assert logout_success, "Logout should be successful"
+        # Perform logout
+        logout_success = self.logout()
+        assert logout_success, "Logout failed"
 
-    #     # Verify we're back at login page
-    #     assert "login" in self.driver.current_url.lower()
+        # Verify redirect to login page
+        assert "/accounts/login/" in self.driver.current_url, "Should redirect to login page after logout"
 
     def tearDown(self):
         """Clean up after each test."""
-        self.user.delete()
         super().tearDown()

sde_collections/tests/frontend/test_collections.py

@@ -1,7 +1,9 @@
+# docker-compose -f local.yml run --rm django pytest -s sde_collections/tests/frontend/test_collections.py
+
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support import expected_conditions as EC
 
-from ..factories import CollectionFactory, UserFactory
+from ..factories import CollectionFactory
 from .base import BaseTestCase
 
 
@@ -11,45 +13,27 @@ class TestCollections(BaseTestCase):
     def setUp(self):
         """Set up test data."""
         super().setUp()
-        # Create test user and collections
-        self.user = UserFactory(is_staff=True)
-        self.user.set_password("test_password123")
-        self.user.save()
+        self.user, self.password = self.create_test_user(is_staff=True)
 
         # Create 3 test collections
         self.collections = [CollectionFactory(curated_by=self.user) for _ in range(3)]
-        # Store collection names for verification
         self.collection_names = [collection.name for collection in self.collections]
 
     def test_collections_display(self):
         """Test that collections are displayed after login."""
-        # Login
-        self.login(self.user.username, "test_password123")
+        self.login(self.user.username, self.password)
 
         # Navigate to collections page
         self.driver.get(f"{self.live_server_url}/")
 
-        # Print page source for debugging
-        # print(f"\nCurrent URL: {self.driver.current_url}")
-        print(f"Page Source: {self.driver.page_source}")
-
         # Wait for specific table to load using ID
         table = self.wait.until(EC.presence_of_element_located((By.ID, "collection_table")))
-
-        # Additional verification that it's the right table
         assert "table-striped dataTable" in table.get_attribute("class")
 
-        # Print debug info
-        print(f"\nCurrent URL: {self.driver.current_url}")
-        print(f"Table HTML: {table.get_attribute('outerHTML')}")
-
-        # Get all table text
-        table_text = table.text
-
         # Verify each collection name is present
+        table_text = table.text
         for collection_name in self.collection_names:
             assert collection_name in table_text, f"Collection '{collection_name}' not found in table"
-            print(f"Found collection: {collection_name}")
 
     def tearDown(self):
         """Clean up test data."""