Merge pull request DiamondLightSource#2 from dls-controls/dev

Excalibur support and general improvements

tests/app_test.py

@@ -0,0 +1,173 @@
+import unittest
+from pkg_resources import require
+
+require("mock")
+from mock import MagicMock, patch, call
+
+from vdsgen import app
+
+app_patch_path = "vdsgen.app"
+parser_patch_path = app_patch_path + ".ArgumentParser"
+VDSGenerator_patch_path = app_patch_path + ".VDSGenerator"
+
+
+class ParseArgsTest(unittest.TestCase):
+
+    @patch(VDSGenerator_patch_path)
+    @patch(app_patch_path + '.ArgumentDefaultsHelpFormatter')
+    @patch(parser_patch_path)
+    def test_parser(self, parser_init_mock, formatter_mock, gen_mock):
+        parser_mock = parser_init_mock.return_value
+        add_mock = parser_mock.add_argument
+        add_group_mock = parser_mock.add_argument_group
+        add_exclusive_group_mock = parser_mock.add_mutually_exclusive_group
+        parse_mock = parser_mock.parse_args
+        parse_mock.return_value = MagicMock(empty=False, files=None)
+        empty_mock = MagicMock()
+        other_mock = MagicMock()
+        add_group_mock.side_effect = [empty_mock, other_mock]
+        exclusive_group_mock = add_exclusive_group_mock.return_value
+        expected_message = """
+-------------------------------------------------------------------------------
+A script to create a virtual dataset composed of multiple raw HDF5 files.
+
+The minimum required arguments are <path> and either -p <prefix> or -f <files>.
+
+For example:
+
+ > ../vdsgen/app.py /scratch/images -p stripe_
+ > ../vdsgen/app.py /scratch/images -f stripe_1.hdf5 stripe_2.hdf5
+
+You can create an empty VDS, for raw files that don't exist yet, with the -e
+flag; you will then need to provide --shape and --data_type, though defaults
+are provided for these.
+-------------------------------------------------------------------------------
+"""
+
+        args = app.parse_args()
+
+        parser_init_mock.assert_called_once_with(
+            usage=expected_message,
+            formatter_class=formatter_mock)
+        add_exclusive_group_mock.assert_called_with(required=True)
+        exclusive_group_mock.add_argument.assert_has_calls(
+            [call("-p", "--prefix", type=str, default=None, dest="prefix",
+                  help="Prefix of files to search <path> for - e.g 'stripe_' "
+                       "to combine 'stripe_1.hdf5' and 'stripe_2.hdf5'."),
+             call("-f", "--files", nargs="*", type=str, default=None,
+                  dest="files",
+                  help="Explicit names of raw files in <path>.")])
+
+        add_mock.assert_called_with(
+            "path", type=str, help="Root folder of source files and VDS.")
+
+        add_group_mock.assert_has_calls([call()] * 2)
+        empty_mock.add_argument.assert_has_calls(
+            [call("-e", "--empty", action="store_true", dest="empty",
+                  help="Make empty VDS pointing to datasets "
+                       "that don't exist yet."),
+             call("--shape", type=int, nargs="*", default=[1, 256, 2048],
+                  dest="shape",
+                  help="Shape of dataset - 'frames height width', where "
+                       "frames is N dimensional."),
+             call("-t", "--data_type", type=str, default="uint16",
+                  dest="data_type", help="Data type of raw datasets.")])
+        other_mock.add_argument.assert_has_calls(
+            [call("-o", "--output", type=str, default=None, dest="output",
+                  help="Output file name. If None then generated as input "
+                       "file prefix with vds suffix."),
+             call("-s", "--stripe_spacing", type=int, dest="stripe_spacing",
+                  default=gen_mock.stripe_spacing,
+                  help="Spacing between two stripes in a module."),
+             call("-m", "--module_spacing", type=int, dest="module_spacing",
+                  default=gen_mock.module_spacing,
+                  help="Spacing between two modules."),
+             call("--source_node", type=str, dest="source_node",
+                  default=gen_mock.source_node,
+                  help="Data node in source HDF5 files."),
+             call("--target_node", type=str,
+                  default=gen_mock.target_node, dest="target_node",
+                  help="Data node in VDS file."),
+             call("-l", "--log_level", type=int, dest="log_level",
+                  default=gen_mock.log_level,
+                  help="Logging level (off=3, info=2, debug=1).")])
+
+        parse_mock.assert_called_once_with()
+        self.assertEqual(parse_mock.return_value, args)
+
+    @patch(parser_patch_path + '.error')
+    @patch(parser_patch_path + '.parse_args',
+           return_value=MagicMock(empty=True, files=None))
+    def test_empty_and_not_files_then_error(self, parse_mock, error_mock):
+
+        app.parse_args()
+
+        error_mock.assert_called_once_with(
+            "To make an empty VDS you must explicitly define --files for the "
+            "eventual raw datasets.")
+
+    @patch(parser_patch_path + '.error')
+    @patch(parser_patch_path + '.parse_args',
+           return_value=MagicMock(empty=True, files=["file"]))
+    def test_only_one_file_then_error(self, parse_mock, error_mock):
+
+        app.parse_args()
+
+        error_mock.assert_called_once_with(
+            "Must define at least two files to combine.")
+
+
+class MainTest(unittest.TestCase):
+    @patch(VDSGenerator_patch_path)
+    @patch(app_patch_path + '.parse_args',
+           return_value=MagicMock(
+               path="/test/path", prefix="stripe_", empty=True,
+               files=["file1.hdf5", "file2.hdf5"], output="vds",
+               shape=[3, 256, 2048], data_type="int16",
+               source_node="data", target_node="full_frame",
+               stripe_spacing=3, module_spacing=127,
+               log_level=2))
+    def test_main_empty(self, parse_mock, init_mock):
+        gen_mock = init_mock.return_value
+        args_mock = parse_mock.return_value
+
+        app.main()
+
+        parse_mock.assert_called_once_with()
+        init_mock.assert_called_once_with(
+            args_mock.path,
+            prefix=args_mock.prefix, files=args_mock.files,
+            output=args_mock.output,
+            source=dict(shape=args_mock.shape, dtype=args_mock.data_type),
+            source_node=args_mock.source_node,
+            target_node=args_mock.target_node,
+            stripe_spacing=args_mock.stripe_spacing,
+            module_spacing=args_mock.module_spacing,
+            log_level=args_mock.log_level)
+
+        gen_mock.generate_vds.assert_called_once_with()
+
+    @patch(VDSGenerator_patch_path)
+    @patch(app_patch_path + '.parse_args',
+           return_value=MagicMock(
+               path="/test/path", prefix="stripe_", empty=False,
+               files=["file1.hdf5", "file2.hdf5"], output="vds",
+               frames=3, height=256, width=2048, data_type="int16",
+               source_node="data", target_node="full_frame",
+               stripe_spacing=3, module_spacing=127,
+               log_level=2))
+    def test_main_not_empty(self, parse_mock, generate_mock):
+        args_mock = parse_mock.return_value
+
+        app.main()
+
+        parse_mock.assert_called_once_with()
+        generate_mock.assert_called_once_with(
+            args_mock.path,
+            prefix=args_mock.prefix, output="vds", files=args_mock.files,
+            source=None,
+            source_node=args_mock.source_node,
+            stripe_spacing=args_mock.stripe_spacing,
+            target_node=args_mock.target_node,
+            module_spacing=args_mock.module_spacing,
+            log_level=args_mock.log_level)