Browse Source

Initial commit

Alois Mahdal 6 years ago
commit
5a6f42f9ba
49 changed files with 5873 additions and 0 deletions
  1. 1
    0
      .gitignore
  2. 503
    0
      LICENSE.md
  3. 8
    0
      Makefile
  4. 4
    0
      README.md
  5. 39
    0
      mkit.ini
  6. 21
    0
      notes/TODO.md
  7. 59
    0
      notes/jattest
  8. 5
    0
      packaging/debian/changelog
  9. 1
    0
      packaging/debian/compat
  10. 28
    0
      packaging/debian/control
  11. 1
    0
      packaging/debian/copyright
  12. 2
    0
      packaging/debian/install
  13. 14
    0
      packaging/debian/rules
  14. 1
    0
      packaging/debian/source/format
  15. 47
    0
      packaging/template.spec
  16. 43
    0
      src/_pretty_jat.sh
  17. 1203
    0
      src/jat.sh.skel
  18. 387
    0
      src/jat_dump.sh.skel
  19. 3
    0
      tests/TF_HEADER
  20. 104
    0
      tests/basic/TF_RUN
  21. 0
    0
      tests/basic/oracle/ylog_both.stderr
  22. 115
    0
      tests/basic/oracle/ylog_both.stdout
  23. 0
    0
      tests/basic/oracle/ylog_fail.stderr
  24. 115
    0
      tests/basic/oracle/ylog_fail.stdout
  25. 0
    0
      tests/basic/oracle/ylog_pass.stderr
  26. 115
    0
      tests/basic/oracle/ylog_pass.stdout
  27. 290
    0
      utils/mkit/include/build.sh
  28. 130
    0
      utils/mkit/include/deploy.sh
  29. 175
    0
      utils/mkit/include/facts.sh
  30. 177
    0
      utils/mkit/include/ini.sh
  31. 162
    0
      utils/mkit/include/mkit.sh
  32. 232
    0
      utils/mkit/include/release.sh
  33. 61
    0
      utils/mkit/include/vars.sh
  34. 34
    0
      utils/mkit/make
  35. 56
    0
      utils/mkit/mkit.mk
  36. 715
    0
      utils/mkit/stub
  37. 399
    0
      utils/tfkit/doc/README.md
  38. 26
    0
      utils/tfkit/doc/templates/grep_engine/TF_RUN
  39. 3
    0
      utils/tfkit/doc/templates/grep_engine/oracle/basic.stdout
  40. 3
    0
      utils/tfkit/doc/templates/grep_engine/oracle/extended.stdout
  41. 1
    0
      utils/tfkit/doc/templates/grep_engine/oracle/fixed.stdout
  42. 6
    0
      utils/tfkit/doc/templates/grep_engine/test/ALL.stdin
  43. 37
    0
      utils/tfkit/doc/templates/simple/TF_RUN
  44. 142
    0
      utils/tfkit/include/common.sh
  45. 125
    0
      utils/tfkit/include/harness.sh
  46. 84
    0
      utils/tfkit/include/subtest.sh
  47. 86
    0
      utils/tfkit/include/tools.sh
  48. 92
    0
      utils/tfkit/runtests
  49. 18
    0
      utils/tfkit/tfkit.mk

+ 1
- 0
.gitignore View File

@@ -0,0 +1 @@
1
+relics

+ 503
- 0
LICENSE.md View File

@@ -0,0 +1,503 @@
1
+### GNU LESSER GENERAL PUBLIC LICENSE
2
+
3
+Version 2.1, February 1999
4
+
5
+    Copyright (C) 1991, 1999 Free Software Foundation, Inc.
6
+    51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
7
+    
8
+    Everyone is permitted to copy and distribute verbatim copies
9
+    of this license document, but changing it is not allowed.
10
+
11
+    [This is the first released version of the Lesser GPL.  It also counts
12
+     as the successor of the GNU Library Public License, version 2, hence
13
+     the version number 2.1.]
14
+
15
+### Preamble
16
+
17
+The licenses for most software are designed to take away your freedom
18
+to share and change it. By contrast, the GNU General Public Licenses
19
+are intended to guarantee your freedom to share and change free
20
+software--to make sure the software is free for all its users.
21
+
22
+This license, the Lesser General Public License, applies to some
23
+specially designated software packages--typically libraries--of the
24
+Free Software Foundation and other authors who decide to use it. You
25
+can use it too, but we suggest you first think carefully about whether
26
+this license or the ordinary General Public License is the better
27
+strategy to use in any particular case, based on the explanations
28
+below.
29
+
30
+When we speak of free software, we are referring to freedom of use,
31
+not price. Our General Public Licenses are designed to make sure that
32
+you have the freedom to distribute copies of free software (and charge
33
+for this service if you wish); that you receive source code or can get
34
+it if you want it; that you can change the software and use pieces of
35
+it in new free programs; and that you are informed that you can do
36
+these things.
37
+
38
+To protect your rights, we need to make restrictions that forbid
39
+distributors to deny you these rights or to ask you to surrender these
40
+rights. These restrictions translate to certain responsibilities for
41
+you if you distribute copies of the library or if you modify it.
42
+
43
+For example, if you distribute copies of the library, whether gratis
44
+or for a fee, you must give the recipients all the rights that we gave
45
+you. You must make sure that they, too, receive or can get the source
46
+code. If you link other code with the library, you must provide
47
+complete object files to the recipients, so that they can relink them
48
+with the library after making changes to the library and recompiling
49
+it. And you must show them these terms so they know their rights.
50
+
51
+We protect your rights with a two-step method: (1) we copyright the
52
+library, and (2) we offer you this license, which gives you legal
53
+permission to copy, distribute and/or modify the library.
54
+
55
+To protect each distributor, we want to make it very clear that there
56
+is no warranty for the free library. Also, if the library is modified
57
+by someone else and passed on, the recipients should know that what
58
+they have is not the original version, so that the original author's
59
+reputation will not be affected by problems that might be introduced
60
+by others.
61
+
62
+Finally, software patents pose a constant threat to the existence of
63
+any free program. We wish to make sure that a company cannot
64
+effectively restrict the users of a free program by obtaining a
65
+restrictive license from a patent holder. Therefore, we insist that
66
+any patent license obtained for a version of the library must be
67
+consistent with the full freedom of use specified in this license.
68
+
69
+Most GNU software, including some libraries, is covered by the
70
+ordinary GNU General Public License. This license, the GNU Lesser
71
+General Public License, applies to certain designated libraries, and
72
+is quite different from the ordinary General Public License. We use
73
+this license for certain libraries in order to permit linking those
74
+libraries into non-free programs.
75
+
76
+When a program is linked with a library, whether statically or using a
77
+shared library, the combination of the two is legally speaking a
78
+combined work, a derivative of the original library. The ordinary
79
+General Public License therefore permits such linking only if the
80
+entire combination fits its criteria of freedom. The Lesser General
81
+Public License permits more lax criteria for linking other code with
82
+the library.
83
+
84
+We call this license the "Lesser" General Public License because it
85
+does Less to protect the user's freedom than the ordinary General
86
+Public License. It also provides other free software developers Less
87
+of an advantage over competing non-free programs. These disadvantages
88
+are the reason we use the ordinary General Public License for many
89
+libraries. However, the Lesser license provides advantages in certain
90
+special circumstances.
91
+
92
+For example, on rare occasions, there may be a special need to
93
+encourage the widest possible use of a certain library, so that it
94
+becomes a de-facto standard. To achieve this, non-free programs must
95
+be allowed to use the library. A more frequent case is that a free
96
+library does the same job as widely used non-free libraries. In this
97
+case, there is little to gain by limiting the free library to free
98
+software only, so we use the Lesser General Public License.
99
+
100
+In other cases, permission to use a particular library in non-free
101
+programs enables a greater number of people to use a large body of
102
+free software. For example, permission to use the GNU C Library in
103
+non-free programs enables many more people to use the whole GNU
104
+operating system, as well as its variant, the GNU/Linux operating
105
+system.
106
+
107
+Although the Lesser General Public License is Less protective of the
108
+users' freedom, it does ensure that the user of a program that is
109
+linked with the Library has the freedom and the wherewithal to run
110
+that program using a modified version of the Library.
111
+
112
+The precise terms and conditions for copying, distribution and
113
+modification follow. Pay close attention to the difference between a
114
+"work based on the library" and a "work that uses the library". The
115
+former contains code derived from the library, whereas the latter must
116
+be combined with the library in order to run.
117
+
118
+### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
119
+
120
+**0.** This License Agreement applies to any software library or other
121
+program which contains a notice placed by the copyright holder or
122
+other authorized party saying it may be distributed under the terms of
123
+this Lesser General Public License (also called "this License"). Each
124
+licensee is addressed as "you".
125
+
126
+A "library" means a collection of software functions and/or data
127
+prepared so as to be conveniently linked with application programs
128
+(which use some of those functions and data) to form executables.
129
+
130
+The "Library", below, refers to any such software library or work
131
+which has been distributed under these terms. A "work based on the
132
+Library" means either the Library or any derivative work under
133
+copyright law: that is to say, a work containing the Library or a
134
+portion of it, either verbatim or with modifications and/or translated
135
+straightforwardly into another language. (Hereinafter, translation is
136
+included without limitation in the term "modification".)
137
+
138
+"Source code" for a work means the preferred form of the work for
139
+making modifications to it. For a library, complete source code means
140
+all the source code for all modules it contains, plus any associated
141
+interface definition files, plus the scripts used to control
142
+compilation and installation of the library.
143
+
144
+Activities other than copying, distribution and modification are not
145
+covered by this License; they are outside its scope. The act of
146
+running a program using the Library is not restricted, and output from
147
+such a program is covered only if its contents constitute a work based
148
+on the Library (independent of the use of the Library in a tool for
149
+writing it). Whether that is true depends on what the Library does and
150
+what the program that uses the Library does.
151
+
152
+**1.** You may copy and distribute verbatim copies of the Library's
153
+complete source code as you receive it, in any medium, provided that
154
+you conspicuously and appropriately publish on each copy an
155
+appropriate copyright notice and disclaimer of warranty; keep intact
156
+all the notices that refer to this License and to the absence of any
157
+warranty; and distribute a copy of this License along with the
158
+Library.
159
+
160
+You may charge a fee for the physical act of transferring a copy, and
161
+you may at your option offer warranty protection in exchange for a
162
+fee.
163
+
164
+**2.** You may modify your copy or copies of the Library or any
165
+portion of it, thus forming a work based on the Library, and copy and
166
+distribute such modifications or work under the terms of Section 1
167
+above, provided that you also meet all of these conditions:
168
+
169
+-   **a)** The modified work must itself be a software library.
170
+-   **b)** You must cause the files modified to carry prominent
171
+    notices stating that you changed the files and the date of
172
+    any change.
173
+-   **c)** You must cause the whole of the work to be licensed at no
174
+    charge to all third parties under the terms of this License.
175
+-   **d)** If a facility in the modified Library refers to a function
176
+    or a table of data to be supplied by an application program that
177
+    uses the facility, other than as an argument passed when the
178
+    facility is invoked, then you must make a good faith effort to
179
+    ensure that, in the event an application does not supply such
180
+    function or table, the facility still operates, and performs
181
+    whatever part of its purpose remains meaningful.
182
+
183
+    (For example, a function in a library to compute square roots has
184
+    a purpose that is entirely well-defined independent of
185
+    the application. Therefore, Subsection 2d requires that any
186
+    application-supplied function or table used by this function must
187
+    be optional: if the application does not supply it, the square
188
+    root function must still compute square roots.)
189
+
190
+These requirements apply to the modified work as a whole. If
191
+identifiable sections of that work are not derived from the Library,
192
+and can be reasonably considered independent and separate works in
193
+themselves, then this License, and its terms, do not apply to those
194
+sections when you distribute them as separate works. But when you
195
+distribute the same sections as part of a whole which is a work based
196
+on the Library, the distribution of the whole must be on the terms of
197
+this License, whose permissions for other licensees extend to the
198
+entire whole, and thus to each and every part regardless of who wrote
199
+it.
200
+
201
+Thus, it is not the intent of this section to claim rights or contest
202
+your rights to work written entirely by you; rather, the intent is to
203
+exercise the right to control the distribution of derivative or
204
+collective works based on the Library.
205
+
206
+In addition, mere aggregation of another work not based on the Library
207
+with the Library (or with a work based on the Library) on a volume of
208
+a storage or distribution medium does not bring the other work under
209
+the scope of this License.
210
+
211
+**3.** You may opt to apply the terms of the ordinary GNU General
212
+Public License instead of this License to a given copy of the Library.
213
+To do this, you must alter all the notices that refer to this License,
214
+so that they refer to the ordinary GNU General Public License, version
215
+2, instead of to this License. (If a newer version than version 2 of
216
+the ordinary GNU General Public License has appeared, then you can
217
+specify that version instead if you wish.) Do not make any other
218
+change in these notices.
219
+
220
+Once this change is made in a given copy, it is irreversible for that
221
+copy, so the ordinary GNU General Public License applies to all
222
+subsequent copies and derivative works made from that copy.
223
+
224
+This option is useful when you wish to copy part of the code of the
225
+Library into a program that is not a library.
226
+
227
+**4.** You may copy and distribute the Library (or a portion or
228
+derivative of it, under Section 2) in object code or executable form
229
+under the terms of Sections 1 and 2 above provided that you accompany
230
+it with the complete corresponding machine-readable source code, which
231
+must be distributed under the terms of Sections 1 and 2 above on a
232
+medium customarily used for software interchange.
233
+
234
+If distribution of object code is made by offering access to copy from
235
+a designated place, then offering equivalent access to copy the source
236
+code from the same place satisfies the requirement to distribute the
237
+source code, even though third parties are not compelled to copy the
238
+source along with the object code.
239
+
240
+**5.** A program that contains no derivative of any portion of the
241
+Library, but is designed to work with the Library by being compiled or
242
+linked with it, is called a "work that uses the Library". Such a work,
243
+in isolation, is not a derivative work of the Library, and therefore
244
+falls outside the scope of this License.
245
+
246
+However, linking a "work that uses the Library" with the Library
247
+creates an executable that is a derivative of the Library (because it
248
+contains portions of the Library), rather than a "work that uses the
249
+library". The executable is therefore covered by this License. Section
250
+6 states terms for distribution of such executables.
251
+
252
+When a "work that uses the Library" uses material from a header file
253
+that is part of the Library, the object code for the work may be a
254
+derivative work of the Library even though the source code is not.
255
+Whether this is true is especially significant if the work can be
256
+linked without the Library, or if the work is itself a library. The
257
+threshold for this to be true is not precisely defined by law.
258
+
259
+If such an object file uses only numerical parameters, data structure
260
+layouts and accessors, and small macros and small inline functions
261
+(ten lines or less in length), then the use of the object file is
262
+unrestricted, regardless of whether it is legally a derivative work.
263
+(Executables containing this object code plus portions of the Library
264
+will still fall under Section 6.)
265
+
266
+Otherwise, if the work is a derivative of the Library, you may
267
+distribute the object code for the work under the terms of Section 6.
268
+Any executables containing that work also fall under Section 6,
269
+whether or not they are linked directly with the Library itself.
270
+
271
+**6.** As an exception to the Sections above, you may also combine or
272
+link a "work that uses the Library" with the Library to produce a work
273
+containing portions of the Library, and distribute that work under
274
+terms of your choice, provided that the terms permit modification of
275
+the work for the customer's own use and reverse engineering for
276
+debugging such modifications.
277
+
278
+You must give prominent notice with each copy of the work that the
279
+Library is used in it and that the Library and its use are covered by
280
+this License. You must supply a copy of this License. If the work
281
+during execution displays copyright notices, you must include the
282
+copyright notice for the Library among them, as well as a reference
283
+directing the user to the copy of this License. Also, you must do one
284
+of these things:
285
+
286
+-   **a)** Accompany the work with the complete corresponding
287
+    machine-readable source code for the Library including whatever
288
+    changes were used in the work (which must be distributed under
289
+    Sections 1 and 2 above); and, if the work is an executable linked
290
+    with the Library, with the complete machine-readable "work that
291
+    uses the Library", as object code and/or source code, so that the
292
+    user can modify the Library and then relink to produce a modified
293
+    executable containing the modified Library. (It is understood that
294
+    the user who changes the contents of definitions files in the
295
+    Library will not necessarily be able to recompile the application
296
+    to use the modified definitions.)
297
+-   **b)** Use a suitable shared library mechanism for linking with
298
+    the Library. A suitable mechanism is one that (1) uses at run time
299
+    a copy of the library already present on the user's computer
300
+    system, rather than copying library functions into the executable,
301
+    and (2) will operate properly with a modified version of the
302
+    library, if the user installs one, as long as the modified version
303
+    is interface-compatible with the version that the work was
304
+    made with.
305
+-   **c)** Accompany the work with a written offer, valid for at least
306
+    three years, to give the same user the materials specified in
307
+    Subsection 6a, above, for a charge no more than the cost of
308
+    performing this distribution.
309
+-   **d)** If distribution of the work is made by offering access to
310
+    copy from a designated place, offer equivalent access to copy the
311
+    above specified materials from the same place.
312
+-   **e)** Verify that the user has already received a copy of these
313
+    materials or that you have already sent this user a copy.
314
+
315
+For an executable, the required form of the "work that uses the
316
+Library" must include any data and utility programs needed for
317
+reproducing the executable from it. However, as a special exception,
318
+the materials to be distributed need not include anything that is
319
+normally distributed (in either source or binary form) with the major
320
+components (compiler, kernel, and so on) of the operating system on
321
+which the executable runs, unless that component itself accompanies
322
+the executable.
323
+
324
+It may happen that this requirement contradicts the license
325
+restrictions of other proprietary libraries that do not normally
326
+accompany the operating system. Such a contradiction means you cannot
327
+use both them and the Library together in an executable that you
328
+distribute.
329
+
330
+**7.** You may place library facilities that are a work based on the
331
+Library side-by-side in a single library together with other library
332
+facilities not covered by this License, and distribute such a combined
333
+library, provided that the separate distribution of the work based on
334
+the Library and of the other library facilities is otherwise
335
+permitted, and provided that you do these two things:
336
+
337
+-   **a)** Accompany the combined library with a copy of the same work
338
+    based on the Library, uncombined with any other
339
+    library facilities. This must be distributed under the terms of
340
+    the Sections above.
341
+-   **b)** Give prominent notice with the combined library of the fact
342
+    that part of it is a work based on the Library, and explaining
343
+    where to find the accompanying uncombined form of the same work.
344
+
345
+**8.** You may not copy, modify, sublicense, link with, or distribute
346
+the Library except as expressly provided under this License. Any
347
+attempt otherwise to copy, modify, sublicense, link with, or
348
+distribute the Library is void, and will automatically terminate your
349
+rights under this License. However, parties who have received copies,
350
+or rights, from you under this License will not have their licenses
351
+terminated so long as such parties remain in full compliance.
352
+
353
+**9.** You are not required to accept this License, since you have not
354
+signed it. However, nothing else grants you permission to modify or
355
+distribute the Library or its derivative works. These actions are
356
+prohibited by law if you do not accept this License. Therefore, by
357
+modifying or distributing the Library (or any work based on the
358
+Library), you indicate your acceptance of this License to do so, and
359
+all its terms and conditions for copying, distributing or modifying
360
+the Library or works based on it.
361
+
362
+**10.** Each time you redistribute the Library (or any work based on
363
+the Library), the recipient automatically receives a license from the
364
+original licensor to copy, distribute, link with or modify the Library
365
+subject to these terms and conditions. You may not impose any further
366
+restrictions on the recipients' exercise of the rights granted herein.
367
+You are not responsible for enforcing compliance by third parties with
368
+this License.
369
+
370
+**11.** If, as a consequence of a court judgment or allegation of
371
+patent infringement or for any other reason (not limited to patent
372
+issues), conditions are imposed on you (whether by court order,
373
+agreement or otherwise) that contradict the conditions of this
374
+License, they do not excuse you from the conditions of this License.
375
+If you cannot distribute so as to satisfy simultaneously your
376
+obligations under this License and any other pertinent obligations,
377
+then as a consequence you may not distribute the Library at all. For
378
+example, if a patent license would not permit royalty-free
379
+redistribution of the Library by all those who receive copies directly
380
+or indirectly through you, then the only way you could satisfy both it
381
+and this License would be to refrain entirely from distribution of the
382
+Library.
383
+
384
+If any portion of this section is held invalid or unenforceable under
385
+any particular circumstance, the balance of the section is intended to
386
+apply, and the section as a whole is intended to apply in other
387
+circumstances.
388
+
389
+It is not the purpose of this section to induce you to infringe any
390
+patents or other property right claims or to contest validity of any
391
+such claims; this section has the sole purpose of protecting the
392
+integrity of the free software distribution system which is
393
+implemented by public license practices. Many people have made
394
+generous contributions to the wide range of software distributed
395
+through that system in reliance on consistent application of that
396
+system; it is up to the author/donor to decide if he or she is willing
397
+to distribute software through any other system and a licensee cannot
398
+impose that choice.
399
+
400
+This section is intended to make thoroughly clear what is believed to
401
+be a consequence of the rest of this License.
402
+
403
+**12.** If the distribution and/or use of the Library is restricted in
404
+certain countries either by patents or by copyrighted interfaces, the
405
+original copyright holder who places the Library under this License
406
+may add an explicit geographical distribution limitation excluding
407
+those countries, so that distribution is permitted only in or among
408
+countries not thus excluded. In such case, this License incorporates
409
+the limitation as if written in the body of this License.
410
+
411
+**13.** The Free Software Foundation may publish revised and/or new
412
+versions of the Lesser General Public License from time to time. Such
413
+new versions will be similar in spirit to the present version, but may
414
+differ in detail to address new problems or concerns.
415
+
416
+Each version is given a distinguishing version number. If the Library
417
+specifies a version number of this License which applies to it and
418
+"any later version", you have the option of following the terms and
419
+conditions either of that version or of any later version published by
420
+the Free Software Foundation. If the Library does not specify a
421
+license version number, you may choose any version ever published by
422
+the Free Software Foundation.
423
+
424
+**14.** If you wish to incorporate parts of the Library into other
425
+free programs whose distribution conditions are incompatible with
426
+these, write to the author to ask for permission. For software which
427
+is copyrighted by the Free Software Foundation, write to the Free
428
+Software Foundation; we sometimes make exceptions for this. Our
429
+decision will be guided by the two goals of preserving the free status
430
+of all derivatives of our free software and of promoting the sharing
431
+and reuse of software generally.
432
+
433
+**NO WARRANTY**
434
+
435
+**15.** BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
436
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
437
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
438
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
439
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
440
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
441
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
442
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
443
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
444
+
445
+**16.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
446
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
447
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
448
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
449
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
450
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
451
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
452
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
453
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
454
+DAMAGES.
455
+
456
+### END OF TERMS AND CONDITIONS
457
+
458
+### How to Apply These Terms to Your New Libraries
459
+
460
+If you develop a new library, and you want it to be of the greatest
461
+possible use to the public, we recommend making it free software that
462
+everyone can redistribute and change. You can do so by permitting
463
+redistribution under these terms (or, alternatively, under the terms
464
+of the ordinary General Public License).
465
+
466
+To apply these terms, attach the following notices to the library. It
467
+is safest to attach them to the start of each source file to most
468
+effectively convey the exclusion of warranty; and each file should
469
+have at least the "copyright" line and a pointer to where the full
470
+notice is found.
471
+
472
+    one line to give the library's name and an idea of what it does.
473
+    Copyright (C) year  name of author
474
+
475
+    This library is free software; you can redistribute it and/or
476
+    modify it under the terms of the GNU Lesser General Public
477
+    License as published by the Free Software Foundation; either
478
+    version 2.1 of the License, or (at your option) any later version.
479
+
480
+    This library is distributed in the hope that it will be useful,
481
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
482
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
483
+    Lesser General Public License for more details.
484
+
485
+    You should have received a copy of the GNU Lesser General Public
486
+    License along with this library; if not, write to the Free Software
487
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
488
+
489
+Also add information on how to contact you by electronic and paper
490
+mail.
491
+
492
+You should also get your employer (if you work as a programmer) or
493
+your school, if any, to sign a "copyright disclaimer" for the library,
494
+if necessary. Here is a sample; alter the names:
495
+
496
+    Yoyodyne, Inc., hereby disclaims all copyright interest in
497
+    the library `Frob' (a library for tweaking knobs) written
498
+    by James Random Hacker.
499
+
500
+    signature of Ty Coon, 1 April 1990
501
+    Ty Coon, President of Vice
502
+
503
+That's all there is to it!

+ 8
- 0
Makefile View File

@@ -0,0 +1,8 @@
1
+# JaT - Just A[nother] Testing library
2
+# See LICENSE.md file for copyright and license details.
3
+
4
+MKIT_DIR=utils/mkit
5
+include $(MKIT_DIR)/mkit.mk
6
+
7
+TF_DIR=utils/tfkit
8
+include $(TF_DIR)/tfkit.mk

+ 4
- 0
README.md View File

@@ -0,0 +1,4 @@
1
+JaT
2
+===
3
+
4
+Just A[nother] Testing library

+ 39
- 0
mkit.ini View File

@@ -0,0 +1,39 @@
1
+[project]
2
+    version     = 0.0.0
3
+    name        = JaT
4
+    tagline     = Just A[nother] Testing library
5
+    pkgname     = shellfu-bash-jat
6
+    maintainer  = Alois Mahdal <netvor+jat@vornet.cz>
7
+    vcs_browser = https://github.com/AloisMahdal/shellfu-bash-jat
8
+    relsrc      = master
9
+    reldst      = last
10
+
11
+[dist]
12
+    tarball  = LICENSE.md
13
+    tarball  = Makefile
14
+    tarball  = README.md
15
+    tarball  = mkit.ini
16
+    tarball  = packaging
17
+    tarball  = src
18
+    tarball  = tests
19
+    tarball  = utils
20
+    rpmstuff = packaging/template.spec
21
+    debstuff = packaging/debian
22
+
23
+[ENV]
24
+    PREFIX = /usr/local
25
+
26
+[roots]
27
+    doc   = [ENV:PREFIX]/share/doc/shellfu-bash-jat
28
+    sfmod = [ENV:PREFIX]/share/shellfu/include-bash
29
+
30
+[macros]
31
+    __SHELLFU_MODNAME__ = jat
32
+    __SHELLFU_MODDESC__ = Just A[nother] Testing library
33
+
34
+[files]
35
+    doc   = README.md
36
+    sfmod = src/jat.sh
37
+    sfmod = src/jat_dump.sh
38
+
39
+#mkit version=0.0.32

+ 21
- 0
notes/TODO.md View File

@@ -0,0 +1,21 @@
1
+TODO
2
+====
3
+
4
+ *  Add way to pass:
5
+     *  test name, etc.
6
+     *  env info,
7
+     *  sut info.
8
+
9
+ *  think hard about promises
10
+
11
+ *  do YAML more right
12
+
13
+ *  wait, are phases preserved across sessions?
14
+
15
+ *  WAIT, are phases preserved into subshell (logging..)?
16
+
17
+ *  jat__lsummary()
18
+
19
+ *  add .j2 for HTML/text/whatever (separate module?)
20
+
21
+ *  fortify against running from within test

+ 59
- 0
notes/jattest View File

@@ -0,0 +1,59 @@
1
+#!/bin/bash
2
+
3
+if ! test -f /var/tmp/jat/rebooted; then
4
+
5
+    jat__cmp 0 eq 1
6
+
7
+    jat__pstarts init
8
+        jat__cmp -h "math works" \
9
+            0 eq 0
10
+    jat__pend
11
+
12
+    jat__pstartt
13
+        jat__cmd true
14
+        jat__cmd false
15
+        jat__cmd -e 1 true
16
+        jat__cmd -e 1 false
17
+        jat__cmp 5 eq 3
18
+        jat__cmp 5 gt 3
19
+        jat__cmp foo re oo
20
+        jat__cmp foo re '.*oo'
21
+        jat__pass -h "so it looks fine"
22
+        jat__fail -h "it still looks fine"
23
+        jat__fail
24
+        jat__pass
25
+        jat__log_info "this is normal"
26
+    jat__pend
27
+
28
+    jat__pstartt beidz
29
+        jat__cmd -b foo true
30
+        jat__cmd -b foo2 false
31
+    jat__pend
32
+
33
+    jat__pstartt pre-reboot
34
+        jat__cmd true
35
+        touch /var/tmp/jat/rebooted
36
+    jat__pend
37
+
38
+    jat__log_info "rebooting"
39
+    exit
40
+
41
+else
42
+
43
+    jat__log_info "rebooted"
44
+    jat__pstartt post-reboot
45
+        rm /var/tmp/jat/rebooted
46
+        jat__cmd true
47
+    jat__pend
48
+
49
+fi
50
+
51
+# jat__pstartt "torture"
52
+#     jat__cmd
53
+#     jat__cmd -z zaza
54
+#     jat__cmp foo bar baz
55
+#     jat__cmp foo eq baz
56
+#     jat__fail "heya"
57
+#     jat__pass "hoya"
58
+#     jat__log_error "this is not normal"
59
+# jat__pend

+ 5
- 0
packaging/debian/changelog View File

@@ -0,0 +1,5 @@
1
+__MKIT_PROJ_PKGNAME__ (__MKIT_PROJ_VERSION__-1) UNRELEASED; urgency=medium
2
+
3
+  * Initial release. (Closes: #XXXXXX)
4
+
5
+ -- __MKIT_PROJ_MAINTAINER__  Thu, 03 May 2018 00:29:14 +0200

+ 1
- 0
packaging/debian/compat View File

@@ -0,0 +1 @@
1
+9

+ 28
- 0
packaging/debian/control View File

@@ -0,0 +1,28 @@
1
+Source: __MKIT_PROJ_PKGNAME__
2
+Maintainer: __MKIT_PROJ_MAINTAINER__
3
+Vcs-Browser: __MKIT_PROJ_VCS_BROWSER__
4
+Section: misc
5
+Priority: extra
6
+Standards-Version: 3.9.2
7
+Build-Depends:
8
+ debhelper (>= 9),
9
+ shellfu (>= 0.10.7),
10
+ shellfu (<< 0.11),
11
+ shellfu-bash,
12
+ shellfu-bash-pretty,
13
+ shellfu-sh-isa,
14
+ shellfu-sh-termcolors,
15
+
16
+Package: __MKIT_PROJ_PKGNAME__
17
+Architecture: all
18
+Depends:
19
+ shellfu (>= 0.10.7),
20
+ shellfu (<< 0.11),
21
+ shellfu-bash,
22
+ shellfu-bash-pretty,
23
+ shellfu-sh-isa,
24
+ shellfu-sh-termcolors,
25
+Description: __MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__
26
+ __SHELLFU_MODDESC__
27
+
28
+# control file built with MKit __MKIT_SELF_VERSION__

+ 1
- 0
packaging/debian/copyright View File

@@ -0,0 +1 @@
1
+

+ 2
- 0
packaging/debian/install View File

@@ -0,0 +1,2 @@
1
+/usr/share/shellfu/include-bash/__SHELLFU_MODNAME__.sh
2
+/usr/share/shellfu/include-bash/jat_dump.sh

+ 14
- 0
packaging/debian/rules View File

@@ -0,0 +1,14 @@
1
+#!/usr/bin/make -f
2
+
3
+%:
4
+
5
+	dh $@
6
+
7
+override_dh_auto_install:
8
+
9
+	make install PREFIX=/usr DESTDIR=debian/tmp
10
+
11
+override_dh_auto_test:
12
+	make install PREFIX=/usr DESTDIR=debian/tmp
13
+	make test \
14
+		SHELLFU_PATH=$(shell pwd)/debian/tmp/usr/share/shellfu/include-bash

+ 1
- 0
packaging/debian/source/format View File

@@ -0,0 +1 @@
1
+3.0 (quilt)

+ 47
- 0
packaging/template.spec View File

@@ -0,0 +1,47 @@
1
+%global sfincb %{_datadir}/shellfu/include-bash
2
+%global sfmodn __SHELLFU_MODNAME__
3
+%global shellfu_req shellfu >= 0.10.7, shellfu < 0.11
4
+
5
+Name:       __MKIT_PROJ_PKGNAME__
6
+Version:    __MKIT_PROJ_VERSION__
7
+Release:    1%{?dist}
8
+Summary:    __MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__
9
+URL:        __MKIT_PROJ_VCS_BROWSER__
10
+License:    LGPLv2
11
+Source0:    %{name}-%{version}.tar.gz
12
+BuildArch:  noarch
13
+BuildRequires: %shellfu_req
14
+BuildRequires: shellfu-bash-pretty
15
+BuildRequires: shellfu-sh-isa
16
+BuildRequires: shellfu-sh-termcolors
17
+
18
+Requires: %shellfu_req
19
+Requires: shellfu-bash
20
+Requires: shellfu-bash-pretty
21
+Requires: shellfu-sh-isa
22
+Requires: shellfu-sh-termcolors
23
+%description
24
+__SHELLFU_MODDESC__
25
+
26
+%prep
27
+%setup -q
28
+
29
+%build
30
+make %{?_smp_mflags} PREFIX=/usr
31
+
32
+%install
33
+%make_install PREFIX=/usr
34
+
35
+%check
36
+make test \
37
+    SHELLFU_PATH=%{buildroot}/%{_datadir}/shellfu/include-bash
38
+
39
+%files
40
+%doc %{_docdir}/%{name}/README.md
41
+%{sfincb}/%{sfmodn}.sh
42
+%{sfincb}/%{sfmodn}_dump.sh
43
+
44
+
45
+%changelog
46
+
47
+# specfile built with MKit __MKIT_SELF_VERSION__

+ 43
- 0
src/_pretty_jat.sh View File

@@ -0,0 +1,43 @@
1
+#!/bin/bash
2
+
3
+shellfu import jat
4
+
5
+_pretty__debug() {
6
+    local decor="()"
7
+    local caller_is_main=${caller_is_main:-false}
8
+    local caller=${caller:-UNKNOWN}
9
+    $caller_is_main && decor=
10
+    while IFS= read -r line;
11
+    do jat__log_info "debug:$caller$decor:"
12
+       jat__log_info "$line"; done
13
+}
14
+
15
+
16
+_pretty__die() {
17
+    while IFS= read -r line;
18
+    do jat__log_error "$line"; done
19
+}
20
+
21
+
22
+_pretty__mkhelp() {
23
+    while IFS= read -r line;
24
+    do jat__log_info "$line"; done
25
+}
26
+
27
+
28
+_pretty__mkusage() {
29
+    while IFS= read -r line;
30
+    do jat__log_info "$line"; done
31
+}
32
+
33
+
34
+_pretty__think() {
35
+    while IFS= read -r line;
36
+    do jat__log_info "$line"; done
37
+}
38
+
39
+
40
+_pretty__warn() {
41
+    while IFS= read -r line;
42
+    do jat__log_warning "$line"; done
43
+}

+ 1203
- 0
src/jat.sh.skel
File diff suppressed because it is too large
View File


+ 387
- 0
src/jat_dump.sh.skel View File

@@ -0,0 +1,387 @@
1
+#!/bin/bash
2
+
3
+shellfu import jat
4
+shellfu import pretty
5
+
6
+#
7
+# Helpers for dumping files to log
8
+#
9
+# This module provides several functions to enable showing
10
+# contents of (supposedly small) files or command outputs directly
11
+# inside JAT log.
12
+#
13
+# This can be very helpful, especially if you know you are dealing
14
+# with relatively small files or to provide generic diagnostic
15
+# data.
16
+#
17
+# For example:
18
+#
19
+#     some_command >out 2>err
20
+#     jat__eval "grep foo out"
21
+#     jat__eval "grep bar out" 1
22
+#     jat__eval "test -s err" 1
23
+#     jat_dump__file out err
24
+#
25
+# Here, if your asserts fail, it will be very useful to see the content
26
+# right in the log.
27
+#
28
+# Another example (from real life):
29
+#
30
+#     rlPhaseStartTest infodump
31
+#         ps -C cimserver -o euser,ruser,suser,fuser,f,comm,label \
32
+#           | jat_dump__pipe PS_SECINFO
33
+#         ps -C cimserver -f \
34
+#           | jat_dump__pipe PS_F
35
+#         ps -C cimserver -Lf \
36
+#           | jat_dump__pipe PS_THREADS
37
+#         ps -ef \
38
+#           | jat_dump__pipe PS_EF
39
+#         jat_dump__file /etc/passwd /etc/group
40
+#     rlPhaseEnd
41
+#
42
+# Here, in one phase -- without getting in the way of other code
43
+# we can get reasonable profile of the cimserver process and
44
+# basic system setup.
45
+#
46
+
47
+#
48
+# Pipe via hexdump before printing?
49
+#
50
+# `always` to enforce all files through hexdump, `never` to disable
51
+# hexdump, `auto` to have the filetype detected.
52
+#
53
+JAT_DUMP__HEXMODE=${JAT_DUMP__HEXMODE:-auto}
54
+
55
+
56
+#
57
+# Command to use for hex dumping
58
+#
59
+JAT_DUMP__HEXCMD=${JAT_DUMP__HEXCMD:-hexdump -C}
60
+
61
+
62
+#
63
+# Limit in lines before rlFileSubmit is used instead of printing
64
+#
65
+JAT_DUMP__LIMIT_L=${JAT_DUMP__LIMIT_L:-100}
66
+
67
+
68
+#
69
+# Limit in bytes before rlFileSubmit is used instead of printing
70
+#
71
+JAT_DUMP__LIMIT_B=${JAT_DUMP__LIMIT_B:-10000}
72
+
73
+
74
+#
75
+# Function to use for logging
76
+#
77
+JAT_DUMP__DMPFUN=${JAT_DUMP__DMPFUN:-jat__log_info}
78
+
79
+
80
+jat_dump__file() {
81
+    #
82
+    # Dump contents of given file(s) using jat__log_info
83
+    #
84
+    # Usage:
85
+    #
86
+    #     jat_dump__file [options] FILE...
87
+    #
88
+    # Description:
89
+    #
90
+    # Print contents of given file(s) to the main TESTOUT.log
91
+    # using jat_log* functions and adding BEGIN/END delimiters.
92
+    # If a file is too big, use rlFileSubmit instead.  If a file
93
+    # is binary, pipe it through `hexdump -C`.
94
+    #
95
+    # Options:
96
+    #
97
+    #   *  -h, --hex
98
+    #   *  -H, --no-hex
99
+    #               enforce or ban hexdump for all files
100
+    #   *  -b BYTES, --max-bytes BYTES
101
+    #   *  -l LINES, --max-lines LINES
102
+    #               set limit to lines or bytes; if file is bigger,
103
+    #               use rlFileSubmit instead
104
+    #   *  -I, --info
105
+    #   *  -E, --error
106
+    #   *  -D, --debug
107
+    #               use different level of jat_log* (Info by default)
108
+    #   *  -s, --skip-empty
109
+    #               do not do anything if file is empty
110
+    #   *  -S, --skip-missing
111
+    #               do not do anything if file is missing
112
+    #
113
+    local hexmode=$JAT_DUMP__HEXMODE
114
+    local limit_b=$JAT_DUMP__LIMIT_B
115
+    local limit_l=$JAT_DUMP__LIMIT_L
116
+    local dmpfun="$JAT_DUMP__DMPFUN"
117
+    local skip_empty=false
118
+    local skip_missing=false
119
+    while true; do case "$1" in
120
+        -h|--hex)        hexmode=always;      shift 1 ;;
121
+        -H|--no-hex)     hexmode=never;       shift 1 ;;
122
+        -b|--max-bytes)  limit_b=$2;          shift 2 ;;
123
+        -l|--max-lines)  limit_l=$2;          shift 2 ;;
124
+        -I|--info)       dmpfun=jat__log_info; shift 1 ;;
125
+        -E|--error)      dmpfun=jat__log_error;     shift 1 ;;
126
+        -D|--debug)      dmpfun=debug;          shift 1 ;;
127
+        -s|--skip-empty) skip_empty=true;     shift 1 ;;
128
+        -S|--skip-missing) skip_missing=true; shift 1 ;;
129
+        *) break ;;
130
+    esac done
131
+
132
+    local fpath     # path to original file
133
+    local hexdump   # path to hexdumped file, if needed
134
+
135
+    for fpath in "$@";
136
+    do
137
+
138
+        # skipping logic
139
+        ! test -e "$fpath" && $skip_missing && continue
140
+        test -e "$fpath" || { jat__log_error "no such file: $fpath"; continue; }
141
+        test -f "$fpath" || { jat__log_error "not a file: $fpath"; continue; }
142
+        ! test -s "$fpath" && $skip_empty && continue
143
+
144
+        if __jat_dump__use_hex "$hexmode" "$fpath";
145
+        then
146
+            hexdump=$(__jat_dump__mkhexdump < "$fpath")
147
+            __jat_dump__logobj HEXDUMP "$hexdump" "$fpath" "$fpath"
148
+            rm "$hexdump"
149
+        else
150
+            __jat_dump__logobj FILE "$fpath" "$fpath"
151
+        fi
152
+
153
+    done
154
+}
155
+
156
+jat_dump__mkphase() {
157
+    #
158
+    # Make a dump phase incl. JAT formalities
159
+    #
160
+    # Usage:
161
+    #     jat_dump__mkphase [-n NAME] FILE...
162
+    #
163
+    # Create a separate diag phase called NAME ('dump' by
164
+    # default) and dump all listed files there.
165
+    #
166
+    local name="dump"           # phase name, should you not like dump
167
+    while true; do case "$1" in
168
+        -n|--name) name=$2; shift 2 ;;
169
+        *) break ;;
170
+    esac done
171
+    jat__pstartd "$name"
172
+        jat_dump__file "$@"
173
+    jat__pend
174
+}
175
+
176
+jat_dump__pipe() {
177
+    #
178
+    # Dump contents passed to stdin using jat__log_info
179
+    #
180
+    # Usage:
181
+    #
182
+    #     some_command | jat_dump__pipe [options] [NAME]
183
+    #
184
+    # Description:
185
+    #
186
+    # Cache contents of stream given on STDIN and print them to
187
+    # the main TESTOUT.log using jat__log* functions and adding
188
+    # BEGIN/END delimiters.  If the content is too big, use
189
+    # rlFileSubmit instead.  If the content is binary, pipe it
190
+    # through `hexdump -C`.
191
+    #
192
+    # NAME will appear along with pipe content delimiters,  and
193
+    # if a limit is reached, will be used as name for file to
194
+    # store using rlFileSubmit.  NAME will be generated if
195
+    # omitted.
196
+    #
197
+    # Options:
198
+    #
199
+    #   *  -h, --hex
200
+    #   *  -H, --no-hex
201
+    #               enforce or ban hexdump for all files
202
+    #   *  -b BYTES, --max-bytes BYTES
203
+    #   *  -l LINES, --max-lines LINES
204
+    #               set limit to lines or bytes; if file is bigger,
205
+    #               use rlFileSubmit instead
206
+    #   *  -I, --info
207
+    #   *  -E, --error
208
+    #   *  -D, --debug
209
+    #               use different level of jat__log* (Info by default)
210
+    #
211
+    local hexmode=$JAT_DUMP__HEXMODE
212
+    local limit_b=$JAT_DUMP__LIMIT_B
213
+    local limit_l=$JAT_DUMP__LIMIT_L
214
+    local dmpfun="$JAT_DUMP__DMPFUN"
215
+    local cache
216
+    while true; do case "$1" in
217
+        -h|--hex)        hexmode=always;      shift 1 ;;
218
+        -H|--no-hex)     hexmode=never;       shift 1 ;;
219
+        -b|--max-bytes)  limit_b=$2;          shift 2 ;;
220
+        -l|--max-lines)  limit_l=$2;          shift 2 ;;
221
+        -I|--info)       dmpfun=jat__log_info;    shift 1 ;;
222
+        -E|--error)      dmpfun=jat__log_error;   shift 1 ;;
223
+        -D|--debug)      dmpfun=debug;        shift 1 ;;
224
+        *) break ;;
225
+    esac done
226
+    local name="$1"
227
+
228
+    # cache the stream
229
+    cache=$(mktemp -t jat_dump-cache.XXXXXXXXXX)
230
+    cat > "$cache"
231
+
232
+    # make up name if not given (re-use XXXXXXXXXX from $cache)
233
+    test -n "$name" || name="ANONYMOUS.$$.${cache##*.}"
234
+
235
+    if __jat_dump__use_hex "$hexmode" "$cache";
236
+    then
237
+        hexdump=$(__jat_dump__mkhexdump < "$cache")
238
+        __jat_dump__logobj HEXDUMP "$hexdump" "$name" "$cache"
239
+        rm "$hexdump"
240
+    else
241
+        __jat_dump__logobj PIPE "$cache" "$name"
242
+    fi
243
+
244
+    rm "$cache"
245
+}
246
+
247
+
248
+##                    ## starts behind this strip                           ##
249
+## museum of INTERNAL ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ##
250
+##           '''''''' ## no admission; you can steal but not touch anything ##
251
+
252
+__jat_dump__count() {
253
+    #
254
+    # Count sizes, compare to limits and print problem report if any
255
+    #
256
+    #inherits: limit_l limit_b
257
+    local file="$1"
258
+    local sizes size_b size_l
259
+    local over_b over_l many
260
+    sizes="$(wc -lc <"$file")"      # [newline] [bytes]
261
+    sizes="$(eval "echo $sizes")"   # squash + trim whites
262
+    size_b="${sizes##* }"
263
+    size_l="${sizes%% *}"
264
+    test "$size_b" -gt "$limit_b"; over_b=$?
265
+    test "$size_l" -gt "$limit_l"; over_l=$?
266
+    case "$over_b:$over_l" in
267
+        1:1) many=""                                    ;;
268
+        1:0) many="lines ($size_l)"                     ;;
269
+        0:1) many="bytes ($size_b)"                     ;;
270
+        0:0) many="lines ($size_l) and bytes ($size_b)" ;;
271
+        *)   jat__log_error "panic: $FUNCNAME"         ;;
272
+    esac
273
+    echo "$many"
274
+    test -z "$many"
275
+}
276
+
277
+__jat_dump__is_binary() {
278
+    #
279
+    # Check if file is binary
280
+    #
281
+    local path="$1"
282
+    test -s "$path"     || return 1
283
+    grep -qI . "$path"  && return 1
284
+    return 0
285
+}
286
+
287
+__jat_dump__logobj() {
288
+    #
289
+    # Dump the object type $1 from $2, or save it under name $3
290
+    #
291
+    # Type can be FILE, HEXDUMP or PIPE.  If object is too big to dump
292
+    # to log, it will be submitted using rlFileSubmit. in that case
293
+    # $3 may be specified as alternative name.
294
+    #
295
+    # In case of HEXDUMP, path to original file must be specified
296
+    # as $4, since in case file is too big, we want to submitt *both*
297
+    # the original and the hexdump (suffixed with .hex).
298
+    #
299
+    # FIXME: no way of dumping HEXDUMP without supplying alternate name
300
+    #
301
+    # In case of PIPE that needs to be submitted, suffiix ".pipe" is added
302
+    # to the filename.
303
+    #
304
+    # FIXME: Account for PIPE that gets HEXDUMPed (now be treated as file)
305
+    #
306
+    local otype=$1              # PIPE|HEXDUMP|FILE
307
+    local opath=$2              # printable data
308
+    local oname=${3:-$opath}    # chosen name
309
+    local oorig=$4              # original file in case of HEXDUMP
310
+    local bloat=""              # human description of limit excess; empty
311
+                                # .. means OK to dump to log; else use rlFileSubmit
312
+    local lline=""              # logged line
313
+
314
+    oname="$(tr / - <<<"$oname")"
315
+    bloat="$(__jat_dump__count "$opath")"
316
+
317
+    debug "$FUNCNAME:otype='$otype'"
318
+    debug "$FUNCNAME:opath='$opath'"
319
+    debug "$FUNCNAME:oname='$oname'"
320
+    debug "$FUNCNAME:oorig='$oorig'"
321
+    debug "$FUNCNAME:bloat='$bloat'"
322
+
323
+    # start outputting
324
+    if test -z "$bloat";
325
+    then
326
+        test -s "$opath" || {
327
+            case $dmpfun in
328
+                debug) debug "=====EMPTY $otype $oname=====" ;;
329
+                *)     jat__log_info  "=====EMPTY $otype $oname=====" ;;
330
+            esac
331
+            return
332
+        }
333
+        {
334
+            echo "=====BEGIN $otype $oname====="
335
+            cat "$opath"
336
+            test -n "$(tail -c 1 "$opath")" \
337
+             && echo "=====NO_NEWLINE_AT_EOF====="
338
+            echo  "=====END $otype $oname====="
339
+        } \
340
+          | while IFS= read -r lline; do
341
+                $dmpfun "$lline"
342
+            done
343
+    else
344
+        case $otype in
345
+            FILE)
346
+                jat__log_info "not dumping, file has too many $bloat: $opath"
347
+                rlFileSubmit -- "$opath" "$oname"
348
+                ;;
349
+            PIPE)
350
+                jat__log_info "not dumping, pipe has too many $bloat: $oname"
351
+                rlFileSubmit -- "$opath" "$oname.pipe"
352
+                ;;
353
+            HEXDUMP)
354
+                jat__log_info "not dumping, hexdump is too long for: $oorig"
355
+                rlFileSubmit -- "$opath" "$oname.hex"
356
+                rlFileSubmit -- "$oorig" "$oname"
357
+                ;;
358
+        esac
359
+    fi
360
+
361
+}
362
+
363
+__jat_dump__mkhexdump() {
364
+    #
365
+    # Create hexdump (as tempfile) from stdin and echo path to it
366
+    #
367
+    local hdtmp
368
+    hdtmp=$(mktemp -t jat_dump-hex.XXXXXXXXXX)
369
+    $JAT_DUMP__HEXCMD > "$hdtmp"
370
+    echo "$hdtmp"
371
+}
372
+
373
+__jat_dump__use_hex() {
374
+    #
375
+    # True if we need to use hexdump
376
+    #
377
+    local hexmode="$1"
378
+    local fpath="$2"
379
+    case "$hexmode" in
380
+        always) return 0 ;;
381
+        never)  return 1 ;;
382
+        auto)   __jat_dump__is_binary "$fpath"; return $? ;;
383
+        *)      rlFail "bad value of JAT_DUMP__HEXMODE: $hexmode" ;;
384
+    esac
385
+}
386
+
387
+#shellfu module-version=__MKIT_PROJ_VERSION__

+ 3
- 0
tests/TF_HEADER View File

@@ -0,0 +1,3 @@
1
+#!/bin/bash
2
+. "$(sfpath)" || exit 3
3
+echo "version: $(shellfu version jat)"

+ 104
- 0
tests/basic/TF_RUN View File

@@ -0,0 +1,104 @@
1
+#!/bin/bash
2
+#shellcheck disable=SC2016,SC1090
3
+
4
+. "$TF_DIR/include/subtest.sh"
5
+. "$TF_DIR/include/tools.sh"
6
+
7
+. "$(sfpath)" || tf_exit_error "failed to init shellfu"
8
+shellfu import jat  || tf_exit_error "failed to import jat"
9
+
10
+tf_enum_subtests() {
11
+    echo ylog_pass
12
+    echo ylog_fail
13
+    echo ylog_both
14
+}
15
+
16
+rndtoken() {
17
+    head -c 100 /dev/urandom | md5sum | head -c 7
18
+}
19
+
20
+mkhacks() {
21
+    echo '__JAT__SELF_VERSION=0.0.0+TESTED_VERSION'
22
+    echo '__JAT__DETERMINISTIC=true'
23
+    echo ''
24
+}
25
+
26
+mkhead() {
27
+    echo '#!/bin/bash'
28
+    echo ''
29
+    echo '. "$(sfpath)" || exit 3'
30
+    echo 'shellfu import jat'
31
+    echo ''
32
+    mkhacks
33
+    echo ''
34
+    echo "JAT__DIR=$PWD/result/$name/dir"
35
+    echo "JAT__YLOG=$PWD/result/$name/ylog"
36
+    echo ''
37
+    echo 'jat__sinit'
38
+    echo ''
39
+}
40
+
41
+mkbody() {
42
+    #shellcheck disable=SC1003
43
+    case $name in
44
+        ylog_pass)
45
+            echo '    jat__pstartt'
46
+            echo '        jat__cmd -h "true is true" \'
47
+            echo '            true'
48
+            echo '        jat__cmd -h "false is false" -S 1 \'
49
+            echo '            false'
50
+            echo '    jat__pend'
51
+            ;;
52
+        ylog_fail)
53
+            echo '    jat__pstartt'
54
+            echo '        jat__cmd -h "true is false" -S 1 \'
55
+            echo '            true'
56
+            echo '        jat__cmd -h "false is true" -S 0 \'
57
+            echo '            false'
58
+            echo '    jat__pend'
59
+            ;;
60
+        ylog_both)
61
+            echo '    jat__pstartt'
62
+            echo '        jat__cmd -h "true is true" -S 0 \'
63
+            echo '            true'
64
+            echo '        jat__cmd -h "false is true" -S 0 \'
65
+            echo '            false'
66
+            echo '    jat__pend'
67
+            ;;
68
+    esac
69
+}
70
+
71
+mktail() {
72
+    echo ''
73
+    echo 'jat__sfinish'
74
+}
75
+
76
+unveil() {
77
+    #
78
+    # Remove arbitrary values
79
+    #
80
+    sed "
81
+        s/^jat_version: .*$/jat_version: JAT_VERSION/
82
+    "
83
+}
84
+
85
+runtest() {
86
+    mkdir -p "test" "result/$name"
87
+    {
88
+        mkhead
89
+        mkbody
90
+        mktail
91
+    } > "test/$name.sh"
92
+    bash "test/$name.sh" 2>/dev/null
93
+    < "result/$name/ylog" unveil
94
+}
95
+
96
+
97
+tf_do_subtest() {
98
+    local name=$1
99
+    local o_out=oracle/$name.stdout
100
+    local o_err=oracle/$name.stderr
101
+    tf_testflt -n "$name" -E "$o_err" -O "$o_out" runtest
102
+}
103
+
104
+tf_do_subtests

+ 0
- 0
tests/basic/oracle/ylog_both.stderr View File


+ 115
- 0
tests/basic/oracle/ylog_both.stdout View File

@@ -0,0 +1,115 @@
1
+---
2
+format: jat/0.0
3
+jat_version: JAT_VERSION
4
+test:
5
+    id: _jat_anon_test_
6
+start: time-1
7
+events:
8
+    -
9
+        origin: jat__sinit
10
+        etype: SINFO
11
+        stamp: time-2
12
+        hint: |-
13
+            started new session
14
+        beids: []
15
+        data: {}
16
+        phase:
17
+            id: dummy
18
+            name: _jat_dummy_phase_
19
+            type: none
20
+    -
21
+        origin: __jat__pstart
22
+        etype: SINFO
23
+        stamp: time-3
24
+        hint: ~
25
+        beids: []
26
+        data: {}
27
+        phase:
28
+            id: phasid-1
29
+            name: _jat_anon_phase_
30
+            type: test
31
+    -
32
+        origin: jat__log_info
33
+        etype: SINFO
34
+        stamp: time-4
35
+        hint: |-
36
+            CMD: true
37
+        beids: []
38
+        data: {}
39
+        phase:
40
+            id: phasid-1
41
+            name: _jat_anon_phase_
42
+            type: test
43
+    -
44
+        origin: __jat__assert
45
+        etype: PASS
46
+        stamp: time-5
47
+        hint: |-
48
+            true is true
49
+        beids: []
50
+        data:
51
+            CMDLINE: |
52
+                true
53
+            ES_EXPR: |
54
+                0
55
+            ES: |
56
+                0
57
+        phase:
58
+            id: phasid-1
59
+            name: _jat_anon_phase_
60
+            type: test
61
+    -
62
+        origin: jat__log_info
63
+        etype: SINFO
64
+        stamp: time-6
65
+        hint: |-
66
+            CMD: false
67
+        beids: []
68
+        data: {}
69
+        phase:
70
+            id: phasid-1
71
+            name: _jat_anon_phase_
72
+            type: test
73
+    -
74
+        origin: __jat__assert
75
+        etype: FAIL
76
+        stamp: time-7
77
+        hint: |-
78
+            false is true
79
+        beids: []
80
+        data:
81
+            CMDLINE: |
82
+                false
83
+            ES_EXPR: |
84
+                0
85
+            ES: |
86
+                1
87
+        phase:
88
+            id: phasid-1
89
+            name: _jat_anon_phase_
90
+            type: test
91
+    -
92
+        origin: jat__pend
93
+        etype: SINFO
94
+        stamp: time-8
95
+        hint: ~
96
+        beids: []
97
+        data: {}
98
+        phase:
99
+            id: dummy
100
+            name: _jat_dummy_phase_
101
+            type: none
102
+    -
103
+        origin: jat__sfinish
104
+        etype: SINFO
105
+        stamp: time-9
106
+        hint: |-
107
+            finishing session
108
+        beids: []
109
+        data: {}
110
+        phase:
111
+            id: dummy
112
+            name: _jat_dummy_phase_
113
+            type: none
114
+finalized: true
115
+end: time-10

+ 0
- 0
tests/basic/oracle/ylog_fail.stderr View File


+ 115
- 0
tests/basic/oracle/ylog_fail.stdout View File

@@ -0,0 +1,115 @@
1
+---
2
+format: jat/0.0
3
+jat_version: JAT_VERSION
4
+test:
5
+    id: _jat_anon_test_
6
+start: time-1
7
+events:
8
+    -
9
+        origin: jat__sinit
10
+        etype: SINFO
11
+        stamp: time-2
12
+        hint: |-
13
+            started new session
14
+        beids: []
15
+        data: {}
16
+        phase:
17
+            id: dummy
18
+            name: _jat_dummy_phase_
19
+            type: none
20
+    -
21
+        origin: __jat__pstart
22
+        etype: SINFO
23
+        stamp: time-3
24
+        hint: ~
25
+        beids: []
26
+        data: {}
27
+        phase:
28
+            id: phasid-1
29
+            name: _jat_anon_phase_
30
+            type: test
31
+    -
32
+        origin: jat__log_info
33
+        etype: SINFO
34
+        stamp: time-4
35
+        hint: |-
36
+            CMD: true
37
+        beids: []
38
+        data: {}
39
+        phase:
40
+            id: phasid-1
41
+            name: _jat_anon_phase_
42
+            type: test
43
+    -
44
+        origin: __jat__assert
45
+        etype: FAIL
46
+        stamp: time-5
47
+        hint: |-
48
+            true is false
49
+        beids: []
50
+        data:
51
+            CMDLINE: |
52
+                true
53
+            ES_EXPR: |
54
+                1
55
+            ES: |
56
+                0
57
+        phase:
58
+            id: phasid-1
59
+            name: _jat_anon_phase_
60
+            type: test
61
+    -
62
+        origin: jat__log_info
63
+        etype: SINFO
64
+        stamp: time-6
65
+        hint: |-
66
+            CMD: false
67
+        beids: []
68
+        data: {}
69
+        phase:
70
+            id: phasid-1
71
+            name: _jat_anon_phase_
72
+            type: test
73
+    -
74
+        origin: __jat__assert
75
+        etype: FAIL
76
+        stamp: time-7
77
+        hint: |-
78
+            false is true
79
+        beids: []
80
+        data:
81
+            CMDLINE: |
82
+                false
83
+            ES_EXPR: |
84
+                0
85
+            ES: |
86
+                1
87
+        phase:
88
+            id: phasid-1
89
+            name: _jat_anon_phase_
90
+            type: test
91
+    -
92
+        origin: jat__pend
93
+        etype: SINFO
94
+        stamp: time-8
95
+        hint: ~
96
+        beids: []
97
+        data: {}
98
+        phase:
99
+            id: dummy
100
+            name: _jat_dummy_phase_
101
+            type: none
102
+    -
103
+        origin: jat__sfinish
104
+        etype: SINFO
105
+        stamp: time-9
106
+        hint: |-
107
+            finishing session
108
+        beids: []
109
+        data: {}
110
+        phase:
111
+            id: dummy
112
+            name: _jat_dummy_phase_
113
+            type: none
114
+finalized: true
115
+end: time-10

+ 0
- 0
tests/basic/oracle/ylog_pass.stderr View File


+ 115
- 0
tests/basic/oracle/ylog_pass.stdout View File

@@ -0,0 +1,115 @@
1
+---
2
+format: jat/0.0
3
+jat_version: JAT_VERSION
4
+test:
5
+    id: _jat_anon_test_
6
+start: time-1
7
+events:
8
+    -
9
+        origin: jat__sinit
10
+        etype: SINFO
11
+        stamp: time-2
12
+        hint: |-
13
+            started new session
14
+        beids: []
15
+        data: {}
16
+        phase:
17
+            id: dummy
18
+            name: _jat_dummy_phase_
19
+            type: none
20
+    -
21
+        origin: __jat__pstart
22
+        etype: SINFO
23
+        stamp: time-3
24
+        hint: ~
25
+        beids: []
26
+        data: {}
27
+        phase:
28
+            id: phasid-1
29
+            name: _jat_anon_phase_
30
+            type: test
31
+    -
32
+        origin: jat__log_info
33
+        etype: SINFO
34
+        stamp: time-4
35
+        hint: |-
36
+            CMD: true
37
+        beids: []
38
+        data: {}
39
+        phase:
40
+            id: phasid-1
41
+            name: _jat_anon_phase_
42
+            type: test
43
+    -
44
+        origin: __jat__assert
45
+        etype: PASS
46
+        stamp: time-5
47
+        hint: |-
48
+            true is true
49
+        beids: []
50
+        data:
51
+            CMDLINE: |
52
+                true
53
+            ES_EXPR: |
54
+                0
55
+            ES: |
56
+                0
57
+        phase:
58
+            id: phasid-1
59
+            name: _jat_anon_phase_
60
+            type: test
61
+    -
62
+        origin: jat__log_info
63
+        etype: SINFO
64
+        stamp: time-6
65
+        hint: |-
66
+            CMD: false
67
+        beids: []
68
+        data: {}
69
+        phase:
70
+            id: phasid-1
71
+            name: _jat_anon_phase_
72
+            type: test
73
+    -
74
+        origin: __jat__assert
75
+        etype: PASS
76
+        stamp: time-7
77
+        hint: |-
78
+            false is false
79
+        beids: []
80
+        data:
81
+            CMDLINE: |
82
+                false
83
+            ES_EXPR: |
84
+                1
85
+            ES: |
86
+                1
87
+        phase:
88
+            id: phasid-1
89
+            name: _jat_anon_phase_
90
+            type: test
91
+    -
92
+        origin: jat__pend
93
+        etype: SINFO
94
+        stamp: time-8
95
+        hint: ~
96
+        beids: []
97
+        data: {}
98
+        phase:
99
+            id: dummy
100
+            name: _jat_dummy_phase_
101
+            type: none
102
+    -
103
+        origin: jat__sfinish
104
+        etype: SINFO
105
+        stamp: time-9
106
+        hint: |-
107
+            finishing session
108
+        beids: []
109
+        data: {}
110
+        phase:
111
+            id: dummy
112
+            name: _jat_dummy_phase_
113
+            type: none
114
+finalized: true
115
+end: time-10

+ 290
- 0
utils/mkit/include/build.sh View File

@@ -0,0 +1,290 @@
1
+#!/bin/bash
2
+# MKit - simple install helper
3
+# See LICENSE file for copyright and license details.
4
+
5
+mkit_import ini
6
+mkit_import facts
7
+
8
+
9
+__build1() {
10
+    #
11
+    # Process one skeleton $1 of type $3 (or guessed) to path $2
12
+    #
13
+    local srcpath=$1    # skeleton path
14
+    local dstpath=$2    # destination meaty animal path
15
+    local ftype=$3      # file/builder type
16
+    test -n "$dstpath"  || dstpath=${srcpath%.skel}
17
+    test -n "$ftype"    || ftype=$(__guess_ftype "$dstpath")
18
+    debug_var srcpath dstpath ftype
19
+    <"$srcpath" __build1_ftype "$ftype" >"$dstpath"
20
+    __rec_built "$dstpath"
21
+}
22
+
23
+__build1_ftype() {
24
+    #
25
+    # Build a file of type $1; fom stdin to stdout
26
+    #
27
+    local ftype=$1      # file/builder type
28
+    case $ftype in
29
+        MKIT_COMMON)    __expand_macros "macros" ;;
30
+        rpmstuff)       __expand_macros "macros" "rpmstuff:macros" ;;
31
+        debstuff)       __expand_macros "macros" "debstuff:macros" ;;
32
+        *)              die "unknown file type: $ftype" ;;
33
+    esac
34
+}
35
+
36
+__expand_line() {
37
+    #
38
+    # Expand macro from $MacroMap in single line $1
39
+    #
40
+    # If macro value has multiple lines, repeat original line with
41
+    # different substitution.
42
+    #
43
+    # E.g. if macro value is "foo\nbar" and macro name is __FOO__,
44
+    # line `see: "__FOO__"` will expand to two lines: `see: "foo"`
45
+    # and `see: "bar"`.
46
+    #
47
+    local line=$1   # line to process
48
+    local mname     # macro name
49
+    local mvline    # line of macro value
50
+    local xline     # expanded line
51
+    xline=$line
52
+    for mname in "${!MacroMap[@]}"; do
53
+        if ! test "${line//$mname}" == "$line"; then
54
+            xline=$(
55
+                while IFS= read -r mvline; do
56
+                    echo "${line//$mname/$mvline}"
57
+                done <<<"${MacroMap[$mname]}"
58
+            )
59
+        fi
60
+        line=$xline
61
+    done
62
+    echo "$xline"
63
+    return 1
64
+}
65
+
66
+__expand_macros() {
67
+    #
68
+    # Read stdin, expanding macros from sections $@
69
+    #
70
+    local section       # each section to expand macros from
71
+    local line          # each line on stdin
72
+    local mname         # each macro name
73
+    local -A MacroMap   # macro value map
74
+    MacroMap[__MKIT_PROJ_NAME__]=$(ini 1value project:name)
75
+    MacroMap[__MKIT_PROJ_CODENAME__]=$(ini 1value project:codename)
76
+    MacroMap[__MKIT_PROJ_LICENSE__]=$(ini 1value project:license)
77
+    MacroMap[__MKIT_PROJ_PKGNAME__]=$(ini 1value project:pkgname)
78
+    MacroMap[__MKIT_PROJ_TAGLINE__]=$(ini 1value project:tagline)
79
+    MacroMap[__MKIT_PROJ_MAINTAINER__]=$(ini 1value project:maintainer)
80
+    MacroMap[__MKIT_PROJ_VCS_BROWSER__]=$(ini 1value project:vcs_browser)
81
+    MacroMap[__MKIT_PROJ_GIT_LASTHASH__]=$(__cached git_lasthash)
82
+    MacroMap[__MKIT_PROJ_VERSION__]=$(__cached semver)
83
+    MacroMap[__MKIT_SELF_VERSION__]=$MKIT_VERSION
84
+    for section in "$@"; do
85
+        for mname in $(ini lskeys "$section"); do
86
+            MacroMap[$mname]=$(ini values "$section:$mname")
87
+        done
88
+    done
89
+    debug_var MacroMap
90
+    while IFS= read -r line; do
91
+        __expand_line "$line"
92
+    done
93
+}
94
+
95
+__guess_ftype() {
96
+    #
97
+    # Guess file type from destination path $1
98
+    #
99
+    local dstpath=$1    # destination path
100
+    case $dstpath in
101
+        *)    echo MKIT_COMMON ;;
102
+    esac
103
+}
104
+
105
+__qfs() {
106
+    #
107
+    # Quote for our sed scipt's RHS
108
+    #
109
+    sed '
110
+        s:\\:\\\\:g
111
+        s:|:\\|:g
112
+    '
113
+}
114
+
115
+__cached() {
116
+    #
117
+    # Cached value $1 of function $1()
118
+    #
119
+    # In order to support git-less builds, some values might be cached
120
+    # in $MKIT_LOCAL.  This function gets file $1 from that cache (cache
121
+    # hit) or re-creates it (cache miss), but prints its body in either
122
+    # case.
123
+    #
124
+    # The command to re-create file is the same as the key (ie. no
125
+    # arguments).
126
+    #
127
+    local name=$1
128
+    __local_get "$name" && return 0
129
+    "$name" | __local_putb "$name"
130
+    __local_get "$name"
131
+}
132
+
133
+__local_putb() {
134
+    #
135
+    # Make file $1 in $MKIT_LOCAL from stdin and mark as built
136
+    #
137
+    local fpath=$1
138
+    __local_put "$fpath" && __rec_built "$MKIT_LOCAL/$fpath"
139
+}
140
+
141
+__local_put() {
142
+    #
143
+    # Make file $1 in $MKIT_LOCAL from stdin
144
+    #
145
+    local fpath="$MKIT_LOCAL/$1"
146
+    { mkdir -p "${fpath%/*}" && cat >"$fpath"; } \
147
+     || die "cannot write to local cache: $fpath"
148
+}
149
+
150
+__local_get() {
151
+    #
152
+    # Read file $1 in $MKIT_LOCAL
153
+    #
154
+    local fpath="$MKIT_LOCAL/$1"
155
+    cat "$fpath" 2>/dev/null
156
+}
157
+
158
+__rec_built() {
159
+    #
160
+    # Record file $1 for deletion on `clean`
161
+    #
162
+    local file=$1
163
+    mkdir -p "$MKIT_LOCAL"
164
+    echo "$file" >> "$MKIT_LOCAL/built.lst"
165
+}
166
+
167
+_mkit_data() {
168
+    #
169
+    # Build sampler showing all macro values
170
+    #
171
+    local macro
172
+    local section
173
+    local sections
174
+    sections=()
175
+    ini lskeys macros | grep -q . && sections=(macros)
176
+    sections+=( $(ini lssect | grep ':macros$') )
177
+    {
178
+        echo "(builtin):"
179
+        echo "  x_MKIT_PROJ_NAME__ => '__MKIT_PROJ_NAME__'"
180
+        echo "  x_MKIT_PROJ_CODENAME__ => '__MKIT_PROJ_CODENAME__'"
181
+        echo "  x_MKIT_PROJ_LICENSE__ => '__MKIT_PROJ_LICENSE__'"
182
+        echo "  x_MKIT_PROJ_PKGNAME__ => '__MKIT_PROJ_PKGNAME__'"
183
+        echo "  x_MKIT_PROJ_TAGLINE__ => '__MKIT_PROJ_TAGLINE__'"
184
+        echo "  x_MKIT_PROJ_MAINTAINER__ => '__MKIT_PROJ_MAINTAINER__'"
185
+        echo "  x_MKIT_PROJ_VCS_BROWSER__ => '__MKIT_PROJ_VCS_BROWSER__'"
186
+        echo "  x_MKIT_PROJ_GIT_LASTHASH__ => '__MKIT_PROJ_GIT_LASTHASH__'"
187
+        echo "  x_MKIT_PROJ_VERSION__ => '__MKIT_PROJ_VERSION__'"
188
+        echo "  x_MKIT_SELF_VERSION__ => '__MKIT_SELF_VERSION__'"
189
+        for section in "${sections[@]}"; do
190
+            echo "$section:"
191
+            for macro in $(ini lskeys "$section"); do
192
+                echo "  x${macro:1} => '$macro'"
193
+            done
194
+        done
195
+    } \
196
+      | __expand_macros "MKIT_BUILTIN" "${sections[@]}" \
197
+      | sed '/^  x/ s|x|_|'
198
+}
199
+
200
+build() {
201
+    #
202
+    # Add meat to all skeletons
203
+    #
204
+    local srcpath   # each source path
205
+    find . -type f -name '*.skel' \
206
+     | while read -r srcpath; do
207
+           __build1 "$srcpath"
208
+       done
209
+}
210
+
211
+clean() {
212
+    #
213
+    # Clean up tree after building
214
+    #
215
+    test -f "$MKIT_LOCAL/built.lst" && {
216
+        <"$MKIT_LOCAL/built.lst" grep -v -e '\.\.' -e ^/ \
217
+          | xargs -r rm -rf
218
+        rm -f "$MKIT_LOCAL/built.lst"
219
+        rmdir --ignore-fail-on-non-empty "$MKIT_LOCAL"
220
+    }
221
+    true
222
+}
223
+
224
+debstuff() {
225
+    #
226
+    # Build Debian stuff (eamed tarball, debian dir)
227
+    #
228
+    local version       # package version
229
+    local debian_skel   # 'debian' folder skeleton
230
+    local dfsrc         # each source file from ^^
231
+    local dftgt         # each built packaging file
232
+    version=$(__cached semver)
233
+
234
+    # tarball - we should already have by means of 'dist'
235
+    #
236
+    mv "${MKIT_PROJ_PKGNAME}-$version.tar.gz" \
237
+       "${MKIT_PROJ_PKGNAME}_$version.orig.tar.gz" \
238
+     || die "could not rename tarball"
239
+    __rec_built "${MKIT_PROJ_PKGNAME}_$version.orig.tar.gz"
240
+
241
+    # read content of each mandatory file from debian_skel
242
+    #
243
+    debian_skel=$(ini 1value dist:debstuff)
244
+    test -n "$debian_skel" || die "dist:debstuff not specified"
245
+    test -d "$debian_skel" || die "debian directory template found: $debian_skel"
246
+    mkdir -p debian/source
247
+    find "$debian_skel" -type f \
248
+      | while read -r dfsrc; do
249
+            dftgt="debian/${dfsrc#$debian_skel}"
250
+            mkdir -p "$(dirname "$dftgt")"
251
+            __build1 "$dfsrc" "$dftgt" debstuff
252
+        done
253
+    __rec_built debian
254
+}
255
+
256
+dist() {
257
+    #
258
+    # Create distributable tarball
259
+    #
260
+    #FIXME: lacking Makefile skills, we do this step twice for
261
+    #       rpmstuff, hence -f hack for gzip
262
+    #
263
+    local version           # tarball version
264
+    local git_lasthash      # last git commit hash
265
+    local dirname           # directory and tarball name
266
+    version=$(semver)
267
+    dirname=$MKIT_PROJ_PKGNAME-$version
268
+    git_lasthash=$(git_lasthash)
269
+    mkdir -p "$dirname"
270
+    ini values "dist:tarball" | xargs -I DIST_ITEM cp -R DIST_ITEM "$dirname"
271
+    mkdir -p "$dirname/.mkit"
272
+    echo -n "$version" > "$dirname/.mkit/semver"
273
+    echo -n "$git_lasthash" > "$dirname/.mkit/git_lasthash"
274
+    tar -cf "$dirname.tar" "$dirname"
275
+    gzip -f "$dirname.tar"      # see above FIXME
276
+    __rec_built "$dirname.tar.gz"
277
+    rm -rf "$dirname"
278
+}
279
+
280
+rpmstuff() {
281
+    #
282
+    # Build specfile
283
+    #
284
+    local specname=$MKIT_PROJ_PKGNAME.spec      # .spec filename
285
+    local specsrc                               # source of specfile
286
+    specsrc="$(ini 1value "dist:rpmstuff")"
287
+    test -n "$specsrc" || die "dist:rpmstuff not specified"
288
+    test -f "$specsrc" || die "specfile template not found: $specsrc"
289
+    __build1 "$specsrc" "$specname" rpmstuff
290
+}

+ 130
- 0
utils/mkit/include/deploy.sh View File

@@ -0,0 +1,130 @@
1
+#!/bin/bash
2
+# MKit - simple install helper
3
+# See LICENSE file for copyright and license details.
4
+
5
+mkit_import ini
6
+
7
+__deploy_item() {
8
+    #
9
+    # Deploy item and make it look like wanted
10
+    #
11
+    # usage: __deploy_item src dst [mode]
12
+    #
13
+    # Both src and dst must be names of actual items[1],
14
+    # whereas dst must not exist.  On update, dst is
15
+    # usually to be replaced but that is uninstall's
16
+    # job!
17
+    #
18
+    #  [1] Ie. src=foo and dst=/foo/bar does *always*
19
+    #      mean that foo will become 'bar'.  This is
20
+    #      different than traditional `cp` behavior,
21
+    #      when this depends if 'bar' already exists
22
+    #      as a directory.
23
+    #
24
+    # If mode is omitted or empty, MKIT_DEFAULT_MODE is
25
+    # used instead.
26
+    #
27
+    # Directories are copied recursively, and mode is
28
+    # applied only to files.
29
+    #
30
+    local src=$1                            # source path
31
+    local dst=$2                            # destination path
32
+    local mode=${3:-$MKIT_DEFAULT_MODE}     # mode
33
+    local item                              # each in directory
34
+    if test -d "$src"; then
35
+        find "$src" -type f \
36
+          | while read -r item; do
37
+                [[ $item =~ .skel$ ]] \
38
+                 && grep -q "${item%.skel}" "$MKIT_LOCAL/built.lst" \
39
+                 && continue
40
+                __deploy_item "$item" "$dst${item#$src}" "$mode"
41
+            done
42
+    else
43
+        test "$mode" == "SRC" && mode=$(stat -c "%a" "$src")
44
+        __maybe install -DTvm "$mode" "$src" "$dst"
45
+    fi
46
+}
47
+
48
+__get_dst() {
49
+    #
50
+    # Find out target path for src file $2 of group $1
51
+    #
52
+    local grp=$1        # deploy group
53
+    local src=$2        # each source
54
+    local dst=$3        # alternative destination name
55
+    test -n "$dst" || dst=${src##*/}
56
+    echo "$(__get_root "$grp")/$dst"
57
+}
58
+
59
+__get_root() {
60
+    #
61
+    # Find out target root for group $1
62
+    #
63
+    local grp=$1        # deploy group
64
+    local root          # root for this group
65
+    local destdir       # value of DESTDIR
66
+    root=$(ini 1value "roots:$grp")
67
+    destdir=$(ini 1value ENV:DESTDIR)
68
+    destdir=${destdir%/}
69
+    case $destdir:$root in
70
+        *:)     die "missing in config.ini: roots:$grp" ;;
71
+        :*)     echo "$root" ;;
72
+        *:*)    echo "$destdir/$root" ;;
73
+    esac
74
+}
75
+
76
+__maybe() {
77
+    #
78
+    # Call the deploy command $1 $@ unless in dry mode
79
+    #
80
+    debug "$@"
81
+    local cmd="$1"; shift
82
+    $MKIT_DRY && return
83
+    case "$cmd" in
84
+        cp|rm|rmdir|chmod|mkdir) $cmd "$@" ;;
85
+        install)                 command -p install "$@" ;;
86
+        *)                       die "bad command called";;
87
+    esac
88
+}
89
+
90
+install() {
91
+    #
92
+    # Install product
93
+    #
94
+    local group     # each deploy group
95
+    local mode      # mode (group-specific)
96
+    local src       # each source path
97
+    local dst       # each (final absolute) destination path
98
+    ini lskeys "files" \
99
+      | sort \
100
+      | uniq \
101
+      | while read -r group; do
102
+            mode=$(ini 1value "modes:$group")
103
+            ini values "files:$group" \
104
+              | while read -r src dst; do
105
+                    dst=$(__get_dst "$group" "$src" "$dst")
106
+                    __deploy_item "$src" "$dst" "$mode"
107
+                done
108
+        done
109
+    test -f "$MKIT_LOCAL/autoclean" && clean
110
+    true
111
+}
112
+
113
+uninstall() {
114
+    #
115
+    # Uninstall product
116
+    #
117
+    local group     # each deploy group
118
+    local src       # each source path
119
+    local dst       # each (final absolute) destination path
120
+    ini lskeys "files" \
121
+      | sort \
122
+      | uniq \
123
+      | while read -r group; do
124
+            ini values "files:$group" \
125
+              | while read -r src dst; do
126
+                    dst=$(__get_dst "$group" "$src" "$dst")
127
+                    __maybe rm -vrf "$dst"
128
+                done
129
+        done
130
+}

+ 175
- 0
utils/mkit/include/facts.sh View File

@@ -0,0 +1,175 @@
1
+#!/bin/bash
2
+# MKit - simple install helper
3
+# See LICENSE file for copyright and license details.
4
+
5
+mkit_import ini
6
+
7
+git_bool() {
8
+    #
9
+    # Get git bool (ie. exit status counts) $1
10
+    #
11
+    local bool_name=$1      # name of boolean to get
12
+    git_present || warn "can't give bool outside git repo: $bool_name"
13
+    case "$bool_name" in
14
+        dirty_files)
15
+            git diff-files | grep -qm 1 .
16
+            ;;
17
+        dirty_index)
18
+            git diff-index HEAD | grep -qm 1 .
19
+            ;;
20
+        dirty)
21
+            git_bool dirty_files || git_bool dirty_index
22
+            ;;
23
+        *)
24
+            warn "unknown git bool asked: $bool_name"
25
+            return 2
26
+            ;;
27
+    esac
28
+}
29
+
30
+git_fact() {
31
+    #
32
+    # Get git fact $1
33
+    #
34
+    local fact_name=$1      # name of fact to get
35
+    git_present || warn "can't give fact outside git repo: $fact_name"
36
+    case "$fact_name" in
37
+        latest_tag)
38
+            git log --format="%d" \
39
+              | sed 's/,/\n/g' \
40
+              | sed 's/^[[:blank:]]*//' \
41
+              | grep -E '^\(?tag' \
42
+              | tr -cd '[[:digit:]].v\n' \
43
+              | grep . -m 1
44
+            ;;
45
+        latest_version)
46
+            git_fact latest_tag | git_tag2ver
47
+            ;;
48
+        current_branch)
49
+            git rev-parse --abbrev-ref HEAD
50
+            ;;
51
+        reldiff)
52
+            git log --oneline "$(git_fact latest_tag)..HEAD" --name-only
53
+            ;;
54
+        latest_sha)
55
+            git log -1 --pretty=format:%h HEAD
56
+            ;;
57
+        *)
58
+            warn "unknown git fact asked: $fact_name"
59
+            ;;
60
+    esac
61
+}
62
+
63
+git_present() {
64
+    #
65
+    # True if we're in a git repo
66
+    #
67
+    git rev-parse HEAD >&/dev/null
68
+}
69
+
70
+git_tag2ver() {
71
+    #
72
+    # Convert tag to version
73
+    #
74
+    sed s/^v//
75
+}
76
+
77
+git_ver2tag() {
78
+    #
79
+    # Convert version to tag
80
+    #
81
+    sed s/^/v/
82
+}
83
+
84
+git_lasthash() {
85
+    #
86
+    # Show last commit hash (with .dirty suffix if needed)
87
+    #
88
+    # We can't do it outside git repo (or without git) but we should
89
+    # not be asked to; targets that don't require git should make use
90
+    # of cache built by dist target.
91
+    #
92
+    local last_hash     # last commit hash
93
+    git_present || {
94
+        echo UNKNOWN_HASH
95
+        warn "no git present; could not determine last hash"
96
+        return 3
97
+    }
98
+    last_hash=$(git rev-parse HEAD)
99
+    echo -n "$last_hash"
100
+    git_bool dirty && echo -n ".dirty"
101
+}
102
+
103
+semver() {
104
+    #
105
+    # Build proper SemVer version string
106
+    #
107
+    # Build version string from available info using following
108
+    # logic:
109
+    #
110
+    #  1. Use version from last git tag (or mkit.ini if there is no
111
+    #     tag, which is possible on new project)
112
+    #  2. if set, add project:prerl (from mkit.ini) as pre-release ID
113
+    #     (afer dash)
114
+    #  3. if we are at a later commit than the last tag, add branch
115
+    #     name and commit sha1 to build metadata (after plus sign)
116
+    #  4. if the tree is "dirty", i.e. has uncommited changes,
117
+    #     add "dirty" to build metadata
118
+    #
119
+    # The version is compatible with SemVer 2.0.0.
120
+    #
121
+    # Examples:
122
+    #
123
+    #     foo v1.0.7                            # all clear; proper release
124
+    #     foo v1.0.7-beta                       # mkit.ini: project:prerl="beta"
125
+    #     foo v1.0.7-beta+g1aef811.master       # ^^ + some commits after
126
+    #     foo v1.0.7-beta+gf14fc4f.api2         # ^^ + on a feature branch
127
+    #     foo v1.0.7-beta+gf14fc4f.api2.dirty   # ^^ + tree edited
128
+    #     foo v1.0.7-beta+dirty                 # tag OK but tree edited
129
+    #     foo v1.0.7+dirty                      # ^^ but no pre-release id
130
+    #
131
+    # Note that versions with "dirty" should be perceived as kind of
132
+    # dangerous outside developer's own machine.  Versions with sha1 are
133
+    # safer but must not be released.
134
+    #
135
+    # FIXME:  Using project:prerl for release IDs may not be compatible with
136
+    #         release strategy implemented in release.sh
137
+    #
138
+    local xyz           # base version string
139
+    local prerl         # pre-release keyword (from mkit.ini, eg. 'beta')
140
+    local latest_tag    # latest git tag
141
+    local commit        # commit indicator (CURRENT_BRANCH.gHASH)
142
+    local dirty         # 0 if dirty, 1 if clean
143
+    local suffix        # version suffix
144
+    prerl=$(ini 1value project:prerl)
145
+    grep ":" <<<"$prerl" \
146
+     && warn "colon in project:prerl may corrupt version data: $prerl"
147
+    git_present || {
148
+        echo UNKNOWN_VERSION
149
+        warn "no git present; could not determine SemVer"
150
+        return 3
151
+    }
152
+    latest_tag=$(git_fact latest_tag)
153
+    case $latest_tag in
154
+        v*) xyz=${latest_tag:1} ;;
155
+        "") warn "no tags, using base version from mkit.ini (ok for new project)"
156
+            xyz=$(ini 1value project:version) ;;
157
+        *)  warn "bad form of last tag, using base version from mkit.ini: tag is '$latest_tag'"
158
+            xyz=$(ini 1value project:version) ;;
159
+    esac
160
+    if ! git describe --tags --exact-match HEAD >&/dev/null;
161
+    then    # we are at a later commit than the last tag
162
+        commit="$(git_fact current_branch).g$(git_fact latest_sha)"
163
+    fi
164
+    git_bool dirty; dirty=$?
165
+    case "$dirty:$commit" in
166
+        1:)  suffix=""               ;;
167
+        0:)  suffix="+dirty"         ;;
168
+        1:*) suffix="+$commit"       ;;
169
+        0:*) suffix="+$commit.dirty" ;;
170
+        *)   suffix=MKIT_BUG
171
+             warn "MKIT_BUG: bad dirt/commit detection" ;;
172
+    esac
173
+    test -n "$prerl" && suffix="-$prerl$suffix"
174
+    echo "$xyz$suffix"
175
+}

+ 177
- 0
utils/mkit/include/ini.sh View File

@@ -0,0 +1,177 @@
1
+#!/bin/bash
2
+# MKit - simple install helper
3
+# See LICENSE file for copyright and license details.
4
+
5
+__ini_cat() {
6
+    #
7
+    # A no-op for text stream
8
+    #
9
+    local line      # each line
10
+    while read -r line; do
11
+        printf -- "%s\n" "$line"
12
+    done
13
+}
14
+
15
+__ini_expand() {
16
+    #
17
+    # Expand reference value (prefix only)
18
+    #
19
+    local line      # each input line
20
+    local suffix    # tail of the line
21
+    local ref       # reference
22
+    local value     # value if reference
23
+    while read -r line; do                  # [foo:bar]/path
24
+        suffix="${line#\[*\]}"              # /path
25
+        ref="${line%$suffix}"               # [foo:bar]
26
+        ref="${ref%\]}"                     # [foo:bar
27
+        ref="${ref#\[}"                     # foo:bar
28
+        value="$(ini 1value "$ref")"        # foo_bar_value
29
+        printf -- "%s\n" "$value$suffix"    # foo_bar_value/path
30
+    done
31
+}
32
+
33
+__ini_grepcmt() {
34
+    #
35
+    # Remove comments from INI file on stdin
36
+    #
37
+    grep -v '^[[:space:]]*#'
38
+}
39
+
40
+__ini_grepkey() {
41
+    #
42
+    # Read key from a section
43
+    #
44
+    local wnt=$1    # wanted key
45
+    grep '.' \
46
+      | sed -e 's/ *= */=/; s/ +$//; s/^//;' \
47
+      | grep -e "^$wnt=" \
48
+      | cut -d= -f2- \
49
+      | __ini_maybe_expand
50
+}
51
+
52
+__ini_greppath() {
53
+    #
54
+    # Read key from the right section
55
+    #
56
+    # E.g. `files:share:my/lib.sh` should read
57
+    #
58
+    #     [files:share]
59
+    #         my/lib.sh   = proj/my/lib.sh
60
+    #
61
+    local wnt=$1                    # wanted path
62
+    local wntkey=${wnt##*:}         # ^^ key part
63
+    local wntsec=${wnt%:$wntkey}    # ^^ section part
64
+    local override                  # ENV override (only ENV section)
65
+    if test "$wntsec" = 'ENV'; then
66
+        override=${!wntkey}
67
+        test -n "$override" \
68
+         && echo "$override" \
69
+         && return
70
+    fi
71
+    __ini_grepsec "$wntsec" | __ini_grepkey "$wntkey"
72
+}
73
+
74
+__ini_grepsec() {
75
+    #
76
+    # Read one INI section
77
+    #
78
+    local wnt=$1        # wanted section name
79
+    local ok=false      # are we in the section?
80
+    local line          # each input line
81
+    grep '.' \
82
+      | while read -r line; do
83
+            case "$line" in
84
+                \[$wnt\]) ok=true;  continue ;;
85
+                \[*\])    ok=false; continue ;;
86
+            esac
87
+            $ok || continue
88
+            printf -- "%s\n" "$line"
89
+        done \
90
+      | sed -e 's/ *= */=/; s/ +$//; s/^//;'
91
+}
92
+
93
+__ini_lskeys() {
94
+    #
95
+    # List keys from a section
96
+    #
97
+    local sct=$1    # section of interest
98
+    __ini_grepsec "$sct" | cut -d= -f1 | awk '!x[$0]++'
99
+}
100
+
101
+__ini_lssect() {
102
+    #
103
+    # List all section names
104
+    #
105
+    local arg=$1    # unused argument
106
+    grep -x '\[.*\]' | sed 's/^.//; s/.$//'
107
+}
108
+
109
+__ini_maybe_expand() {
110
+    #
111
+    # Decide whether or not to expand
112
+    #
113
+    if test "$MKIT_INI_EXPAND" -gt 0; then
114
+        MKIT_INI_EXPAND=$(( --MKIT_INI_EXPAND )) __ini_expand
115
+    else
116
+        __ini_cat
117
+    fi
118
+}
119
+
120
+__ini_body() {
121
+    #
122
+    # Produce mkit.ini body including INCLUDE
123
+    #
124
+    # Note: recursive includes are not supported.
125
+    #
126
+    local inc                       # file to include
127
+    local incre='\[INCLUDE:.*\]'    # include directive regex
128
+    local iline                     # include directive line
129
+    if iline=$(grep -m1 -x "$incre" "$MKIT_INI"); then
130
+        inc=${iline#*:}; inc=${inc%]}
131
+        grep -vx "$incre" "$inc"
132
+        grep -vx "$incre" "$MKIT_INI"
133
+    else
134
+        cat "$MKIT_INI"
135
+    fi | __ini_grepcmt
136
+}
137
+
138
+ini() {
139
+    #
140
+    # do ini operation
141
+    #
142
+    local op=$1             # operator
143
+    local arg=$2            # argument
144
+    local fn                # internal function implementing $op
145
+    local limit=__ini_cat    # limiting internal function
146
+    case $op in
147
+        lskeys) fn=__ini_lskeys   ;;
148
+        lssect) fn=__ini_lssect   ;;
149
+        sec)    fn=__ini_grepsec  ;;
150
+        values) fn=__ini_greppath ;;
151
+        1value) fn=__ini_greppath; limit="tail -1" ;;
152
+        *)      die "incorrect use of \`ini()\`"
153
+    esac
154
+    __ini_body | $fn "$arg" | $limit
155
+}
156
+
157
+update_version() {
158
+    #
159
+    # Change project:version in mkit.ini at path $2 to value $1
160
+    #
161
+    local version=$1    # new version
162
+    local inifile=$2    # mkit.ini path
163
+    local tmp           # mkit.ini cache
164
+    tmp=$(mktemp -t mkit.update_version.XXXXXXXX)
165
+    <"$inifile" perl -e '
166
+        my $hit = 0;
167
+        my $done = 0;
168
+        foreach (<STDIN>) {
169
+            if      ($done) { print; next; }
170
+            elsif   (m/\[project\]/) { $hit++; print; next; }
171
+            elsif   (m/\[/) { $hit = 0; print; next; }
172
+            elsif   ($hit) { s/\bversion\b( *)=( *).*/version$1=$2$ARGV[0]/ and $done++; print; }
173
+            else { print; next; }
174
+        }
175
+    ' "$version" >"$tmp" || die "failed to update version in mkit.ini"
176
+    mv "$tmp" "$inifile"
177
+}

+ 162
- 0
utils/mkit/include/mkit.sh View File

@@ -0,0 +1,162 @@
1
+#!/bin/bash
2
+# MKit - simple install helper
3
+# See LICENSE file for copyright and license details.
4
+
5
+die() {
6
+    #
7
+    # Exit with message and non-zero exit status
8
+    #
9
+    echo "fatal: $*" >&2
10
+    exit 4
11
+}
12
+
13
+mkit_import() {
14
+    #
15
+    # Import mkit module $1.sh
16
+    #
17
+    # Check for module, source it and die with reasonable message if needed.
18
+    #
19
+    local modname=$1
20
+    local modpath
21
+    modpath="$MKIT_DIR/include/$modname.sh"
22
+    test -f "$modpath" || die "no such module: $modpath"
23
+    bash -n "$modpath" || die "bad syntax: $modpath"
24
+    #shellcheck disable=SC1090
25
+    . "$modpath" || die "failed to import: $modname"
26
+}
27
+
28
+mkit_import build
29
+mkit_import deploy
30
+mkit_import release
31
+mkit_import ini
32
+
33
+__valid_targets() {
34
+    #
35
+    # List valid routes
36
+    #
37
+    echo _mkit_data
38
+    echo build
39
+    echo clean
40
+    echo debstuff
41
+    echo dist
42
+    echo install
43
+    echo release
44
+    echo release_x
45
+    echo release_y
46
+    echo release_z
47
+    echo rpmstuff
48
+    echo uninstall
49
+    echo vbump
50
+    echo vbump_x
51
+    echo vbump_y
52
+    echo vbump_z
53
+}
54
+
55
+debug() {
56
+    #
57
+    # Print debug message
58
+    #
59
+    $MKIT_DEBUG || return 0
60
+    echo "MKIT_DEBUG: ${FUNCNAME[1]}()" "$@" >&2
61
+}
62
+
63
+debug_var() {
64
+    #
65
+    # Print debug message
66
+    #
67
+    $MKIT_DEBUG || return 0
68
+    local __mkit_debug_var_name__       # variable name to debug
69
+    local decl                          # declare string
70
+    for __mkit_debug_var_name__ in "$@"; do
71
+        {
72
+            decl=$(declare -p "$__mkit_debug_var_name__")
73
+            decl=${decl#declare ?? }
74
+            echo "MKIT_DEBUG: ${FUNCNAME[1]}(): $decl"
75
+        } >&2
76
+    done
77
+}
78
+
79
+__compver() {
80
+    #
81
+    # True if version $1 matches our version
82
+    #
83
+    # If our x is 0, check first two fragments, otherwise check just
84
+    # the x.  Fragments must equal.
85
+    #
86
+    local their_ver=$1      # their version
87
+    local our_x             # our X
88
+    local our_y             # our Y
89
+    local their_x           # their X
90
+    local their_y           # their Y
91
+    their_x=${their_ver%%.*}
92
+    their_y=${their_ver##$their_x.}
93
+    their_y=${their_y%%.*}
94
+    our_x=${MKIT_VERSION%%.*}
95
+    our_y=${MKIT_VERSION##$our_x.}
96
+    our_y=${our_y%%.*}
97
+    debug_var MKIT_VERSION our_x our_y their_ver their_x their_y
98
+    test "$their_x" -eq "$our_x" || return 1
99
+    test "$our_x" -eq 0 && {
100
+        test "$their_y" = "$our_y"
101
+        return $?
102
+    }
103
+    return 0
104
+}
105
+
106
+__chkiniversion() {
107
+    #
108
+    # Check if ini version is supported
109
+    #
110
+    # Look for "#mkit version=0.0.0" or similar in first or last
111
+    # 3 lines of the file; then check if the version is supported.
112
+    #
113
+    local ver_line      # line declaring version
114
+    local their_ver     # the declared version
115
+    ver_line=$(
116
+        {
117
+            head -3 "$MKIT_INI"
118
+            tail -3 "$MKIT_INI"
119
+        } | grep -m 1 -E '^# *mkit +version *= *v?[0-9]+\.[0-9]+\.[0-9]+'
120
+    )
121
+    test -n "$ver_line" \
122
+     || die "version mark ('#mkit version=x.y.z') not found in: $MKIT_INI"
123
+    their_ver="$(tr -d '[:blank:]v' <<<"${ver_line##*=}")"
124
+    __compver "$their_ver" \
125
+     || die "bad mkit.ini version: $their_ver does not match $MKIT_VERSION"
126
+}
127
+
128
+mkit_init() {
129
+    #
130
+    # Do basic initialization
131
+    #
132
+    # Check for ini file and some variables
133
+    #
134
+    $MKIT_DRY && MKIT_DEBUG=true
135
+    #shellcheck disable=SC2034
136
+    MKIT_PROJ_PKGNAME=$(ini 1value "project:pkgname")
137
+    test -f "$MKIT_INI" || die "cannot find mkit.ini: $MKIT_INI"
138
+    __chkiniversion
139
+}
140
+
141
+route() {
142
+    #
143
+    # Call correct function based on $1
144
+    #
145
+    if __valid_targets | grep -qwx "^$1"; then
146
+        "$1"
147
+    else
148
+        {
149
+            echo "usage: $(basename "$0") TARGET"
150
+            echo
151
+            echo "valid targets:"
152
+            __valid_targets | sed 's/^/    /'
153
+        } >&2
154
+    fi
155
+}
156
+
157
+warn() {
158
+    #
159
+    # Print warning message
160
+    #
161
+    echo "$@" >&2
162
+}

+ 232
- 0
utils/mkit/include/release.sh View File

@@ -0,0 +1,232 @@
1
+#!/bin/bash
2
+# MKit - simple install helper
3
+# See LICENSE file for copyright and license details.
4
+
5
+mkit_import ini
6
+mkit_import facts
7
+
8
+__bump_version() {
9
+    #
10
+    # Bump version on stdin by level $1 (x, y or z)
11
+    #
12
+    local rlevel=$1     # release level
13
+    local old           # old version
14
+    local oldx          # ... X
15
+    local oldz          # ... Z
16
+    local oldy          # ... Y
17
+    local tmpy          # Y parsing cache
18
+    local new           # bumped version
19
+    read -r old
20
+    oldx=${old%.*.*}
21
+    oldz=${old#*.*.}
22
+    tmpy=${old%.*}
23
+    oldy=${tmpy#*.}
24
+    case $rlevel in
25
+        x) new="$((oldx+MKIT_BUMPSIZE)).0.0"            ;;
26
+        y) new="$oldx.$((oldy+MKIT_BUMPSIZE)).0"        ;;
27
+        z) new="$oldx.$oldy.$((oldz+MKIT_BUMPSIZE))"    ;;
28
+        *) die "invalid release level: $1"  ;;
29
+    esac
30
+    echo "$new"
31
+}
32
+
33
+__relck() {
34
+    #
35
+    # Die if blocking condition $1 is detected
36
+    #
37
+    local condition=$1      # condition name
38
+    local oracle            # expected value
39
+    case "$condition" in
40
+        git_present)
41
+            git rev-parse HEAD >&/dev/null\
42
+             || die "cannot do this outside git repo"
43
+            ;;
44
+        at_relsrc)
45
+            oracle=$(ini 1value project:relsrc)
46
+            git_fact current_branch \
47
+              | grep -qFx "$oracle" \
48
+             || die "you are not on release source branch: $oracle"
49
+            ;;
50
+        not_dirty)
51
+            git diff --shortstat 2>/dev/null \
52
+              | grep -q . \
53
+             && die "tree is dirty!"
54
+            ;;
55
+        tags_ok)
56
+            git_fact latest_tag \
57
+              | grep -q . \
58
+             || die "cannot find latest tag"
59
+            ;;
60
+        vbump_hot)
61
+            git diff-tree --no-commit-id --name-only -r HEAD \
62
+              | grep -qFx mkit.ini \
63
+             || die "last change must be version bump in mkit.ini"
64
+            ;;
65
+        no_wip)
66
+            git_fact reldiff \
67
+              | grep '^....... WIP ' \
68
+             && die "WIP commit since $(git_fact latest_tag)"
69
+            ;;
70
+        ini_version)
71
+            oracle=$(git_fact latest_version | __bump_version "$rlevel")
72
+            ini 1value project:version  \
73
+              | grep -qFx "$oracle" \
74
+             || die "new version not in mkit.ini: $oracle"
75
+            ;;
76
+        *)
77
+            die "unknown release check: $condition"
78
+            ;;
79
+    esac
80
+}
81
+
82
+__release() {
83
+    #
84
+    # Prepare release
85
+    #
86
+    # Span release routines: make a signed tag, check branch
87
+    # and update release branch
88
+    #
89
+    # FIXME: Using project:prerl as build.sh:semver() does may not be
90
+    #        compatible with this release strategy
91
+    #
92
+    local rlevel=$1     # release level (x, y or z)
93
+    local newtag        # new tag
94
+    local relsrc        # release source branch (if any)
95
+    local reldst        # release destination branch (if any)
96
+
97
+    __relck git_present
98
+    __relck at_relsrc
99
+    __relck not_dirty
100
+    __relck tags_ok
101
+    __relck vbump_hot
102
+    __relck no_wip
103
+    __relck ini_version
104
+
105
+    newtag=$(git_fact latest_version | __bump_version "$rlevel" | git_ver2tag )
106
+    set -e
107
+    debug_var newtag
108
+    $MKIT_DRY && return
109
+    git tag -m "$(__release_msg)" "$newtag"
110
+
111
+    relsrc=$(ini 1value project:relsrc)
112
+    reldst=$(ini 1value project:reldst)
113
+    debug_var relsrc reldst
114
+    if test -n "$reldst" && test "$reldst" != "$relsrc"; then
115
+        git branch -f "$reldst" "$newtag"
116
+    fi
117
+}
118
+
119
+__release_msg() {
120
+    #
121
+    # Generate message for annotated tag
122
+    #
123
+    # The last commit before issuing a release must be "Bump version" commit
124
+    # suggested by _vbump_gitmsg() and  manually edited by user.  Since the
125
+    # commit contains changelog, this function just uses the message body.
126
+    #
127
+    # The sort message (first line) is replaced with a nicer one (with project
128
+    # name, codename and version).
129
+    #
130
+    echo "$(ini 1value project:name) $newtag - $(ini 1value project:codename)"
131
+    echo
132
+    git show -s --format=%B \
133
+      | tail -n +3
134
+}
135
+
136
+__vbump() {
137
+    #
138
+    # Do version bump at level $1
139
+    #
140
+    # Perform checks, compute new version, update mkit.ini and initiate
141
+    # 'Bump version' commit with changelog template.
142
+    #
143
+    local rlevel=$1     # bump level (x, y or z)
144
+    local nextver       # version after the bump
145
+    local cache         # cache for the message
146
+    __relck git_present
147
+    __relck at_relsrc
148
+    __relck not_dirty
149
+    nextver=$(ini 1value project:version | __bump_version "$rlevel")
150
+    debug_var nextver
151
+    $MKIT_DRY && return
152
+    update_version "$nextver" mkit.ini \
153
+      || die "failed to update version in mkit.ini"
154
+    git add mkit.ini \
155
+      || die "failed to add mkit.ini to the index"
156
+    cache=$(mktemp -t "mkit._vbump_gitmsg.XXXXXXXX")
157
+    _vbump_gitmsg > "$cache"
158
+    git commit -e -F "$cache"   # note: reading from stdin will break vim
159
+    rm "$cache"
160
+}
161
+
162
+_vbump_gitmsg() {
163
+    #
164
+    # Compose git message template for 'Bump version' commit
165
+    #
166
+    echo "Bump version"
167
+    echo ""
168
+    echo "Overview of changes:"
169
+    echo ""
170
+    git_fact reldiff \
171
+      | sed '
172
+            s/^[a-f0-9]\{7\} /\n *  &/; t PATHS
173
+            s/^/        /
174
+            :PATHS
175
+        '
176
+}
177
+
178
+release() {
179
+    #
180
+    # Perform release on Z level
181
+    #
182
+    __release z
183
+}
184
+
185
+release_x() {
186
+    #
187
+    # Perform release on X level
188
+    #
189
+    __release x
190
+}
191
+
192
+release_y() {
193
+    #
194
+    # Perform release on Y level
195
+    #
196
+    __release y
197
+}
198
+
199
+release_z() {
200
+    #
201
+    # Perform release on Z level
202
+    #
203
+    __release z
204
+}
205
+
206
+vbump() {
207
+    #
208
+    # Perform version bump on Z level
209
+    #
210
+    __vbump z
211
+}
212
+
213
+vbump_x() {
214
+    #
215
+    # Perform version bump on X level
216
+    #
217
+    __vbump x
218
+}
219
+
220
+vbump_y() {
221
+    #
222
+    # Perform version bump on Y level
223
+    #
224
+    __vbump y
225
+}
226
+
227
+vbump_z() {
228
+    #
229
+    # Perform version bump on Z level
230
+    #
231
+    __vbump z
232
+}

+ 61
- 0
utils/mkit/include/vars.sh View File

@@ -0,0 +1,61 @@
1
+#!/bin/bash
2
+#shellcheck disable=SC2034
3
+# MKit - simple install helper
4
+# See LICENSE file for copyright and license details.
5
+
6
+
7
+#
8
+# Bump size (for vbump_? and release_?)
9
+#
10
+MKIT_BUMPSIZE=${MKIT_BUMPSIZE:-1}
11
+
12
+#
13
+# Debug mode (true|false)
14
+#
15
+MKIT_DEBUG=${MKIT_DEBUG:-false}
16
+
17
+#
18
+# Default deploy mode for files
19
+#
20
+MKIT_DEFAULT_MODE="644"
21
+
22
+#
23
+# Dry mode (true|false)
24
+#
25
+# Set to true to not install anything. Implies MKIT_DEBUG.
26
+#
27
+MKIT_DRY=${MKIT_DRY:-false}
28
+
29
+#
30
+# Path to mkit.ini
31
+#
32
+MKIT_INI=${MKIT_INI:-mkit.ini}
33
+
34
+#
35
+# Limit ini expansion depth
36
+#
37
+# To avoid endless loops, this value is subtracted each
38
+# time ini() expands a reference; when zero is reached,
39
+# no more expansions happen.
40
+#
41
+MKIT_INI_EXPAND=2
42
+
43
+#
44
+# Path to MKit local config and temp
45
+#
46
+# Typically hidden in project root, here MKit can
47
+# save its temporary lists.
48
+#
49
+MKIT_LOCAL=${MKIT_LOCAL:-.mkit}
50
+
51
+#
52
+# Package name
53
+#
54
+# Used as base for tarball and in some default macros.
55
+#
56
+MKIT_PROJ_PKGNAME=""
57
+
58
+#
59
+# This MKit version
60
+#
61
+MKIT_VERSION=0.0.32

+ 34
- 0
utils/mkit/make View File

@@ -0,0 +1,34 @@
1
+#!/bin/bash
2
+#shellcheck disable=SC2034
3
+# mkit - simple install helper
4
+# See LICENSE file for copyright and license details.
5
+
6
+init_core() {
7
+    #
8
+    # Load core module (or die)
9
+    #
10
+    #shellcheck disable=SC1090
11
+    . "$MKIT_DIR/include/mkit.sh" \
12
+     && . "$MKIT_DIR/include/vars.sh" \
13
+     && return 0
14
+    echo "failed to load core; check if MKIT_DIR is set properly: $MKIT_DIR" >&2
15
+    exit 9
16
+}
17
+
18
+#
19
+# Path to MKit dir (where 'include' is)
20
+#
21
+MKIT_DIR=${MKIT_DIR:-$(dirname "$0")}
22
+
23
+
24
+init_core
25
+
26
+case "$1" in
27
+    -V|--version-semver)    echo "$MKIT_VERSION"; exit 0 ;;
28
+    --version)              echo "Mkit (Simple Makefile target helper) $MKIT_VERSION"
29
+                            exit 0 ;;
30
+esac
31
+
32
+mkit_init
33
+
34
+route "$@"

+ 56
- 0
utils/mkit/mkit.mk View File

@@ -0,0 +1,56 @@
1
+# mkit - Simple Makefile target helper
2
+# See LICENSE file for copyright and license details.
3
+
4
+export MKIT_DIR
5
+
6
+all: build
7
+
8
+_mkit_data:
9
+	@"$(MKIT_DIR)"/make _mkit_data
10
+
11
+build:
12
+	@"$(MKIT_DIR)"/make build
13
+
14
+clean:
15
+	@"$(MKIT_DIR)"/make clean
16
+
17
+debstuff: dist
18
+	@"$(MKIT_DIR)"/make debstuff
19
+
20
+dist: clean
21
+	@"$(MKIT_DIR)"/make dist
22
+
23
+rpmstuff: dist
24
+	@"$(MKIT_DIR)"/make rpmstuff
25
+
26
+install: all
27
+	@"$(MKIT_DIR)"/make install
28
+
29
+release:
30
+	@"$(MKIT_DIR)"/make release
31
+
32
+release_x:
33
+	@"$(MKIT_DIR)"/make release_x
34
+
35
+release_y:
36
+	@"$(MKIT_DIR)"/make release_y
37
+
38
+release_z:
39
+	@"$(MKIT_DIR)"/make release_z
40
+
41
+uninstall:
42
+	@"$(MKIT_DIR)"/make uninstall
43
+
44
+vbump:
45
+	@"$(MKIT_DIR)"/make vbump
46
+
47
+vbump_x:
48
+	@"$(MKIT_DIR)"/make vbump_x
49
+
50
+vbump_y:
51
+	@"$(MKIT_DIR)"/make vbump_y
52
+
53
+vbump_z:
54
+	@"$(MKIT_DIR)"/make vbump_z
55
+
56
+.PHONY: all _mkit_data clean dist rpmstuff install uninstall release release_x release_y release_z vbump vbump_x vbump_y vbump_z

+ 715
- 0
utils/mkit/stub View File

@@ -0,0 +1,715 @@
1
+#!/bin/bash
2
+# mkit - simple install helper
3
+# See LICENSE file for copyright and license details.
4
+
5
+init_core() {
6
+    #
7
+    # Load core modules (or die)
8
+    #
9
+    #shellcheck disable=SC1090
10
+    . "$MKIT_DIR/include/mkit.sh" \
11
+     && . "$MKIT_DIR/include/vars.sh" \
12
+     && return 0
13
+    echo "failed to load core; check if MKIT_DIR is set properly: $MKIT_DIR" >&2
14
+    exit 9
15
+}
16
+
17
+#
18
+# Path to MKit dir (where 'include' is)
19
+#
20
+MKIT_DIR=${MKIT_DIR:-$(dirname "$0")}
21
+
22
+init_core
23
+
24
+mkit_import ini
25
+
26
+declare -A MKIT_STUB_LICENSES
27
+MKIT_STUB_LICENSES[GPLv1]="http://www.gnu.org/licenses/old-licenses/gpl-1.0.md"
28
+MKIT_STUB_LICENSES[GPLv2]="http://www.gnu.org/licenses/old-licenses/gpl-2.0.md"
29
+MKIT_STUB_LICENSES[GPLv3]="http://www.gnu.org/licenses/gpl-3.0.md"
30
+MKIT_STUB_LICENSES[LGPLv2]="http://www.gnu.org/licenses/old-licenses/lgpl-2.1.md"
31
+MKIT_STUB_LICENSES[LGPLv3]="http://www.gnu.org/licenses/lgpl-3.0.md"
32
+MKIT_STUB_LICENSES[AGPLv3]="http://www.gnu.org/licenses/agpl-3.0.md"
33
+MKIT_STUB_LICENSES[FDLv1.3]="http://www.gnu.org/licenses/fdl-1.3.md"
34
+MKIT_STUB_LICENSES[FDLv1.2]="http://www.gnu.org/licenses/old-licenses/fdl-1.2.md"
35
+MKIT_STUB_LICENSES[FDLv1.1]="http://www.gnu.org/licenses/old-licenses/fdl-1.1.md"
36
+
37
+
38
+deploy() {
39
+    local file=$1       # which known file?
40
+    local any_name=${NiceName:-$PackageName}
41
+    local tmp
42
+    tmp=$(mktemp -t mkit.stub.deploy.XXXXXXX)
43
+    mkdir -p "$(dirname "$file")"
44
+    case $file in
45
+
46
+        Makefile)
47
+            echo -n "# $any_name"
48
+            test -n "$Tagline" && echo -n " - $Tagline"
49
+            echo
50
+            $MkLicense && echo '# See LICENSE.md file for copyright and license details.'
51
+            echo ''
52
+            echo 'MKIT_DIR=utils/mkit'
53
+            #shellcheck disable=SC2016
54
+            echo 'include $(MKIT_DIR)/mkit.mk'
55
+            ;;
56
+
57
+        README.md)
58
+            echo "$any_name"
59
+            tr -c '=\n' '=' <<<"$any_name"
60
+            echo ''
61
+            if test -n "$Tagline"; then
62
+                echo "$Tagline"
63
+            else
64
+                echo "(Nothing to say about this project.)"
65
+            fi
66
+            ;;
67
+
68
+        */mkit.ini|mkit.ini)
69
+            echo "[project]"
70
+            {
71
+                echo "version = $Version"
72
+                test -n "$Codename"     && echo "codename    = $Codename"
73
+                test -n "$NiceName"     && echo "name        = $NiceName"
74
+                test -n "$Tagline"      && echo "tagline     = $Tagline"
75
+                test -n "$PackageName"  && echo "pkgname     = $PackageName"
76
+                test -n "$Maintainer"   && echo "maintainer  = $Maintainer"
77
+                test -n "$VcsBrowser"   && echo "vcs_browser = $VcsBrowser"
78
+                test -n "$RelSrc"       && echo "relsrc      = $RelSrc"
79
+                test -n "$RelDst"       && echo "reldst      = $RelDst"
80
+            } | reformat_section
81
+            if updating; then
82
+                remake_section dist
83
+                remake_section ENV
84
+                remake_section roots
85
+                remake_section macros
86
+                remake_section modes
87
+                remake_section files
88
+            else
89
+                echo ""
90
+                echo "[dist]"
91
+                {
92
+                    $MkLicense  && echo "tarball = LICENSE.md"
93
+                    $MkMakefile && echo "tarball = Makefile"
94
+                    $MkReadme   && echo "tarball = README.md"
95
+                    echo "tarball = mkit.ini"
96
+                    $MkPackaging && echo "tarball = packaging"
97
+                    echo "tarball = src"
98
+                    echo "tarball = tests"
99
+                    echo "tarball = utils"
100
+                    $MkPackaging && echo "rpmstuff = packaging/template.spec"
101
+                    $MkPackaging && echo "debstuff = packaging/debian"
102
+                } | reformat_section
103
+                echo ""
104
+                echo "[ENV]"
105
+                {
106
+                    echo "    PREFIX = /usr/local"
107
+                } | reformat_section
108
+                echo ""
109
+                echo "[roots]"
110
+                {
111
+                    echo "bin = [ENV:PREFIX]/bin"
112
+                    echo "doc = [ENV:PREFIX]/share/doc/$PackageName"
113
+                } | reformat_section
114
+                echo ""
115
+                echo "[macros]"
116
+                {
117
+                    echo "__${PackageName^^}_FOO__ = Barr.."
118
+                } | reformat_section
119
+                echo ""
120
+                echo "[modes]"
121
+                {
122
+                    echo "bin = 755"
123
+                    echo "doc = 644"
124
+                } | reformat_section
125
+                echo ""
126
+                echo "[files]"
127
+                {
128
+                    echo "bin = src/$PackageName"
129
+                    $MkLicense && echo "doc = LICENSE.md"
130
+                    $MkReadme  && echo "doc = README.md"
131
+                } | reformat_section
132
+            fi
133
+            echo ""
134
+            echo "#mkit version=$MKIT_VERSION"
135
+            ;;
136
+
137
+        packaging/template.spec)
138
+            echo 'Name:       __MKIT_PROJ_PKGNAME__'
139
+            echo 'Version:    __MKIT_PROJ_VERSION__'
140
+            echo 'Release:    1%{?dist}'
141
+            echo 'Summary:    __MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__'
142
+            test -n "$VcsBrowser" && echo 'URL:        __MKIT_PROJ_VCS_BROWSER__'
143
+            $MkLicense && echo "License:    $License"
144
+            echo 'Source0:    %{name}-%{version}.tar.gz'
145
+            echo 'BuildArch:  noarch'
146
+            echo ''
147
+            echo 'Requires: MKIT_STUB_REQUIRES'
148
+            echo '%description'
149
+            echo 'MKIT_STUB_DESCRIPTION'
150
+            echo ''
151
+            echo '%prep'
152
+            echo '%setup -q'
153
+            echo ''
154
+            echo '%build'
155
+            echo 'make %{?_smp_mflags} PREFIX=/usr'
156
+            echo ''
157
+            echo '%install'
158
+            echo '%make_install PREFIX=/usr'
159
+            echo ''
160
+            echo '%files'
161
+            echo 'MKIT_STUB_FILELIST'
162
+            echo ''
163
+            echo '%changelog'
164
+            echo ''
165
+            echo '# specfile built with MKit __MKIT_SELF_VERSION__'
166
+            ;;
167
+
168
+        packaging/debian/copyright)
169
+            echo ""
170
+            ;;
171
+
172
+        packaging/debian/control)
173
+            echo 'Source: __MKIT_PROJ_PKGNAME__'
174
+            echo 'Maintainer: __MKIT_PROJ_MAINTAINER__'
175
+            test -n "$VcsBrowser" && echo 'Vcs-Browser: __MKIT_PROJ_VCS_BROWSER__'
176
+            echo 'Section: misc'
177
+            echo 'Priority: extra'
178
+            echo 'Standards-Version: 3.9.2'
179
+            echo 'Build-Depends:'
180
+            echo ' debhelper (>= 9),'
181
+            echo ''
182
+            echo 'Package: __MKIT_PROJ_PKGNAME__'
183
+            echo 'Architecture: all'
184
+            echo 'Depends: MKIT_STUB_REQUIRES'
185
+            echo 'Description: __MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__'
186
+            echo ' MKIT_STUB_DESCRIPTION'
187
+            echo ''
188
+            echo '# control file built with MKit __MKIT_SELF_VERSION__'
189
+            ;;
190
+
191
+        packaging/debian/changelog)
192
+            echo '__MKIT_PROJ_PKGNAME__ (__MKIT_PROJ_VERSION__-1) UNRELEASED; urgency=medium'
193
+            echo ''
194
+            echo '  * Initial release. (Closes: #XXXXXX)'
195
+            echo ''
196
+            echo " -- __MKIT_PROJ_MAINTAINER__  $(date -R)"
197
+            ;;
198
+
199
+        packaging/debian/compat)
200
+            echo 9
201
+            ;;
202
+
203
+        packaging/debian/rules)
204
+            echo '#!/usr/bin/make -f'
205
+            echo ''
206
+            echo '%:'
207
+            echo ''
208
+            echo '	dh $@'
209
+            echo ''
210
+            echo 'override_dh_auto_install:'
211
+            echo ''
212
+            echo '	make install PREFIX=/usr DESTDIR=debian/tmp'
213
+            ;;
214
+
215
+        packaging/debian/source/format)
216
+            echo '3.0 (quilt)'
217
+            ;;
218
+
219
+        packaging/debian/install)
220
+            echo MKIT_STUB_FILELIST
221
+            ;;
222
+
223
+        src/*.skel)
224
+            echo 'echo "my version is: __MKIT_PROJ_VERSION__"'
225
+            echo 'echo "And that'"'"'s all, folks!"'
226
+            ;;
227
+
228
+        LICENSE.md)
229
+            local url   # license URL
230
+            url="${MKIT_STUB_LICENSES[$License]}"
231
+            curl -sf "$url" \
232
+             || die "failed to download license: $url"
233
+            ;;
234
+
235
+        .mkit/autoclean)
236
+            ;;
237
+
238
+        MKIT_STUB_README.md)
239
+            echo "FINISHING MKIT CONFIGURATION"
240
+            echo "============================"
241
+            echo ""
242
+            echo "Congratulations, your new project has been configured!"
243
+            echo ""
244
+            echo "However, the *stub* script is not able to figure out"
245
+            echo "everything, so few things still need to be done manually."
246
+            echo "This document will guide you throught the rest of the"
247
+            echo "process."
248
+            echo ""
249
+            echo ""
250
+            echo "Structure"
251
+            echo "---------"
252
+            echo ""
253
+            echo "First, let's go through the directory structure:"
254
+            echo ""
255
+            echo " *  *src* directory - here is your main place to store"
256
+            echo "    source files.  This includes also documents like user"
257
+            echo "    manuals---IOW, anything intended to end up on user's"
258
+            echo "    machine should be uder 'src'."
259
+            echo ""
260
+            echo "    Note that during build time, files named ending with"
261
+            echo "    '.skel' are subject to macro expansion, see mkit.ini"
262
+            echo "    section below for details."
263
+            echo ""
264
+            echo " *  *notes* directory - here you shall store notes"
265
+            echo "    intended for people contributing to your project,"
266
+            echo "    for instance, guidelines, coding style documents,"
267
+            echo "    TODOs, ideas, plans..."
268
+            echo ""
269
+            echo " *  *utils* directory - here you shall store utilities"
270
+            echo "    and scripts that will help you with project maintenance,"
271
+            echo "    and that, unlike software like compilers or versioning"
272
+            echo "    systems, can (and should) be embedded inside the"
273
+            echo "    repository."
274
+            echo ""
275
+            echo "    MKit itself is one nice example. :)"
276
+
277
+            if $MkPackaging; then
278
+            echo ""
279
+            echo " *  *packaging* directory contains templates that enable"
280
+            echo "    MKit create raw stuffs used to create DEB or RPM"
281
+            echo "    packages.  Similar to '.skel' files in 'src', all files"
282
+            echo "    here are automatically considered for macro expansion,"
283
+            echo "    no matter how they are named (see mkit.ini section"
284
+            echo "    below)."
285
+            echo ""
286
+            echo "    NOTE: these templates, as well as any packages created by"
287
+            echo "    them are intended only for experimental, private use and"
288
+            echo "    testing."
289
+            echo ""
290
+            echo "    Should you have ambition to create 'real' packages for"
291
+            echo "    OS distribution such as Debian or Fedora (what a great"
292
+            echo "    idea!), be prepared that you will need to follow their"
293
+            echo "    guidelines.  This will most probably mean huge changes"
294
+            echo "    to these packages or even changes to your workflow."
295
+            echo ""
296
+            echo ""
297
+            echo "Placeholders"
298
+            echo "------------"
299
+            echo ""
300
+            echo "At places where *stub* script did not have way to get all"
301
+            echo "information automatically, it has inserted placeholders."
302
+            echo "You will need to go through all of these placeholders and"
303
+            echo "replace them with proper data."
304
+            echo ""
305
+            echo "Please follow instructions:"
306
+            echo ""
307
+            echo " 1. Look for placeholders starting with \`MKIT_STUB_\`"
308
+            echo "    prefix by calling this command:"
309
+            echo ""
310
+            echo "        grep -l MKIT_STUB_ -r"
311
+            echo ""
312
+            echo " 2. Go through each file and locate the placeholder.  (You"
313
+            echo "    will also see placeholders like \`__MKIT_*__\`, you can"
314
+            echo "    ignore those."
315
+            echo ""
316
+            echo " 3. Replace placeholder with appropriate information:"
317
+            echo ""
318
+            echo "     *  \`MKIT_STUB_REQUIRES\` - Requirements of your"
319
+            echo "        project."
320
+            echo ""
321
+            echo "     *  \`MKIT_STUB_DESCRIPTION\` - Description of your"
322
+            echo "        project (few sentences to paragraphs)."
323
+            echo ""
324
+            echo "     *  \`MKIT_STUB_FILELIST\` - List of full paths to"
325
+            echo "        your files after installation."
326
+            echo ""
327
+            echo "        Note that in case of debian/install files, PREFIX"
328
+            echo "        based paths (eg. /usr/bin) in this file should be as"
329
+            echo "        if PREFIX was /usr."
330
+            echo ""
331
+            echo "        In case of Fedora-based distro, you should make use"
332
+            echo "        of RPM macros:"
333
+            echo ""
334
+            echo "            https://fedoraproject.org/wiki/Packaging:RPMMacros"
335
+            echo ""
336
+            echo "    Refer to these documents for further details:"
337
+            echo ""
338
+            echo "        http://rpm-guide.readthedocs.io/"
339
+            echo "        https://www.debian.org/doc/manuals/maint-guide/"
340
+            fi
341
+
342
+            echo ""
343
+            echo ""
344
+            echo "mkit.ini"
345
+            echo "--------"
346
+            echo ""
347
+            echo "Most sections still need to be reviewed. In order to do"
348
+            echo "that, you will need to understand how MKit works:"
349
+            echo ""
350
+            echo " 1. First, you need to define *roles* your files will play"
351
+            echo "    when they are installed on user's file systems.  These"
352
+            echo "    roles then imply where and how the files should be"
353
+            echo "    deployed."
354
+            echo ""
355
+            echo "    Typical example of a role is e.g. 'bin' for commands"
356
+            echo "    (normally under '/usr/bin' or '/usr/local/bin'), 'doc'"
357
+            echo "    for documents or 'lib' for libraries."
358
+            echo ""
359
+            echo " 2. Next, in \`[roots]\` section, you have to set target"
360
+            echo "    root directory for each role.  However, in order to"
361
+            echo "    enable people to implement local conventions, it is"
362
+            echo "    considered a good manner to also respect PREFIX"
363
+            echo "    environment variable.  For this reason, most paths"
364
+            echo "    need to start with \`[ENV:PREFIX]\`."
365
+            echo ""
366
+            echo " 3. \`[files]\` section is where you assign actual files"
367
+            echo "    from your repository to their final paths.  The format"
368
+            echo "    is \`ROLE = REPOPATH [RENAMED]\`, where ROLE is file's"
369
+            echo "    role, REPOPATH is relative path to the file."
370
+            echo ""
371
+            echo "    Final path is then composed by taking path assigned to"
372
+            echo "    ROLE and appending file's name.  However, if you need"
373
+            echo "    the deployed file to have different name than in the"
374
+            echo "    codebase, you can specify the other name as RENAMED."
375
+            echo ""
376
+            echo "    Note that you don't need to address every single file"
377
+            echo "    individually, if in your repo you have a directory with"
378
+            echo "    100 files of the same role, you can add just path to the"
379
+            echo "    directory itself."
380
+            echo ""
381
+            echo " 4. If some roles require special permissions on your files,"
382
+            echo "    \`[modes]\` section is your friend.  Permissions here"
383
+            echo "    should be in UNIX octal format."
384
+            echo ""
385
+            echo " 5. Next, \`[macros]\` section allows you to define own"
386
+            echo "    placeholders that will be replaced when your scripts are"
387
+            echo "    built.  Each file in 'src' directory that is named with"
388
+            echo "    '.skel' suffix, and each file from 'packaging' directory"
389
+            echo "    (no matter its name), can contain one or more of macros"
390
+            echo "    defined here, plus range of macros automatically defined"
391
+            echo "    by MKit.  During build, these macros are replaced with"
392
+            echo "    their actual values."
393
+            echo ""
394
+            echo " 6. Less interesting, but important section is \`[dist]\`,"
395
+            echo "    which lists files in your codebase that will be added"
396
+            echo "    to distribution tarball (part of \"stuffs\" mentioned"
397
+            echo "    above).  Listing directory here will include all its"
398
+            echo "    contents, and normally it's OK to be very inclusive, so"
399
+            echo "    most of the time this section should be OK."
400
+            echo ""
401
+            echo " 7. Even less interesting is section \`[ENV]\`.  It is"
402
+            echo "    special in that it provides *default* value for an"
403
+            echo "    environment variable.  You almost never need to touch"
404
+            echo "    this."
405
+            echo ""
406
+            echo " 8. Finally, the most interesting section!  \`[project]\`,"
407
+            echo "    provides most general information for your project such"
408
+            echo "    as name and version."
409
+            echo ""
410
+            echo "    Note that the \`version\` key is another \"special"
411
+            echo "    snowflake\" -- it is now set to 0.0.0, and you **should"
412
+            echo "    not need** to change  it manually.  When you feel you"
413
+            echo "    a are ready to release next version of your evolving"
414
+            echo "    project, simply call \`make vbump\` and MKit will take"
415
+            echo "    care of everything!"
416
+
417
+            if $MkMakefile; then
418
+            echo ""
419
+            echo ""
420
+            echo "Makefile"
421
+            echo "--------"
422
+            echo ""
423
+            echo "*stub* script also created a Makefile for you, but all"
424
+            echo "it really does is include MKit's own mkit.mk, which in turn"
425
+            echo "only maps \`make\` targets to actual mkit script calls."
426
+            echo "Unless your project already uses GNU Make, you should not"
427
+            echo "need to change this file."
428
+            fi
429
+
430
+            if $MkReadme; then
431
+            echo ""
432
+            echo ""
433
+            echo "README.md"
434
+            echo "---------"
435
+            echo ""
436
+            echo "Each serious project needs a serious README.  Which is why"
437
+            echo "*stub* has created a 'stub' of one for you."
438
+            fi
439
+
440
+            echo ""
441
+            echo ""
442
+            echo "The final touch"
443
+            echo "---------------"
444
+            echo ""
445
+            echo "Once you have reviewed everything, just delete this file!"
446
+            ;;
447
+
448
+    esac >"$tmp"
449
+    cat "$tmp" > "$file"
450
+    rm "$tmp"
451
+}
452
+
453
+known_licenses() {
454
+    local key
455
+    local first=true
456
+    for key in "${!MKIT_STUB_LICENSES[@]}"; do
457
+        $first && echo "$key"  && continue
458
+        echo ", $key"
459
+    done
460
+}
461
+
462
+usage() {
463
+    {
464
+        echo "Usage:"
465
+        echo "   stub [options] new PKGNAME"
466
+        echo "   stub [options] update"
467
+        echo "   stub -L"
468
+        echo ""
469
+        echo "Options:"
470
+        echo ""
471
+        echo "    -c CODENAME   your project codename"
472
+        echo "    -t TAGLINE    your project tagline"
473
+        echo "    -b RELSRC     pre-release branch"
474
+        echo "    -B RELDST     post-release branch"
475
+        echo "    -n NICENAME   your project's 'nice' name"
476
+        echo "    -l LICENSE    your options's license (see -L)"
477
+        echo "    -m MAINT      project maintainer's name and e-mail"
478
+        echo "    -v URL        URL to public code browser"
479
+        echo "    -V VERSION    initial version (default: 0.0.0)"
480
+        echo "    -a            enable autoclean ('make clean' after"
481
+        echo "                  each 'make install')"
482
+        echo "    -g            make git commits before and adter"
483
+        echo "                  (implies -y)"
484
+        echo "    -y            don't ask, just do it"
485
+        echo "    -R            skip creating README.md"
486
+        echo "    -M            skip creating Makefile"
487
+        echo "    -P            skip creating packaging templates"
488
+        echo "    -L            list known licenses and exit"
489
+        echo ""
490
+        echo "PKGNAME should be packaging-friendly name, ie. consist"
491
+        echo "only of small letters, numbers, underscore and dash."
492
+        echo "For your 'real' name, use NICENAME, which can be any"
493
+        echo "string."
494
+    } >&2
495
+    exit 2
496
+}
497
+
498
+confirm() {
499
+    local response      # user's response to our warning
500
+    $Force && return 0
501
+    {
502
+        echo "Warning: This operation can be destructive for your"
503
+        echo "current codebase.  At least following files will be"
504
+        echo "created or overwritten:"
505
+        echo ""
506
+        $MkPackaging    && echo " *  'packaging' directory (pass -P to avoid)"
507
+        $MkMakefile     && echo " *  'Makefile' (pass -M to avoid)"
508
+        $MkReadme       && echo " *  'README.md' (pass -R to avoid)"
509
+        $MkLicense      && echo " *  'LICENSE.md' (omit -l to avoid)"
510
+        echo " *  'mkit.ini'"
511
+        echo ""
512
+        read -p "Type 'yes' to proceed: " -r response
513
+    } >&2
514
+    test "$response" == "yes" && return 0
515
+    warn "Aborting."
516
+    return 1
517
+}
518
+
519
+mkcommit_backup() {
520
+    git ls-files --others \
521
+      | grep -qv -e '^utils/mkit$' -e '^utils/mkit/' \
522
+     || { warn "nothing to back up"; return 0; }
523
+    git add .                           || return
524
+    git rm -r --cached utils/mkit       || return
525
+    git commit -m "WIP [mkit/stub] backup" || return
526
+}
527
+
528
+mkcommit_mkit_code() {
529
+    git ls-files --others \
530
+      | grep -q -e '^utils/mkit$' -e '^utils/mkit/' \
531
+     || return 0
532
+    git add utils/mkit || return
533
+    git commit -m "WIP [mkit/stub] Add MKit version v$MKIT_VERSION" || return
534
+}
535
+
536
+mkcommit_mkit_conf() {
537
+    local msg       # commit message (the important art
538
+    git add . || return
539
+    case $Action in
540
+        new)    msg="Add MKit configuration stub" ;;
541
+        update) msg="Update MKit configuration"   ;;
542
+    esac
543
+    git commit -m "WIP [mkit/stub] $msg" || return
544
+}
545
+
546
+deploy_packaging() {
547
+    rm -rf packaging
548
+    deploy packaging/template.spec
549
+    deploy packaging/debian/copyright
550
+    deploy packaging/debian/control
551
+    deploy packaging/debian/changelog
552
+    deploy packaging/debian/compat
553
+    deploy packaging/debian/install
554
+    deploy packaging/debian/rules
555
+    deploy packaging/debian/source/format
556
+}
557
+
558
+init_from_existing() {
559
+    #
560
+    # Initialize variables from old mkit.ini
561
+    #
562
+    test -f "$MKIT_INI" \
563
+     || die "mkit.ini not found; aborting update: $MKIT_INI"
564
+    user_gave Codename    || Codename=$(ini_raw1v project:codename)
565
+    user_gave License     || License=$(ini_raw1v project:license)
566
+    user_gave Maintainer  || Maintainer=$(ini_raw1v project:maintainer)
567
+    user_gave NiceName    || NiceName=$(ini_raw1v project:name)
568
+    user_gave PackageName || PackageName=$(ini_raw1v project:pkgname)
569
+    user_gave RelDst      || RelDst=$(ini_raw1v project:reldst)
570
+    user_gave RelSrc      || RelSrc=$(ini_raw1v project:relsrc)
571
+    user_gave Tagline     || Tagline=$(ini_raw1v project:tagline)
572
+    user_gave VcsBrowser  || VcsBrowser=$(ini_raw1v project:vcs_browser)
573
+    user_gave Version     || Version=$(ini_raw1v project:version)
574
+}
575
+
576
+ini_raw1v() {
577
+    #
578
+    # Read raw scalar from mkit.ini
579
+    #
580
+    local path=$1
581
+    MKIT_INI_EXPAND=0 ini 1value "$path"
582
+}
583
+
584
+user_gave() {
585
+    #
586
+    # True if user gave value to variable $1
587
+    #
588
+    local var=$1    # name of the variable
589
+    { test "${UserGave[$var]}" == 1; } 2>/dev/null
590
+}
591
+
592
+updating() {
593
+    #
594
+    # Are we updating?
595
+    #
596
+    test "$Action" == update
597
+}
598
+
599
+remake_section() {
600
+    #
601
+    # Re-compose mkit.ini section $1
602
+    #
603
+    local section=$1
604
+    local key
605
+    local value
606
+    ini lskeys "$section" | grep -q . \
607
+     || return 1
608
+    echo ""
609
+    echo "[$section]"
610
+    ini lskeys "$section" \
611
+      | while read -r key; do
612
+            MKIT_INI_EXPAND=0 ini values "$section:$key" \
613
+              | while read -r value; do
614
+                    echo "$key = $value"
615
+                done
616
+        done \
617
+      | reformat_section
618
+}
619
+
620
+reformat_section() {
621
+    #
622
+    # Re-format "k = v" on stdin as "nice" ini section
623
+    #
624
+    local key
625
+    local eq
626
+    local value
627
+    while read -r key eq value; do
628
+        test "$eq" == "=" || {
629
+            warn "ignoring malformed ini line: $key $eq $value"
630
+            continue
631
+        }
632
+        echo "$key = $value"
633
+    done \
634
+      | sed 's/ *= */=/; s/^ *//; s/ *$//' \
635
+      | column -t -s= -o' = ' \
636
+      | sed 's/^/    /'
637
+}
638
+
639
+main() {
640
+    local NiceName          # human-readable project name
641
+    local PackageName       # machine-safe project (package) name
642
+    local RelSrc            # pre-release branch
643
+    local RelDst            # post-release branch
644
+    local Codename          # release codename
645
+    local Tagline           # project tagline
646
+    local Maintainer        # project maintainer (Name + e-mail)
647
+    local VcsBrowser        # VCS browser (eg. GitHub URL)
648
+    local Version=0.0.0     # project version
649
+    local AutoClean=false   # touch .mkit/autoclean?
650
+    local MkCommits=false   # create pre/post git commits?
651
+    local Force=false       # go without asking?
652
+    local MkReadme=true     # create README.md?
653
+    local MkMakefile=true   # create Makefile?
654
+    local MkPackaging=true  # create packaging templates?
655
+    local MkLicense=false   # create LICENSE.md file
656
+    local Action            # 'update' to respect existing, 'new' to force
657
+                            # rewrite incl. MKIT_STUB_* placeholders
658
+    declare -A UserGave
659
+    while true; do case $1 in
660
+        -n) NiceName=$2;   UserGave[NiceName]=1;   shift 2 || usage ;;
661
+        -b) RelSrc=$2;     UserGave[RelSrc]=1;     shift 2 || usage ;;
662
+        -B) RelDst=$2;     UserGave[RelDst]=1;     shift 2 || usage ;;
663
+        -c) Codename=$2;   UserGave[Codename]=1;   shift 2 || usage ;;
664
+        -t) Tagline=$2;    UserGave[Tagline]=1;    shift 2 || usage ;;
665
+        -l) License=$2;    UserGave[License]=1;    shift 2 || usage ;;
666
+        -m) Maintainer=$2; UserGave[Maintainer]=1; shift 2 || usage ;;
667
+        -v) VcsBrowser=$2; UserGave[VcsBrowser]=1; shift 2 || usage ;;
668
+        -V) Version=$2;    UserGave[Version]=1;    shift 2 || usage ;;
669
+        -M) MkMakefile=false;   shift ;;
670
+        -R) MkReadme=false;     shift ;;
671
+        -a) AutoClean=true;     shift ;;
672
+        -y) Force=true;         shift ;;
673
+        -g) MkCommits=true;     shift ;;
674
+        -P) MkPackaging=false;  shift ;;
675
+        -L) known_licenses | tr , '\n'; exit 0 ;;
676
+        -*) usage ;;
677
+        *)  break ;;
678
+    esac done
679
+    Action=$1; PackageName=$2
680
+    case $Action:$PackageName in
681
+        new:)     usage ;;
682
+        new:*)    :     ;;
683
+        update:)  :     ;;
684
+        update:*) usage ;;
685
+        *)        usage ;;
686
+    esac
687
+    updating && init_from_existing
688
+    if test -n "$License"; then
689
+        known_licenses | grep -qxF "$License" \
690
+         || die "unknown license (use -L to get list): $License"
691
+        MkLicense=true
692
+    fi
693
+    if $MkCommits; then
694
+        mkcommit_backup || die "failed creating backup commit"
695
+        Force=true
696
+    fi
697
+    confirm            || return 1
698
+    deploy "$MKIT_INI"
699
+    deploy src/"$PackageName".skel
700
+    $MkMakefile     && deploy Makefile
701
+    $MkReadme       && deploy README.md
702
+    $MkLicense      && deploy LICENSE.md
703
+    $AutoClean      && deploy .mkit/autoclean
704
+    $MkPackaging    && deploy_packaging
705
+    if $MkCommits; then
706
+        mkcommit_mkit_code || die "failed creating post-commit"
707
+        mkcommit_mkit_conf || die "failed creating post-commit"
708
+    fi
709
+    deploy MKIT_STUB_README.md
710
+    warn "Configuration stub built, follow instructions in"
711
+    warn "MKIT_STUB_README.md to finish configuration."
712
+    return 0
713
+}
714
+
715
+main "$@"

+ 399
- 0
utils/tfkit/doc/README.md View File

@@ -0,0 +1,399 @@
1
+TFKit
2
+=====
3
+
4
+
5
+Installation
6
+------------
7
+
8
+The easiest way is to embed TFKit within your repo, ie. clone TFKit and
9
+install it using:
10
+
11
+    make install DESTDIR=/path/to/your/repo
12
+
13
+Now you can run your test suite using *runtests* binary:
14
+
15
+    $ cd /path/to/your/repo
16
+    $ utils/tfkit/runtest
17
+
18
+Note that the above probably won't return any useful results as you still
19
+don't have any tests.
20
+
21
+
22
+Writing tests
23
+-------------
24
+
25
+Tests can be written in any scripting language, although the built-in
26
+framework, written in Bash, provides some useful features for writing
27
+certain kind of relatively simple tests.
28
+
29
+The harness, though, assumes that:
30
+
31
+ *  Any direct sub-directory of `$TF_SUITE` directory ("tests" by default)
32
+    that contains at least *TF_RUN* executable becomes a test,
33
+
34
+ *  basename of this directory becomes the name of the test,
35
+
36
+ *  and return code from running the executable is reported
37
+    as result of the test, according to "Exit status" section below.
38
+
39
+
40
+Naming
41
+------
42
+
43
+Test name should start with name of the module that is tested and
44
+underscore.  If module name contains dots, they should be replaced with
45
+underscores as well.
46
+
47
+    core_sanity
48
+    mod_submod_function
49
+    ini_iniread
50
+
51
+are valid test names.
52
+
53
+
54
+Data
55
+----
56
+
57
+Should the test need any data, just leave it around in the test directory
58
+along with *TF_RUN*.
59
+
60
+Note that before running, the whole test directory is automatically
61
+copied to a temporary location (one per test), and should the test fail,
62
+copied back as a debugging relic.  For this reason, *do not store
63
+huge amounts of data here*.  If you really need huge data, consider
64
+obtaining it (and throwing it away) within runtime of *TF_RUN*.
65
+
66
+
67
+Exit status
68
+-----------
69
+
70
+We try hard to follow this semantic:
71
+
72
+ *  *Zero* means *OK* -- test has been run and passed.
73
+
74
+ *  *One* means *Failure* -- test has been run but failed (e.g. found
75
+     a bug).
76
+
77
+ *  *Two* means *Bailout* --  test has decided not to run at all.
78
+
79
+ *  *Three* means *Error* -- there was error detected during execution,
80
+     but script was able to clean up properly.
81
+
82
+ *  *Four* means *Panic* -- there was other error but script *was not*
83
+     able to clean up properly.
84
+
85
+ *  Anything else should indicate other uncaught errors, including those
86
+    outside control of the program such as segfaults in the test code
87
+    or test being SIGKILLed.
88
+
89
+Notice that the higher the value is, the worse situation it indicates.
90
+Thus, if a test is composed of several sub-tests, you need to make sure
91
+to always **exit with the highest value** (subtest.sh does take care
92
+of this).
93
+
94
+See *common.sh* for functions and variables to help with handling exit
95
+statuses with this semantic.
96
+
97
+Also see Notes section for more details on exit statuses, including
98
+cheat sheet and dscussuion.
99
+
100
+
101
+Framework
102
+---------
103
+
104
+
105
+### harness.sh ###
106
+
107
+This part is not intended to be used in tests, but rather contains
108
+functions that help govern test discovery, preparation and execution as
109
+is described in previous sections.  Feel free to poke around, of course.
110
+
111
+
112
+### subtest.sh ###
113
+
114
+As name suggests, this file defines few functions to handle subtests
115
+in *TF_RUN*.
116
+
117
+In order to make use of the subtests functionality, you will need to
118
+define two functions yourself:  `tf_enum_subtests` to enumerate names of
119
+tests you want to run, and `tf_do_subtest` with actual test
120
+implementation.
121
+
122
+The minimal *TF_RUN* with two subtests could look like this:
123
+
124
+    #!/bin/bash
125
+
126
+    . $TF_DIR/include/subtest.sh
127
+
128
+    tf_enum_subtests() {
129
+        echo test1
130
+        echo test2
131
+        something && echo test3
132
+    }
133
+
134
+    tf_do_subtest() {
135
+        case $1 in
136
+            test1)  myprog foo ;;
137
+            test2)  myprog bar ;;
138
+            test3)  myprog baz ;;
139
+        esac
140
+    }
141
+
142
+    tf_do_subtests
143
+
144
+At the end, `tf_do_subtests` acts as a launcher of the actual test.
145
+In short, it will
146
+
147
+ 1. run `tf_enum_subtests`, taking each line as name of a subtest;
148
+    for each subtest:
149
+
150
+     1. source *TF_SETUP*, if such file is found,
151
+     2. launch the `tf_do_subtest()` function with subtest name as
152
+        the only argument,
153
+     3. source *TF_CLEANUP*, if such file is found,
154
+
155
+ 2. and finally, report "worst" exit status encountered.
156
+
157
+Note that subtest names need to be single words (`[a-zA-Z0-9_]`).
158
+
159
+
160
+### tools.sh ###
161
+
162
+This file contains various tools and utilities to help with testing.
163
+
164
+Curently there is only one function, `tf_testflt` designed to help write
165
+tests for simple unix filters.
166
+
167
+
168
+#### tf_testflt ####
169
+
170
+The idea is that tester specifies
171
+
172
+ *  test name,
173
+ *  command to launch the system under test,
174
+ *  a data stream to use as STDIN,
175
+ *  and expected STDOUT, STDERR, and exit status.
176
+
177
+and tf_testflt launches the command, collects tha data and evaluates
178
+and reports the result using unified diff.
179
+
180
+In its simplest form:
181
+
182
+    tf_testflt -n foo my_command arg
183
+
184
+the function will run `my_command arg` (not piping anything to it),
185
+and will expect it to finish with exit status 0 and empty both STDERR
186
+and STDOUT.
187
+
188
+Example of full form,
189
+
190
+    tf_testflt -n foo -i foo.in -O foo.stdout -E foo.stderr -S 2 myprog
191
+
192
+will pipe foo.in into `myprog`, expecting exit status of 2, and STDOUT and
193
+STDERR as above.  Notice that parameters specifying expected values are
194
+uppercase, and those specifying input values are lowercase.
195
+
196
+Specifying name is mandatory, because it's used in reporting messages,
197
+and as a basis for naming temporary result files: these are saved in
198
+*results* subdirectory and kept for further reference.
199
+
200
+
201
+### common.sh ###
202
+
203
+This includes simple functions and variables shared between both mentioned
204
+libraries.
205
+
206
+First group is designed to help support the exit status semantic:
207
+
208
+ *  The functions are `tf_exit_pass`, `tf_exit_fail`, `tf_exit_bailout`,
209
+    `tf_exit_error` and `tf_exit_panic` and each take any number of
210
+    parameters that are printed on stderr.
211
+
212
+ *  The variables are `TF_ES_OK`, `TF_ES_FAIL`, `TF_ES_BAILOUT`,
213
+    `TF_ES_ERROR` and `TF_ES_PANIC` and are supposed to be used with
214
+    `return` builtin, e.g. to return from `tf_exit_error`.
215
+
216
+Second group is useful to better control output:  functions `tf_warn`,
217
+`tf_debug` and `tf_think` are used to print stuff on STDERR.  Use of
218
+`tf_warn` is apparent, just as `tf_debug`, the latter being muted if
219
+`TF_DEBUG` is set to `false` (set it to `true` to turn on debugging).
220
+
221
+`tf_think` is used for progress info, and is muted unless `TF_VERBOSE`
222
+is set to `true`, which is by default.
223
+
224
+
225
+### Setup and cleanup ###
226
+
227
+Special files *TF_SETUP* and *TF_CLEANUP* (one of them or both) can be
228
+added along with *TF_RUN*.  These will be sourced before (*TF_SETUP*)
229
+and after every subtest (*TF_CLEANUP*).
230
+
231
+First, if any of these files are missing, it is considered as if the
232
+respective phase succeeded.  Second, if setup phase fails, test will
233
+be skipped and subtest exit status will be *TF_ES_BAILOUT*.   Last,
234
+if cleanup fails (no matter result of setup), subtests aborts with
235
+*TF_ES_PANIC* returned.  Be aware that in this case the actual test
236
+status, albeit useful, is lost.
237
+
238
+When coming from other test frameworks, this may feel harsh, but note
239
+that this has been designed with the idea that if a cleanup fails,
240
+it may render all further tests are automatically unsafe, because the
241
+environment is not as expected.
242
+
243
+To cope with this behavior, try to bear in mind following advice:
244
+
245
+ 1. Make sure you write setup/cleanup procedures with extreme care and
246
+    test them well.
247
+
248
+ 2. Do not do complicated and risky things in the setup/cleanup phases.
249
+
250
+ 3. If you need to do such things, consider doing them in the *TF_RUN*
251
+    instead of doing them for all subtests.
252
+
253
+ 4. You don't need to clean up everything, the contents of the testing dir
254
+    will be moved out from the test system.
255
+
256
+ 5. If there are scenarios you can safely fix or ignore, handle them in
257
+    a robust manner.
258
+
259
+
260
+Notes
261
+-----
262
+
263
+
264
+### bailout vs. `tf_enum_subtests` ###
265
+
266
+One more note to claify relation of bailout and `tf_enum_subtests`.
267
+As you may have noticed, there are two ways how to skip a test:
268
+return prematurely with `TF_ES_BAILOUT`, or suppress enumeration in
269
+`tf_enum_subtests`.  The problem is that the latter does not do anything
270
+to inform upper in the stack that a test has been skipped, which seems to
271
+break the principle described in previous sections.
272
+
273
+Don't confuse these mechanisms, though. Each is supposed to be used
274
+for distinct purpose.  Compare: by using the `tf_enum_subtests` you are
275
+saying that you actually **did not even want** to run the test in the
276
+first place.  By using `TF_ES_BAILOUT`, you are saying that you **wanted**
277
+to run the test but could not.
278
+
279
+A few common cases if that helps you:
280
+
281
+ *  If during the test you find out that for some reason it can't be
282
+    carried out (e.g. an external resource is not available, or
283
+    something outside the SUT is broken), use `TF_ES_BAILOUT`.
284
+
285
+        tf_enum_subtests() {
286
+            echo test1
287
+            echo test2
288
+            echo test3
289
+        }
290
+
291
+        tf_do_subtest() {
292
+            case $1 in
293
+                test1) do_stuff  ;;
294
+                test2) do_other_stuff ;;
295
+                test3) curl -s http://www.example.com/ >file \
296
+                        || return $TF_ES_BAILOUT
297
+                       do_stuff_with file ;;
298
+            esac
299
+        }
300
+
301
+ *  If you want to filter out some sub-tests for some platforms, e.g. a
302
+    test for only 64-bit architectures, or a test only for Mac OS (IOW,
303
+    you can safely say that running this sub-test would be totally
304
+    pointless on this box), use `tf_enum_subtests`--just omit this test
305
+    from enumeration.
306
+
307
+        tf_enum_subtests() {
308
+            echo test1
309
+            echo test2
310
+            if this_is_macos_x; then
311
+                echo test3
312
+            fi
313
+        }
314
+
315
+ *  If you want to disable (comment out test) that you might not have
316
+    implemented yet or is broken (and for some reason you still want
317
+    it to haunt the test code) or something else outside SUT is broken
318
+    and prevents you from running the test, use `tf_enum_subtests` and
319
+    properly comment the reasons in code.
320
+
321
+        tf_enum_subtests() {
322
+            echo test1
323
+            echo test2
324
+        #   echo test3      #FIXME: implement after bz1234
325
+        }
326
+
327
+ *  If in doubt, use `TF_ES_BAILOUT`.
328
+
329
+
330
+### On exit statuses: three and above ###
331
+
332
+The difference in *error*, *panic* and higher values is subtle but
333
+important.  Follow me as I try to explain:
334
+
335
+ 1. If script has changed something on the system outside the working
336
+    directory, it is apparently expected to revert that change.
337
+
338
+ 2. Now if an error occurs, but the code responsible for cleaning up is
339
+    safely run, you can say there was *error but we have recovered*.
340
+
341
+ 3. But if the change can't be reverted safely, we know that we have
342
+    broken something and latter code may lead to weird results (including
343
+    masking bugs(!)), it's time to *panic* (in the code, not in real
344
+    life ;))
345
+
346
+ 4. And then there are corner cases like a bug in the script, OOM kill
347
+    or timeout when the status will be different and not really controlled
348
+    by the script.  Such cases will have to be treated the same way as
349
+    the "panic" case, but...
350
+
351
+ 5. the use of *panic* adds hint that the status has been set consciously
352
+    by the script, albeit exiting "in a hurry"--without proper clean up.
353
+
354
+Unfortunately there will be cases like above but with the error code less
355
+than four.   Example is a Bash script syntax error, which returns 2, or
356
+Python exception which returns 1.  Yes, in such cases the information
357
+conveyed by the exit status is wrong and you should do everything to
358
+avoid it.
359
+
360
+Possibilities like "test has passed but then something blew up" exist,
361
+but conveying this information is responsibility of the test output.
362
+
363
+Following table can be used as a cheat-sheet:
364
+
365
+    .---------------------------------------------------------------.
366
+    | e |    state of         |                                     |
367
+    | s |---------------------| script says                         |
368
+    |   | SUT   | environment |                                     |
369
+    |---|-------|-------------|-------------------------------------|
370
+    | 0 | OK    | safe        | test passed, everything worked fine |
371
+    | 1 | buggy | safe        | test failed, everything worked fine |
372
+    | 2 | ???   | safe        | I decided not to run the test       |
373
+    | 3 | ???   | safe        | Something blew up but I managed to  |
374
+    |   |       |             | clean up (I promise!)               |
375
+    | 4 | ???   | broken      | Something blew up and I rushed out  |
376
+    |   |       |             | in panic                            |
377
+    | * | ???   | broken      | ...nothing (is dead)                |
378
+    '---------------------------------------------------------------'
379
+
380
+As you can see, following this semantic allows us to see both the state
381
+of the system under test (SUT) *and* the environment.
382
+
383
+Following table illustrates how different statuses map to different
384
+scenarios with regard to test result as well as state of the environment:
385
+
386
+    .--------------------------------------------------.
387
+    | environment |  test result   |  test result      |
388
+    |             | pass fail unkn | pass fail unkn    |
389
+    |-------------|----------------|-------------------|
390
+    | clean(ed)   |  0    1    3   |  OK  FAIL ERROR   |
391
+    | untouched   |  ~    ~    2   |  ~    ~   BAILOUT |
392
+    | mess        |  ~    ~    4   |  ~    ~   PANIC   |
393
+    | ?! (trap)   |  ~    ~    5   |  ~    ~   ~       |
394
+    | ?! (sig 9)  |  ~    ~    137 |  ~    ~   ~       |
395
+    | ?! (aliens) |  ~    ~    ?   |  ~    ~   ~       |
396
+    '-------------|----------------|-------------------|
397
+                  |  exit status   |  human-readable   |
398
+                  |                |  name (TF_ES_*)   |
399
+                  '------------------------------------'

+ 26
- 0
utils/tfkit/doc/templates/grep_engine/TF_RUN View File

@@ -0,0 +1,26 @@
1
+#!/bin/bash
2
+
3
+. "$TF_DIR/include/subtest.sh"
4
+. "$TF_DIR/include/tools.sh"
5
+
6
+tf_enum_subtests() {
7
+    echo fixed
8
+    echo basic
9
+    echo extended
10
+#   echo perl       # TODO: write test
11
+}
12
+
13
+tf_name2cmd() {
14
+    local name=$1
15
+    local t_in="test/ALL.stdin"
16
+    local o_out="oracle/$name.stdout"
17
+    local args
18
+    case $name in
19
+        fixed)       args="-F 'The mask *.* matches all.'" ;;
20
+        basic)       args="-G 'he.*'" ;;
21
+        extended)    args="-P '.*og?g'" ;;
22
+    esac
23
+    echo "tf_testflt -n $name -i $t_in -O $o_out grep $args"
24
+}
25
+
26
+tf_do_subtests

+ 3
- 0
utils/tfkit/doc/templates/grep_engine/oracle/basic.stdout View File

@@ -0,0 +1,3 @@
1
+Linda and Nina work together.
2
+The mask *.* matches all.
3
+The mask *.docx matches Word documents.

+ 3
- 0
utils/tfkit/doc/templates/grep_engine/oracle/extended.stdout View File

@@ -0,0 +1,3 @@
1
+Alice uses Google.
2
+Bob wears goggles.
3
+Linda and Nina work together.

+ 1
- 0
utils/tfkit/doc/templates/grep_engine/oracle/fixed.stdout View File

@@ -0,0 +1 @@
1
+The mask *.* matches all.

+ 6
- 0
utils/tfkit/doc/templates/grep_engine/test/ALL.stdin View File

@@ -0,0 +1,6 @@
1
+Alice uses Google.
2
+Bob wears goggles.
3
+Joe and John are friends.
4
+Linda and Nina work together.
5
+The mask *.* matches all.
6
+The mask *.docx matches Word documents.

+ 37
- 0
utils/tfkit/doc/templates/simple/TF_RUN View File

@@ -0,0 +1,37 @@
1
+#!/bin/bash
2
+#shellcheck disable=SC1090
3
+
4
+. "$TF_DIR/include/subtest.sh"
5
+. "$TF_DIR/include/tools.sh"
6
+
7
+tf_enum_subtests() {
8
+    echo one
9
+    echo two
10
+    echo three
11
+}
12
+
13
+my_sut() {
14
+    local word=$1
15
+    declare -A map
16
+    map[one]=1
17
+    map[two]=2
18
+    map[three]=33
19
+    echo "${map[$word]}"
20
+}
21
+
22
+mkoracle() {
23
+    mkdir -p oracle
24
+    case $subtest in
25
+        one)    echo 1 ;;
26
+        two)    echo 2 ;;
27
+        three)  echo 3 ;;
28
+    esac > "oracle/$subtest.stdout"
29
+}
30
+
31
+tf_do_subtest() {
32
+    local subtest=$1
33
+    mkoracle
34
+    tf_testflt -n "$subtest" -O "oracle/$subtest.stdout" "my_sut $subtest"
35
+}
36
+
37
+tf_do_subtests

+ 142
- 0
utils/tfkit/include/common.sh View File

@@ -0,0 +1,142 @@
1
+#
2
+# Variables to hold exit status semantic
3
+#
4
+TF_ES_OK=0
5
+TF_ES_FAIL=1
6
+TF_ES_BAILOUT=2
7
+TF_ES_ERROR=3
8
+TF_ES_PANIC=4
9
+
10
+#
11
+# Color definition variables
12
+#
13
+TF_COLOR_BLACK="\033[0;30m"
14
+TF_COLOR_RED="\033[0;31m"
15
+TF_COLOR_GREEN="\033[0;32m"
16
+TF_COLOR_YELLOW="\033[0;33m"
17
+TF_COLOR_BLUE="\033[0;34m"
18
+TF_COLOR_MAGENTA="\033[0;35m"
19
+TF_COLOR_CYAN="\033[0;36m"
20
+TF_COLOR_WHITE="\033[0;37m"
21
+TF_COLOR_LBLACK="\033[1;30m"
22
+TF_COLOR_LRED="\033[1;31m"
23
+TF_COLOR_LGREEN="\033[1;32m"
24
+TF_COLOR_LYELLOW="\033[1;33m"
25
+TF_COLOR_LBLUE="\033[1;34m"
26
+TF_COLOR_LMAGENTA="\033[1;35m"
27
+TF_COLOR_LCYAN="\033[1;36m"
28
+TF_COLOR_LWHITE="\033[1;37m"
29
+TF_COLOR_NONE="\033[1;0m"
30
+
31
+
32
+_tf__is_word() {
33
+    #
34
+    # Check if $1 contains only alphanumeric chars or _
35
+    #
36
+    local tainted=$1    # "dirty" version
37
+    local clean         # clean version
38
+    clean=$(tr -c -d '_[:alnum:]' <<< "$tainted")
39
+    test "$tainted" = "$clean"
40
+}
41
+
42
+tf_exit_ok() {
43
+    #
44
+    # Exit with OK status
45
+    #
46
+    exit $TF_ES_OK
47
+}
48
+
49
+tf_exit_fail() {
50
+    #
51
+    # Warn $1 and exit with status FAIL
52
+    #
53
+    tf_warn "$@"
54
+    exit $TF_ES_FAIL
55
+}
56
+
57
+tf_exit_bailout() {
58
+    #
59
+    # Warn $1 and exit with status FAIL
60
+    #
61
+    tf_warn "$@"
62
+    exit $TF_ES_BAILOUT
63
+}
64
+
65
+tf_exit_error() {
66
+    #
67
+    # Warn $1 and exit with status FAIL
68
+    #
69
+    tf_warn "$@"
70
+    exit $TF_ES_ERROR
71
+}
72
+
73
+tf_exit_panic() {
74
+    #
75
+    # Warn $1 and exit with status FAIL
76
+    #
77
+    tf_warn "$@"
78
+    exit $TF_ES_PANIC
79
+}
80
+
81
+tf_debug() {
82
+    #
83
+    # Emit debug message
84
+    #
85
+    $TF_DEBUG || return 0
86
+    local msg
87
+    for msg in "$@";
88
+    do
89
+        $TF_COLOR && echo -ne "$TF_COLOR_CYAN" >&2
90
+        echo "||| $msg" >&2;
91
+        $TF_COLOR && echo -ne "$TF_COLOR_NONE" >&2
92
+    done
93
+}
94
+
95
+tf_debugv() {
96
+    #
97
+    # Emit debug message showing value of each named variable
98
+    #
99
+    local varname
100
+    local declare_str
101
+    for varname in "$@";
102
+    do
103
+        if ! _tf__is_word "$varname";
104
+        then
105
+            tf_warn "tf_debugv: unsafe value skipped: $varname";
106
+            continue
107
+        fi
108
+        if declare_str=$(declare -p "$varname" 2>/dev/null);
109
+        then
110
+            tf_debug "${declare_str#declare ?? }"
111
+        else
112
+            tf_debug "$varname #Unset"
113
+        fi
114
+    done
115
+}
116
+
117
+tf_think() {
118
+    #
119
+    # Emit status/progress message
120
+    #
121
+    $TF_VERBOSE || return 0
122
+    local msg
123
+    for msg in "$@";
124
+    do
125
+        $TF_COLOR && echo -ne "$TF_COLOR_LBLACK" >&2
126
+        echo "$pfx$msg$sfx" >&2;
127
+        $TF_COLOR && echo -ne "$TF_COLOR_NONE" >&2
128
+    done
129
+}
130
+
131
+tf_warn() {
132
+    #
133
+    # Emit warning
134
+    #
135
+    local msg
136
+    for msg in "$@";
137
+    do
138
+        $TF_COLOR && echo -ne "$TF_COLOR_LRED" >&2
139
+        echo "$msg" >&2;
140
+        $TF_COLOR && echo -ne "$TF_COLOR_NONE" >&2
141
+    done
142
+}

+ 125
- 0
utils/tfkit/include/harness.sh View File

@@ -0,0 +1,125 @@
1
+#!/bin/bash
2
+# tfkit - Shellfu's movable test framework
3
+# See LICENSE file for copyright and license details.
4
+
5
+. "$TF_DIR/include/common.sh"
6
+
7
+
8
+__tf_collect_if_needed() {
9
+    #
10
+    # Collect relic if exit status suggests it
11
+    #
12
+    # Use test exit status $1 to help decide if relics are
13
+    # needed, and collect them if so.
14
+    #
15
+    # If TF_COLLECT is set to "always", collect regardless of
16
+    # the status.  If set to "never", do not collect anything.
17
+    # The default setting, "auto" collects unless status is 0
18
+    # or 1 (pass or bailout); in that case do nothing.
19
+    #
20
+    local tes=$1    # test exit status
21
+    local will      # should we collect relics?
22
+    case "$TF_COLLECT:$tes" in
23
+        always:*)   will=true ;;
24
+        never:*)    will=false ;;
25
+        auto:0)     will=false ;;
26
+        auto:2)     will=false ;;
27
+        auto:*)     will=true ;;
28
+        *)          tf_exit_bailout "bad value of TF_COLLECT: $TF_COLLECT" ;;
29
+    esac
30
+    $will || return 0
31
+    mkdir -p "$relic_dir/$stamp"
32
+    cp -r "$tmpdir"/* "$relic_dir/$stamp"
33
+}
34
+
35
+__tf_header() {
36
+    #
37
+    # create header to add to output before test
38
+    #
39
+    local hdrline                       # each line from generator
40
+    local hdrgen="$TF_SUITE/TF_HEADER"  # header generator script
41
+    tf_think "#"
42
+    tf_think "# ---"
43
+    tf_think "# tfkit:"
44
+    if test -x "$hdrgen";
45
+    then
46
+        tf_think "#     sut:"
47
+        $hdrgen \
48
+          | while IFS= read -r hdrline;
49
+            do
50
+                test -n "$hdrline" || break
51
+                tf_think "#         $hdrline"
52
+            done
53
+    else
54
+        tf_think "#     hint: >"
55
+        tf_think "#         Add $hdrgen executable for own header."
56
+        tf_think "#         It should output YAML (\"key: value\" pairs) about"
57
+        tf_think "#         your SUT ('version' at least')."
58
+    fi
59
+    tf_think "#     run:"
60
+    tf_think "#         start_time: $(date -Iseconds)"
61
+    test -n "$TF_FILTER_TEST" \
62
+     && tf_think "#         TF_FILTER_TEST: $TF_FILTER_TEST"
63
+    test -n "$TF_FILTER_SUBTEST" \
64
+     && tf_think "#         TF_FILTER_SUBTEST: $TF_FILTER_SUBTEST"
65
+    tf_think "#"
66
+    tf_think ""
67
+}
68
+
69
+tf_enum_tests() {
70
+    #
71
+    # List what looks like test; relative to $TF_SUITE
72
+    #
73
+    tf_debug "TF_SUITE='$TF_SUITE'"
74
+    test -d "$TF_SUITE" || return 0
75
+    find -L \
76
+        "$TF_SUITE" \
77
+        -mindepth 2 \
78
+        -maxdepth 2 \
79
+        -type f \
80
+        -perm /111 \
81
+        -name TF_RUN \
82
+      | cut -d/ -f2
83
+}
84
+
85
+tf_run_tests() {
86
+    #
87
+    # Discover and run tests
88
+    #
89
+    local es=0          # overall exit status
90
+    local tmpdir=""     # test temporary dir
91
+    local tname=""      # test name
92
+    local tes=0         # test result
93
+    local stamp=""      # test stamp to use as relic name
94
+    local tf_dir        # to keep absolute path for TF_RUN
95
+    local relic_dir     # where to keep relics
96
+    relic_dir="$(readlink -f "$TF_RELICS")"
97
+    __tf_header
98
+    tf_debug "TF_VERSION='$TF_VERSION'"
99
+    tf_dir="$(readlink -f "$TF_DIR")"
100
+    es=0
101
+    for tname in $(tf_enum_tests | grep -e "$TF_FILTER_TEST");
102
+    do
103
+        tf_think "... $tname"
104
+        tmpdir=$(mktemp -d)
105
+        stamp=$(date "+relics-$tname-%Y%m%d-%H%M%S")
106
+        cp -r "$TF_SUITE/$tname/"* "$tmpdir"
107
+        pushd "$tmpdir" >/dev/null
108
+            TF_DEBUG=$TF_DEBUG TF_VERBOSE=$TF_VERBOSE \
109
+            TF_DIR="$tf_dir" TF_TEST="$tname" \
110
+            TF_FILTER_SUBTEST=$TF_FILTER_SUBTEST \
111
+                ./TF_RUN
112
+            tes=$?
113
+            __tf_collect_if_needed $tes
114
+            test $tes -gt $es && es=$tes
115
+        popd >/dev/null
116
+        rm -rf "$tmpdir"
117
+        if test $tes -eq 0;
118
+        then
119
+            tf_think "''' $tname ($tes)"
120
+        else
121
+            tf_warn "??? $tname ($tes)"
122
+        fi
123
+    done
124
+    return $es
125
+}

+ 84
- 0
utils/tfkit/include/subtest.sh View File

@@ -0,0 +1,84 @@
1
+#!/bin/bash
2
+
3
+. "$TF_DIR/include/common.sh"
4
+
5
+tf_enum_subtests() {
6
+    #
7
+    # Stub: enumerate subtests
8
+    #
9
+    tf_warn "implement tf_enum_subtests()!"
10
+    return "$TF_ES_ERROR"
11
+}
12
+
13
+tf_do_subtest() {
14
+    #
15
+    # Stub: perform test named $1
16
+    #
17
+    tf_warn "implement tf_do_subtest()!"
18
+    return "$TF_ES_ERROR"
19
+}
20
+
21
+_tf_do_subtest() {
22
+    #
23
+    # Run single subtest inc. setup/cleanup if present
24
+    #
25
+    local subtname="$1"     # this subtest name
26
+    local ses=0             # subtest exit status
27
+    local setup=true        # setup command
28
+    local cleanup=true      # cleanup command
29
+    if test -f TF_SETUP;
30
+    then
31
+        setup=". TF_SETUP"
32
+        bash -n TF_SETUP || {
33
+            tf_warn "synax errors in TF_SETUP, skipping"
34
+            return "$TF_ES_ERROR"
35
+        }
36
+    fi
37
+    if test -f TF_CLEANUP;
38
+    then
39
+        setup=". TF_CLEANUP"
40
+        bash -n TF_CLEANUP || {
41
+            tf_warn "synax errors in TF_CLEANUP, skipping"
42
+            return "$TF_ES_ERROR"
43
+        }
44
+    fi
45
+    if $setup;
46
+    then
47
+        tf_do_subtest "$subtname"; ses=$?
48
+    else
49
+        tf_warn "setup phase failed, skipping: $subtname"
50
+        ses=$TF_ES_ERROR
51
+    fi
52
+    if ! $cleanup;
53
+    then
54
+        tf_warn "cleanup phase failed: $subtname"
55
+        ses=$TF_ES_PANIC
56
+    fi
57
+    return "$ses"
58
+}
59
+
60
+tf_do_subtests() {
61
+    #
62
+    # Run all subtests and return highest status
63
+    #
64
+    local es=0              # final exit status ("worst" of subtests)
65
+    local subtname=""       # one subtest name
66
+    local tes=""            # one subtest exit status
67
+    local enumd=TF_ENUMERATED_SUBTESTS
68
+    local fltrd=TF_FILTERED_SUBTESTS
69
+    tf_enum_subtests >$enumd    || { tf_warn "error enumerating subtests"; return "$TF_ES_BAILOUT"; }
70
+    test -s $enumd              || { tf_warn "no subtests enumerated";     return "$TF_ES_BAILOUT"; }
71
+    grep -e "$TF_FILTER_SUBTEST" $enumd > $fltrd
72
+    test -s $fltrd  || tf_debug "TF_FILTER_SUBTEST ate everything: $TF_FILTER_SUBTEST"
73
+
74
+    for subtname in $(<$fltrd);
75
+    do
76
+        tf_think "::: $TF_TEST::$subtname"
77
+        TF_SUBTEST=$subtname _tf_do_subtest "$subtname";
78
+        tes=$?
79
+        test $tes -gt $es              && es=$tes
80
+        test $tes -gt "$TF_ES_OK"      && tf_warn "!!! $TF_TEST::$subtname ($tes)"
81
+        test $tes -gt "$TF_ES_BAILOUT" && break
82
+    done
83
+    return $es
84
+}

+ 86
- 0
utils/tfkit/include/tools.sh View File

@@ -0,0 +1,86 @@
1
+#!/bin/bash
2
+
3
+. "$TF_DIR/include/common.sh"
4
+
5
+# 1. exec: [test] -> [result]
6
+# 2. eval:           [result] == [oracle]
7
+
8
+tf_testflt() {
9
+    #
10
+    # Run a simple test for a unix filter
11
+    #
12
+    #     tf_testflt -n foo [-i foo.stdin] \
13
+    #                [-O foo.stdout] [-E foo.stderr] [-S 3] \
14
+    #                cmd arg...
15
+    #
16
+    # Will drop *result/NAME.stdout* and *result/NAME.stderr* (intentionally
17
+    # not cleaning up).
18
+    #
19
+
20
+    # defaults
21
+    #
22
+    local t_in="/dev/null"      # test: stdin
23
+    local t_name=""             # test: name
24
+                                # command is "$@" after arg parsing
25
+    local t_es="0"              # final test exit status
26
+    local o_out="/dev/null"     # oracle: stdout
27
+    local o_err="/dev/null"     # oracle: stderr
28
+    local o_es="0"              # oralce: exit status
29
+    local r_out r_err r_es      # result: ^ ^ ^ those 3
30
+
31
+    local diff=diff
32
+    type colordiff >/dev/null 2>/dev/null && diff=colordiff
33
+
34
+    # get args
35
+    #
36
+    local orig_args="$0 $*"
37
+    tf_debug "orig_args=$orig_args"
38
+    local arg_err=false
39
+    while true; do case "$1" in
40
+        -i) t_in="$2";          shift 2 || { arg_err=true; break; } ;;
41
+        -n) t_name="$2";        shift 2 || { arg_err=true; break; } ;;
42
+        -O) o_out="$2";         shift 2 || { arg_err=true; break; } ;;
43
+        -E) o_err="$2";         shift 2 || { arg_err=true; break; } ;;
44
+        -S) o_es="$2";          shift 2 || { arg_err=true; break; } ;;
45
+        --)                     shift; break ;;
46
+        "")                            break ;;
47
+        -*) tf_warn "wrong testcli arg: $1"; return $TF_ES_BAILOUT ;;
48
+        *)                             break ;;
49
+    esac done
50
+    $arg_err && { tf_warn "error parsing arguments: $orig_args"; return $TF_ES_BAILOUT; }
51
+    tf_debug "t_in='$t_in'"
52
+    tf_debug "t_name='$t_name'"
53
+    tf_debug "o_out='$o_out'"
54
+    tf_debug "o_err='$o_err'"
55
+    tf_debug "o_es='$o_es'"
56
+    tf_debug "test command: $*"
57
+    test "$t_in" = "-" && t_in=/dev/stdin   # works better for check below
58
+    test -z "$t_name"  && { tf_warn "missing test name"             ; return $TF_ES_BAILOUT; }
59
+    test -z "$1"       && { tf_warn "missing test command"          ; return $TF_ES_BAILOUT; }
60
+    test -r "$t_in"    || { tf_warn "missing input file: $t_in"     ; return $TF_ES_BAILOUT; }
61
+    test -e "$o_out"   || { tf_warn "missing oracle stdout: $o_out" ; return $TF_ES_BAILOUT; }
62
+    test -e "$o_err"   || { tf_warn "missing oracle stderr: $o_err" ; return $TF_ES_BAILOUT; }
63
+    test "$o_es" -ge 0 || { tf_warn "invalid oracle status: $o_es"  ; return $TF_ES_BAILOUT; }
64
+
65
+    # prepare
66
+    #
67
+    mkdir -p result
68
+    r_out="result/$t_name.stdout"
69
+    r_err="result/$t_name.stderr"
70
+    tf_debug "r_out='$r_out'"
71
+    tf_debug "r_err='$r_err'"
72
+    touch "$r_out" || { tf_warn "cannot create tmp file: $r_out" ; return $TF_ES_BAILOUT; }
73
+    touch "$r_err" || { tf_warn "cannot create tmp file: $r_err" ; return $TF_ES_PANIC; }
74
+
75
+    # run
76
+    #
77
+    ( <"$t_in" eval "$@" >"$r_out" 2>"$r_err" ); r_es=$?
78
+    tf_debug "r_es='$r_es'"
79
+
80
+    # eval/report/exit
81
+    #
82
+    test $r_es = $o_es || { tf_warn "bad exit status: $r_es (need $o_es)" ; t_es=$TF_ES_FAIL; }
83
+    $diff -u "$o_err" "$r_err" || t_es=$TF_ES_FAIL
84
+    $diff -u "$o_out" "$r_out" || t_es=$TF_ES_FAIL
85
+    return $t_es
86
+}

+ 92
- 0
utils/tfkit/runtests View File

@@ -0,0 +1,92 @@
1
+#!/bin/bash
2
+# tfkit - Shellfu's movable test framework
3
+# See LICENSE file for copyright and license details.
4
+
5
+TF_VERSION="0.0.16"
6
+
7
+die() {
8
+    echo "$@" && exit 9
9
+}
10
+
11
+usage() {
12
+    echo "usage: $(basename "$0") [-c|-C] [-t tests_re] [-s subtest_re] [-p binpath] [-v] [-d]" >&2
13
+    exit 2
14
+}
15
+
16
+version() {
17
+    echo "TFKit (A trivial test kit) $TF_VERSION"
18
+    exit 0
19
+}
20
+
21
+#
22
+# Relic directory path
23
+#
24
+TF_RELICS="${TF_RELICS:-relics}"
25
+
26
+#
27
+# Relic collection mode
28
+#
29
+# 'always' to always collect, 'never` to never collect and 'auto'
30
+# to collect only on failed tests.
31
+#
32
+TF_COLLECT="${TF_COLLECT:-auto}"
33
+
34
+#
35
+# Enable color?
36
+#
37
+TF_COLOR=${TF_COLOR:-true}
38
+
39
+#
40
+# Turn on debug mode?
41
+#
42
+TF_DEBUG="${TF_DEBUG:-false}"
43
+
44
+#
45
+# Location of own directory
46
+#
47
+TF_DIR=${TF_DIR:-$(dirname "$0")}
48
+
49
+#
50
+# Regex (BRE) to filter subtests based on name
51
+#
52
+TF_FILTER_SUBTEST=${TF_FILTER_SUBTEST:-}
53
+
54
+#
55
+# Regex (BRE) to filter tests based on name
56
+#
57
+TF_FILTER_TEST=${TF_FILTER_TEST:-}
58
+
59
+#
60
+# Location of test suite
61
+#
62
+TF_SUITE="${TF_SUITE:-tests}"
63
+
64
+#
65
+# Turn on verbosity?
66
+#
67
+TF_VERBOSE=${TF_VERBOSE:-true}
68
+
69
+
70
+. "$TF_DIR/include/harness.sh" \
71
+ || die "cannot import harness; is TF_DIR set properly?: $TF_DIR"
72
+
73
+main() {
74
+    while true; do case "$1" in
75
+        -c|--collect)           TF_COLLECT=always;          shift ;;
76
+        -C|--no-collect)        TF_COLLECT=never;           shift ;;
77
+        -d|--debug)             TF_DEBUG=true;              shift ;;
78
+        -p|--prefix)            export PATH="$(readlink -f "$2")/bin:$PATH"
79
+                                                            shift 2 || usage ;;
80
+        -s|--filter-subtest)    TF_FILTER_SUBTEST="$2";     shift 2 || usage ;;
81
+        -t|--filter-test)       TF_FILTER_TEST="$2";        shift 2 || usage ;;
82
+        -v|--verbose)           TF_VERBOSE=true;            shift ;;
83
+        --version-semver)       echo "$TF_VERSION"; exit 0 ;;
84
+        --version)              version ;;
85
+        "") break ;;
86
+        *)  usage ;;
87
+    esac done
88
+    export LC_ALL=C
89
+    time tf_run_tests
90
+}
91
+
92
+main "$@"

+ 18
- 0
utils/tfkit/tfkit.mk View File

@@ -0,0 +1,18 @@
1
+# tfkit - Shellfu's movable test framework
2
+# See LICENSE file for copyright and license details.
3
+#
4
+# To use, set TF_DIR (make macro) in your Makefile and
5
+# include this file.
6
+#
7
+# Adds `test` target.
8
+#
9
+# Note that running "runtests" directly should have the same
10
+# effect but you will need to set TF_DIR and/or TF_SUITE properly
11
+# unless they are default (see README)
12
+
13
+export TF_DIR
14
+
15
+test:
16
+	@$(TF_DIR)/runtests
17
+
18
+.PHONY: test