Overview  Index  Help 

ASSERT

All Known Implementing Modules:

AssertSMLUnit.Assert


signature ASSERT =
sig
  type 'a assertEqual = 'a -> 'a -> 'a
  type 'a valueFormatter = 'a -> string
  datatype failure =
           GeneralFailure of string | NotEqualFailure of string * string
  exception Fail of failure
  val assertEqual : ('a * 'a -> bool) -> 'a valueFormatter -> 'a assertEqual
  val fail : string -> 'a
  val failByNotEqual : string * string -> 'a
  val assertEqualUnit : unit assertEqual
  val assertEqualInt : int assertEqual
  val assertEqualWord : word assertEqual
  val assertEqualWord8 : Word8.word assertEqual
  val assertEqualWord32 : Word32.word assertEqual
  val assertEqualReal : real assertEqual
  val assertEqualChar : char assertEqual
  val assertEqualString : string assertEqual
  val assertEqualSubstring : substring assertEqual
  val assertEqualExceptionName : exn assertEqual
  val assertEqualRef : 'a assertEqual -> 'a ref assertEqual
  val assertSameRef : 'a ref assertEqual
  val assertEqualBool : bool assertEqual
  val assertTrue : bool -> bool
  val assertFalse : bool -> bool
  val assertEqualOption : 'a assertEqual -> 'a option assertEqual
  val assertEqualIntOption : int option assertEqual
  val assertEqualWordOption : word option assertEqual
  val assertEqualWord8Option : Word8.word option assertEqual
  val assertEqualWord32Option : Word32.word option assertEqual
  val assertEqualRealOption : real option assertEqual
  val assertEqualCharOption : char option assertEqual
  val assertEqualStringOption : string option assertEqual
  val assertEqualSubstringOption : substring option assertEqual
  val assertSome : 'a option -> 'a option
  val assertNone : 'a option -> 'a option
  val assertEqualOrder : order assertEqual
  val assertEqual2Tuple
      : 'a assertEqual * 'b assertEqual -> ('a * 'b) assertEqual
  val assertEqual3Tuple
      : 'a assertEqual * 'b assertEqual * 'c assertEqual ->
          ('a * 'b * 'c) assertEqual
  val assertEqualContainer
      : ('a -> int) * ('a * int -> 'b) * 'b assertEqual -> 'a assertEqual
  val assertEqualVector : 'a assertEqual -> 'a vector assertEqual
  val assertEqualWord8Vector : Word8Vector.vector assertEqual
  val assertEqualCharVector : CharVector.vector assertEqual
  val assertEqualArray : 'a assertEqual -> 'a array assertEqual
  val assertEqualWord8Array : Word8Array.array assertEqual
  val assertEqualCharArray : CharArray.array assertEqual
  val assertEqualList : 'a assertEqual -> 'a list assertEqual
  val assertEqualIntList : int list assertEqual
  val assertEqualWordList : word list assertEqual
  val assertEqualWord8List : Word8.word list assertEqual
  val assertEqualWord32List : Word32.word list assertEqual
  val assertEqualRealList : real list assertEqual
  val assertEqualCharList : char list assertEqual
  val assertEqualStringList : string list assertEqual
  val assertEqualSubstringList : substring list assertEqual
end

A set of assert functions.

Author:
YAMATODANI Kiyoshi
Version:
$Id: SigASSERT.html,v 1.3 2004/10/20 02:12:44 kiyoshiy Exp $

 
Type detail

assertEqual

type 'a assertEqual = 'a -> 'a -> 'a

function which asserts the equality of two values.

Functions of this type require two values: expected and actual. They return the actual if the expected and the actual are equal to each other, and raise Fail otherwise.


valueFormatter

type 'a valueFormatter = 'a -> string

function which translates a value of the type into human readable text representation.

 
Datatype detail

failure

datatype failure = GeneralFailure of string | NotEqualFailure of string * string

detail of failures of assertions.

 
DataConstructor detail

GeneralFailure

constructor GeneralFailure message : string -> failure

Parameters:
message
description of the failure

NotEqualFailure

constructor NotEqualFailure (expected, actual) : string * string -> failure

indicates that the expected value and acutal value are not equal to each other.

Parameters:
expected
a string repesentation of expected value
actual
a string representation of actual value

 
Value detail

assertEqual

fun assertEqual comparator formatter
    : ('a * 'a -> bool) -> 'a valueFormatter -> 'a assertEqual

general assertion function.

Parameters:
comparator
a function which compares two value and returns true if they are equal to each other.
formatter
a function which make a string representation of a value of the type
Returns:
a function which asserts two values of the type are equal to each other.

fail

fun fail message : string -> 'a

always fail with the specified message

Parameters:
error
message

failByNotEqual

fun failByNotEqual (expected, actual) : string * string -> 'a

fail because exepcted value and acutal value are not equal.

Parameters:
expected
a string representation of expected value
actual
a string representation of actual value

assertEqualUnit

val assertEqualUnit : unit assertEqual

Asserts that two units are equal. This assertion succeeds always.


assertEqualInt

val assertEqualInt : int assertEqual

Asserts that two integers are equal.


assertEqualWord

val assertEqualWord : word assertEqual

Asserts that two words are equal.


assertEqualWord8

val assertEqualWord8 : Word8.word assertEqual

Asserts that two words are equal.


assertEqualWord32

val assertEqualWord32 : Word32.word assertEqual

Asserts that two words are equal.


assertEqualReal

val assertEqualReal : real assertEqual

Asserts that two real numbers are equal.


assertEqualChar

val assertEqualChar : char assertEqual

Asserts that two characters are equal.


assertEqualString

val assertEqualString : string assertEqual

Asserts that two strings are equal.


assertEqualSubstring

val assertEqualSubstring : substring assertEqual

Asserts that two substrings are equal.


assertEqualExceptionName

val assertEqualExceptionName : exn assertEqual

Asserts that two exceptions are equal.


assertEqualRef

val assertEqualRef : 'a assertEqual -> 'a ref assertEqual

asserts that the locations which two references point hold the same value.


assertSameRef

val assertSameRef : 'a ref assertEqual

asserts that two references point to the same location


assertEqualBool

val assertEqualBool : bool assertEqual

Asserts that two booleans are equal.


assertTrue

val assertTrue : bool -> bool

Asserts that the value is true.


assertFalse

val assertFalse : bool -> bool

Asserts that the value is fasle.


assertEqualOption

val assertEqualOption : 'a assertEqual -> 'a option assertEqual

Asserts that two option values are equal.


assertEqualIntOption

val assertEqualIntOption : int option assertEqual

Asserts that two options of integer are equal.


assertEqualWordOption

val assertEqualWordOption : word option assertEqual

Asserts that two options of word are equal.


assertEqualWord8Option

val assertEqualWord8Option : Word8.word option assertEqual

Asserts that two options of word are equal.


assertEqualWord32Option

val assertEqualWord32Option : Word32.word option assertEqual

Asserts that two options of word are equal.


assertEqualRealOption

val assertEqualRealOption : real option assertEqual

Asserts that two options of real number are equal.


assertEqualCharOption

val assertEqualCharOption : char option assertEqual

Asserts that two options of character are equal.


assertEqualStringOption

val assertEqualStringOption : string option assertEqual

Asserts that two options of string are equal.


assertEqualSubstringOption

val assertEqualSubstringOption : substring option assertEqual

Asserts that two options of substring are equal.


assertSome

val assertSome : 'a option -> 'a option

Asserts that the option is SOME of any.


assertNone

val assertNone : 'a option -> 'a option

Asserts that the option is NONE.


assertEqualOrder

val assertEqualOrder : order assertEqual

Asserts that two orders are equal.


assertEqual2Tuple

val assertEqual2Tuple : 'a assertEqual * 'b assertEqual -> ('a * 'b) assertEqual

Asserts that two 2-tuples are equal.


assertEqual3Tuple

val assertEqual3Tuple
    : 'a assertEqual * 'b assertEqual * 'c assertEqual ->
        ('a * 'b * 'c) assertEqual

Asserts that two 3-tuples are equal.


assertEqualContainer

val assertEqualContainer
    : ('a -> int) * ('a * int -> 'b) * 'b assertEqual -> 'a assertEqual


assertEqualVector

val assertEqualVector : 'a assertEqual -> 'a vector assertEqual

Asserts that two vectors are equal.


assertEqualWord8Vector

val assertEqualWord8Vector : Word8Vector.vector assertEqual

Asserts that two vectors of words are equal.


assertEqualCharVector

val assertEqualCharVector : CharVector.vector assertEqual

Asserts that two vectors of characters are equal.


assertEqualArray

val assertEqualArray : 'a assertEqual -> 'a array assertEqual

Asserts that two arrays are equal.


assertEqualWord8Array

val assertEqualWord8Array : Word8Array.array assertEqual

Asserts that two arrays of words are equal.


assertEqualCharArray

val assertEqualCharArray : CharArray.array assertEqual

Asserts that two arrays of characters are equal.


assertEqualList

val assertEqualList : 'a assertEqual -> 'a list assertEqual

Asserts that two lists are equal.


assertEqualIntList

val assertEqualIntList : int list assertEqual

Asserts that two lists of integers are equal.


assertEqualWordList

val assertEqualWordList : word list assertEqual

Asserts that two lists of words are equal.


assertEqualWord8List

val assertEqualWord8List : Word8.word list assertEqual

Asserts that two lists of words are equal.


assertEqualWord32List

val assertEqualWord32List : Word32.word list assertEqual

Asserts that two lists of words are equal.


assertEqualRealList

val assertEqualRealList : real list assertEqual

Asserts that two lists of reals are equal.


assertEqualCharList

val assertEqualCharList : char list assertEqual

Asserts that two lists of characters are equal.


assertEqualStringList

val assertEqualStringList : string list assertEqual

Asserts that two lists of strings are equal.


assertEqualSubstringList

val assertEqualSubstringList : substring list assertEqual

Asserts that two lists of substrings are equal.

 
Exception detail

Fail

exception Fail of failure

the exception that is raised when any assertion fails.

Parameters:
failure
detail of the failure


Overview  Index  Help 
SMLUnit: regression test framework for SML