TODO

   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
  63 Check source code:
  64 ============
  65
  66 [0.13.0] * Eliminate abbreviations like nf for number_failed
  67 [0.9.13] * Run indent on everything, make sure it works well.
  68 [0.13.0] * Fix START_TEST/END_TEST to look like valid C code.
  69 [     ] * Document things way more.
  70 [     ] * Create check.h automatically using makeheaders.c (not sure)
  71 [     ] * Eliminate check_ prefix from files in src/ ... not needed
  72
  73 Internal Check tests
  74 ======================
  75
  76 [0.9.3] * Use gcov to test and expand coverage of existing unit tests
  77 [     ] * Increase tests for more non-public modules
  78 [0.8.0] * Refactor to allow better unit testing of printing functionality.
  79 [     ] * Document things way more.
  80 [     ] * Clarify what all the different tests mean, whether they are
  81           meant to fail or not --- setting all CK_SILENT to CK_VERBOSE
  82           makes it seem like there are lots of errors being produced!
  83 [     ] * Fix timeout tests.  Currently, on some processors, a test that
  84           asserts no timeout within 2 seconds fails unless the default
  85           timeout is set to 4 or more seconds.  A higher resolution
  86           might help, and there could also be issues with multiple
  87           processes on SMP machines.
  88
  89 Packaging
  90 =========
  91
  92 [0.7.2] * Automate RPM production
  93 [0.7.2] * Debian packaging
  94 [0.9.2] * Get Check into Debian Sid
  95 [0.9.4] * Eliminate .deb and .rpm packaging for vendors --- not necessary
  96
  97 Website
  98 =======
  99 [     ] * Fix: NEWS tab causes download (Github #1)
 100
 101
 102
 103 The following enhancements are being considered for Check.  Please
 104 send an email to <check-devel at lists dot sourceforge dot net> if you
 105 would like to assist in any of these, or if you would like to suggest
 106 additional enhancements.  Also please check the various trackers at
 107 the Check project website.
 108
 109 Printing and Logging
 110 ====================
 111
 112 [     ] * Allow unit test output (stdout and stderr) to be captured and logged
 113 [0.9.1] * Add XML as option for test output
 114 [     ] * Open the API for printing/logging customization
 115 [     ] * JUnit-style UI?
 116
 117 Unit test writing
 118 =================
 119
 120 [0.8.0] * Allow fail and friends to be used within fixture
 121           setup/teardown functions
 122 [0.8.0] * Allow forkless running of suites, to allow debugging
 123 [0.9.2] * Allow unit tests that expect signals
 124 [     ] * Allow unit tests to write to the log
 125 [     ] * Allow unit tests that expect output (see stdout logging above) (but
 126           maybe perl/sh/expect/dejagnu are better tools)
 127 [     ] * Autoproduce unit testing framework from header files
 128 [     ] * Count the number of START_TEST macros and check that each function
 129           is added to some suite; issue a warning message otherwise.  Maybe the
 130           best way to do this is to put each function onto a list or
 131           table as its defined, and then remove it once its added
 132           somewhere.  Then, when finished, print out what remains on the list /
 133           in the table.  This might require some ugly macro hackery...
 134 [     ] * Better macro for START_TEST.  It would be nice to pass in
 135           three separate arguments, something like:
 136             1) a numeric ID for the tests function
 137             2) the exact name of the function being tested
 138             3) the name of the feature in (2) being tested for
 139 [     ] * Find a way to create setup/teardown macros such that global
 140           variables aren't necessary, and they're really just blocks
 141           that get added at the beginning and ending of tests.
 142 [     ] * Some mechanism to profile execution times, and assert that the time
 143           a test takes to complete scales according to some big-O notation.
 144 [     ] * Fork entire test cases, and then fork individual tests from
 145           within each test case, so that unchecked fixtures can in
 146           fact do unsafe things without bringing down the entire test
 147           program.
 148
 149 Check Internals
 150 ===============
 151
 152 [0.8.0] * Implement message passing between unit test and test
 153           programs using pipes, rather than SysV IPC, to allow support
 154           under cygwin.
 155 [     ] * Abstract the forking and message passing implementation to
 156           allow Win32 compatibility.
 157 [0.9.12] * Incorporate existing Win32 support as mentioned here:
 158           http://opendarwin.org/pipermail/cvs-libfoundation-all/2005-March/000177.html
 159 [0.9.11] * Get Cygwin to work, with forking
 160 [0.9.11] * Get MinGW to work, even without forking
 161 [0.9.12] * Get MSVC to work, even without forking