TST: use unittest.skipUnless for conditional tests.

Add flags has_pyobjcryst, has_periodictable for availability
of optional packages.  Use unittest `skip` function to ignore
tests that cannot be run.  Remove mock-up classes that were
used for test avoidance before.

Author: pavoljuhas

src/diffpy/srreal/tests/run.py

@@ -19,7 +19,6 @@
 """
 
 
-
 if __name__ == '__main__':
     import sys
     from diffpy.srreal.tests import test

src/diffpy/srreal/tests/testatomradiitable.py

@@ -6,11 +6,12 @@
 
 import unittest
 import pickle
-from diffpy.srreal.tests.testutils import TestCasePeriodictableOptional
+from diffpy.srreal.tests.testutils import has_periodictable, _msg_noperiodictable
 from diffpy.srreal.atomradiitable import AtomRadiiTable, CovalentRadiiTable
 from diffpy.srreal.atomradiitable import ConstantRadiiTable
 
-##############################################################################
+# ----------------------------------------------------------------------------
+
 class TestAtomRadiiTable(unittest.TestCase):
 
     def setUp(self):
@@ -108,8 +109,10 @@ def test_toString(self):
 
 # End of class TestAtomRadiiTable
 
-##############################################################################
-class TestCovalentRadiiTable(TestCasePeriodictableOptional):
+# ----------------------------------------------------------------------------
+
+@unittest.skipUnless(has_periodictable, _msg_noperiodictable)
+class TestCovalentRadiiTable(unittest.TestCase):
 
     def setUp(self):
         self.rtb = CovalentRadiiTable()
@@ -205,6 +208,8 @@ def test_toString(self):
 
 # End of class TestCovalentRadiiTable
 
+# ----------------------------------------------------------------------------
+
 if __name__ == '__main__':
     unittest.main()
 

src/diffpy/srreal/tests/testbondcalculator.py

@@ -8,12 +8,13 @@
 import pickle
 import numpy
 
-from diffpy.srreal.tests.testutils import TestCaseObjCrystOptional
+from diffpy.srreal.tests.testutils import has_pyobjcryst, _msg_nopyobjcryst
 from diffpy.srreal.tests.testutils import loadDiffPyStructure
 from diffpy.srreal.tests.testutils import loadObjCrystCrystal
 from diffpy.srreal.bondcalculator import BondCalculator
 
-##############################################################################
+# ----------------------------------------------------------------------------
+
 class TestBondCalculator(unittest.TestCase):
 
     def setUp(self):
@@ -267,9 +268,10 @@ def test_setTypeMask(self):
 
 # End of class TestBondCalculator
 
+# ----------------------------------------------------------------------------
 
-##############################################################################
-class TestBondCalculatorObjCryst(TestCaseObjCrystOptional):
+@unittest.skipUnless(has_pyobjcryst, _msg_nopyobjcryst)
+class TestBondCalculatorObjCryst(unittest.TestCase):
 
     def setUp(self):
         self.bdc = BondCalculator()
@@ -372,6 +374,9 @@ def test_filterOff(self):
         self.assertEqual(12, len(bdc(self.nickel)))
         return
 
+# End of class TestBondCalculatorObjCryst
+
+# ----------------------------------------------------------------------------
 
 if __name__ == '__main__':
     unittest.main()

src/diffpy/srreal/tests/testoverlapcalculator.py

@@ -9,12 +9,13 @@
 import copy
 import numpy
 
-from diffpy.srreal.tests.testutils import TestCaseObjCrystOptional
+from diffpy.srreal.tests.testutils import has_pyobjcryst, _msg_nopyobjcryst
 from diffpy.srreal.tests.testutils import loadDiffPyStructure
 from diffpy.srreal.tests.testutils import loadObjCrystCrystal
 from diffpy.srreal.overlapcalculator import OverlapCalculator
 
-##############################################################################
+# ----------------------------------------------------------------------------
+
 class TestOverlapCalculator(unittest.TestCase):
 
     pool = None
@@ -329,8 +330,10 @@ def test_neighborhoods(self):
 
 # End of class TestOverlapCalculator
 
-##############################################################################
-class TestOverlapCalculatorObjCryst(TestCaseObjCrystOptional):
+# ----------------------------------------------------------------------------
+
+@unittest.skipUnless(has_pyobjcryst, _msg_nopyobjcryst)
+class TestOverlapCalculatorObjCryst(unittest.TestCase):
 
     def setUp(self):
         self.olc = OverlapCalculator()
@@ -457,6 +460,8 @@ def test_neighborhoods(self):
 
 # End of class TestOverlapCalculatorObjCryst
 
+# ----------------------------------------------------------------------------
+
 if __name__ == '__main__':
     unittest.main()
 

src/diffpy/srreal/tests/testpdfcalcobjcryst.py

@@ -10,7 +10,7 @@
 import numpy
 from diffpy.srreal.pdfcalculator import PDFCalculator
 
-from diffpy.srreal.tests.testutils import TestCaseObjCrystOptional
+from diffpy.srreal.tests.testutils import has_pyobjcryst, _msg_nopyobjcryst
 from diffpy.srreal.tests.testutils import loadObjCrystCrystal
 from diffpy.srreal.tests.testutils import datafile
 from diffpy.srreal.tests.testpdfcalculator import _maxNormDiff
@@ -54,9 +54,10 @@ def _makePDFCalculator(crst, cfgdict):
         setattr(pdfc, k, v)
     return pdfc
 
+# ----------------------------------------------------------------------------
 
-##############################################################################
-class TestPDFCalcObjcryst(TestCaseObjCrystOptional):
+@unittest.skipUnless(has_pyobjcryst, _msg_nopyobjcryst)
+class TestPDFCalcObjcryst(unittest.TestCase):
 
     def _comparePDFs(self, nickname, pdfbasename, cifbasename):
         def setself(**kwtoset):
@@ -100,9 +101,11 @@ def test_rutileaniso(self):
         self.assertTrue(self.rutileaniso_mxnd < 0.057)
         return
 
-
 # End of class TestPDFCalcObjcryst
 
+# ----------------------------------------------------------------------------
 
 if __name__ == '__main__':
     unittest.main()
+
+# End of file

src/diffpy/srreal/tests/testsfaverage.py

@@ -10,11 +10,11 @@
 from diffpy.srreal.sfaverage import SFAverage
 from diffpy.srreal.scatteringfactortable import ScatteringFactorTable
 from diffpy.srreal.tests.testutils import loadDiffPyStructure
-from diffpy.srreal.tests.testutils import TestCaseObjCrystOptional
+from diffpy.srreal.tests.testutils import has_pyobjcryst, _msg_nopyobjcryst
 from diffpy.srreal.tests.testutils import loadObjCrystCrystal
 
+# ----------------------------------------------------------------------------
 
-##############################################################################
 class TestSFAverage(unittest.TestCase):
 
     def setUp(self):
@@ -76,8 +76,10 @@ def test_fromComposition(self):
 
 # End of class TestSFAverage
 
-##############################################################################
-class TestSFAverageObjCryst(TestCaseObjCrystOptional):
+# ----------------------------------------------------------------------------
+
+@unittest.skipUnless(has_pyobjcryst, _msg_nopyobjcryst)
+class TestSFAverageObjCryst(unittest.TestCase):
 
     def setUp(self):
         self.sftx = ScatteringFactorTable.createByType('X')
@@ -102,6 +104,8 @@ def test_from_rutile(self):
 
 # End of class TestSFAverageObjCryst
 
+# ----------------------------------------------------------------------------
+
 if __name__ == '__main__':
     unittest.main()
 

src/diffpy/srreal/tests/teststructureadapter.py

@@ -9,7 +9,7 @@
 import numpy
 from diffpy.Structure import Structure
 from diffpy.srreal.pdfcalculator import PDFCalculator
-from diffpy.srreal.tests.testutils import TestCaseObjCrystOptional
+from diffpy.srreal.tests.testutils import has_pyobjcryst, _msg_nopyobjcryst
 from diffpy.srreal.tests.testutils import loadObjCrystCrystal
 from diffpy.srreal.tests.testutils import loadDiffPyStructure
 from diffpy.srreal.structureadapter import (
@@ -250,7 +250,8 @@ def test_nosymmetry_pickling(self):
 
 # ----------------------------------------------------------------------------
 
-class TestPyObjCrystAdapter(TestCaseObjCrystOptional):
+@unittest.skipUnless(has_pyobjcryst, _msg_nopyobjcryst)
+class TestPyObjCrystAdapter(unittest.TestCase):
 
     def setUp(self):
         rutile_crystal = loadObjCrystCrystal('TiO2_rutile-fit.cif')
@@ -285,7 +286,7 @@ def test_objcryst_pickling(self):
         self.assertTrue(numpy.array_equal(g0, g1))
         return
 
-# End of class TestNoSymmetry
+# End of class TestPyObjCrystAdapter
 
 # ----------------------------------------------------------------------------
 

src/diffpy/srreal/tests/testutils.py

@@ -1,12 +1,6 @@
 #!/usr/bin/env python
 
 """Helper routines for running other unit tests.
-
-TestCaseObjCrystOptional -- use this as a TestCase base class that
-    disables unit tests when pyobjcryst is not installed.
-
-TestCasePeriodictableOptional -- use this as a TestCase base class to
-    skip unit tests when periodictable is not installed.
 """
 
 
@@ -16,28 +10,32 @@
 from diffpy.srreal.structureconverters import convertObjCrystCrystal
 from diffpy.srreal.tests import logger
 
-# class TestCaseObjCrystOptional
+# Resolve availability of optional packages.
+
+# pyobjcryst
 
+_msg_nopyobjcryst = "No module named 'pyobjcryst'"
 try:
     import pyobjcryst.crystal
-    from unittest import TestCase as TestCaseObjCrystOptional
     convertObjCrystCrystal(pyobjcryst.crystal.Crystal())
+    has_pyobjcryst = True
 except ImportError:
-    TestCaseObjCrystOptional = object
+    has_pyobjcryst = False
     logger.warning('Cannot import pyobjcryst, pyobjcryst tests skipped.')
 except TypeError:
-    TestCaseObjCrystOptional = object
+    has_pyobjcryst = False
     logger.warning('Compiled without ObjCryst, pyobjcryst tests skipped.')
 
-# class TestCasePeriodictableOptional
+# periodictable
 
+_msg_noperiodictable = "No module named 'periodictable'"
 try:
     import periodictable
-    from unittest import TestCase as TestCasePeriodictableOptional
+    has_periodictable = True
     # silence the pyflakes syntax checker
     del periodictable
 except ImportError:
-    TestCasePeriodictableOptional = object
+    has_periodictable = False
     logger.warning('Cannot import periodictable, periodictable tests skipped.')
 
 # helper functions