systemtests python-bareos: add 'list files' test

Co-authored-by: Sebastian Sura <124262655+sebsura@users.noreply.github.com>

systemtests/tests/python-bareos/etc/bareos/bareos-dir.d/fileset/NumberedFiles.conf.in

@@ -0,0 +1,11 @@
+FileSet {
+  Name = "NumberedFiles"
+  Description = "fileset to backup some numbered filesjust to backup some files"
+  Include {
+    Options {
+      Signature = XXH128
+      xattrsupport = no
+    }
+    File = "@tmpdir@/backup-data-numbered-files/"
+  }
+}

systemtests/tests/python-bareos/test-setup

@@ -15,6 +15,11 @@ export TestName="$(get_test_name "$0")"
 
 # Fill ${BackupDirectory} with data.
 setup_data
+# Extra backup data with number of files.
+mkdir -p ${tmp}/backup-data-numbered-files
+for i in `seq 1000 2000`; do
+    echo $i > ${tmp}/backup-data-numbered-files/${i}.txt
+done
 
 # Create a list of paths to backup,
 # containing only simple file types.

systemtests/tests/python-bareos/test_list_command.py

@@ -1,7 +1,7 @@
 #
 #   BAREOS - Backup Archiving REcovery Open Sourced
 #
-#   Copyright (C) 2021-2023 Bareos GmbH & Co. KG
+#   Copyright (C) 2021-2024 Bareos GmbH & Co. KG
 #
 #   This program is Free Software; you can redistribute it and/or
 #   modify it under the terms of version three of the GNU Affero General Public
@@ -40,7 +40,7 @@
 import bareos_unittest
 
 
-class PythonBareosListCommandTest(bareos_unittest.Base):
+class PythonBareosListCommandTest(bareos_unittest.Json):
     def test_list_jobs(self):
         """
         verifying `list jobs` and `llist jobs ...` outputs correct data
@@ -55,7 +55,7 @@ def test_list_jobs(self):
             port=self.director_port,
             name=username,
             password=password,
-            **self.director_extra_options
+            **self.director_extra_options,
         )
 
         director.call("run job=backup-bareos-fd yes")
@@ -332,7 +332,7 @@ def test_list_media(self):
             port=self.director_port,
             name=username,
             password=password,
-            **self.director_extra_options
+            **self.director_extra_options,
         )
 
         director.call("run job=backup-bareos-fd yes")
@@ -418,7 +418,7 @@ def test_list_pool(self):
             port=self.director_port,
             name=username,
             password=password,
-            **self.director_extra_options
+            **self.director_extra_options,
         )
 
         director.call("run job=backup-bareos-fd yes")
@@ -509,3 +509,68 @@ def test_list_pool(self):
             result["pools"][0]["poolid"],
             "3",
         )
+
+    def test_list_files(self):
+        """
+        verifying `list files` outputs correct data
+        """
+        logger = logging.getLogger()
+
+        username = self.get_operator_username()
+        password = self.get_operator_password(username)
+
+        director_json = bareos.bsock.DirectorConsoleJson(
+            address=self.director_address,
+            port=self.director_port,
+            name=username,
+            password=password,
+            **self.director_extra_options,
+        )
+
+        jobid = self.run_job(
+            director_json,
+            jobname="backup-bareos-fd",
+            level="Full",
+            extra="fileset=NumberedFiles",
+            wait=True,
+        )
+        result = director_json.call(f"list files jobid={jobid}")
+        # Before fixing https://bugs.bareos.org/view.php?id=1007 the keys could be scrambled after 100 entries.
+        filenames = result["filenames"]
+        min_files = 100
+        self.assertGreater(
+            len(filenames),
+            min_files,
+            f"More than {min_files} files are required for this test, only {len(filenames)} given.",
+        )
+
+        bad_headers = [f for f in filenames if "filename" not in f]
+        self.assertEqual(
+            bad_headers,
+            [],
+            f"Some files were not listed with the correct 'filename' header.",
+        )
+
+        filenames_json = set(f["filename"] for f in filenames)
+
+        director = bareos.bsock.DirectorConsole(
+            address=self.director_address,
+            port=self.director_port,
+            name=username,
+            password=password,
+            **self.director_extra_options,
+        )
+        result = (
+            director.call(f"list files jobid={jobid}")
+            .decode("utf-8")
+            .replace("\n ", "\n")
+        )
+        # start at the first path,
+        # skipping lines like 'Automatically selected Catalog: MyCatalog\nUsing Catalog "MyCatalog"\n'
+        start = result.find("\n/") + 1
+        filenames_plain = set(result[start:].splitlines())
+        self.assertEqual(
+            filenames_json,
+            filenames_plain,
+            "JSON result is not identical to plain (api 0) result.",
+        )