Tests: self.assertRaises -> with self.assertRaises

Change the instances of "self.assertRaises" to "with self.assertRaises" as using "self.assertRaises" can lead to long statements separated to multiline expressions as pointed out by Jussi here: #1658 (comment) On another hand "with self.assertRaises()" looks a lot better: https://github.com/theupdateframework/python-tuf/blob/589ed9e0d48aad9acaea912f409e1445d5913416/tests/test_api.py#L131 Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
theupdateframework · Nov 10, 2021 · 3c80c5b · 3c80c5b
1 parent 0088ebd
commit 3c80c5b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 48 deletions.
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -613,38 +613,26 @@ def test_length_and_hash_validation(self):
             # test exceptions
             expected_length = snapshot_metafile.length
             snapshot_metafile.length = 2345
-            self.assertRaises(
-                exceptions.LengthOrHashMismatchError,
-                snapshot_metafile.verify_length_and_hashes,
-                data,
-            )
+            with self.assertRaises(exceptions.LengthOrHashMismatchError):
+                snapshot_metafile.verify_length_and_hashes(data)
 
             snapshot_metafile.length = expected_length
             snapshot_metafile.hashes = {"sha256": "incorrecthash"}
-            self.assertRaises(
-                exceptions.LengthOrHashMismatchError,
-                snapshot_metafile.verify_length_and_hashes,
-                data,
-            )
+            with self.assertRaises(exceptions.LengthOrHashMismatchError):
+                snapshot_metafile.verify_length_and_hashes(data)
 
             snapshot_metafile.hashes = {
                 "unsupported-alg": "8f88e2ba48b412c3843e9bb26e1b6f8fc9e98aceb0fbaa97ba37b4c98717d7ab"
             }
-            self.assertRaises(
-                exceptions.LengthOrHashMismatchError,
-                snapshot_metafile.verify_length_and_hashes,
-                data,
-            )
+            with self.assertRaises(exceptions.LengthOrHashMismatchError):
+                snapshot_metafile.verify_length_and_hashes(data)
 
             # Test wrong algorithm format (sslib.FormatError)
             snapshot_metafile.hashes = {
                 256: "8f88e2ba48b412c3843e9bb26e1b6f8fc9e98aceb0fbaa97ba37b4c98717d7ab"
             }
-            self.assertRaises(
-                exceptions.LengthOrHashMismatchError,
-                snapshot_metafile.verify_length_and_hashes,
-                data,
-            )
+            with self.assertRaises(exceptions.LengthOrHashMismatchError):
+                snapshot_metafile.verify_length_and_hashes(data)
 
             # test optional length and hashes
             snapshot_metafile.length = None
@@ -663,19 +651,13 @@ def test_length_and_hash_validation(self):
             # test exceptions
             expected_length = file1_targetfile.length
             file1_targetfile.length = 2345
-            self.assertRaises(
-                exceptions.LengthOrHashMismatchError,
-                file1_targetfile.verify_length_and_hashes,
-                file1,
-            )
+            with self.assertRaises(exceptions.LengthOrHashMismatchError):
+                file1_targetfile.verify_length_and_hashes(file1)
 
             file1_targetfile.length = expected_length
             file1_targetfile.hashes = {"sha256": "incorrecthash"}
-            self.assertRaises(
-                exceptions.LengthOrHashMismatchError,
-                file1_targetfile.verify_length_and_hashes,
-                file1,
-            )
+            with self.assertRaises(exceptions.LengthOrHashMismatchError):
+                file1_targetfile.verify_length_and_hashes(file1)
 
     def test_targetfile_from_file(self):
         # Test with an existing file and valid hash algorithm
@@ -689,23 +671,15 @@ def test_targetfile_from_file(self):
 
         # Test with a non-existing file
         file_path = os.path.join(self.repo_dir, "targets", "file123.txt")
-        self.assertRaises(
-            FileNotFoundError,
-            TargetFile.from_file,
-            file_path,
-            file_path,
-            [sslib_hash.DEFAULT_HASH_ALGORITHM],
-        )
+        with self.assertRaises(FileNotFoundError):
+            TargetFile.from_file(
+                file_path, file_path, [sslib_hash.DEFAULT_HASH_ALGORITHM]
+            )
 
         # Test with an unsupported algorithm
         file_path = os.path.join(self.repo_dir, "targets", "file1.txt")
-        self.assertRaises(
-            exceptions.UnsupportedAlgorithmError,
-            TargetFile.from_file,
-            file_path,
-            file_path,
-            ["123"],
-        )
+        with self.assertRaises(exceptions.UnsupportedAlgorithmError):
+            TargetFile.from_file(file_path, file_path, ["123"])
 
     def test_targetfile_from_data(self):
         data = b"Inline test content"

diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -110,12 +110,12 @@ def test_cleanup(self):
 
 
   def test_server_exit_before_timeout(self):
-    self.assertRaises(utils.TestServerProcessError, utils.TestServerProcess,
-        logger, server='non_existing_server.py')
+    with self.assertRaises(utils.TestServerProcessError):
+      utils.TestServerProcess(logger, server='non_existing_server.py')
 
     # Test starting a server which immediately exits."
-    self.assertRaises(utils.TestServerProcessError, utils.TestServerProcess,
-        logger, server='fast_server_exit.py')
+    with self.assertRaises(utils.TestServerProcessError):
+      utils.TestServerProcess(logger, server='fast_server_exit.py')
 
 
 if __name__ == '__main__':