Trait

org.specs2.runner

FilesRunner

Related Doc: package runner

Permalink

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
Known Subclasses
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
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def afterExecution(specs: Seq[SpecificationStructure])(implicit args: Arguments): Unit

    Permalink

    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
  5. def append(path: String)(function: (Writer) ⇒ Unit): Unit

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

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

    Permalink
    Definition Classes
    FileWriter
  8. final def asInstanceOf[T0]: T0

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

    Permalink

    print a message before the execution

    print a message before the execution

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

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

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

    Permalink
    Definition Classes
    SourceFile
  13. def clone(): AnyRef

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

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

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

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

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

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

    Permalink

    returns

    the Arguments object depending on the command-line options

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

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

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

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

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

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

    Permalink

    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
  26. def createSpecification(className: String, verbose: Boolean = false)(implicit args: Arguments): Option[SpecificationStructure]

    Permalink

    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
  27. def delete(path: String): Boolean

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

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

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

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

    Permalink

    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
  32. def exitSystem(executed: Option[ExecutedSpecification]): Unit

    Permalink

    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
  33. def exitTheSystem(executed: Seq[Option[ExecutedSpecification]]): Unit

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

    Permalink

    this method can be overriden for testing

    this method can be overriden for testing

    Attributes
    protected
    Definition Classes
    SystemExit
  35. def filePaths(basePath: String, path: String, verbose: Boolean): Seq[String]

    Permalink
    Definition Classes
    FileSystem
  36. def filterFiles(found: Seq[File], path: String, verbose: Boolean): Seq[String]

    Permalink
    Definition Classes
    FileSystem
  37. def finalize(): Unit

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

    Permalink
    Definition Classes
    ConsoleOutput → Output
  39. def fromBaseFile(base: File): (File) ⇒ String

    Permalink
    Definition Classes
    FileReader
  40. def getAbsolutePath(path: String): String

    Permalink
    Definition Classes
    FileSystem
  41. def getCanonicalPath(path: String): String

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

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

    Permalink
    Definition Classes
    FileSystem
  44. def getParent(path: String): String

    Permalink
    Definition Classes
    FileSystem
  45. def getWriter(path: String, append: Boolean): Writer

    Permalink
    Definition Classes
    FileWriter
  46. def globToPattern(glob: String): String

    Permalink
    Definition Classes
    FileSystem
  47. def hashCode(): Int

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

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

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

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

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

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

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

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

    Permalink
  56. def listFiles(path: String): List[String]

    Permalink
    Definition Classes
    FileSystem
  57. def loadXhtmlFile(filePath: String, report: (Exception, String) ⇒ Unit, sourceErrors: Boolean): NodeSeq

    Permalink
    Definition Classes
    FileReader
  58. def loadXmlFile(filePath: String)(report: (Exception) ⇒ Unit): NodeSeq

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

    Permalink
  60. def md5(f: File): String

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

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

    Permalink
    Definition Classes
    AnyRef
  63. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  64. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  65. def packageName(content: String): String

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

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

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

    Permalink
    Definition Classes
    ConsoleOutput → Output
  69. def println(m: Any): Unit

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

    Permalink
    Definition Classes
    FileReader
  71. def readFile(path: String): String

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

    Permalink
    Definition Classes
    FileReader
  73. def removeDir(path: String): String

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

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

    Permalink
  76. def samePath(p1: String, p2: String): Boolean

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

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

    Permalink

    pattern to use to get specification names from file contents

    pattern to use to get specification names from file contents

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

    Permalink

    returns

    the specifications class names to execute

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

    Permalink

    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
  81. def specifications(implicit args: Arguments): Seq[SpecificationStructure]

    Permalink

    returns

    the specifications to execute

    Attributes
    protected
  82. 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]

    Permalink

    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
  83. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  84. def toString(): String

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

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

    Permalink
    Definition Classes
    Classes
  87. final def wait(): Unit

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

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

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

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

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

    Permalink
    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