| 1 |
TODO |
| 2 |
==== |
| 3 |
|
| 4 |
The following are considered bugs in Check. If you have a fix, please |
| 5 |
post it as a pull request on GitHub at |
| 6 |
https://github.com/libcheck/check/pulls |
| 7 |
Bug fixing is considered more important than feature requests at this |
| 8 |
point. Please check the GitHub issue tracker before submitting. |
| 9 |
|
| 10 |
Documentation |
| 11 |
============= |
| 12 |
|
| 13 |
[0.9.4] * Convert to info format and update. |
| 14 |
[0.9.4] * Remove old SGML documentation. |
| 15 |
[0.9.4] * Fix building of documentation that relies on diff |
| 16 |
[0.9.4] * Add html generation of Texinfo docs. |
| 17 |
[0.9.4] * Create initial and final versions of money example. |
| 18 |
[0.9.4] * Update tutorial so that it works with modern tools. |
| 19 |
[0.9.5] * Clarify looping tests and give example of usage. |
| 20 |
[ ] * Document pkg-config usage, note that old macro usage is not recommended. |
| 21 |
[0.9.9] * Document selective running of tests with CK_RUN_SUITE and CK_RUN_CASE |
| 22 |
environment variables. |
| 23 |
[ ] * Update tutorial to match with the API changes: TTest* instead of TFun. |
| 24 |
|
| 25 |
Interface |
| 26 |
========= |
| 27 |
|
| 28 |
[ ] * Change check not to clobber things in the global namespace. |
| 29 |
Prepend CHECK_ to all constants, check_ to all exported symbols, |
| 30 |
and _check to all internal functions. Currently fail() is |
| 31 |
causing a problem. Deprecate the old API in a nice way. |
| 32 |
|
| 33 |
Build issues: |
| 34 |
============= |
| 35 |
|
| 36 |
[ ] * Add AC_PROG_CC_C99 in configure.ac when autoconf2.60b is |
| 37 |
commonly availabe. Add checks in src/check.h.in for macro |
| 38 |
varargs support. |
| 39 |
[0.9.4] * Convert Check to use Libtool |
| 40 |
[ ] * Figure out if we need stamp-h.in or not |
| 41 |
[ ] * use AC_CONFIG_MACRO_DIR([m4]) and create an m4/ dir for check.m4 |
| 42 |
aclocaldir = $(datadir)/aclocal |
| 43 |
aclocal_DATA = mymacro.m4 myothermacro.m4 |
| 44 |
ACLOCAL_AMFLAGS = -I m4 # put in top-level Makefile.am |
| 45 |
[ ] * Fix overriding CFLAGS in configure.ac |
| 46 |
[ ] * Use AC_DEFINE to define version number stuff? |
| 47 |
[ ] * Change MICRO to ALPHA? probably not |
| 48 |
[ ] * Add std-options to AM_INIT_AUTOMAKE |
| 49 |
[ ] * Investigate subdir-objects option to AM_INIT_AUTOMAKE |
| 50 |
[ ] * Use filename-length-max=99 in AM_INIT_AUTOMAKE |
| 51 |
[0.9.4] * Make sure libcheck.(l)a works as a dependency, don't call $(MAKE) |
| 52 |
[0.9.4] * Build tests/ dirs after everything else |
| 53 |
[0.9.4] * Fix AM_PATH_CHECK by deprecating it; use pkg-config instead |
| 54 |
[0.9.6] * make Check pass its own unit tests: make (dist)check can fail. |
| 55 |
[ ] * Make the docs pass 'make distcheck' |
| 56 |
[ ] * use stricter CFLAGS for compiling Check |
| 57 |
[ ] * use ax_cflags_gcc_option to add to CFLAGS to Check |
| 58 |
[ ] * prune unused checks from configure.ac |
| 59 |
[ ] * Add option BUILD_DOCUMENTATION to CMake (Github #217). |
| 60 |
[ ] * Missing function check in CMake creates def HAVE_FOO=0. |
| 61 |
There should be no HAVE_FOO (Github #195). |
| 62 |
[ ] * CMake and Autotools should check if compiler supports __attribute__ ((format (a, b, c))) |
| 63 |
to decide if CK_ATTRIBUTE_FORMAT can be defined |
| 64 |
https://www.gnu.org/software/autoconf-archive/ax_gcc_func_attribute.html |
| 65 |
|
| 66 |
|
| 67 |
Check source code: |
| 68 |
============ |
| 69 |
|
| 70 |
[0.13.0] * Eliminate abbreviations like nf for number_failed |
| 71 |
[0.9.13] * Run indent on everything, make sure it works well. |
| 72 |
[0.13.0] * Fix START_TEST/END_TEST to look like valid C code. |
| 73 |
[ ] * Document things way more. |
| 74 |
[ ] * Create check.h automatically using makeheaders.c (not sure) |
| 75 |
[ ] * Eliminate check_ prefix from files in src/ ... not needed |
| 76 |
|
| 77 |
Internal Check tests |
| 78 |
====================== |
| 79 |
|
| 80 |
[0.9.3] * Use gcov to test and expand coverage of existing unit tests |
| 81 |
[ ] * Increase tests for more non-public modules |
| 82 |
[0.8.0] * Refactor to allow better unit testing of printing functionality. |
| 83 |
[ ] * Document things way more. |
| 84 |
[ ] * Clarify what all the different tests mean, whether they are |
| 85 |
meant to fail or not --- setting all CK_SILENT to CK_VERBOSE |
| 86 |
makes it seem like there are lots of errors being produced! |
| 87 |
[ ] * Fix timeout tests. Currently, on some processors, a test that |
| 88 |
asserts no timeout within 2 seconds fails unless the default |
| 89 |
timeout is set to 4 or more seconds. A higher resolution |
| 90 |
might help, and there could also be issues with multiple |
| 91 |
processes on SMP machines. |
| 92 |
|
| 93 |
Packaging |
| 94 |
========= |
| 95 |
|
| 96 |
[0.7.2] * Automate RPM production |
| 97 |
[0.7.2] * Debian packaging |
| 98 |
[0.9.2] * Get Check into Debian Sid |
| 99 |
[0.9.4] * Eliminate .deb and .rpm packaging for vendors --- not necessary |
| 100 |
|
| 101 |
Website |
| 102 |
======= |
| 103 |
[ ] * Fix: NEWS tab causes download (Github #1) |
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
The following enhancements are being considered for Check. Please |
| 108 |
send an email to <check-devel at lists dot sourceforge dot net> if you |
| 109 |
would like to assist in any of these, or if you would like to suggest |
| 110 |
additional enhancements. Also please check the various trackers at |
| 111 |
the Check project website. |
| 112 |
|
| 113 |
Printing and Logging |
| 114 |
==================== |
| 115 |
|
| 116 |
[ ] * Allow unit test output (stdout and stderr) to be captured and logged |
| 117 |
[0.9.1] * Add XML as option for test output |
| 118 |
[ ] * Open the API for printing/logging customization |
| 119 |
[ ] * JUnit-style UI? |
| 120 |
|
| 121 |
Unit test writing |
| 122 |
================= |
| 123 |
|
| 124 |
[0.8.0] * Allow fail and friends to be used within fixture |
| 125 |
setup/teardown functions |
| 126 |
[0.8.0] * Allow forkless running of suites, to allow debugging |
| 127 |
[0.9.2] * Allow unit tests that expect signals |
| 128 |
[ ] * Allow unit tests to write to the log |
| 129 |
[ ] * Allow unit tests that expect output (see stdout logging above) (but |
| 130 |
maybe perl/sh/expect/dejagnu are better tools) |
| 131 |
[ ] * Autoproduce unit testing framework from header files |
| 132 |
[ ] * Count the number of START_TEST macros and check that each function |
| 133 |
is added to some suite; issue a warning message otherwise. Maybe the |
| 134 |
best way to do this is to put each function onto a list or |
| 135 |
table as its defined, and then remove it once its added |
| 136 |
somewhere. Then, when finished, print out what remains on the list / |
| 137 |
in the table. This might require some ugly macro hackery... |
| 138 |
[ ] * Better macro for START_TEST. It would be nice to pass in |
| 139 |
three separate arguments, something like: |
| 140 |
1) a numeric ID for the tests function |
| 141 |
2) the exact name of the function being tested |
| 142 |
3) the name of the feature in (2) being tested for |
| 143 |
[ ] * Find a way to create setup/teardown macros such that global |
| 144 |
variables aren't necessary, and they're really just blocks |
| 145 |
that get added at the beginning and ending of tests. |
| 146 |
[ ] * Some mechanism to profile execution times, and assert that the time |
| 147 |
a test takes to complete scales according to some big-O notation. |
| 148 |
[ ] * Fork entire test cases, and then fork individual tests from |
| 149 |
within each test case, so that unchecked fixtures can in |
| 150 |
fact do unsafe things without bringing down the entire test |
| 151 |
program. |
| 152 |
|
| 153 |
Check Internals |
| 154 |
=============== |
| 155 |
|
| 156 |
[0.8.0] * Implement message passing between unit test and test |
| 157 |
programs using pipes, rather than SysV IPC, to allow support |
| 158 |
under cygwin. |
| 159 |
[ ] * Abstract the forking and message passing implementation to |
| 160 |
allow Win32 compatibility. |
| 161 |
[0.9.12] * Incorporate existing Win32 support as mentioned here: |
| 162 |
http://opendarwin.org/pipermail/cvs-libfoundation-all/2005-March/000177.html |
| 163 |
[0.9.11] * Get Cygwin to work, with forking |
| 164 |
[0.9.11] * Get MinGW to work, even without forking |
| 165 |
[0.9.12] * Get MSVC to work, even without forking |