Fit Specification

Here we describe the framework in sufficient precision to be useful to framework implementors. We will use the framework to test itself. This leads to circular logic that can be unraveled more easily by the computer than a beginner learning the framework. Beginners might want to ReadMore of this site before continuing here.

Each of the following sections will become a specification document in its own right. Each bullet with a section is to become the FitAcceptanceTests.

http:run.cgi

Parse

A parser builds an in memory model of an html document. The model preserves all of the content while exposing table data to further processing. This allows input to be prepared with a variety of tools.

• word tables
• excel tables
• wiki tables

• wiki tables within table

• markup tags
• character escapes
• leading and trailing spaces

• cell background color
• cell contents
• additional rows
• additional columns

Check

Expected values specified in cells are tested for equality with actual values extracted from the program under test.

fat.Equals
type	x	y	=
boolean	true	TRUE	true
integer	00001	1	true
real	1000	1e3	true
string	abc	ABC	false

A sequence of values can be entered and checked as a single (composite) value.

fat.Equals
type	x	y	=
integers	1, 3, 5	01,03,05	true
integers	1, 3, 5	01,05,03	false
booleans	true, true, false	true, false	false
strings	a , b , c	a,b,c	true

Domain values can be constructed from cell contents. Equality comparisons will be subject to appropriate domain rules (i.e. delegated to the domain objects.)

fat.Equals
type	x	y	=
date	Jan 1, 1995	January 1, 1995	true
money	$10000	$10,000.00	true

Floating point numbers are checked to the precision that is normal in the host language. It is possible for a domain object to infer precision from the string representation of expected values. For example, ScientificDouble checks equality to the precision implied by the number of significant digits in a value.

• non-zeros -- 123.45 is 5 digits
• zeros between non-zeros -- 100003 is 6 digits
• zeros in the fraction part -- 12.20 is 4 digits
• but not leading zeros -- 0001000 is 4 digits
• and not exponent digits -- 6.02e23 is 3 digits
• left argument (receiver) controles precision

Improperly specified values may throw exceptions which are reported in the cell that contains the invalid number. Improper value detection is only as good as would be expected in the host language. (We are assuming that incorrectly converted values will lead to detected errors elsewhere.)

• xyz is not an integer
• 10000000000000000000000000 may or may not be an integer

fat.Color
white	white
white	white
white	white
white	yellow

Some character strings have special meaning outside of type conversion.

• blank -- omit check, report value (reported in gray letters)
• error -- expect an error

fat.Color
white	white	white
white	white	white
white	white	green
white	white	gray/white
white	white	green
white	white	gray/white

The framework looks for parse support in different places.

• fixture
• domain object
• type adapter

• yea = true
• nay = false

Fixture

The first cell of a table specifies how that table will be interpreted. Normally this is the name of an objet, a Fixture, that is specifically written for this purpose.

• case Foo != foo
• package alpha.Foo != beta.Foo

• doTables -- sequence tables within a document
• doTable -- interpret a table
• doRows -- sequence rows within a table
• doRow -- interpret a row
• doCells -- sequence cells within a row
• doCell -- interpret a row

Cells contain givens or expected results. The fixture is responsible for distinguishing givens from expected results, checking expected results against actuals, and indicating the result with the background annotation as follows.

• white -- no check wanted (blank input)
• green -- right: expected equals actual
• red -- wrong: expected not equal actual
• yellow -- exception: trouble computing actual or comparing result
• gray -- ignore: desired check not possible

• counts accumulate between tables
• counts are summarized as "# right, # wrong, # exceptions, # ignores".
• runner fixtures (e.g. AllFiles) can control accumulation of counts

• state variables
• state lifetime
• state summary

PrimitiveFixture

The primitive fixture does not depend on TypeAdapter. Type specific functions handle all checking.

• checkBoolean
• checkInteger
• checkFloat
• checkString

ColumnFixture

A column fixture distinguishes givens from expected values by the form of the column head.

• name is setter or field
• name() is getter or field
• camel case -- present value ( ) = presentValue()
• deprecate execute()

RowFixture

A row fixture expects all rows to be expected values. The fixture is assumed to have access to actual rows which it pairs with expected rows.

• name is field or getter
• name() is getter
• camel case

• some given, none actual -- missing row
• none given, some actual -- surplus rows
• one given, one actual -- check remaining columns
• many given, many actual -- match on more columns

• each counts as one wrong
• surplus rows added to table in gray

ActionFixture

An action fixture distinguishes given from expected values based on keywords in the first column.

• enter -- put given in setter or field
• check -- check value with getter or field
• press -- call action (no check other than for execptions)
• start -- new actor

• actor persists between tables
• initial actor is action fixture (subclass) itself
• start with no argument specifies initial actor

• create a new actor
• return to an existing actor

• replace the current actor with a new actor
• replace the current actor with another preexisting actor
• restore the previous actor

• camel case

Runner

A runner creates top-level Fixtures and provides them with parsed documents to be annotated.

• top-level fixture is instance of Fixture

• input-file only -- default output
• input-file output-file -- specific output
• input-directory only -- default output in directory
• input-directory output-directory -- default outputs in specific directory
• index.html result summaries
• - is standard in/out

• exit status is sum of wrong and exceptions up to 255
• main is factored to simplify RunnerFixtures

• AssemblyPath ???