Create or fix up metadata comments in a test file

testCreateFileTemplate

Description

Write a test file containing properly formatted metadata comments required by the Spotfire testing system. If the file already exists then this function will check its metadata comments and complain or fix up inappropriate ones.

Usage

testCreateFileTemplate(file, package, data)

Arguments

file	The name of the file to create or fix up.
package	The name of the package being tested. This is not required if the file already exists and contains a non-empty "## Package:" line.
data	For experimental use. A named list of the sort output by testParseTestFile(). It may contain fields with names like "FunctionalArea" that will be written to the output file as "## FunctionalArea: ".

Details

The metadata fields in a test file should all be at the beginning of the file and should all start with "## ", followed by the tag name and a colon.

Value

Currently this always returns NULL. This may change.

Note

If this function is used to fix up the comments in a test file then the old test file will be replaced by the new one. Use a source control system or make a backup if this is a problem.

Author

Bill Dunlap, TIBCO Software Inc.

See Also

testParseTestFile reads a test file, testFixTags interprets its output and fixes up the tags, and testWriteTestFile writes the output of either of the two previous functions to a file. This function simply runs those three.

Examples

  ## Not run: 
     testCreateFileTemplate(file="myTest.t", package="myPackage")
     # edit that file, adding tests and metadata, then run
     # testCreateFileTemplate(file="myTest.t") again to check
     # the metadata.
  
## End(Not run)

Package assertionTest version 6.1.1-7
Package Index