Package org.apache.ant.antunit

Class AntUnit

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class AntUnit
extends org.apache.tools.ant.Task
    Run every target whose name starts with "test" in a set of build files.

    Run the "setUp" target before each of them if present, same for "tearDown" after each "test*" target (targets named just "test" are ignored). If a target throws an AssertionFailedException, the test has failed; any other exception is considered an error (although BuildException will be scanned recursively for nested AssertionFailedExceptions).

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AntUnit.Reference  
      static class  AntUnit.ReferenceSet
      Defines a collection of inherited references, with an optional nested Mapper that maps them to new reference IDs in the target project.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ERROR_NO_TESTS
      Message if no tests have been specified.
      static java.lang.String ERROR_NON_FILES
      Message if non-File resources have been specified.
      static java.lang.String ERROR_TESTS_FAILED
      Message to print if an error or failure occured.

      • Fields inherited from class org.apache.tools.ant.Task

        target, taskName, taskType, wrapper

      • Fields inherited from class org.apache.tools.ant.ProjectComponent

        description, location, project

    • Constructor Summary

      Constructors 
      Constructor Description
      AntUnit()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(AntUnitListener al)
      Add a test listener.
      void add​(org.apache.tools.ant.types.ResourceCollection rc)
      Add build files to run as tests.
      void addPropertySet​(org.apache.tools.ant.types.PropertySet ps)
      Add a PropertySet.
      void addReference​(AntUnit.Reference reference)
      Add an inherited reference.
      AntUnit.ReferenceSet createReferenceSet()
      Add a set of inherited references.
      void execute()
      Execute the tests.
      void handleErrorFlush​(java.lang.String errorOutputToFlush)
      Redirect error flush to new project instance.
      void handleErrorOutput​(java.lang.String errorOutputToHandle)
      Redirect error output to new project instance.
      void handleFlush​(java.lang.String toFlush)
      Redirect flush to new project instance.
      int handleInput​(byte[] buffer, int offset, int length)
      Redirect input to new project instance.
      void handleOutput​(java.lang.String outputToHandle)
      Redirect output to new project instance.
      void setErrorProperty​(java.lang.String s)
      Set the name of a property to set if an error or failure occurs.
      void setFailOnError​(boolean failOnError)
      Set whether to stop testing if an error or failure occurs?

      • Methods inherited from class org.apache.tools.ant.Task

        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

      • Methods inherited from class org.apache.tools.ant.ProjectComponent

        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • ERROR_TESTS_FAILED

        public static final java.lang.String ERROR_TESTS_FAILED
        Message to print if an error or failure occured.
        See Also:
        Constant Field Values

      • ERROR_NO_TESTS

        public static final java.lang.String ERROR_NO_TESTS
        Message if no tests have been specified.
        See Also:
        Constant Field Values

      • ERROR_NON_FILES

        public static final java.lang.String ERROR_NON_FILES
        Message if non-File resources have been specified.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AntUnit

        public AntUnit()

    • Method Detail

      • add

        public void add​(org.apache.tools.ant.types.ResourceCollection rc)
        Add build files to run as tests.
        Parameters:
        rc - the ResourceCollection to add.

      • add

        public void add​(AntUnitListener al)
        Add a test listener.
        Parameters:
        al - the AntUnitListener to add.

      • addPropertySet

        public void addPropertySet​(org.apache.tools.ant.types.PropertySet ps)
        Add a PropertySet.
        Parameters:
        ps - the PropertySet to add.

      • createReferenceSet

        public AntUnit.ReferenceSet createReferenceSet()
        Add a set of inherited references.
        Returns:
        set of inherited references

      • addReference

        public void addReference​(AntUnit.Reference reference)
        Add an inherited reference.
        Parameters:
        reference - inherited reference

      • setErrorProperty

        public void setErrorProperty​(java.lang.String s)
        Set the name of a property to set if an error or failure occurs.
        Parameters:
        s - the name of the error property.

      • setFailOnError

        public void setFailOnError​(boolean failOnError)
        Set whether to stop testing if an error or failure occurs?
        Parameters:
        failOnError - default true

      • execute

        public void execute()
        Execute the tests.
        Overrides:
        execute in class org.apache.tools.ant.Task

      • handleOutput

        public void handleOutput​(java.lang.String outputToHandle)
        Redirect output to new project instance.
        Overrides:
        handleOutput in class org.apache.tools.ant.Task
        Parameters:
        outputToHandle - the output to handle.

      • handleInput

        public int handleInput​(byte[] buffer,
                       int offset,
                       int length)
                throws java.io.IOException
        Redirect input to new project instance.
        Overrides:
        handleInput in class org.apache.tools.ant.Task
        Parameters:
        buffer - the buffer containing the input.
        offset - the offset into buffer.
        length - the length of the data.
        Throws:
        java.io.IOException

      • handleFlush

        public void handleFlush​(java.lang.String toFlush)
        Redirect flush to new project instance.
        Overrides:
        handleFlush in class org.apache.tools.ant.Task
        Parameters:
        toFlush - the output String to flush.

      • handleErrorOutput

        public void handleErrorOutput​(java.lang.String errorOutputToHandle)
        Redirect error output to new project instance.
        Overrides:
        handleErrorOutput in class org.apache.tools.ant.Task
        Parameters:
        errorOutputToHandle - the error output to handle.

      • handleErrorFlush

        public void handleErrorFlush​(java.lang.String errorOutputToFlush)
        Redirect error flush to new project instance.
        Overrides:
        handleErrorFlush in class org.apache.tools.ant.Task
        Parameters:
        errorOutputToFlush - the error output to flush.