Home | History | Annotate | Line # | Download | only in dist
NEWS revision 1.1.1.2
      1  1.1.1.2  jmmv    Major changes in ATF releases
      2      1.1  jmmv 
      3  1.1.1.2  jmmv    By Julio Merino, The NetBSD Foundation
      4      1.1  jmmv 
      5  1.1.1.2  jmmv                                     Contents
      6      1.1  jmmv 
      7  1.1.1.2  jmmv     1. Changes in version 0.7
      8      1.1  jmmv 
      9  1.1.1.2  jmmv     2. Changes in version 0.6
     10      1.1  jmmv 
     11  1.1.1.2  jmmv     3. Changes in version 0.5
     12      1.1  jmmv 
     13  1.1.1.2  jmmv     4. Changes in version 0.4
     14      1.1  jmmv 
     15  1.1.1.2  jmmv     5. Changes in version 0.3
     16      1.1  jmmv 
     17  1.1.1.2  jmmv     6. Changes in version 0.2
     18      1.1  jmmv 
     19  1.1.1.2  jmmv     7. Changes in version 0.1
     20      1.1  jmmv 
     21  1.1.1.2  jmmv                              Changes in version 0.7
     22      1.1  jmmv 
     23  1.1.1.2  jmmv    Experimental version released on December 22nd, 2009.
     24      1.1  jmmv 
     25  1.1.1.2  jmmv      * Added build-time checks to atf-c and atf-c++. A binding for atf-sh
     26  1.1.1.2  jmmv        will come later.
     27      1.1  jmmv 
     28  1.1.1.2  jmmv      * Migrated all build-time checks for header files to proper ATF tests.
     29  1.1.1.2  jmmv        This demonstrates the use of the new feature described above.
     30      1.1  jmmv 
     31  1.1.1.2  jmmv      * Added an internal API for child process management.
     32      1.1  jmmv 
     33  1.1.1.2  jmmv      * Converted all plain-text distribution documents to a Docbook canonical
     34  1.1.1.2  jmmv        version, and include pre-generated plain text and HTML copies in the
     35  1.1.1.2  jmmv        distribution file.
     36      1.1  jmmv 
     37  1.1.1.2  jmmv      * Simplified the contents of the Makefile.am by regenerating it from a
     38  1.1.1.2  jmmv        canonical Makefile.am.m4 source. As a side-effect, some dependency
     39  1.1.1.2  jmmv        specifications were fixed.
     40      1.1  jmmv 
     41  1.1.1.2  jmmv      * Migrated all checks from the check target to installcheck, as these
     42  1.1.1.2  jmmv        require ATF to be installed.
     43      1.1  jmmv 
     44  1.1.1.2  jmmv      * Fixed sign comparison mismatches triggered by the now-enabled
     45  1.1.1.2  jmmv        -Wsign-compare.
     46      1.1  jmmv 
     47  1.1.1.2  jmmv      * Fixed many memory and object leaks.
     48      1.1  jmmv 
     49  1.1.1.2  jmmv                              Changes in version 0.6
     50      1.1  jmmv 
     51  1.1.1.2  jmmv    Experimental version released on January 18th, 2009.
     52      1.1  jmmv 
     53  1.1.1.2  jmmv      * Make atf-exec be able to kill its child process after a certain period
     54  1.1.1.2  jmmv        of time; this is controlled through the new -t option.
     55      1.1  jmmv 
     56  1.1.1.2  jmmv      * Change atf-sh to use atf-exec's -t option to control the test case's
     57  1.1.1.2  jmmv        timeouts, instead of doing it internally. Same behavior as before, but
     58  1.1.1.2  jmmv        noticeably faster.
     59      1.1  jmmv 
     60  1.1.1.2  jmmv      * atf-exec's -g option and atf-killpg are gone due to the previous
     61  1.1.1.2  jmmv        change.
     62      1.1  jmmv 
     63  1.1.1.2  jmmv      * Added the atf-check(1) tool, a program that executes a given command
     64  1.1.1.2  jmmv        and checks its exit code against a known value and allows the
     65  1.1.1.2  jmmv        management of stdout and stderr in multiple ways. This replaces the
     66  1.1.1.2  jmmv        previous atf_check function in the atf-sh library and exposes this
     67  1.1.1.2  jmmv        functionality to both atf-c and atf-c++.
     68      1.1  jmmv 
     69  1.1.1.2  jmmv      * Added the ATF_REQUIRE family of macros to the C interface. These help
     70  1.1.1.2  jmmv        in checking for fatal test conditions. The old ATF_CHECK macros now
     71  1.1.1.2  jmmv        perform non-fatal checks only. I.e. by using ATF_CHECK, the test case
     72  1.1.1.2  jmmv        can now continue its execution and the failures will not be reported
     73  1.1.1.2  jmmv        until the end of the whole run.
     74      1.1  jmmv 
     75  1.1.1.2  jmmv      * Extended the amount of ATF_CHECK_* C macros with new ones to provide
     76  1.1.1.2  jmmv        more features to the developer. These also have their corresponding
     77  1.1.1.2  jmmv        counterparts in the ATF_REQUIRE_* family. The new macros (listing the
     78  1.1.1.2  jmmv        suffixes only) are: _EQ (replaces _EQUAL), _EQ_MSG, _STREQ and
     79  1.1.1.2  jmmv        _STREQ_MSG.
     80      1.1  jmmv 
     81  1.1.1.2  jmmv                              Changes in version 0.5
     82      1.1  jmmv 
     83  1.1.1.2  jmmv    Experimental version released on May 1st, 2008.
     84      1.1  jmmv 
     85  1.1.1.2  jmmv      * Clauses 3 and 4 of the BSD license used by the project were dropped.
     86  1.1.1.2  jmmv        All the code is now under a 2-clause BSD license compatible with the
     87  1.1.1.2  jmmv        GNU General Public License (GPL).
     88      1.1  jmmv 
     89  1.1.1.2  jmmv      * Added a C-only binding so that binary test programs do not need to be
     90  1.1.1.2  jmmv        tied to C++ at all. This binding is now known as the atf-c library.
     91      1.1  jmmv 
     92  1.1.1.2  jmmv      * Renamed the C++ binding to atf-c++ for consistency with the new atf-c.
     93      1.1  jmmv 
     94  1.1.1.2  jmmv      * Renamed the POSIX shell binding to atf-sh for consistency with the new
     95  1.1.1.2  jmmv        atf-c and atf-c++.
     96      1.1  jmmv 
     97  1.1.1.2  jmmv      * Added a -w flag to test programs through which it is possible to
     98  1.1.1.2  jmmv        specify the work directory to be used. This was possible in prior
     99  1.1.1.2  jmmv        releases by defining the workdir configuration variable (-v
    100  1.1.1.2  jmmv        workdir=...), but was a conceptually incorrect mechanism.
    101      1.1  jmmv 
    102  1.1.1.2  jmmv      * Test programs now preserve the execution order of test cases when they
    103  1.1.1.2  jmmv        are given in the command line. Even those mentioned more than once are
    104  1.1.1.2  jmmv        executed multiple times to comply with the user's requests.
    105      1.1  jmmv 
    106  1.1.1.2  jmmv                              Changes in version 0.4
    107      1.1  jmmv 
    108  1.1.1.2  jmmv    Experimental version released on February 4th, 2008.
    109      1.1  jmmv 
    110  1.1.1.2  jmmv      * Added two new manual pages, atf-c++-api and atf-sh-api, describing the
    111  1.1.1.2  jmmv        C++ and POSIX shell interfaces used to write test programs.
    112      1.1  jmmv 
    113  1.1.1.2  jmmv      * Added a pkg-config file, useful to get the flags to build against the
    114  1.1.1.2  jmmv        C++ library or to easily detect the presence of ATF.
    115      1.1  jmmv 
    116  1.1.1.2  jmmv      * Added a way for test cases to require a specific architecture and/or
    117  1.1.1.2  jmmv        machine type through the new 'require.arch' and 'require.machine'
    118  1.1.1.2  jmmv        meta-data properties, respectively.
    119      1.1  jmmv 
    120  1.1.1.2  jmmv      * Added the 'timeout' property to test cases, useful to set an
    121  1.1.1.2  jmmv        upper-bound limit for the test's run time and thus prevent global test
    122  1.1.1.2  jmmv        program stalls due to the test case's misbehavior.
    123      1.1  jmmv 
    124  1.1.1.2  jmmv      * Added the atf-exec(1) internal utility, used to execute a command
    125  1.1.1.2  jmmv        after changing the process group it belongs to.
    126      1.1  jmmv 
    127  1.1.1.2  jmmv      * Added the atf-killpg(1) internal utility, used to kill process groups.
    128      1.1  jmmv 
    129  1.1.1.2  jmmv      * Multiple portability fixes. Of special interest, full support for
    130  1.1.1.2  jmmv        SunOS (Solaris Express Developer Edition 2007/09) using the Sun Studio
    131  1.1.1.2  jmmv        12 C++ compiler.
    132      1.1  jmmv 
    133  1.1.1.2  jmmv      * Fixed a serious bug that prevented atf-run(1) from working at all
    134  1.1.1.2  jmmv        under Fedora 8 x86_64. Due to the nature of the bug, other platforms
    135  1.1.1.2  jmmv        were likely affected too.
    136      1.1  jmmv 
    137  1.1.1.2  jmmv                              Changes in version 0.3
    138      1.1  jmmv 
    139  1.1.1.2  jmmv    Experimental version released on November 11th, 2007.
    140      1.1  jmmv 
    141  1.1.1.2  jmmv      * Added XML output support to atf-report. This is accompanied by a DTD
    142  1.1.1.2  jmmv        for the format's structure and sample XSLT/CSS files to post-process
    143  1.1.1.2  jmmv        this output and convert it to a plain HTML report.
    144      1.1  jmmv 
    145  1.1.1.2  jmmv      * Changed atf-run to add system information to the report it generates.
    146  1.1.1.2  jmmv        This is currently used by atf-report's XML output only, and is later
    147  1.1.1.2  jmmv        printed in the HTML reports in a nice and useful summary table. The
    148  1.1.1.2  jmmv        user and system administrator are allowed to tune this feature by
    149  1.1.1.2  jmmv        means of hooks.
    150      1.1  jmmv 
    151  1.1.1.2  jmmv      * Removed the test cases' 'isolated' property. This was intended to
    152  1.1.1.2  jmmv        avoid touching the file system at all when running the related test
    153  1.1.1.2  jmmv        case, but this has not been true for a long while: some control files
    154  1.1.1.2  jmmv        are unconditionally required for several purposes, and we cannot
    155  1.1.1.2  jmmv        easily get rid of them. This way we remove several critical and
    156  1.1.1.2  jmmv        delicate pieces of code.
    157      1.1  jmmv 
    158  1.1.1.2  jmmv      * Improved atf-report's CSV output format to include information about
    159  1.1.1.2  jmmv        test programs too.
    160      1.1  jmmv 
    161  1.1.1.2  jmmv      * Fixed the tests that used atf-compile to not require this tool as a
    162  1.1.1.2  jmmv        helper. Avoids systems without build-time utilities to skip many tests
    163  1.1.1.2  jmmv        that could otherwise be run. (E.g. NetBSD without the comp.tgz set
    164  1.1.1.2  jmmv        installed.)
    165      1.1  jmmv 
    166  1.1.1.2  jmmv      * Many general cleanups: Fixed many pieces of code marked as ugly and/or
    167  1.1.1.2  jmmv        incomplete.
    168      1.1  jmmv 
    169  1.1.1.2  jmmv                              Changes in version 0.2
    170      1.1  jmmv 
    171  1.1.1.2  jmmv    Experimental version released on September 20th, 2007.
    172      1.1  jmmv 
    173  1.1.1.2  jmmv      * Test cases now get a known umask on entry.
    174      1.1  jmmv 
    175  1.1.1.2  jmmv      * atf-run now detects many unexpected failures caused by test programs
    176  1.1.1.2  jmmv        and reports them as bogus tests. atf-report is able to handle these
    177  1.1.1.2  jmmv        new errors and nicely reports them to the user.
    178      1.1  jmmv 
    179  1.1.1.2  jmmv      * All the data formats read and written by the tools have been
    180  1.1.1.2  jmmv        documented and cleaned up. These include those grammars that define
    181  1.1.1.2  jmmv        how the different components communicate with each other as well as
    182  1.1.1.2  jmmv        the format of files written by the developers and users: the Atffiles
    183  1.1.1.2  jmmv        and the configuration files.
    184      1.1  jmmv 
    185  1.1.1.2  jmmv      * Added the atf-version tool, a utility that displays information about
    186  1.1.1.2  jmmv        the currently installed version of ATF.
    187  1.1.1.2  jmmv 
    188  1.1.1.2  jmmv      * Test cases can now define an optional cleanup routine to undo their
    189  1.1.1.2  jmmv        actions regardless of their exit status.
    190  1.1.1.2  jmmv 
    191  1.1.1.2  jmmv      * atf-report now summarizes the list of failed (bogus) test programs
    192  1.1.1.2  jmmv        when using the ticker output format.
    193  1.1.1.2  jmmv 
    194  1.1.1.2  jmmv      * Test programs now capture some termination signals and clean up any
    195  1.1.1.2  jmmv        temporary files before exiting the program.
    196  1.1.1.2  jmmv 
    197  1.1.1.2  jmmv      * Multiple bug fixes and improvements all around.
    198  1.1.1.2  jmmv 
    199  1.1.1.2  jmmv                              Changes in version 0.1
    200  1.1.1.2  jmmv 
    201  1.1.1.2  jmmv    Experimental version released on August 20th, 2007.
    202  1.1.1.2  jmmv 
    203  1.1.1.2  jmmv      * First public version. This was released coinciding with the end of the
    204  1.1.1.2  jmmv        Google Summer of Code 2007 program.
    205