Merge playlist branch against trunk to date.

[disorder] / libtests / test.c

/*
 * This file is part of DisOrder.
 * Copyright (C) 2005, 2007, 2008 Richard Kettlewell
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
/** @file libtests/test.c @brief Library tests */

#include "test.h"
#include "version.h"
#include <getopt.h>

/** @brief Count of tests */
long long tests;

/** @brief Count of errors */
long long errors;

/** @brief If set, first error will fail whole test */
int fail_first;

/** @brief Verbose mode */
int verbose;

/** @brief If set, test will return 'skipped' indicator */
int skipped;

/** @brief Count up an error
 *
 * If @ref fail_first is set then the test run is aborted.
 */
void count_error(void) {
  ++errors;
  if(fail_first)
    abort();
}

/** @brief Render a string into printable ASCII
 * @param s String to format
 * @return Allocated copy of formatted string
 *
 * Replaces any non-ASCII characters with a hex escape.
 */
const char *format(const char *s) {
  struct dynstr d;
  int c;
  char buf[10];

  dynstr_init(&d);
  while((c = (unsigned char)*s++)) {
    if(c >= ' ' && c <= '~')
      dynstr_append(&d, c);
    else {
      sprintf(buf, "\\x%02X", (unsigned)c);
      dynstr_append_string(&d, buf);
    }
  }
  dynstr_terminate(&d);
  return d.vec;
}

/** @brief Format a UTF-32 string into hex
 * @param s String to format
 * @return Allocated copy of formatted string
 *
 * Returns the hex codes of @p s separated by spaces.
 */
const char *format_utf32(const uint32_t *s) {
  struct dynstr d;
  uint32_t c;
  char buf[64];

  dynstr_init(&d);
  while((c = *s++)) {
    sprintf(buf, " %04lX", (long)c);
    dynstr_append_string(&d, buf);
  }
  dynstr_terminate(&d);
  return d.vec;
}

/** @brief Convert a string of hex codes to a UTF-32 string
 * @param s String of hex codes, separated by spaces
 * @return Allocated string, 0-terminated
 */
uint32_t *ucs4parse(const char *s) {
  struct dynstr_ucs4 d;
  char *e;

  dynstr_ucs4_init(&d);
  while(*s) {
    errno = 0;
    dynstr_ucs4_append(&d, strtoul(s, &e, 0));
    if(errno) fatal(errno, "strtoul (%s)", s);
    s = e;
  }
  dynstr_ucs4_terminate(&d);
  return d.vec;
}

/** @brief Format a string like asprintf()
 * @param fmt Format string, per printf(3)
 * @param ... Arguments
 * @return Formatted string or null pointer on error
 */
const char *do_printf(const char *fmt, ...) {
  va_list ap;
  char *s;
  int rc;

  va_start(ap, fmt);
  rc = byte_vasprintf(&s, fmt, ap);
  va_end(ap);
  if(rc < 0)
    return 0;
  return s;
}

/** @brief Jump buffer for exitfn() testing */
jmp_buf fatal_env;

/** @brief exitfn() callback for testing
 * @param rc Value to return from setjmp()
 * Jumps to @ref fatal_env
 */
void test_exitfn(int rc) {
  assert(rc != 0);
  longjmp(fatal_env, rc);
}

static const struct option options[] = {
  { "verbose", no_argument, 0, 'v' },
  { "fail-first", no_argument, 0, 'F' },
  { "help", no_argument, 0, 'h' },
  { "version", no_argument, 0, 'V' },
};

/* display usage message and terminate */
static void help(void) {
  xprintf("Usage:\n"
	  "  %s [OPTIONS]\n"
	  "Options:\n"
	  "  --help, -h               Display usage message\n"
	  "  --version, -V            Display version number\n"
          "  --verbose, -v            Verbose output\n"
          "  --fail-first, -F         Stop on first failure\n",
          progname);
  xfclose(stdout);
  exit(0);
}

/** @brief Standard test program initialization
 * @param argc Argument count
 * @param argv Arguments
 */
void test_init(int argc, char **argv) {
  int n;

  set_progname(argv);
  mem_init();
  while((n = getopt_long(argc, argv, "vFhV", options, 0)) >= 0) {
    switch(n) {
    case 'v': verbose = 1; break;
    case 'F': fail_first = 1; break;
    case 'h': help();
    case 'V': version(progname);
    default: exit(1);
    }
  }
  if(getenv("FAIL_FIRST"))
    fail_first = 1;
}


/*
Local Variables:
c-basic-offset:2
comment-column:40
fill-column:79
indent-tabs-mode:nil
End:
*/