Add half-hearted support for Clang, because its `blocks' are deficient.

[finally] / test-guts.c

/* -*-c-*-
 *
 * Main test machinery
 *
 * (c) 2023 Mark Wooding
 */

/*----- Licensing notice --------------------------------------------------*
 *
 * This file is part of the `Finally' package.
 *
 * Finally is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Library General Public License as published
 * by the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Finally 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 Library General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with Finally.  If not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
 * USA.
 */

/*----- Header files ------------------------------------------------------*/

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "finally-test.h"

/*----- Global variables --------------------------------------------------*/

const int secretly_true = 1;

/*----- Static variables --------------------------------------------------*/

static const char *curr;
static unsigned nrun = 0, nskip = 0, nlose = 0;
static unsigned flags = 0;
enum { HUMAN, TAP }; static unsigned outform = HUMAN;
#define f_failthis 1u

static int step;

/*----- Main code ---------------------------------------------------------*/

void init_test(void)
{
  const char *p;

  p = getenv("TEST_OUTFORM");
  if (!p || strcmp(p, "human") == 0) outform = HUMAN;
  else if (strcmp(p, "tap") == 0) outform = TAP;
  else { fprintf(stderr, "unknown output format `%s'\n", p); exit(2); }
}

void begin_test(const char *name)
  { step = 0; flags &= ~f_failthis; curr = name; }

void check_step(int s, const char *where)
{
  FILE *fp;

  if (step != s) {
    switch (outform) {
      case HUMAN: fp = stderr; break;
      case TAP: fp = stdout; fputs("# ", stdout); break;
      default: abort();
    }
    fprintf(fp, "%s (%s): misstep: expected %d but found %d\n",
	    where, curr, step, s);
    flags |= f_failthis;
  }
  step++;
}

void end_test(void)
{
  nrun++; if (flags&f_failthis) nlose++;

  switch (outform) {
    case HUMAN:
      printf("%s: %s\n", curr, flags&f_failthis ? "FAILED" : "ok");
      break;
    case TAP:
      printf("%s %u %s\n", flags&f_failthis ? "not ok" : "ok", nrun, curr);
      break;
    default:
      abort();
  }
}

void skip_test(const char *name, const char *excuse)
{
  nrun++; nskip++;

  switch (outform) {
    case HUMAN: printf("%s: (skipped: %s)\n", name, excuse); break;
    case TAP: printf("ok %u %s # skip (%s)\n", nrun, name, excuse); break;
    default: abort();
  }
}

int test_report(void)
{
#define TESTS(n) ((n) == 1 ? "test" : "tests")

  switch (outform) {
    case HUMAN:
      if (nlose)
	printf("FAILED %u out of %u %s", nlose, nrun, TESTS(nrun));
      else if (nskip)
	printf("passed %u out of %u %s",
	       nrun - nlose - nskip, nrun, TESTS(nrun));
      else
	printf("passed all %u %s", nrun, TESTS(nrun));
      if (nskip) printf(" (skipped %u %s)", nskip, TESTS(nskip));
      putchar('\n');
      return (nlose ? 2 : 0);
    case TAP:
      printf("1..%u\n", nrun);
      return (0);
    default:
      abort();
  }

#undef TESTS
}

/*----- That's all, folks -------------------------------------------------*/