add unit tests, zlib memory optimization

NeuroJSON · Aug 20, 2022 · eab19fb · eab19fb
1 parent 5338fab
commit eab19fb
Show file tree

Hide file tree

Showing 6 changed files with 143 additions and 0 deletions.
diff --git a/test/c/Makefile → example/c/Makefile b/test/c/Makefile → example/c/Makefile
diff --git a/test/c/testzmat.c → example/c/testzmat.c b/test/c/testzmat.c → example/c/testzmat.c
diff --git a/test/f90/Makefile → example/f90/Makefile b/test/f90/Makefile → example/f90/Makefile
diff --git a/test/f90/testzmat.f90 → example/f90/testzmat.f90 b/test/f90/testzmat.f90 → example/f90/testzmat.f90
diff --git a/test/run_zmat_test.m b/test/run_zmat_test.m
@@ -0,0 +1,92 @@
+function run_zmat_test(tests)
+%
+% run_zmat_test
+%   or
+% run_zmat_test(tests)
+% run_zmat_test({'js','jso','bj','bjo'})
+%
+% Unit testing for ZMat toolbox
+%
+% authors:Qianqian Fang (q.fang <at> neu.edu)
+% date: 2020/06/08
+%
+% input:
+%      tests: is a cell array of strings, possible elements include
+%         'c':  compression
+%         'd':  decompression
+%         'err':  error handling
+%
+% license:
+%     BSD or GPL version 3, see LICENSE_{BSD,GPLv3}.txt files for details
+%
+% -- this function is part of JSONLab toolbox (http://iso2mesh.sf.net/cgi-bin/index.cgi?zmat)
+%
+
+if (nargin == 0)
+    tests = {'c', 'err'};
+end
+
+%%
+if (ismember('c', tests))
+    fprintf(sprintf('%s\n', char(ones(1, 79) * 61)));
+    fprintf('Test compression\n');
+    fprintf(sprintf('%s\n', char(ones(1, 79) * 61)));
+
+    test_zmat('zlib (empty)', 'zlib', [], zeros(1,0));
+    test_zmat('gzip (empty)', 'gzip', '', zeros(1,0));
+    test_zmat('lzma (empty)', 'lzma', zeros(0,0), zeros(1,0));
+    test_zmat('lzip (empty)', 'lzip', [], zeros(1,0));
+    test_zmat('lz4 (empty)', 'lz4', '', zeros(1,0));
+    test_zmat('lz4hc (empty)', 'lz4hc', zeros(0,0), zeros(1,0));
+    test_zmat('base64 (empty)', 'base64', [], zeros(1,0));
+
+    test_zmat('zlib (scalar)', 'zlib', pi, [120 156 147 208 117 9 249 173 200 233 0 0 9 224 2 67]);
+    test_zmat('gzip (scalar)', 'gzip', 'test gzip', [31 139 8 0 0 0 0 0 0 3 43 73 45 46 81 72 175 202 44 0 0 35 1 18 68 9 0 0 0]);
+    test_zmat('lzma (scalar)', 'lzma', uint32(1902), [93 0 0 16 0 4 0 0 0 0 0 0 0 0 55 1 188 0 10 215 98 63 255 251 13 160 0]);
+    test_zmat('lzip (scalar)', 'lzip', single(89.8901), [76 90 73 80 0 20 0 93 177 210 100 7 58 15 255 255 252 63 0 0 133 75 237 40 4 0 0 0 0 0 0 0]);
+    test_zmat('lz4 (scalar)', 'lz4', exp(1), [128 106 87 20 139 10 191 5 64]);
+    test_zmat('lz4hc (scalar)', 'lz4hc', 0.0, [128 0 0 0 0 0 0 0 0]);
+    test_zmat('base64 (scalar)', 'base64', uint8(100), [90 65 61 61 10]);
+
+    test_zmat('zlib (array)', 'zlib', uint8([1,2,3]), [120 156 99 100 98 6 0 0 13 0 7]);
+    test_zmat('gzip (array)', 'gzip', single([pi;exp(1)]), [31 139 8 0 0 0 0 0 0 3 187 205 239 233 16 242 67 215 1 0 197 103 247 17 8 0 0 0]);
+    test_zmat('lzma (array)', 'lzma', uint8(magic(3)), [93 0 0 16 0 9 0 0 0 0 0 0 0 0 4 0 207 17 232 198 252 139 53 45 235 13 99 255 249 133 192 0]);
+    test_zmat('lzip (array)', 'lzip', uint8(reshape(1:(2*3*4), [3,2,4])), [76 90 73 80 0 20 0 0 128 157 97 211 13 93 174 25 62 219 132 40 29 52 41 93 234 35 61 128 60 72 152 87 41 88 255 253 203 224 0 163 16 142 146 24 0 0 0 0 0 0 0]);
+    test_zmat('lz4 (array)', 'lz4', [1], [128 0 0 0 0 0 0 240 63]);
+    test_zmat('lz4hc (array)', 'lz4hc', 'test zmat', [144 116 101 115 116 32 122 109 97 116]);
+    test_zmat('base64 (array)', 'base64', ['test';'zmat'], [100 72 112 108 98 88 78 104 100 72 81 61 10]);
+
+    test_zmat('zlib (level=9)', 'zlib', 55, [120 218 99 96 0 130 6 111 7 0 2 94 1 12], 'level', -9);
+    test_zmat('zlib (level=2.6)', 'zlib', 55, [120 94 99 96 0 130 6 111 7 0 2 94 1 12], 'level', -2.6);
+    test_zmat('gzip (level)', 'gzip', 'level 9', [31 139 8 0 0 0 0 0 2 3 203 73 45 75 205 81 176 4 0 182 235 101 120 7 0 0 0], 'level', -9);
+    test_zmat('lzma (level)', 'lzma', uint8([1,2,3,4]), [93 0 0 16 0 4 0 0 0 0 0 0 0 0 0 128 157 97 229 167 24 31 255 247 52 128 0], 'level', -9);
+    test_zmat('lzip (level)', 'lzip', logical([1,2,3,4]), [76 90 73 80 0 20 0 0 232 190 92 247 255 255 224 0 128 0 153 211 38 246 4 0 0 0 0 0 0 0],'level', -9);
+    test_zmat('lz4 (level)', 'lz4', 'random data', [176 114 97 110 100 111 109 32 100 97 116 97],'level', -9);
+    test_zmat('lz4hc (level)', 'lz4hc', 1.2, [128 51 51 51 51 51 51 243 63],'level', -9);
+    test_zmat('base64 (trailing newline)', 'base64', uint8(100), 'ZA==', 'level', 2);
+    test_zmat('base64 (all newline)', 'base64', ones(7,1), 'AAAAAAAA8D8AAAAAAADwPwAAAAAAAPA/AAAAAAAA8D8AAAAAAADwPwAAAAAAAPA/AAAAAAAA8D8=', 'level', 3);
+end
+%%
+if (ismember('d', tests))
+    fprintf(sprintf('%s\n', char(ones(1, 79) * 61)));
+    fprintf('Test decompression\n');
+    fprintf(sprintf('%s\n', char(ones(1, 79) * 61)));
+
+    test_zmat('zlib (empty)', 'zlib', [1, 2, 3, 4], '', 'level', 0);
+end
+%%
+if (ismember('err', tests))
+    fprintf(sprintf('%s\n', char(ones(1, 79) * 61)));
+    fprintf('Test error messages\n');
+    fprintf(sprintf('%s\n', char(ones(1, 79) * 61)));
+
+    test_zmat('unsupported method', 'ppp', [], 'the specified compression method is not supported');
+    test_zmat('unsupported input (cell)', 'zlib', {}, 'input must be a char, non-complex numeric or logical vector or N-D array');
+    test_zmat('unsupported input (handle)', 'zlib', @sin, 'input must be a char, non-complex numeric or logical vector or N-D array');
+    test_zmat('unsupported input (complex)', 'gzip', 1+3i, 'input must be a char, non-complex numeric or logical vector or N-D array');
+    if (exist('string'))
+        test_zmat('unsupported input (string)', 'zlib', string(sprintf('zmat\ntest')), 'input must be a char, non-complex numeric or logical vector or N-D array');
+    end
+    test_zmat('unsupported input (cell)', 'zlib', zeros(1e9,1e9), 'input must be a char, non-complex numeric or logical vector or N-D array');
+end
+
diff --git a/test/test_zmat.m b/test/test_zmat.m
@@ -0,0 +1,51 @@
+function test_zmat(testname, method, input, expected, varargin)
+opt=struct('level',1);
+if(length(varargin)>1 && rem(length(varargin),2)==0 && ischar(varargin{1}))
+    for i=1:2:length(varargin)
+        opt.(varargin{i})=varargin{i+1};
+    end
+end
+try
+    [res, info] = zmat(input, opt.level, method);
+catch ME
+    if(strcmp(ME.message, expected))
+        fprintf(1, 'Testing exception %s: ok\n\toutput:''%s''\n', testname, ME.message);
+    else
+        warning('Test exception %s: failed: expected ''%s'', obtained ''%s''', testname, mat2str(expected), ME.message);
+    end
+    return;
+end
+if(isfield(opt,'info'))
+    res=info.(opt.info);
+end
+res
+expected
+if (~isequal(res, expected))
+    warning('Test %s: failed: expected ''%s'', obtained ''%s''', testname, mat2str(expected), mat2str(res));
+else
+    if(ischar(res))
+        fprintf(1, 'Testing %s: ok\n\toutput:''%s''\n', testname, res);
+    else
+        fprintf(1, 'Testing %s: ok\n\toutput:''%s''\n', testname, mat2str(res));
+    end
+    if(isfield(opt,'info'))
+        return;
+    end
+    newres = zmat(res, info);
+    if (exist('isequaln'))
+        try
+            if (isequaln(newres, input))
+                fprintf(1, '\t%s successfully restored the input\n', method);
+            end
+        catch
+        end
+    else
+        try
+            if (newres == input)
+                fprintf(1, '\t%s successfully restored the input\n', method);
+            end
+        catch
+        end
+    end
+end
+end