/* * ==================================================================== * Copyright (c) 2000-2004, 2008 CollabNet. All rights reserved. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms * are also available at http://subversion.tigris.org/license-1.html. * If newer versions of this license are posted there, you may use a * newer version instead, at your option. * * This software consists of voluntary contributions made by many * individuals. For exact contribution history, see the revision * history and logs, available at http://subversion.tigris.org/. * ==================================================================== */ #ifndef SVN_TEST_H #define SVN_TEST_H #ifndef SVN_ENABLE_DEPRECATION_WARNINGS_IN_TESTS #undef SVN_DEPRECATED #define SVN_DEPRECATED #endif /* ! SVN_ENABLE_DEPRECATION_WARNINGS_IN_TESTS */ #include <apr_pools.h> #include "svn_delta.h" #include "svn_path.h" #include "svn_types.h" #include "svn_error.h" #include "svn_string.h" #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ /* Baton for any arguments that need to be passed from main() to svn * test functions. */ typedef struct svn_test_opts_t { /* Description of the fs backend that should be used for testing. */ const char *fs_type; /* Config file. */ const char *config_file; /* Minor version to use for servers and FS backends, or zero to use the current latest version. */ int server_minor_version; /* Add future "arguments" here. */ } svn_test_opts_t; /* Prototype for test driver functions. */ typedef svn_error_t* (*svn_test_driver_t)(const char **msg, svn_boolean_t msg_only, svn_test_opts_t *opts, apr_pool_t *pool); /* Test modes. */ enum svn_test_mode_t { svn_test_pass, svn_test_xfail, svn_test_skip }; /* Each test gets a test descriptor, holding the function and other * associated data. */ struct svn_test_descriptor_t { /* A pointer to the test driver function. */ svn_test_driver_t func; /* Is the test marked XFAIL? */ enum svn_test_mode_t mode; }; /* All Subversion test programs include an array of svn_test_descriptor_t's * (all of our sub-tests) that begins and ends with a SVN_TEST_NULL entry. */ extern struct svn_test_descriptor_t test_funcs[]; /* A null initializer for the test descriptor. */ #define SVN_TEST_NULL {NULL, 0} /* Initializer for PASS tests */ #define SVN_TEST_PASS(func) {func, svn_test_pass} /* Initializer for XFAIL tests */ #define SVN_TEST_XFAIL(func) {func, svn_test_xfail} /* Initializer for conditional XFAIL tests */ #define SVN_TEST_XFAIL_COND(func, p)\ {func, (p) ? svn_test_xfail : svn_test_pass} /* Initializer for SKIP tests */ #define SVN_TEST_SKIP(func, p) {func, ((p) ? svn_test_skip : svn_test_pass)} /* Return a pseudo-random number based on SEED, and modify SEED. * * This is a "good" pseudo-random number generator, intended to replace * all those "bad" rand() implementations out there. */ apr_uint32_t svn_test_rand(apr_uint32_t *seed); /* Add PATH to the test cleanup list. */ void svn_test_add_dir_cleanup(const char *path); /* Set *EDITOR and *EDIT_BATON to an editor that prints its * arguments to OUT_STREAM. The edit starts at PATH, that is, * PATH will be prepended to the appropriate paths in the output. * Allocate the editor in POOL. * * EDITOR_NAME is a name for the editor, a string that will be * prepended to the editor output as shown below. EDITOR_NAME may * be the empty string (but it may not be null). * * VERBOSE is a flag for specifying whether or not your want all the * nitty gritty details displayed. When VERBOSE is FALSE, each * editor function will print only a one-line summary. * * INDENTATION is the number of spaces to indent by at each level; use * 0 for no indentation. The indent level is always the same for a * given call (i.e, stack frame). * * SOME EXAMPLES * * With an indentation of 3, editor name of "COMMIT-TEST" and with * VERBOSE = TRUE * * [COMMIT-TEST] open_root (wc) * base_revision: 1 * [COMMIT-TEST] open_directory (wc/A) * parent: wc * base_revision: 1 * [COMMIT-TEST] delete_entry (wc/A/B) * [COMMIT-TEST] open_file (wc/A/mu) * parent: wc/A * base_revision: 1 * [COMMIT-TEST] change_file_prop (wc/A/mu) * name: foo * value: bar * [COMMIT-TEST] close_file (wc/A/mu) * [COMMIT-TEST] close_directory (wc/A) * [COMMIT-TEST] add_file (wc/zeta) * parent: wc * copyfrom_path: * copyfrom_revision: 0 * [COMMIT-TEST] open_file (wc/iota) * parent: wc * base_revision: 1 * [COMMIT-TEST] close_directory (wc) * [COMMIT-TEST] apply_textdelta (wc/iota) * [COMMIT-TEST] window_handler (2 ops) * (1) new text: length 11 * (2) source text: offset 0, length 0 * [COMMIT-TEST] window_handler (EOT) * [COMMIT-TEST] close_file (wc/iota) * [COMMIT-TEST] apply_textdelta (wc/zeta) * [COMMIT-TEST] window_handler (1 ops) * (1) new text: length 11 * [COMMIT-TEST] window_handler (EOT) * [COMMIT-TEST] close_file (wc/zeta) * [COMMIT-TEST] close_edit * * The same example as above, but with verbose = FALSE * * [COMMIT-TEST] open_root (wc) * [COMMIT-TEST] open_directory (wc/A) * [COMMIT-TEST] delete_entry (wc/A/B) * [COMMIT-TEST] open_file (wc/A/mu) * [COMMIT-TEST] change_file_prop (wc/A/mu) * [COMMIT-TEST] close_file (wc/A/mu) * [COMMIT-TEST] close_directory (wc/A) * [COMMIT-TEST] add_file (wc/zeta) * [COMMIT-TEST] open_file (wc/iota) * [COMMIT-TEST] close_directory (wc) * [COMMIT-TEST] apply_textdelta (wc/iota) * [COMMIT-TEST] close_file (wc/iota) * [COMMIT-TEST] apply_textdelta (wc/zeta) * [COMMIT-TEST] close_file (wc/zeta) * [COMMIT-TEST] close_edit * */ svn_error_t *svn_test_get_editor(const svn_delta_editor_t **editor, void **edit_baton, const char *editor_name, svn_stream_t *out_stream, int indentation, svn_boolean_t verbose, const char *path, apr_pool_t *pool); #ifdef __cplusplus } #endif /* __cplusplus */ #endif /* SVN_TEST_H */