Refactor unit tests to move everything under tests. (#59)

* Reorganize tests and minor fixes to change dppl to dpctl.

* Change test class name.

* Fix names in docstrings.

* Fix names etc.

* Rename function from is_in_dpctl_ctxt to is_in_device_context.

* Fix names of test cases.

* Update dpctl/tests/test_sycl_queue_manager.py

Author: diptorupd

dpctl/sycl_core.pyx

@@ -199,7 +199,7 @@ cdef class _SyclQueueManager:
         '''
         DPPLPlatform_DumpInfo()
 
-    def is_in_dppl_ctxt (self):
+    def is_in_device_context (self):
         cdef size_t num = DPPLQueueMgr_GetNumActivatedQueues()
         if num:
             return True
@@ -219,7 +219,7 @@ has_cpu_queues           = _qmgr.has_cpu_queues
 has_gpu_queues           = _qmgr.has_gpu_queues
 has_sycl_platforms       = _qmgr.has_sycl_platforms
 set_default_queue        = _qmgr.set_default_queue
-is_in_dppl_ctxt          = _qmgr.is_in_dppl_ctxt
+is_in_device_context     = _qmgr.is_in_device_context
 
 from contextlib import contextmanager
 

dpctl/tests/__init__.py

@@ -1,2 +1,27 @@
+##===-------- tests/dpctl_tests/__init__.py - dpctl  ------*- Python -*----===##
+##
+##                      Data Parallel Control (dpCtl)
+##
+## Copyright 2020 Intel Corporation
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+##    http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+##===----------------------------------------------------------------------===##
+##
+## \file
+## Top-level module of all dpctl Python unit test cases.
+##===----------------------------------------------------------------------===##
+
+from .test_sycl_queue_manager import *
+from .test_sycl_usm import *
 from .test_dump_functions import *
-from .dppl_tests import *

dpctl/tests/dppl_tests/__init__.py

@@ -1,18 +1,26 @@
-#*******************************************************************************
-# Copyright 2020 Intel Corporation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#******************************************************************************/
+##===---------- test_sycl_queue_manager.py - dpctl  -------*- Python -*----===##
+##
+##                      Data Parallel Control (dpCtl)
+##
+## Copyright 2020 Intel Corporation
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+##    http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+##===----------------------------------------------------------------------===##
+###
+### \file
+### A basic unit test to verify that dpctl and dpct.ocldrv exist.
+##===----------------------------------------------------------------------===##
 
 import unittest
 
@@ -22,19 +30,24 @@
 
 class TestDumpMethods(unittest.TestCase):
 
-    def test_dppl_dump (self):
+    def test_dpctl_dump (self):
         try:
             dpctl.dump()
         except Exception:
             self.fail("Encountered an exception inside dump().")
 
-    def test_dppl_dump_device_info (self):
+    def test_dpctl_dump_device_info (self):
         q = dpctl.get_current_queue()
         try:
             q.get_sycl_device().dump_device_info()
         except Exception:
             self.fail("Encountered an exception inside dump_device_info().")
 
+    def test_dpctl_ocldrv_dump (self):
+        try:
+            dpctl.ocldrv.runtime.dump()
+        except Exception:
+            self.fail("Encountered an exception inside dump_device_info().")
 
 if __name__ == '__main__':
     unittest.main()

dpctl/tests/test_dump_functions.py

@@ -1,6 +1,6 @@
-##===---------- test_sycl_queue_manager.py - dpctl  -------*- Python -*-----===##
+##===---------- test_sycl_queue_manager.py - dpctl  -------*- Python -*----===##
 ##
-##               Python Data Parallel Processing Library (PyDPPL)
+##                      Data Parallel Control (dpCtl)
 ##
 ## Copyright 2020 Intel Corporation
 ##
@@ -19,51 +19,51 @@
 ##===----------------------------------------------------------------------===##
 ###
 ### \file
-### This file has unit test cases to for the SyclQueueManager class
-### in sycl_core.pyx.
+### Defines unit test cases for the SyclQueueManager class in sycl_core.pyx.
 ##===----------------------------------------------------------------------===##
 
 import dpctl
 import unittest
 
 class TestGetNumPlatforms (unittest.TestCase):
-    @unittest.skipIf(not dpctl.has_sycl_platforms(), "No SYCL platforms available")
-    def test_dppl_get_num_platforms (self):
+    @unittest.skipIf(not dpctl.has_sycl_platforms(),
+                    "No SYCL platforms available")
+    def test_dpctl_get_num_platforms (self):
         if(dpctl.has_sycl_platforms):
             self.assertGreaterEqual(dpctl.get_num_platforms(), 1)
 
 @unittest.skipIf(not dpctl.has_sycl_platforms(), "No SYCL platforms available")
 class TestDumpMethods (unittest.TestCase):
-    def test_dppl_dump (self):
+    def test_dpctl_dump (self):
         try:
             dpctl.dump()
         except Exception:
             self.fail("Encountered an exception inside dump().")
 
-    def test_dppl_dump_device_info (self):
+    def test_dpctl_dump_device_info (self):
         q = dpctl.get_current_queue()
         try:
             q.get_sycl_device().dump_device_info()
         except Exception:
             self.fail("Encountered an exception inside dump_device_info().")
 
 @unittest.skipIf(not dpctl.has_sycl_platforms(), "No SYCL platforms available")
-class TestDPPLIsInDPPLCtxt (unittest.TestCase):
+class TestIsInDeviceContext (unittest.TestCase):
 
-    def test_is_in_dppl_ctxt_outside_device_ctxt (self):
-        self.assertFalse(dpctl.is_in_dppl_ctxt())
+    def test_is_in_device_context_outside_device_ctxt (self):
+        self.assertFalse(dpctl.is_in_device_context())
 
-    def test_is_in_dppl_ctxt_inside_device_ctxt (self):
+    def test_is_in_device_context_inside_device_ctxt (self):
         with dpctl.device_context(dpctl.device_type.gpu):
-            self.assertTrue(dpctl.is_in_dppl_ctxt())
+            self.assertTrue(dpctl.is_in_device_context())
 
     @unittest.skipIf(not dpctl.has_cpu_queues(), "No CPU platforms available")
-    def test_is_in_dppl_ctxt_inside_nested_device_ctxt (self):
+    def test_is_in_device_context_inside_nested_device_ctxt (self):
         with dpctl.device_context(dpctl.device_type.cpu):
             with dpctl.device_context(dpctl.device_type.gpu):
-                self.assertTrue(dpctl.is_in_dppl_ctxt())
-            self.assertTrue(dpctl.is_in_dppl_ctxt())
-        self.assertFalse(dpctl.is_in_dppl_ctxt())
+                self.assertTrue(dpctl.is_in_device_context())
+            self.assertTrue(dpctl.is_in_device_context())
+        self.assertFalse(dpctl.is_in_device_context())
 
 @unittest.skipIf(not dpctl.has_sycl_platforms(), "No SYCL platforms available")
 class TestGetCurrentQueueInMultipleThreads (unittest.TestCase):

dpctl/tests/dppl_tests/test_sycl_queue_manager.py renamed to dpctl/tests/test_sycl_queue_manager.py

@@ -1,6 +1,6 @@
-##===---------- test_sycl_queue_manager.py - dpctl  -------*- Python -*-----===##
+##===---------- test_sycl_queue_manager.py - dpctl  -------*- Python -*----===##
 ##
-##               Python Data Parallel Processing Library (PyDPPL)
+##                      Data Parallel Control (dpCtl)
 ##
 ## Copyright 2020 Intel Corporation
 ##
@@ -17,6 +17,10 @@
 ## limitations under the License.
 ##
 ##===----------------------------------------------------------------------===##
+##
+## \file
+## Defines unit test cases for the Memory classes in _memory.pyx.
+##===----------------------------------------------------------------------===##
 
 import unittest
 import dpctl
@@ -111,3 +115,6 @@ class TestMemoryUSMDevice(TestMemoryUSMBase, unittest.TestCase):
 
     MemoryUSMClass = MemoryUSMDevice
     usm_type = 'device'
+
+if __name__ == '__main__':
+    unittest.main()