testworks-lib.dylan

Module:       dylan-user
Synopsis:     TestWorks - a test harness library for dylan
Author:       Andrew Armstrong, James Kirsch
Copyright:    Original Code is Copyright (c) 1995-2004 Functional Objects, Inc.
              All rights reserved.
License:      See License.txt in this distribution for details.
Warranty:     Distributed WITHOUT WARRANTY OF ANY KIND

define library testworks
  use command-line-parser;
  use common-dylan;
  use io;
  use system;

  export testworks;
end library testworks;

// TODO(cgay): This is in serious need of refactoring into internal
// (%testworks) and external (testworks) modules.
define module testworks
  use command-line-parser;
  use common-dylan;
  use format-out;
  use standard-io;
  use streams;
  use threads,
    import: { dynamic-bind };

  // Debugging options
  export *debug?*,
         debug-failures?,
         debug?;

  // Formatting
  export *format-function*,
         test-output,
         plural;

  // Announcing suite/test/check names
  export *announce-checks?*,
         *announce-check-function*;

  // Components
  export <component>,
         execute-component?,
         perform-component,
         component-name,
         component-description,
         component-tags,
         status-name;

  // Perform options
  export <perform-options>,
         perform-tags, perform-tags-setter,
         perform-announce-function, perform-announce-function-setter,
         perform-announce-checks?, perform-announce-checks?-setter,
         perform-progress-format-function, perform-progress-format-function-setter,
         perform-progress-function, perform-progress-function-setter,
         perform-debug?, perform-debug?-setter;

  // Checks
  export check,
         check-condition,
         check-no-condition,
         check-equal,
         check-false,
         check-no-errors,
         check-instance?,
         check-true;

  // Benchmarks
  export benchmark;

  // Tests
  export <test>,
         test-definer,
         <test-unit>,
         \with-test-unit,
         test-function,
         perform-test,
         find-test,
         find-test-object;
     
  // Suites
  export <suite>,
         make-suite,   //--- Needed for macro hygiene problems
         suite-definer,
         suite-setup-function, suite-cleanup-function,
         suite-components,
         perform-suite,
         root-suite,
         find-suite;  

  // Result objects
  export <result>,
         result-name,
         result-type-name,
         result-status,
              $passed, $failed, $skipped, $not-implemented, $crashed,
         result-seconds,
         result-microseconds,
         result-time,
         result-bytes,

         <component-result>,
         result-subresults,

         <test-result>,
         <suite-result>,
         <unit-result>,
         result-operation,
         result-value,
         do-results,

         <check-result>,
         <test-unit-result>,
         <benchmark-result>,
         $benchmark-result-divider,
         print-one-benchmark-result,
         print-benchmark-result-header,
         print-benchmark-result-footer;

  // Progress functions
  export *default-progress-function*,
         null-progress-function,
         full-progress-function;

  // Report functions
  export *default-report-function*,
         display-results,
         null-report-function,
         summary-report-function,
         failures-report-function,
         full-report-function,
         log-report-function,
         xml-report-function;

  // Command line handling
  export compute-application-options,
         run-test-application,
         parse-args;

  // Internals for use by testworks-test-suite
  export $test-log-header,
         $test-log-footer,
         $xml-version-header,
         *check-recording-function*,
         failure-reason,
         safe-error-to-string;

  // Internals -- mostly due to macro hygiene failures
  export $test-objects-table,
         *test-unit-options*,
         do-check,
         do-check-condition,
         do-benchmark,
         print-failure-reason;
end module testworks;