org.specs2.runner

FilesRunner

trait FilesRunner extends SpecificationsFinder with SystemExit

This trait finds specifications in the source directory, instantiate them as one big specification and report them using the ConsoleReporter or the HtmlReporter depending on the presence of the html flag

See also

org.specs2.main.Arguments for the regular expression defining the specification names to extract and other options

org.specs2.io.FromSource for the definition of the source directory

Linear Supertypes
SystemExit, SpecificationsFinder, SourceFile, ConsoleOutput, Classes, Output, FileSystem, FileWriter, FileReader, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FilesRunner
  2. SystemExit
  3. SpecificationsFinder
  4. SourceFile
  5. ConsoleOutput
  6. Classes
  7. Output
  8. FileSystem
  9. FileWriter
  10. FileReader
  11. AnyRef
  12. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def afterExecution(specs: Seq[SpecificationStructure])(implicit args: Arguments): Unit

    print a message after the execution based on the number of specifications

    print a message after the execution based on the number of specifications

    Attributes
    protected
  7. def append(path: String)(function: (Writer) ⇒ Unit): Unit

    append some content to a file and take care of closing the file.

    append some content to a file and take care of closing the file.

    Usage:

    write("./dir/hello.txt") { out =>
    out.write("content")
    }
    path

    path of the file to write

    Definition Classes
    FileWriter
  8. def appendToFile(path: String, content: ⇒ String): Unit

    writes some content to a file.

    writes some content to a file.

    path

    path of the file to read

    content

    content of the file to write

    Definition Classes
    FileWriter
  9. def appendToXmlFile(path: String, content: ⇒ NodeSeq): Unit

    writes some xml content to a file.

    writes some xml content to a file.

    path

    path of the file to read

    content

    content of the file to write

    Definition Classes
    FileWriter
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def beforeExecution(implicit args: Arguments): Unit

    print a message before the execution

    print a message before the execution

    Attributes
    protected
  12. def canRead(path: String): Boolean

    returns

    true if the file can be read

    Definition Classes
    FileSystem
  13. def canWrite(path: String): Boolean

    returns

    true if the file can be written

    Definition Classes
    FileSystem
  14. def classNames(packageName: String, content: String, pattern: Pattern, suffix: String, verbose: Boolean = false): Seq[String]

    extract the class names corresponding to a pattern found in a content

    extract the class names corresponding to a pattern found in a content

    packageName

    the base package for the class names

    content

    content of a source file

    pattern

    a regular expression for a class name

    Definition Classes
    SourceFile
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def copy(input: InputStream, output: OutputStream): Unit

    Copy an input stream to an output stream.

    Copy an input stream to an output stream.

    input

    input stream

    output

    output stream

    Definition Classes
    FileSystem
  17. def copyDir(src: String, dest: String): Unit

    copy the content of a directory to another.

    copy the content of a directory to another.

    dest

    destination directory path

    Definition Classes
    FileSystem
  18. def copyFile(path: String, dest: String): Unit

    copy a file to a destination directory

    copy a file to a destination directory

    path

    path of the file to copy

    dest

    destination directory path

    Definition Classes
    FileSystem
  19. def copySpecResourcesDir(base: String, src: String, outputDir: String, loader: ClassLoader): Unit

    Copy specs resources found either in the specs jar or in the classpath directories to an output directory

    Copy specs resources found either in the specs jar or in the classpath directories to an output directory

    base

    path of the base package (must not be empty!)

    src

    name of the resource directory to copy (relative to the base package)

    outputDir

    output directory where to copy the files to

    Definition Classes
    FileSystem
  20. def create[T <: AnyRef](className: String = "", classLoader: ClassLoader = ...)(implicit m: ClassTag[T]): Either[Throwable, T]

    returns

    an instance of a given class, returning either the instance, or an exception

    Definition Classes
    Classes
  21. def createArguments(arguments: Array[String]): Arguments

    returns

    the Arguments object depending on the command-line options

    Attributes
    protected
  22. def createDir(path: String): Boolean

    creates a directory for a given path

    creates a directory for a given path

    Definition Classes
    FileSystem
  23. def createFile(path: String): AnyVal

    creates a file for a given path.

    creates a file for a given path. Create the parent directory if necessary.

    Definition Classes
    FileWriter
  24. def createObject[T <: AnyRef](className: String, printMessage: Boolean, printStackTrace: Boolean)(implicit m: ClassTag[T]): Option[T]

    A system property 'debugCreateObject' can be set to override the printMessage and printStackTrace parameters so that the exception message and stacktrace are printed when the object can't be created

    A system property 'debugCreateObject' can be set to override the printMessage and printStackTrace parameters so that the exception message and stacktrace are printed when the object can't be created

    returns

    an instance of a given class and optionally print message and/or the stacktrace if the class can't be loaded.

    Definition Classes
    Classes
  25. def createObject[T <: AnyRef](className: String, printMessage: Boolean)(implicit m: ClassTag[T]): Option[T]

    returns

    an instance of a given class and optionally print message if the class can't be loaded

    Definition Classes
    Classes
  26. def createObject[T <: AnyRef](className: String)(implicit m: ClassTag[T]): Option[T]

    returns

    an instance of a given class

    Definition Classes
    Classes
  27. def createSpecification(className: String, printMessage: Boolean, printStackTrace: Boolean): Option[SpecificationStructure]

    returns

    a SpecificationStructure object from a className if that class is a SpecificationStructure class.
    Tries to load the class name and cast it to a specification None in case of an exception.

    Definition Classes
    SpecificationsFinder
  28. def createSpecification(className: String, verbose: Boolean = false)(implicit args: Arguments): Option[SpecificationStructure]

    returns

    a SpecificationStructure object from a className if that class is a SpecificationStructure class.
    Tries to load the class name and cast it to a specification None in case of an exception.

    Definition Classes
    SpecificationsFinder
  29. def delete(path: String): Boolean

    delete a file

    delete a file

    Definition Classes
    FileWriter
  30. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  32. def exists(path: String): Boolean

    returns

    true if the file exists

    Definition Classes
    FileWriter
  33. def exitSystem(executed: Seq[ExecutedSpecification]): Unit

    exit the system with a specific code:

    exit the system with a specific code:

    - 0 if all the specifications are successful - 1 if there are only failures - 100 if there is any error - 101 if one of them could not even be executed (this is represented by None)

    Definition Classes
    SystemExit
  34. def exitSystem(executed: Option[ExecutedSpecification]): Unit

    exit the system for one executed specification (None means that the specification could not be executed)

    exit the system for one executed specification (None means that the specification could not be executed)

    Definition Classes
    SystemExit
  35. def exitTheSystem(executed: Seq[Option[ExecutedSpecification]]): Unit

    Attributes
    protected
    Definition Classes
    SystemExit
  36. def exitWith(status: Int): Unit

    this method can be overriden for testing

    this method can be overriden for testing

    Attributes
    protected
    Definition Classes
    SystemExit
  37. def filePaths(basePath: String = ".", path: String = "*", verbose: Boolean = false): Seq[String]

    path

    glob expression, for example: ./dir/**/.xml

    returns

    the list of paths represented by the "glob" definition path

    Definition Classes
    FileSystem
  38. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def flush(): Unit

    flush the content if necessary

    flush the content if necessary

    Definition Classes
    ConsoleOutputOutput
  40. def fromBaseFile(base: File): (File) ⇒ String

    returns

    the path of a File relative to a base file

    Definition Classes
    FileReader
  41. def getAbsolutePath(path: String): String

    returns

    the file absolute path

    Definition Classes
    FileSystem
  42. def getCanonicalPath(path: String): String

    returns

    the file canonical path

    Definition Classes
    FileSystem
  43. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  44. def getName(path: String): String

    returns

    the file name

    Definition Classes
    FileSystem
  45. def getParent(path: String): String

    returns

    the file parent path

    Definition Classes
    FileSystem
  46. def getWriter(path: String, append: Boolean = false): Writer

    The getWriter function can be overriden to provide a mock writer writing to the console for example

    The getWriter function can be overriden to provide a mock writer writing to the console for example

    returns

    a Writer object opened on the file designated by path

    Definition Classes
    FileWriter
  47. def globToPattern(glob: String): String

    returns

    the regular expression equivalent to a glob pattern (see the specs for Fragments)

    Definition Classes
    FileSystem
  48. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  49. def inputStream(filePath: String): InputStream

    returns

    a FileInputStream for a given file path

    Definition Classes
    FileReader
  50. def isAbsolute(path: String): Boolean

    returns

    true if the file is absolute

    Definition Classes
    FileSystem
  51. def isDir(path: String): Boolean

    returns

    true if the File represented by this path is a directory

    Definition Classes
    FileSystem
  52. def isDirectory(path: String): Boolean

    returns

    true if the file is a directory

    Definition Classes
    FileSystem
  53. def isFile(path: String): Boolean

    returns

    true if the file is a file

    Definition Classes
    FileSystem
  54. def isHidden(path: String): Boolean

    returns

    true if the file is hidden

    Definition Classes
    FileSystem
  55. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  56. def isVerbose(implicit args: Arguments): Boolean

  57. def listFiles(path: String): List[String]

    returns

    the files of that directory

    Definition Classes
    FileSystem
  58. def loadXhtmlFile(filePath: String, report: (Exception, String) ⇒ Unit = defaultLoadXhtmlFileReport, sourceErrors: Boolean = true): NodeSeq

    returns

    the xml content of a file using the Xhtml parser

    if the file contains several nodes, it wraps them up in a single artificial node

    Definition Classes
    FileReader
  59. def loadXmlFile(filePath: String)(report: (Exception) ⇒ Unit = (e:Exception) => e.printStackTrace): NodeSeq

    returns

    the xml content of a file, using the XML parser

    Definition Classes
    FileReader
  60. def main(arguments: Array[String]): Unit

  61. def md5(f: File): String

    returns

    the MD5 hash of a file

    Definition Classes
    FileReader
  62. def mkdirs(path: String): Boolean

    creates a new directory

    creates a new directory

    Definition Classes
    FileWriter
  63. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  64. final def notify(): Unit

    Definition Classes
    AnyRef
  65. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  66. def packageName(content: String): String

    returns

    the package name corresponding to the package declarations at the beginning of a file

    Definition Classes
    SourceFile
  67. def print(m: Any): Unit

    print an object with no newline

    print an object with no newline

    Definition Classes
    Output
  68. def printStackTrace(t: Throwable): Unit

    print stacktraces

    print stacktraces

    Definition Classes
    Output
  69. def printf(s: String, args: Any*): Unit

    print several objects according to a format string (see Console.

    print several objects according to a format string (see Console.printf)

    Definition Classes
    ConsoleOutputOutput
  70. def println(m: Any): Unit

    print an object with a newline

    print an object with a newline

    Definition Classes
    Output
  71. def readBytes(path: String): Array[Byte]

    returns

    the bytes of a file

    Definition Classes
    FileReader
  72. def readFile(path: String): String

    reads the content of a file

    reads the content of a file

    path

    the path of the file to read

    returns

    the content of the file at path

    Definition Classes
    FileReader
  73. def readLines(path: String): IndexedSeq[String]

    returns

    the lines of a file

    Definition Classes
    FileReader
  74. def removeDir(path: String): String

    deletes the directory and all directory content at the specified path and return the parent path of that directory

    deletes the directory and all directory content at the specified path and return the parent path of that directory

    Definition Classes
    FileSystem
  75. def reporter(implicit args: Arguments): DefaultReporter with AllExporting

  76. def run(arguments: Array[String]): List[ExecutedSpecification]

  77. def samePath(p1: String, p2: String): Boolean

    returns

    true if 2 paths are the same according to their canonical representation

    Definition Classes
    FileSystem
  78. def silentLoadXhtmlFileReport: (Exception, String) ⇒ Unit

    Definition Classes
    FileReader
  79. def specPattern(specType: String, pattern: String): String

    pattern to use to get specification names from file contents

    pattern to use to get specification names from file contents

    Definition Classes
    SpecificationsFinder
  80. def specificationClassNames(implicit args: Arguments): Seq[String]

    returns

    the specifications class names to execute

    Attributes
    protected
  81. def specificationNames(path: String = "**/*.scala", pattern: String = ".*Spec", basePath: String = FromSource.srcTestDir, verbose: Boolean = false): Seq[String]

    path

    a path to a directory containing scala files (it can be a glob: i.e. "dir/**/spec.scala")

    pattern

    a regular expression which is supposed to match an object name extending a Specification

    returns

    specification names by scanning files and trying to find specifications declarations

    Definition Classes
    SpecificationsFinder
  82. def specifications(implicit args: Arguments): Seq[SpecificationStructure]

    returns

    the specifications to execute

    Attributes
    protected
  83. def specifications(path: String = "**/*.scala", pattern: String = ".*Spec", filter: (String) ⇒ Boolean = (name: String) => true, basePath: String = FromSource.srcTestDir, verbose: Boolean = false)(implicit args: Arguments = Arguments()): Seq[SpecificationStructure]

    path

    a path to a directory containing scala files (it can be a glob: i.e. "dir/**/spec.scala")

    pattern

    a regular expression which is supposed to match an object name extending a Specification

    filter

    a function to filter out unwanted specifications

    returns

    specifications created from specification names

    Definition Classes
    SpecificationsFinder
  84. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  85. def toString(): String

    Definition Classes
    AnyRef → Any
  86. def tryToCreateObject[T <: AnyRef](className: String, printMessage: Boolean = true, printStackTrace: Boolean = true, loader: ClassLoader = ..., parameter: Option[AnyRef] = None)(implicit m: ClassTag[T]): Option[T]

    Try to create an instance of a given class by using whatever constructor is available and trying to instantiate the first parameter recursively if there is a parameter for that constructor.

    Try to create an instance of a given class by using whatever constructor is available and trying to instantiate the first parameter recursively if there is a parameter for that constructor.

    This is useful to instantiate nested classes which are referencing their outer class in their constructor

    Definition Classes
    Classes
  87. def tryToCreateObjectEither[T <: AnyRef](className: String, loader: ClassLoader = ..., parameter: Option[AnyRef] = None)(implicit m: ClassTag[T]): Either[Throwable, T]

    Try to create an instance of a given class by using whatever constructor is available and trying to instantiate the first parameter recursively if there is a parameter for that constructor.

    Try to create an instance of a given class by using whatever constructor is available and trying to instantiate the first parameter recursively if there is a parameter for that constructor.

    This is useful to instantiate nested classes which are referencing their outer class in their constructor

    Definition Classes
    Classes
  88. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  89. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  90. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  91. def write(path: String)(function: (Writer) ⇒ Unit): Unit

    writes some content to a file and take care of closing the file.

    writes some content to a file and take care of closing the file.

    Usage:

    write("./dir/hello.txt") { out =>
    out.write("content")
    }
    path

    path of the file to write

    Definition Classes
    FileWriter
  92. def writeFile(path: String, content: ⇒ String): Unit

    writes some content to a file.

    writes some content to a file.

    path

    path of the file to read

    content

    content of the file to write

    Definition Classes
    FileWriter
  93. def writeXmlFile(path: String, content: ⇒ NodeSeq): Unit

    writes some xml content to a file.

    writes some xml content to a file.

    path

    path of the file to read

    content

    content of the file to write

    Definition Classes
    FileWriter

Inherited from SystemExit

Inherited from SpecificationsFinder

Inherited from SourceFile

Inherited from ConsoleOutput

Inherited from Classes

Inherited from Output

Inherited from FileSystem

Inherited from FileWriter

Inherited from FileReader

Inherited from AnyRef

Inherited from Any

Ungrouped