OVERVIEW |  PACKAGE | CONSTR |  FIELDS |  METHODS FRAMES    NO FRAMES INHERITED

org.specs.runner.Xml

trait Xml

trait Xml

 extends FileSystem with ConsoleLog with Console

The XmlRunner trait is used to create an xml file, in a specified output directory with the results of a specification execution. If the output directory is not specified 
object runner extends XmlRunner(mySpec)
then the current directory will be used Usage: class mySpecRunner extends Runner(mySpec) with Xml The output directory can be overriden if necessary:
 class mySpecRunner extends Runner(mySpec) with Xml { override def outputDir = "./results/specs" }


Source: Xml.scala(40)

Direct Known Subclasses

XmlRunner,

 Fields

Debug val Debug Int Log
Error val Error Int Log
Info val Info Int Log
Warning val Warning Int Log
args var args
optional arguments to the main method if called from the code directly
Array[String] Console
fileName def fileName
the default name of the file is the specification name
String
filePath def filePath
the default path is the output dir + specification name + [details]
xml
String
level var level Int Log
outputDir def outputDir
[details]
return
- the output directory path
 String
outputDirPath protected var outputDirPath
private variable storing the output directory path
String
spec def spec
[details]
return
- the first and only spec to execute from the SpecsHolder trait
 Specification
specs abstract val specs Seq[Specification] SpecsHolder
timer val timer
this timer uses java Calendar to compute hours, minutes, seconds and milliseconds
SimpleTimer ConsoleReporter

 Methods

!= final def !=(arg0 : Object) Boolean AnyRef
!= final def !=(arg0 : Any) Boolean Any
== final def ==(arg0 : Any) Boolean Any
== final def ==(arg0 : Object) Boolean AnyRef
asInstanceOf final def asInstanceOf[T0] T0 Any
asList implicit def asList[T](v : Vector[T])
[details]
return
- the vector elements as a List
 List[T] JavaConversions
asXml def asXml(error : Throwable)
[details]
return
- s an error translated as to xml
 Elem
asXml def asXml(sut : Sut)
[details]
return
- s the sut results translated as to xml
 Elem
asXml def asXml(skipped : SkippedException)
[details]
return
- s a skipped example translated as to xml
 Elem
asXml def asXml(e : Example)
[details]
return
- s the example results translated as to xml (including sub-examples)
 Elem
asXml def asXml(s : Specification)
[details]
return
- s the specification results translated as to xml (including subspecifications)
 Elem
asXml def asXml(failure : FailureException)
[details]
return
- s a failure translated as to xml
 Elem
canRead def canRead(path : String)
[details]
return
- true if the file can be read
 Boolean FileSystem
canWrite def canWrite(path : String)
[details]
return
- true if the file can be written
 Boolean FileSystem
clone protected def clone Object AnyRef
createDir def createDir(path : String)
creates a directory for a given path
Boolean FileSystem
createFile def createFile(path : String)
creates a file for a given path [details]
Create the parent directory if necessary
Boolean FileSystem
debug def debug(msg : String)
prints the message if the log level is Debug
Unit Log
enumerationToList implicit def enumerationToList[T](e : Enumeration[T])
[details]
return
- the enumeration elements as a List
 List[T] JavaConversions
eq final def eq(arg0 : Object) Boolean AnyRef
equals def equals(arg0 : Any) Boolean AnyRef
error def error(msg : String)
prints the message if the log level is <= Error
Unit Log
exists def exists(path : String)
[details]
return
- true if the file exists
 Boolean FileSystem
filePaths def filePaths(path : String)
[details]
param
path - glob expression, for example: ./dir*.xml
return
- the list of paths represented by the "glob" definition path
 List[String] FileSystem
finalize protected def finalize Unit AnyRef
flush def flush
flushes the content if necessary
Unit ConsoleOutput
getAbsolutePath def getAbsolutePath(path : String)
[details]
return
- the file absolute path
 String FileSystem
getCanonicalPath def getCanonicalPath(path : String)
[details]
return
- the file canonical path
 String FileSystem
getClass final def getClass Class[Object] AnyRef
getName def getName(path : String)
[details]
return
- the file name
 String FileSystem
getParent def getParent(path : String)
[details]
return
- the file parent path
 String FileSystem
getWriter def getWriter(path : String)
The getWriter function can be overriden to provide a mock writer writing to the console for example [details]
return
- a Writer object opened on the file designated by path
 Writer FileWriter
globToPattern def globToPattern(glob : String)
[details]
return
- the regular expression equivalent to a glob pattern (see the specs for examples)
 String FileSystem
hashCode def hashCode Int AnyRef
info def info(msg : String)
prints the message if the log level is <= Info
Unit Log
isAbsolute def isAbsolute(path : String)
[details]
return
- true if the file is absolute
 Boolean FileSystem
isDir def isDir(path : String)
[details]
return
- true if the File represented by this path is a directory
 Boolean FileSystem
isDirectory def isDirectory(path : String)
[details]
return
- true if the file is a directory
 Boolean FileSystem
isFile def isFile(path : String)
[details]
return
- true if the file is a file
 Boolean FileSystem
isHidden def isHidden(path : String)
[details]
return
- true if the file is hidden
 Boolean FileSystem
isInstanceOf final def isInstanceOf[T0] Boolean Any
javaArrayToList implicit def javaArrayToList[T](array : Array[T])
[details]
return
- the array elements as a List
 List[T] JavaConversions
listFiles def listFiles(path : String)
[details]
return
- the files of that directory
 List[String] FileSystem
main def main(arguments : Array[String]) Unit Console
ne final def ne(arg0 : Object) Boolean AnyRef
normalize def normalize(dir : String)
[details]
return
- s a path with Unix like path separators and a final / separator
 String
notify final def notify Unit AnyRef
notifyAll final def notifyAll Unit AnyRef
outputDir_= def outputDir_=(path : String)
set the output directory path
Unit
printStackTrace def printStackTrace(t : Throwable)
prints stacktraces
Unit Output
printStats def printStats(sut : Sut, padding : String)
prints the statistics for a sut
Unit OutputReporter
printStats def printStats(stat : (Int, Int, Int, Int, Int), padding : String)
prints the statistics for a specification
Unit OutputReporter
printSut def printSut(sut : Sut, padding : String)
prints one sut specification
Unit OutputReporter
printf def printf(format : String, args : Any*)
prints several objects according to a format string (see Console [details]
printf)
Unit ConsoleOutput
println def println(m : Any)
prints an object with a newline
Unit ConsoleOutput
readFile def readFile(path : String)
reads the content of a file [details]
param
path - the path of the file to read
return
- the content of the file at path
 String FileReader
removeDir def removeDir(path : String)
deletes the directory and all directory contents at the specified path and return the parent path of that directory
String FileSystem
report def report(specs : Iterable[Specification], padding : String)
reports a list of specifications with a given space separator to display before the results [details]

This method may be called recursively by the reportSpec method if a specification has subSpecifications, hence the padding will be incremented
Unit OutputReporter
report def report(specs : Iterable[Specification])
reports a list of specifications
Unit OutputReporter
reportExample def reportExample(example : Example, padding : String)
reports one example: + if it succeeds, x if it fails, its description, its failures or errors
Unit OutputReporter
reportExamples def reportExamples(examples : Iterable[Example], padding : String)
reports a list of examples and indent subexamples if there are some
Unit OutputReporter
reportSpec def reportSpec(spec : Specification, padding : String)
reports a specification with a given space separator to display before the results [details]

This method may be called recursively by the reportSpec method if a specification has subSpecifications, hence the padding will be incremented
Unit OutputReporter
reportSpec def reportSpec(spec : Specification)
reports a specification with no padding
Unit OutputReporter
reportSpec def reportSpec
creates the file and write the xml result of the specification execution
Unit
reportSpecs override def reportSpecs Unit
reportSut def reportSut(sut : Sut, padding : String)
reports one sut results: print the sut specifications, then the statistics
Unit OutputReporter
reportSuts def reportSuts(suts : Iterable[Sut], padding : String)
reports the sut results [details]
If there are more than one, then report stats for each else just print the specification of the sut, the parent specification will display the total for that sut
Unit OutputReporter
setNoStacktrace def setNoStacktrace Unit OutputReporter
stats def stats(example : Example)
[details]
return
- the number of examples, assertions, failures and errors for an example by collecting those numbers on this example and on sub-examples
(Int, Int, Int, Int, Int) OutputReporter
stats def stats(spec : Specification)
[details]
return
- the number of examples, assertions, failures and errors for a specification by collecting those numbers on sub-specifications and suts
(Int, Int, Int, Int, Int) OutputReporter
stats def stats(sut : Sut)
[details]
return
- the number of examples, assertions, failures and errors for a sut by collecting those numbers on examples
(Int, Int, Int, Int, Int) OutputReporter
synchronized final def synchronized[T0](arg0 : T0) T0 AnyRef
toAddableTuple implicit def toAddableTuple(t1 : (Int, Int, Int, Int, Int))
utility implicit definition to be able to add tuples
AddableTuple OutputReporter
toString def toString String AnyRef
wait final def wait(arg0 : Long, arg1 : Int) Unit AnyRef
wait final def wait(arg0 : Long) Unit AnyRef
wait final def wait Unit AnyRef
warning def warning(msg : String)
prints the message if the log level is <= Warning
Unit Log
write def write(path : String)(function : (Writer) => Unit)
writes some content to a file and take care of closing the file [details]

Usage: 

   write("./dir/hello.txt") { out =>
     out.write("content")
   }
param
path - path of the file to read
 Unit FileWriter
OVERVIEW |  PACKAGE | CONSTR |  FIELDS |  METHODS FRAMES    NO FRAMES INHERITED
Copyright (c) 2007-2008. All Rights Reserved.