1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
## Copyright (C) 2012,2013,2014 Philip Nienhuis <pr.nienhuis at users.sf.net>
##
## This program is free software; you can redistribute it and/or modify it under
## the terms of the GNU General Public License as published by the Free Software
## Foundation; either version 3 of the License, or (at your option) any later
## version.
##
## This program is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
## details.
##
## You should have received a copy of the GNU General Public License along with
## this program; if not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} io_ods_testscript (@var{intf1})
## @deftypefnx {Function File} io_ods_testscript (@var{intf1}, @var{fname})
## @deftypefnx {Function File} io_ods_testscript (@var{intf1}, @var{fname}, @var{intf2})
## Try to check proper operation of ODS spreadsheet scripts using
## interface @var{intf1}.
##
## @var{intf1} can be one of OTK, JOD, UNO, or OCT. No checks
## are made as to whether the requested interface is supported at all. If
## @var{fname} is supplied, that filename is used for the tests, otherwise
## filename "io-test.ods" is chosen by default. This parameter is required
## to have e.g., JOD distinguish between testing (reading) .ods (ODS 1.2)
## and .sxc (old OpenOffice.org & StarOffice) files (that UNO can write).
##
## If @var{intf2} is supplied, that interface will be used for writing the
## spreadsheet file and @var{intf1} will be used for reading. The OCT
## interface doesn't have write support (yet), so it will read spreadsheet
## files made by OTK (if supported) unless another interface is supplied
## for @var{intf2}.
##
## As the tests are meant to be run interactively, no output arguments are
## returned. The results of all test steps are printed on the terminal.
##
## @seealso {test_spsh, io_xls_testscript}
##
## @end deftypefn
## Author: Philip Nienhuis
## Created: 2012-02-25
## Updates:
## 2012-09-04 Add small delay between LibreOffice calls to avoid lock-ups with UNO
## 2013-04-21 Made it into a function
## 2013-12-18 Add option to write and read with different interfaces (needed for OCT)
## '' Catch more erroneous read-back results
## 2013-12-31 More extensive texinfo help text
## '' Provide default test file name
## 2014-01-23 Adapted to write support for OCT
## 2014-01-24 Fiddle with delays to allow OS to zip/unzip files to/from disk
## 2014-01-05 Update copyright string
function io_ods_testscript (intf, fname="io-test.ods", intf2='')
printf ("\nTesting .ods interface %s using file %s...\n", upper (intf), fname);
isuno = false; dly = 0.25;
if (isempty (intf2))
intf2 = intf;
else
printf ("(Writing files is done with interface %s)\n", upper (intf2));
endif
if (strcmpi (intf, "uno") || strcmpi (intf2, "uno"));
isuno = true;
endif
## 1. Initialize test arrays
printf ("\n 1. Initialize arrays.\n");
arr1 = [ 1 2; 3 4.5];
arr2 = {'r1c1', '=c2+d2'; '', 'r2c2'; true, -83.4};
opts = struct ("formulas_as_text", 0);
## 2. Insert empty sheet
printf ("\n 2. Insert first empty sheet.\n");
odswrite (fname, {''}, 'EmptySheet', 'b4', intf2);
sleep (dly);
## 3. Add data to test sheet
printf ("\n 3. Add data to test sheet.\n");
odswrite (fname, arr1, 'Testsheet', 'c2:d3', intf2); if (isuno); sleep (dly); endif
odswrite (fname, arr2, 'Testsheet', 'd4:z20', intf2);
sleep (dly);
## 4. Insert another sheet
printf ("\n 4. Add another sheet with just one number in A1.\n");
odswrite (fname, [1], 'JustOne', 'A1', intf2);
sleep (dly);
## 5. Get sheet info & find sheet with data and data range
printf ("\n 5. Explore sheet info.\n");
[~, shts] = odsfinfo (fname, intf);
shnr = strmatch ('Testsheet', shts(:, 1)); # Note case!
crange = shts{shnr, 2};
sleep (dly);
## 6. Read data back
printf ("\n 6. Read data back.\n");
[num, txt, raw, lims] = odsread (fname, shnr, crange, intf);
sleep (dly);
## First check: has anything been read at all?
if (isempty (raw))
printf ("No data at all have been read... test failed.\n");
return
elseif (isempty (num))
printf ("No numeric data have been read... test failed.\n");
return
elseif (isempty (txt))
printf ("No text data have been read... test failed.\n");
return
endif
## 7. Here come the tests, part 1
printf ("\n 7. Tests part 1 (basic I/O):\n");
try
printf (" ...Numeric array... ");
assert (num(1:2, 1:3), [1, 2, NaN; 3, 4.5, NaN], 1e-10);
assert (num(4:5, 1:3), [NaN, NaN, NaN; NaN, 1, -83.4], 1e-10);
assert (num(3, 1:2), [NaN, NaN], 1e-10);
# Just check if it's numeric, the value depends too much on cached results
assert (isnumeric (num(3,3)), true);
printf ("matches.\n");
catch
printf ("Hmmm.... error, see 'num'\n");
num
end_try_catch
try
printf (" ...Cellstr array... ");
assert (txt{1, 1}, 'r1c1');
assert (txt{2, 2}, 'r2c2');
printf ("matches.\n");
catch
printf ("Hmmm.... error, see 'txt'\n");
txt
end_try_catch
try
printf (" ...Boolean... ");
assert (islogical (raw{5, 2}), true); ## Fails on JOD
printf ("recovered.\n");
catch
if (size (raw, 1) < 5 || size (raw, 2) < 2)
printf ("Too little data read, boolean value not in expected data limits.\n");
elseif (isnumeric (raw{5, 2}))
printf ("recovered as numeric '1' rather than logical TRUE\n");
else
printf ("Hmmm.... error, see 'raw'\n");
raw
endif
end_try_catch
sleep (dly);
## Check if formulas_as_text works:
printf ("\n 8. Repeat reading, now return formulas as text\n");
opts.formulas_as_text = 1;
ods = odsopen (fname, 0, intf);
raw = ods2oct (ods, shnr, crange, opts);
ods = odsclose (ods);
clear ods;
## 9. Here come the tests, part 2. Fails on COM
printf ("\n 9. Tests part 2 (read back formula):\n");
try
# Just check if it contains any string
assert ( (ischar (raw{3, 3}) && ~isempty (raw(3, 3))), true);
printf (" ...OK, formula recovered ('%s').\n", raw{3, 3});
catch
printf ("Hmmm.... error, see 'raw(3, 3)'");
if (isempty (raw{3, 3}))
printf (" (<empty>, should be a string like '=c2+d2')\n");
elseif (isnumeric (raw{3, 3}))
printf (" (equals %f, should be a string like '=c2+d2')\n", raw{3, 3});
else
printf ("\n");
endif
end_try_catch
## 10. Clean up
printf ("\n10. Cleaning up.....");
delete (fname);
clear arr1 arr2 ods num txt raw lims opts shnr shts crange dly;
printf (" OK\n");
endfunction
|
