aesubunit(1) aesubunit(1) NNAAMMEE aesubunit - run SubUnit tests SSYYNNOOPPSSIISS aaeessuubbuunniitt [ _o_p_t_i_o_n... ] _f_i_l_e_n_a_m_e... aaeessuubbuunniitt --HHeellpp aaeessuubbuunniitt --VVEERRSSiioonn DDEESSCCRRIIPPTTIIOONN The aaeessuubbuunniitt command is used to invoke tests via the http://- www.robertcollins.net/unittest/subunit unit testing interface. The shape of the external unittest should not need to be known _a _p_r_i_- _o_r_i. After the test has run, tests should still exist as discrete objects, so that anything taking a reference to them doesn't get 50 copies of the same object. The _a_e_s_u_b_u_n_i_t command may be used to replace the _t_e_s_t___c_o_m_m_a_n_d or _b_a_t_c_h___t_e_s_t___c_o_m_m_a_n_d fields of the project configuration file. CCoonnttrrooll PPrroottooccooll The results of the test are obtained by examining the standard output of the tests as they run. The text is meant to be human readable, so that tests may run stand-alone. Tests should ideally print a header of the form test testing test: _t_e_s_t _l_a_b_e_l testing: _t_e_s_t _l_a_b_e_l A successful test will produce lines of the form success success: successful _t_e_s_t _l_a_b_e_l successful: _t_e_s_t _l_a_b_e_l A test failure will produce text of the form failure _t_e_s_t _l_a_b_e_l failure: _t_e_s_t _l_a_b_e_l failure _t_e_s_t _l_a_b_e_l [ ] failure: _t_e_s_t _l_a_b_e_l [ ] The square brackets indicate text which may describe the test in more detail. It will be printed on the standartd output by the _a_e_s_u_b_u_n_i_t program. A test which produces no result (neither succes nor failure) uses the following forms error: _t_e_s_t _l_a_b_e_l error: _t_e_s_t _l_a_b_e_l [ ] In general, unexpected output from the test will be sent through to the _a_e_s_u_b_u_n_i_t standard output. If a subunit test terminates with an exit status other than zero, this is taken to be a no result indication for that test. OOPPTTIIOONNSS The following options are understood: --BBaattcchh This option may be useed to specify that a batch test should be performed, and produce results in the appropriate form. --CChhaannggee _n_u_m_b_e_r This option may be used to specify a particular change within a project. See _a_e_g_i_s(1) for a complete description of this option. --PPrroojjeecctt _n_a_m_e This option may be used to select the project of interest. When no --PPrroojjeecctt option is specified, the _A_E_G_I_S___P_R_O_J_E_C_T envi- ronment variable is consulted. If that does not exist, the user's _$_H_O_M_E_/_._a_e_g_i_s_r_c file is examined for a default project field (see _a_e_u_c_o_n_f(5) for more information). If that does not exist, when the user is only working on changes within a sin- gle project, the project name defaults to that project. Oth- erwise, it is an error. --HHeellpp This option may be used to obtain more information about how to use the _a_e_s_u_b_u_n_i_t program. See also _a_e_g_i_s(1) for options common to all aegis commands. All options may be abbreviated; the abbreviation is documented as the upper case letters, all lower case letters and underscores (_) are optional. You must use consecutive sequences of optional letters. All options are case insensitive, you may type them in upper case or lower case or a combination of both, case is not important. For example: the arguments "-project", "-PROJ" and "-p" are all inter- preted to mean the --PPrroojjeecctt option. The argument "-prj" will not be understood, because consecutive optional characters were not supplied. Options and other command line arguments may be mixed arbitrarily on the command line, after the function selectors. The GNU long option names are understood. Since all option names for _a_e_s_u_b_u_n_i_t are long, this means ignoring the extra leading '-'. The "----_o_p_t_i_o_n==_v_a_l_u_e" convention is also understood. EEXXIITT SSTTAATTUUSS The _a_e_s_u_b_u_n_i_t command will exit with a status of 1 on any error. The _a_e_s_u_b_u_n_i_t command will only exit with a status of 0 if there are no errors. EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS See _a_e_g_i_s(1) for a list of environment variables which may affect this command. See _a_e_p_c_o_n_f(5) for the project configuration file's _p_r_o_j_e_c_t___s_p_e_c_i_f_i_c field for how to set environment variables for all commands executed by Aegis. CCOOPPYYRRIIGGHHTT aesubunit version 4.25.D611 Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 Peter Miller The aesubunit program comes with ABSOLUTELY NO WARRANTY; for details use the '_a_e_s_u_b_u_n_i_t _-_V_E_R_S_i_o_n _L_i_c_e_n_s_e' command. This is free software and you are welcome to redistribute it under certain conditions; for details use the '_a_e_s_u_b_u_n_i_t _-_V_E_R_S_i_o_n _L_i_c_e_n_s_e' command. AAUUTTHHOORR Peter Miller E-Mail: pmiller@opensource.org.au /\/\* WWW: http://miller.emu.id.au/pmiller/ Reference Manual Aegis aesubunit(1)