Field Detail

• ALL_TESTS_PROPERTY_VALUE

  public static final String ALL_TESTS_PROPERTY_VALUE

  Value for the SKIP_TESTS_PROPERTY property that indicates that all tests that can be skipped are disabled. Current value: "all".

  See Also:

  Constant Field Values

• BIG_MEMORY_TEST_MESSAGE

  public static final String BIG_MEMORY_TEST_MESSAGE

  A message indicating that the current test requires a lot of memory, and giving instructions how to skip it. Should be logged immediately after calling assumeBigMemoryTestsEnabled().

• BIG_MEMORY_TESTS_PROPERTY_VALUE

  public static final String BIG_MEMORY_TESTS_PROPERTY_VALUE

  Value for the SKIP_TESTS_PROPERTY property that indicates that tests requiring a lot of memory should be disabled. Current value: "bigMem".

  See Also:

  Constant Field Values

• COMMON_TESTS_PROPERTY_VALUE

  public static final String COMMON_TESTS_PROPERTY_VALUE

  Value for the SKIP_TESTS_PROPERTY property that indicates that commonly skipped tests should be disabled. Currently, this will disable at least "long" and "bigMem" tests. It will also typically disable tests that require binaries that are hard to build (e.g. tk-svmlight, crfsuite). Current value: "common".

  See Also:

  Constant Field Values

• folder

  public org.junit.rules.TemporaryFolder folder

• jCas

  protected JCas jCas

• logger

  protected Logger logger

  A Logger instance associated with the class, intended for use by subclasses.

• LONG_TEST_MESSAGE

  protected static final String LONG_TEST_MESSAGE

  A message indicating that the current test runs for a long time, and giving instructions how to skip it. Should be logged immediately after calling assumeLongTestsEnabled().

• LONG_TESTS_PROPERTY_VALUE

  public static final String LONG_TESTS_PROPERTY_VALUE

  Value for the SKIP_TESTS_PROPERTY property that indicates that long-running tests should be disabled. Current value: "long".

  See Also:

  Constant Field Values

• outputDirectory

  protected File outputDirectory

• outputDirectoryName

  protected String outputDirectoryName

• SKIP_TESTS_PROPERTY

  public static final String SKIP_TESTS_PROPERTY

  The name of the property that can be set to skip some tests. The property value will be parsed as a comma-separated list of values, where each value can designate one type of test to skip, e.g. "long" or "bigMem". Example usage:
  -Dcleartk.skipTests=long,bigMem

  See Also:

  Constant Field Values

Constructor Detail

• CleartkTestBase

  public CleartkTestBase()

Method Detail

• assumeBigMemoryTestsEnabled

  protected void assumeBigMemoryTestsEnabled()

  Subclasses should call this method at the beginning of a test that will take a long time to run. Immediately after calling this method, they should also call this.logger.info(BIG_MEMORY_TEST_MESSAGE).

• assumeLongTestsEnabled

  protected void assumeLongTestsEnabled()

  Subclasses should call this method at the beginning of a test that will take a long time to run. Immediately after calling this method, they should also call this.logger.info(LONG_TEST_MESSAGE).

• assumeTestsEnabled

  protected void assumeTestsEnabled(String... testNames)

  Subclasses should call this method at the beginning of a test to check whether a specific type of test is enabled by checking whether the name of that test is contained in the "cleartk.skipTests" property. If the name is present, then the test will be skipped. Typically, immediately after calling assumeTestsEnabled(java.lang.String...), a test should log a message created by createTestEnabledMessage(java.lang.String, java.lang.String) to explain to a user how to disable the test if they wish. Note that if "cleartk.skipTests" contains "all" then the test will be skipped even if ALL_TESTS_PROPERTY_VALUE was not passed as an argument to this method.

• createTestEnabledMessage

  public static String createTestEnabledMessage(String testName,
                                String message)

  Subclasses should call this method to create a message that explains how to disable a test. Typically such a message should be logged immediately after calling assumeTestsEnabled(String...).

  Parameters:

  testName - The name of the test (i.e. the value that should be present in the "cleartk.skipTests" property)

  message - A message describing the requirements of the tests that are run when the named test is enabled.

  Returns:

  A message that contains both the given description and an explanation of how to disable the test.

• setUp

  public void setUp()
             throws Exception

  Throws:

  Exception