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