add more check and error ids

Author: scivision

+hdf5nc/TestHDF5.m

@@ -5,14 +5,17 @@
 end
 
 properties (TestParameter)
-type = {'single', 'double', 'int32', 'int64'};
+type = {'single', 'double', 'int32', 'int64'}
+vars = {'A0', 'A1', 'A2', 'A3', 'A4'}
+str = {"string", 'char'}
 end
 
 
-methods (TestClassSetup)
+methods (TestMethodSetup)
 
 function setup_file(tc)
 import hdf5nc.h5save
+import matlab.unittest.constraints.IsFile
 
 A0 = 42.;
 A1 = [42.; 43.];
@@ -36,11 +39,17 @@ function setup_file(tc)
 h5save(basic, '/A2', A2)
 h5save(basic, '/A3', A3, "size", size(A3))
 h5save(basic, '/A4', A4)
+
+h5save(basic, '/t/x', 12)
+h5save(basic, '/t/y', 13)
+h5save(basic, '/j/a/b', 6)
+
+tc.assumeThat(basic, IsFile)
 end
 end
 
 
-methods (TestClassTeardown)
+methods (TestMethodTeardown)
 function cleanup(tc)
 delete(tc.TestData.basic)
 end
@@ -58,25 +67,49 @@ function test_auto_chunk_size(tc)
 
 function test_get_variables(tc)
 import hdf5nc.h5variables
+basic = tc.TestData.basic;
+
+v = h5variables(basic);
+tc.verifyEqual(sort(v), ["A0", "A1", "A2", "A3", "A4"])
+
+[v1,g] = h5variables(basic);
+tc.verifyEqual(v,v1)
+tc.verifyEqual(sort(g), ["/j", "/t"])
+
+% 1-level group
+[v, g] = h5variables(basic, "/t");
+tc.verifyEqual(sort(v), ["x", "y"])
+tc.verifyEmpty(g)
+
+% traversal
+[v, g] = h5variables(basic, "/j");
+tc.verifyEmpty(v)
+tc.verifyEqual(g, "/j/a")
+
+[v, g] = h5variables(basic, "/j/a");
+tc.verifyEqual(v, "b")
+tc.verifyEmpty(g)
 
-vars = h5variables(tc.TestData.basic);
-tc.verifyEqual(sort(vars), ["A0", "A1", "A2", "A3", "A4"])
 end
 
 
-function test_exists(tc)
+function test_exists(tc, vars)
 import hdf5nc.h5exists
 import matlab.unittest.constraints.IsScalar
+basic = tc.TestData.basic;
 
-e0 = h5exists(tc.TestData.basic, '/A3');
-tc.verifyThat(e0, IsScalar)
-tc.verifyTrue(e0)
+e = h5exists(basic, "/" + vars);
+tc.verifyThat(e, IsScalar)
+tc.verifyTrue(e)
 
-tc.verifyFalse(h5exists(tc.TestData.basic, '/oops'))
+% vector
+e = h5exists(basic, [vars, "oops", ""]);
+tc.verifyTrue(isrow(e))
+tc.verifyEqual(e, [true, false, false])
 
-e1 = h5exists(tc.TestData.basic, ["A3", "oops"]);
-tc.verifyTrue(isrow(e1))
-tc.verifyEqual(e1, [true, false])
+% empty
+e = h5exists(basic, string.empty);
+tc.verifyEmpty(e)
 end
 
 
@@ -104,14 +137,15 @@ function test_size(tc)
 s = h5size(basic, '/A4');
 tc.verifyTrue(isvector(s))
 tc.verifyEqual(s, [4,3,2,5])
+
+% empty
+tc.verifyError(@() h5size(basic, string.empty), 'MATLAB:validation:IncompatibleSize')
 end
 
 
 function test_read(tc)
 import matlab.unittest.constraints.IsScalar
-import matlab.unittest.constraints.IsFile
 basic = tc.TestData.basic;
-tc.assumeThat(basic, IsFile)
 
 s = h5read(basic, '/A0');
 tc.verifyThat(s, IsScalar)
@@ -161,22 +195,31 @@ function test_rewrite(tc)
 tc.verifyEqual(h5read(basic, '/A2'), 3*magic(4))
 end
 
-function test_string(tc)
+function test_string(tc, str)
 import hdf5nc.h5save
 basic = tc.TestData.basic;
 
-h5save(basic, "/a_string", "hello")
-h5save(basic, "/a_char", 'there')
+h5save(basic, "/"+str, str)
 
-astr = h5read(basic, "/a_string");
-achar = h5read(basic, "/a_char");
-tc.verifyEqual(astr, "hello")
-tc.verifyEqual(achar, "there")
+a = h5read(basic, "/"+str);
+tc.verifyEqual(a, string(str))
+end
+
+function test_file_missing(tc)
+
+tc.verifyError(@() hdf5nc.h5exists(tempname,""), 'hdf5nc:h5variables:fileNotFound')
+tc.verifyError(@() hdf5nc.h5variables(tempname), 'hdf5nc:h5variables:fileNotFound')
+tc.verifyError(@() hdf5nc.h5size(tempname,""), 'hdf5nc:h5size:fileNotFound')
+[~,badname] = fileparts(tempname);
+tc.verifyError(@() hdf5nc.h5save(badname,"",0), 'hdf5nc:h5save:fileNotFound')
 end
 
 function test_real_only(tc)
 import hdf5nc.h5save
-tc.verifyError(@() h5save(tc.TestData.basic, "/bad_imag", 1j), 'MATLAB:validators:mustBeReal')
+basic = tc.TestData.basic;
+
+tc.verifyError(@() h5save(basic, "/bad_imag", 1j), 'MATLAB:validators:mustBeReal')
+tc.verifyError(@() h5save(basic, "", 0), 'MATLAB:expectedNonempty')
 end
 
 end

+hdf5nc/TestNetCDF.m

@@ -5,14 +5,16 @@
 end
 
 properties (TestParameter)
-type = {'single', 'double', 'int32', 'int64'};
+type = {'single', 'double', 'int32', 'int64'}
+vars = {'A0', 'A1', 'A2', 'A3', 'A4'}
 end
 
 
-methods (TestClassSetup)
+methods (TestMethodSetup)
 
 function setup_file(tc)
 import hdf5nc.ncsave
+import matlab.unittest.constraints.IsFile
 
 A0 = 42.;
 A1 = [42.; 43.];
@@ -36,11 +38,13 @@ function setup_file(tc)
 ncsave(basic, 'A2', A2, "dims", {'x2', size(A2,1), 'y2', size(A2,2)})
 ncsave(basic, 'A3', A3, "dims", {'x3', size(A3,1), 'y3', size(A3,2), 'z3', size(A3,3)})
 ncsave(basic, 'A4', A4, "dims", {'x4', size(A4,1), 'y4', size(A4,2), 'z4', size(A4,3), 'w4', size(A4,4)})
+
+tc.assumeThat(basic, IsFile)
 end
 end
 
 
-methods (TestClassTeardown)
+methods (TestMethodTeardown)
 function cleanup(tc)
 delete(tc.TestData.basic)
 end
@@ -51,24 +55,27 @@ function cleanup(tc)
 function test_get_variables(tc)
 import hdf5nc.ncvariables
 
-vars = ncvariables(tc.TestData.basic);
-tc.verifyEqual(sort(vars), ["A0", "A1", "A2", "A3", "A4"])
+tc.verifyEqual(sort(ncvariables(tc.TestData.basic)), ["A0", "A1", "A2", "A3", "A4"])
 end
 
 
-function test_exists(tc)
+function test_exists(tc, vars)
 import hdf5nc.ncexists
 import matlab.unittest.constraints.IsScalar
+basic = tc.TestData.basic;
 
-e0 = ncexists(tc.TestData.basic, 'A3');
-tc.verifyThat(e0, IsScalar)
-tc.verifyTrue(e0)
+e = ncexists(basic, vars);
+tc.verifyThat(e, IsScalar)
+tc.verifyTrue(e)
 
-tc.verifyFalse(ncexists(tc.TestData.basic, '/oops'))
+% vector
+e = ncexists(basic, [vars, "oops", ""]);
+tc.verifyTrue(isrow(e))
+tc.verifyEqual(e, [true, false, false])
 
-e1 = ncexists(tc.TestData.basic, ["A3", "oops"]);
-tc.verifyTrue(isrow(e1))
-tc.verifyEqual(e1, [true, false])
+% empty
+e = ncexists(basic, string.empty);
+tc.verifyEmpty(e)
 end
 
 
@@ -96,14 +103,15 @@ function test_size(tc)
 s = ncsize(basic, 'A4');
 tc.verifyTrue(isvector(s))
 tc.verifyEqual(s, [4,3,2,5])
+
+% empty
+tc.verifyError(@() ncsize(basic, string.empty), 'MATLAB:validation:IncompatibleSize')
 end
 
 
 function test_read(tc)
 import matlab.unittest.constraints.IsScalar
-import matlab.unittest.constraints.IsFile
 basic = tc.TestData.basic;
-tc.assumeThat(basic, IsFile)
 
 s = ncread(basic, '/A0');
 tc.verifyThat(s, IsScalar)
@@ -159,9 +167,21 @@ function test_no_char_string(tc)
 
 end
 
+function test_file_missing(tc)
+
+tc.verifyError(@() hdf5nc.ncexists(tempname,""), 'hdf5nc:ncvariables:fileNotFound')
+tc.verifyError(@() hdf5nc.ncvariables(tempname), 'hdf5nc:ncvariables:fileNotFound')
+tc.verifyError(@() hdf5nc.ncsize(tempname,""), 'hdf5nc:ncsize:fileNotFound')
+[~,badname] = fileparts(tempname);
+tc.verifyError(@() hdf5nc.ncsave(badname,"",0), 'hdf5nc:ncsave:fileNotFound')
+end
+
 function test_real_only(tc)
 import hdf5nc.ncsave
-tc.verifyError(@() ncsave(tc.TestData.basic, "/bad_imag", 1j), 'MATLAB:validators:mustBeReal')
+basic = tc.TestData.basic;
+
+tc.verifyError(@() ncsave(basic, "bad_imag", 1j), 'MATLAB:validators:mustBeReal')
+tc.verifyError(@() ncsave(basic, "", 0), 'MATLAB:imagesci:netcdf:badLocationString')
 end
 
 end

+hdf5nc/h5exists.m

@@ -1,23 +1,23 @@
-function exists = h5exists(filename, varnames)
+function exists = h5exists(file, varnames)
 % check if variable(s) exists in HDF5 file
 %
 % parameters
 % ----------
-% filename: HDF5 filename
+% file: HDF5 filename
 % varname: name of variable inside HDF5 file
 %
 % returns
 % -------
 % exists: boolean (scalar or vector)
 
 arguments
-  filename (1,1) string
+  file (1,1) string
   varnames (1,:) string
 end
 
 i = startsWith(varnames, "/");
 varnames(i) = extractAfter(varnames(i), 1);
 % NOT contains because we want exact string match
-exists = ismember(varnames, hdf5nc.h5variables(filename));
+exists = ismember(varnames, hdf5nc.h5variables(file));
 
 end % function

+hdf5nc/h5save.m

@@ -59,7 +59,7 @@ function exist_file(filename, varname, A, sizeA)
 elseif all(diskshape == fliplr(sizeA))
   h5write(filename, varname, A.', start, fliplr(sizeA))
 else
-  error('h5save:value_error', ['shape of ',varname,': ', int2str(sizeA), ' does not match existing HDF5 shape ', int2str(diskshape)])
+  error('hdf5nc:h5save:value_error', ['shape of ',varname,': ', int2str(sizeA), ' does not match existing HDF5 shape ', int2str(diskshape)])
 end
 
 end % function
@@ -68,7 +68,9 @@ function exist_file(filename, varname, A, sizeA)
 function new_file(filename, varname, A, sizeA)
 
 folder = fileparts(filename);
-assert(isfolder(folder), '%s is not a folder, cannot create %s', folder, filename)
+if ~isfolder(folder)
+  error('hdf5nc:h5save:fileNotFound', '%s is not a folder, cannot create %s', folder, filename)
+end
 
 if isvector(A)
   h5create(filename, varname, sizeA, 'DataType', class(A))

+hdf5nc/h5size.m

@@ -1,15 +1,20 @@
-function fsize = h5size(filename, variable)
+function fsize = h5size(file, variable)
 % get size (shape) of an HDF5 dataset
 %
 % filename: HDF5 filename
 % variable: name of variable inside HDF5 file
 %
 % fsize: vector of variable size per dimension
 arguments
-  filename (1,1) string
+  file (1,1) string
   variable (1,1) string
 end
 
-fsize = h5info(expanduser(filename), variable).Dataspace.Size;
+file = expanduser(file);
+if ~isfile(file)
+  error('hdf5nc:h5size:fileNotFound', "%s does not exist", file)
+end
+
+fsize = h5info(file, variable).Dataspace.Size;
 
-end % function
+end

+hdf5nc/h5variables.m

@@ -17,28 +17,28 @@
   group string = string.empty
 end
 
+file = expanduser(file);
+if ~isfile(file)
+  error('hdf5nc:h5variables:fileNotFound', "%s does not exist", file)
+end
+
 names = string.empty;
 groups = string.empty;
 
-finf = h5info(expanduser(file));
-ds = finf.Datasets;
-if isempty(ds)
-  return
+if isempty(group)
+  finf = h5info(file);
+else
+  finf = h5info(file, group);
 end
 
-if ~isempty(group)
-  gs = finf.Groups;
-  i = string({gs(:).Name}) == group;
-  if ~any(i)
-    return
-  end
-  ds = gs(i).Datasets;
-end
+ds = finf.Datasets;
+gs = finf.Groups;
 
-names = string({ds(:).Name});
+if ~isempty(ds)
+  names = string({ds.Name});
+end
 
-if nargout > 1
-  gs = finf.Groups;
+if nargout > 1 && ~isempty(gs)
   groups = string({gs.Name});
 end