tests: Port to nose2 and unittest

The test are still using nose which has been superseeded by
nose2. Update the tests to use the nose2 and unittest.

To minimize errors in most of the porting is done using sed, e.g
's/TestNVMeIO.__init__(self)/super().setUp()/g'.

While at it also update the build system and move the test files to
the build dir. This avoids in tree exectution of the Python files
which leaves the __pycache__ dir in the source tree.

This also fixes the problem, that the config file is not found when
'meson test -C .build' is used. We have the prober dir structure for
Python and nose2 to find all resources in the build root. Furthermore,
when running the tests the output is captured in the nvmetests
dir. This dir is also created under the build root dir.

Signed-off-by: Daniel Wagner <[email protected]>

Author: igaw

Diff for: tests/README

@@ -67,10 +67,10 @@ nvmetests
        test_*.
     3. Based on the requirement one can inherit TestNVMe or TestNVMeIO
        class.
-    4. Write test precondition code into __init__. Make sure you are calling
-       super class __init__.
-    5. Write test post condition code into __del__. Make sure you are calling
-       super class __del__.
+    4. Write test precondition code into setUp. Make sure you are calling
+       super class setUp.
+    5. Write test post condition code into tearDown. Make sure you are calling
+       super class tearDown.
     6. Before writing a new function have a look into TestNVMe to see if it
        can be reused.
     7. Once testcase is ready make sure :-
@@ -83,9 +83,9 @@ nvmetests
 
 4. Running testcases with framework
 -----------------------------------
-    1. Running single testcase with nose2 :-
-       $ nose2 --verbose nvme_writezeros_test
-       $ nose2 --verbose nvme_read_write_test
+    1. Running single testcase (in the source tree) with nose2 :-
+       $ nose2 --verbose --start-dir tests nvme_writezeros_test
+       $ nose2 --verbose --start-dir tests nvme_read_write_test
 
-    2. Running all the testcases with ninja :-
+    2. Running all the testcases (in the build root directory) with ninja :-
        $ ninja test -C .build

Diff for: tests/meson.build

@@ -1,38 +1,49 @@
 # SPDX-License-Identifier: GPL-2.0-or-later
 
+infra = [
+  'config.json',
+  'nvme_test.py',
+  'nvme_test_io.py',
+  'nvme_test_logger.py',
+  'nvme_simple_template_test.py',
+]
+
 tests = [
-  'nvme_attach_detach_ns_test',
-  'nvme_compare_test',
-  'nvme_create_max_ns_test',
-  'nvme_error_log_test',
-  'nvme_flush_test',
-  'nvme_format_test',
-  'nvme_fw_log_test',
-  'nvme_get_features_test',
-  'nvme_id_ctrl_test',
-  'nvme_id_ns_test',
-  'nvme_read_write_test',
-  'nvme_simple_template_test',
-  'nvme_smart_log_test',
-  'nvme_test_io',
-  'nvme_test_logger',
-  'nvme_test',
-  'nvme_writeuncor_test',
-  'nvme_writezeros_test',
-  'nvme_copy_test',
-  'nvme_dsm_test',
-  'nvme_verify_test',
-  'nvme_lba_status_log_test',
-  'nvme_get_lba_status_test',
+  'nvme_attach_detach_ns_test.py',
+  'nvme_compare_test.py',
+  'nvme_create_max_ns_test.py',
+  'nvme_error_log_test.py',
+  'nvme_flush_test.py',
+  'nvme_format_test.py',
+  'nvme_fw_log_test.py',
+  'nvme_get_features_test.py',
+  'nvme_id_ctrl_test.py',
+  'nvme_id_ns_test.py',
+  'nvme_read_write_test.py',
+  'nvme_smart_log_test.py',
+  'nvme_writeuncor_test.py',
+  'nvme_writezeros_test.py',
+  'nvme_copy_test.py',
+  'nvme_dsm_test.py',
+  'nvme_verify_test.py',
+  'nvme_lba_status_log_test.py',
+  'nvme_get_lba_status_test.py',
 ]
 
 runtests = find_program('nose2', required : false)
 
 if runtests.found()
+  foreach file : infra + tests
+    configure_file(
+      input: file,
+      output: file,
+      copy: true)
+  endforeach
+
   foreach t : tests
-    test(t, runtests,
-         args: ['--verbose', '--start-dir', meson.current_source_dir(), t],
-         workdir: meson.current_source_dir(),
+    t_name = t.split('.')[0]
+    test(t_name, runtests,
+         args: ['--verbose', '--start-dir', meson.build_root() + '/tests', t_name],
          env: ['PATH=' + meson.build_root() + ':/usr/bin:/usr/sbin'],
          timeout: 500)
   endforeach

Diff for: tests/nvme_attach_detach_ns_test.py

@@ -31,7 +31,6 @@
 
 import time
 
-from nose.tools import assert_equal
 from nvme_test import TestNVMe
 
 
@@ -48,9 +47,9 @@ class TestNVMeAttachDetachNSCmd(TestNVMe):
               - ctrl_id : controller id.
     """
 
-    def __init__(self):
+    def setUp(self):
         """ Pre Section for TestNVMeAttachDetachNSCmd """
-        TestNVMe.__init__(self)
+        super().setUp()
         self.dps = 0
         self.flbas = 0
         self.nsze = 0x1400000
@@ -60,21 +59,21 @@ def __init__(self):
         self.delete_all_ns()
         time.sleep(1)
 
-    def __del__(self):
+    def tearDown(self):
         """
         Post Section for TestNVMeAttachDetachNSCmd
 
             - Create primary namespace.
             - Atttach it to controller.
             - Call super class's destructor.
         """
-        assert_equal(self.create_and_validate_ns(self.default_nsid,
-                                                 self.nsze,
-                                                 self.ncap,
-                                                 self.flbas,
-                                                 self.dps), 0)
+        self.assertEqual(self.create_and_validate_ns(self.default_nsid,
+                                                     self.nsze,
+                                                     self.ncap,
+                                                     self.flbas,
+                                                     self.dps), 0)
         self.attach_ns(self.ctrl_id, self.default_nsid)
-        TestNVMe.__del__(self)
+        super().tearDown()
 
     def test_attach_detach_ns(self):
         """ Testcase main """
@@ -83,11 +82,11 @@ def test_attach_detach_ns(self):
                                           self.ncap,
                                           self.flbas,
                                           self.dps)
-        assert_equal(err, 0)
-        assert_equal(self.attach_ns(self.ctrl_id, self.default_nsid), 0)
+        self.assertEqual(err, 0)
+        self.assertEqual(self.attach_ns(self.ctrl_id, self.default_nsid), 0)
 
         self.run_ns_io(self.default_nsid, 0)
 
-        assert_equal(self.detach_ns(self.ctrl_id, self.default_nsid), 0)
-        assert_equal(self.delete_and_validate_ns(self.default_nsid), 0)
+        self.assertEqual(self.detach_ns(self.ctrl_id, self.default_nsid), 0)
+        self.assertEqual(self.delete_and_validate_ns(self.default_nsid), 0)
         self.nvme_reset_ctrl()

Diff for: tests/nvme_compare_test.py

@@ -30,7 +30,6 @@
 
 """
 
-from nose.tools import assert_equal, assert_not_equal
 from nvme_test_io import TestNVMeIO
 
 
@@ -46,9 +45,9 @@ class TestNVMeCompareCmd(TestNVMeIO):
               - test_log_dir : directory for logs, temp files.
     """
 
-    def __init__(self):
+    def setUp(self):
         """ Pre Section for TestNVMeCompareCmd """
-        TestNVMeIO.__init__(self)
+        super().setUp()
         self.data_size = 1024
         self.start_block = 1023
         self.setup_log_dir(self.__class__.__name__)
@@ -57,9 +56,9 @@ def __init__(self):
         self.create_data_file(self.write_file, self.data_size, "15")
         self.create_data_file(self.compare_file, self.data_size, "25")
 
-    def __del__(self):
+    def tearDown(self):
         """ Post Section for TestNVMeCompareCmd """
-        TestNVMeIO.__del__(self)
+        super().tearDown()
 
     def nvme_compare(self, cmp_file):
         """ Wrapper for nvme compare command.
@@ -76,6 +75,6 @@ def nvme_compare(self, cmp_file):
 
     def test_nvme_compare(self):
         """ Testcase main """
-        assert_equal(self.nvme_write(), 0)
-        assert_not_equal(self.nvme_compare(self.compare_file), 0)
-        assert_equal(self.nvme_compare(self.write_file), 0)
+        self.assertEqual(self.nvme_write(), 0)
+        self.assertNotEqual(self.nvme_compare(self.compare_file), 0)
+        self.assertEqual(self.nvme_compare(self.write_file), 0)

Diff for: tests/nvme_copy_test.py

@@ -13,7 +13,6 @@
 
 """
 
-from nose.tools import assert_equal
 from nvme_test import TestNVMe
 
 
@@ -28,18 +27,18 @@ class TestNVMeCopy(TestNVMe):
               - test_log_dir :  directory for logs, temp files.
     """
 
-    def __init__(self):
+    def setUp(self):
         """ Pre Section for TestNVMeCopy """
-        TestNVMe.__init__(self)
+        super().setUp()
         self.start_block = 0
         self.range = 1
         self.slbs = 1
         self.namespace = 1
         self.setup_log_dir(self.__class__.__name__)
 
-    def __del__(self):
+    def tearDown(self):
         """ Post Section for TestNVMeCopy """
-        TestNVMe.__del__(self)
+        super().tearDown()
 
     def copy(self):
         """ Wrapper for nvme copy
@@ -57,4 +56,4 @@ def copy(self):
 
     def test_copy(self):
         """ Testcase main """
-        assert_equal(self.copy(), 0)
+        self.assertEqual(self.copy(), 0)

Diff for: tests/nvme_create_max_ns_test.py

@@ -31,7 +31,6 @@
 
 import time
 
-from nose.tools import assert_equal
 from nvme_test import TestNVMe
 
 
@@ -48,9 +47,9 @@ class TestNVMeCreateMaxNS(TestNVMe):
               - ctrl_id : controller id.
     """
 
-    def __init__(self):
+    def setUp(self):
         """ Pre Section for TestNVMeAttachDetachNSCmd """
-        TestNVMe.__init__(self)
+        super().setUp()
         self.dps = 0
         self.flbas = 0
         self.nsze = int(self.get_ncap() /
@@ -62,21 +61,21 @@ def __init__(self):
         self.delete_all_ns()
         time.sleep(1)
 
-    def __del__(self):
+    def tearDown(self):
         """
         Post Section for TestNVMeAttachDetachNSCmd
 
             - Create primary namespace.
             - Atttach it to controller.
             - Call super class's destructor.
         """
-        assert_equal(self.create_and_validate_ns(self.default_nsid,
-                                                 self.nsze,
-                                                 self.ncap,
-                                                 self.flbas,
-                                                 self.dps), 0)
+        self.assertEqual(self.create_and_validate_ns(self.default_nsid,
+                                                     self.nsze,
+                                                     self.ncap,
+                                                     self.flbas,
+                                                     self.dps), 0)
         self.attach_ns(self.ctrl_id, self.default_nsid)
-        TestNVMe.__del__(self)
+        super.tearDown()
 
     def test_attach_detach_ns(self):
         """ Testcase main """
@@ -87,15 +86,15 @@ def test_attach_detach_ns(self):
                                               self.ncap,
                                               self.flbas,
                                               self.dps)
-            assert_equal(err, 0)
+            self.assertEqual(err, 0)
             print("##### Attaching " + str(nsid))
-            assert_equal(self.attach_ns(self.ctrl_id, nsid), 0)
+            self.assertEqual(self.attach_ns(self.ctrl_id, nsid), 0)
             print("##### Running IOs in " + str(nsid))
             self.run_ns_io(nsid, 0)
 
         for nsid in range(1, self.max_ns):
             print("##### Detaching " + str(nsid))
-            assert_equal(self.detach_ns(self.ctrl_id, nsid), 0)
+            self.assertEqual(self.detach_ns(self.ctrl_id, nsid), 0)
             print("#### Deleting " + str(nsid))
-            assert_equal(self.delete_and_validate_ns(nsid), 0)
+            self.assertEqual(self.delete_and_validate_ns(nsid), 0)
         self.nvme_reset_ctrl()

Diff for: tests/nvme_dsm_test.py

@@ -13,7 +13,6 @@
 
 """
 
-from nose.tools import assert_equal
 from nvme_test import TestNVMe
 
 
@@ -27,17 +26,17 @@ class TestNVMeDsm(TestNVMe):
               - test_log_dir :  directory for logs, temp files.
     """
 
-    def __init__(self):
+    def setUp(self):
         """ Pre Section for TestNVMeDsm """
-        TestNVMe.__init__(self)
+        super().setUp()
         self.start_block = 0
         self.range = 0
         self.namespace = 1
         self.setup_log_dir(self.__class__.__name__)
 
-    def __del__(self):
+    def tearDown(self):
         """ Post Section for TestNVMeDsm """
-        TestNVMe.__del__(self)
+        super().tearDown()
 
     def dsm(self):
         """ Wrapper for nvme verify
@@ -54,4 +53,4 @@ def dsm(self):
 
     def test_dsm(self):
         """ Testcase main """
-        assert_equal(self.dsm(), 0)
+        self.assertEqual(self.dsm(), 0)

Diff for: tests/nvme_error_log_test.py

@@ -26,7 +26,6 @@
 
 """
 
-from nose.tools import assert_equal
 from nvme_test import TestNVMe
 
 
@@ -38,18 +37,18 @@ class TestNVMeErrorLogCmd(TestNVMe):
         - Attributes:
     """
 
-    def __init__(self):
+    def setUp(self):
         """ Pre Section for TestNVMeErrorLogCmd """
-        TestNVMe.__init__(self)
+        super().setUp()
         self.setup_log_dir(self.__class__.__name__)
 
-    def __del__(self):
+    def tearDown(self):
         """
         Post Section for TestNVMeErrorLogCmd
 
             - Call super class's destructor.
         """
-        TestNVMe.__del__(self)
+        super().tearDown()
 
     def get_error_log_ctrl(self):
         """ Wrapper for executing error-log on controller.
@@ -62,4 +61,4 @@ def get_error_log_ctrl(self):
 
     def test_get_error_log(self):
         """ Testcase main """
-        assert_equal(self.get_error_log_ctrl(), 0)
+        self.assertEqual(self.get_error_log_ctrl(), 0)