Update tests and methods to target Documents folder

Author: Tracy-Walker

modules/page_object_about_pages.py

@@ -179,14 +179,17 @@ def check_logins_present(
         else:
             assert expected_logins == actual_logins
 
-    def remove_password_csv(self, home_folder):
-        # Delete password.csv, if there is one in test location
-        if self.sys_platform == "Linux":
-            downloads_folder = os.getcwd()
-        else:
-            downloads_folder = os.path.join(home_folder, "Downloads")
-        passwords_csv = os.path.join(downloads_folder, "passwords.csv")
-        for file in os.listdir(downloads_folder):
+    def get_documents_dir(self) -> str:
+        # Return full path to Documents directory
+        home = os.path.expanduser("~")
+        export_dir = os.path.join(home, "Documents")
+        return export_dir
+
+    def remove_password_csv(self):
+        # Delete password.csv, if there is one in the export location
+        documents_dir = self.get_documents_dir()
+        passwords_csv = os.path.join(documents_dir, "passwords.csv")
+        for file in os.listdir(documents_dir):
             delete_files_regex = re.compile(r"\bpasswords.csv\b")
             if delete_files_regex.match(file):
                 os.remove(passwords_csv)

tests/password_manager/test_password_csv_correctness.py

@@ -22,15 +22,15 @@ def test_case():
 @pytest.mark.headed
 def test_password_csv_correctness(driver_and_saved_logins, home_folder, sys_platform):
     """
-    C2241522: Check that password.csv displays the correct information
+    C2241522: Verify than an exported password.csv file displays the correct information
     """
     # Initializing objects
     (driver, usernames, logins) = driver_and_saved_logins
     about_logins = AboutLogins(driver)
     keyboard = Controller()
 
-    # Ensure the Downloads folder doesn't contain a passwords.csv file
-    about_logins.remove_password_csv(home_folder)
+    # Ensure the export target folder doesn't contain a passwords.csv file
+    about_logins.remove_password_csv()
 
     # Click on buttons to export passwords
     about_logins.open()
@@ -42,20 +42,17 @@ def test_password_csv_correctness(driver_and_saved_logins, home_folder, sys_plat
     time.sleep(5)
     keyboard.tap(Key.enter)
 
-    # Verify that the file exists
-    if sys_platform == "Linux":
-        downloads_folder = os.getcwd()
-    else:
-        downloads_folder = os.path.join(home_folder, "Downloads")
-    passwords_csv = os.path.join(downloads_folder, "passwords.csv")
-    about_logins.wait.until(lambda _: os.path.exists(passwords_csv))
+    # Verify the exported csv file is present in the target folder
+    documents_directory = about_logins.get_documents_dir()
+    csv_file = os.path.join(documents_directory, "passwords.csv")
+    about_logins.wait.until(lambda _: os.path.exists(csv_file))
 
     # Verify the results
     guid_pattern = re.compile(
         r"{[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}}"
     )
     time_pattern = re.compile(r"[0-9]{10}")
-    with open(passwords_csv) as pw:
+    with open(csv_file) as pw:
         reader = csv.DictReader(pw)
         actual_logins = {}
         for row in reader:
@@ -69,4 +66,4 @@ def test_password_csv_correctness(driver_and_saved_logins, home_folder, sys_plat
     about_logins.check_logins_present(actual_logins, logins)
 
     # Delete the password.csv created
-    about_logins.remove_password_csv(home_folder)
+    about_logins.remove_password_csv()

tests/password_manager/test_password_csv_export.py

@@ -22,15 +22,15 @@ def test_password_csv_export(
     driver_and_saved_logins, home_folder, sys_platform, opt_ci
 ):
     """
-    C2241521: Check that password.csv can be downloaded from about:logins
+    C2241521: Verify that a password.csv file can be exported from about:logins
     """
     # Initializing objects
     (driver, usernames, logins) = driver_and_saved_logins
     about_logins = AboutLogins(driver)
     keyboard = Controller()
 
-    # Ensure the Downloads folder doesn't contain a passwords.csv file
-    about_logins.remove_password_csv(home_folder)
+    # Ensure the export target folder doesn't contain a passwords.csv file
+    about_logins.remove_password_csv()
 
     # Click on buttons to export passwords
     about_logins.open()
@@ -42,13 +42,10 @@ def test_password_csv_export(
     time.sleep(5)
     keyboard.tap(Key.enter)
 
-    # Verify that the file exists
-    if sys_platform == "Linux":
-        downloads_folder = os.getcwd()
-    else:
-        downloads_folder = os.path.join(home_folder, "Downloads")
-    passwords_csv = os.path.join(downloads_folder, "passwords.csv")
-    about_logins.wait.until(lambda _: os.path.exists(passwords_csv))
+    # Verify the exported csv file is present in the target folder
+    documents_directory = about_logins.get_documents_dir()
+    csv_file = os.path.join(documents_directory, "passwords.csv")
+    about_logins.wait.until(lambda _: os.path.exists(csv_file))
 
     # Delete the password.csv created
-    about_logins.remove_password_csv(home_folder)
+    about_logins.remove_password_csv()