[tests] Add basic Selenium tests for Dependabot PRs (#537) by aoutifrak · Pull Request #584 · openwisp/openwisp-radius

aoutifrak · 2025-03-21T01:21:58Z

Checklist

I have read the OpenWISP Contributing Guidelines.
I have manually tested the changes proposed in this pull request.
I have written new test cases for new code and/or updated existing tests for changes to existing code.
I have updated the documentation.

Reference to Existing Issue

Closes #537.

Please open a new issue if there isn't an existing issue yet.

Description of Changes

Please describe these changes.

Screenshot

Please include any relevant screenshots.

aoutifrak

Fixed the formatting issues to comply with style guidelines.

openwisp_radius/__init__.py

codesankalp

Hi @aoutifrak, thanks for your contribution!
Please take a look at my comments below. For the Selenium tests, you can refer to other repositories like openwisp-controller to avoid duplication and follow best practices for implementing this feature.

.github/workflows/ci.yml

setup.py

tests/openwisp2/tests/config.json

tests/openwisp2/tests/selenium_test_mixins.py

tests/openwisp2/tests/user_batch_test.py

pandafy

@aoutifrak I have left suggestions to make the tests consistent with other OpenWISP modules.

.github/workflows/ci.yml

requirements-test.txt

tests/openwisp2/tests/test_selenium.py

tests/openwisp2/tests/user_batch_test.py

openwisp_radius/tests/test_selenium.py

aoutifrak

Updated test cases for batch user creation, CSV import, and user generation.
Replaced double quotes with single quotes for string literals to maintain code consistency.
Added detailed comments to explain each part of the test case logic for better understanding.
Ensured alignment with OpenWISP conventions, including the use of self.open() and self.find_element().
These changes enhance the clarity and maintainability of the tests.

aoutifrak

Added SELENIUM_HEADLESS=1 to the workflow environment variables.
Ensures Selenium tests run in headless mode in CI for consistency.
Helps prevent UI-related flakiness in automated tests.

This change improves reliability and aligns the workflow with best practices for Selenium testing in CI environments.

pandafy

Thanks for contributing! I have left some suggestions to improve the tests.

pandafy · 2025-03-25T16:13:46Z

openwisp_radius/tests/csv_files/csv_user_gen.csv

@@ -0,0 +1,3 @@
+csv-user1,password1,csvuser1@example.com,CSV1,User1
+csv-user2,password2,csvuser2@example.com,CSV2,User2
+csv-user3,password3,csvuser3@example.com,CSV3,User3


Add a blank line at end of the file. You can configure your code editor to always do that.

endline are exsiste just didn't show here

pandafy · 2025-03-25T16:16:41Z

openwisp_radius/tests/test_selenium.py

+        self.open(reverse('admin:openwisp_users_organization_add'))
+        self.find_element(By.ID, "id_name").send_keys("Test Batch")
+        self.find_element(By.CSS_SELECTOR, "input[type=submit]").click()


You can use self._get_org() helper method to create an organization here.

pandafy · 2025-03-25T16:18:55Z

openwisp_radius/tests/test_selenium.py

+
+        self.find_element(By.ID, "id_name").send_keys("Test Batch")
+        prefix_field = self.find_element(By.ID, "id_prefix")
+        prefix_field.clear()


Why are we clearing the field before entering data? Wouldn't the field be already empty?

pandafy · 2025-03-25T16:29:58Z

openwisp_radius/tests/test_selenium.py

+        self.find_element(By.ID, "id_name").send_keys("Test Batch")
+        self.find_element(By.CSS_SELECTOR, "input[type=submit]").click()
+
+        self.open("/admin/openwisp_radius/radiusbatch/add/")


Let's maintain consistent quoting style.

Also, use django.urls.reverse to get the path of the page. This applies to all the occurrences.

pandafy · 2025-04-01T16:04:33Z

openwisp_radius/tests/test_selenium.py

+class BasicTest(
+    SeleniumTestMixin, FileMixin, StaticLiveServerTestCase, TestOrganizationMixin
+):
+    browser = 'chrome'


Any specific reason for using chrome browser for this test? If not, we can remove this.

there is no reason thanks

pandafy · 2025-04-01T16:11:32Z

openwisp_radius/tests/test_selenium.py

+        # Verify that users from the CSV file were created
+        self.find_element(By.CLASS_NAME, 'field-name').click()
+        self.open(reverse('admin:openwisp_users_user_changelist'))
+        user1_link = self.wait_for_visibility(
+            By.XPATH, "//a[contains(text(), 'user1')]", 10
+        )
+        self.assertIsNotNone(user1_link)
+
+        # Ensure another user from the CSV is also created
+        user2_link = self.find_element(By.XPATH, "//a[contains(text(), 'user2')]")
+        self.assertIsNotNone(user2_link)


Verify that user were created in the database using

self.assertEqual(User.objects.filter(username='<user1>).exists(), True) self.assertEqual(User.objects.filter(username='<user2>).exists(), True)

pandafy · 2025-04-01T16:12:20Z

openwisp_radius/tests/test_selenium.py

+        # Navigate to organization creation page
+        self.open(reverse('admin:openwisp_users_organization_add'))
+        self.find_element(By.ID, 'id_name', 10).send_keys('Test Batch')
+        self.find_element(By.CSS_SELECTOR, 'input[type=submit]', 10).click()


Use self._get_org() to create organization object.

pandafy · 2025-04-01T16:14:08Z

openwisp_radius/tests/test_selenium.py

+        # Verify that users with hashed passwords are created
+        self.find_element(By.CLASS_NAME, 'field-name').click()
+        self.open(reverse('admin:openwisp_users_user_changelist'))
+        hash_user1_link = self.wait_for_visibility(
+            By.XPATH, "//a[contains(text(), 'hash_user1')]", 10
+        )
+        self.assertIsNotNone(hash_user1_link)
+
+        hash_user2_link = self.find_element(
+            By.XPATH, "//a[contains(text(), 'hash_user2')]", 10
+        )
+        self.assertIsNotNone(hash_user2_link)


You can verify that the users are created using

self.assertEqual(User.objects.filter(username='<>').exists(), Trie)

We should also verify that the password works for the user. Otherwise, this test is similar to one above it.

pandafy · 2025-04-01T16:15:41Z

openwisp_radius/tests/test_selenium.py

+        # Create an organization for the prefix user generation
+        self.open(reverse('admin:openwisp_users_organization_add'))
+        self.find_element(By.ID, 'id_name', 10).send_keys('Test Batch')
+        self.find_element(By.CSS_SELECTOR, 'input[type=submit]', 10).click()


Use self._get_org() to create organization object.

pandafy · 2025-04-01T16:16:25Z

openwisp_radius/tests/test_selenium.py

+        assert contains_ten, "No element contains the number 10"
+
+    # Test case for user generation using CSV file upload
+    def test_csv_user_generation(self):


Is this a duplicate test?

nemesifier · 2025-04-04T18:55:36Z

@aoutifrak why did you close this pull request?

nemesifier · 2025-04-04T18:57:19Z

Reopening.

aoutifrak

failed to reopen

aoutifrak commented Mar 22, 2025

View reviewed changes

nemesifier requested changes Mar 22, 2025

View reviewed changes

openwisp_radius/__init__.py Show resolved Hide resolved

aoutifrak requested a review from nemesifier March 22, 2025 17:45

codesankalp self-requested a review March 22, 2025 17:52

codesankalp requested changes Mar 22, 2025

View reviewed changes

aoutifrak closed this Mar 23, 2025

aoutifrak reopened this Mar 23, 2025

aoutifrak requested a review from codesankalp March 23, 2025 14:54

pandafy added this to OpenWISP Contributor's Board Mar 24, 2025

pandafy moved this to Needs review in OpenWISP Contributor's Board Mar 24, 2025

pandafy requested changes Mar 24, 2025

View reviewed changes

github-project-automation bot moved this from Needs review to In progress in OpenWISP Contributor's Board Mar 24, 2025

aoutifrak requested a review from pandafy March 24, 2025 23:17

codesankalp requested changes Mar 25, 2025

View reviewed changes

openwisp_radius/tests/test_selenium.py Outdated Show resolved Hide resolved

openwisp_radius/tests/test_selenium.py Outdated Show resolved Hide resolved

aoutifrak requested a review from codesankalp March 26, 2025 16:57

aoutifrak commented Mar 26, 2025

View reviewed changes

aoutifrak commented Mar 28, 2025

View reviewed changes

pandafy requested changes Apr 1, 2025

View reviewed changes

aoutifrak closed this Apr 2, 2025

github-project-automation bot moved this from In progress to Done in OpenWISP Contributor's Board Apr 2, 2025

aoutifrak commented Apr 4, 2025

View reviewed changes

aoutifrak mentioned this pull request Apr 5, 2025

[tests] Add basic Selenium tests for Dependabot PRs (#537) #589

Merged

4 tasks

Uh oh!

Conversation

aoutifrak commented Mar 21, 2025 • edited by pandafy Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Reference to Existing Issue

Description of Changes

Screenshot

Uh oh!

aoutifrak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codesankalp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pandafy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aoutifrak left a comment

Choose a reason for hiding this comment

Uh oh!

aoutifrak left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pandafy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nemesifier commented Apr 4, 2025

Uh oh!

nemesifier commented Apr 4, 2025

Uh oh!

aoutifrak left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

aoutifrak commented Mar 21, 2025 •

edited by pandafy

Loading

aoutifrak left a comment •

edited

Loading

aoutifrak left a comment •

edited

Loading