Interface ExecutionEnvironment

public interface ExecutionEnvironment
An interface to model the execution environment.

  • Field Details

    • PROPERTY_KEY_FOR_TEST_RESULT_DIRECTORY

      static final String PROPERTY_KEY_FOR_TEST_RESULT_DIRECTORY
      A system property key for a base directory under which test results are stored.
      See Also:

  • Method Details

    • testClassName

      String testClassName()
      A currently ongoing test class name.
      Returns:
      A test class name.

    • testSceneName

      Optional<String> testSceneName()
      Returns a name of a currently ongoing scene, if any.
      Returns:
      A name of an ongoing scene.
      See Also:

    • stepName

      String stepName()
      A name of an ongoing step, such as beforeAll, afterEach, or main.
      Returns:
      A name of an ongoing step.
      See Also:

    • withDisplayName

      default ExecutionEnvironment withDisplayName(String displayName, String stageName)
      Returns a new ExecutionEnvironment instance, with a currently ongoing display name and a step name.
      Parameters:
      displayName - A display name of a currently ongoing scene.
      stageName - A stage name of a currently ongoing scene.
      Returns:
      A new execution environment object.

    • testResultDirectory

      default Path testResultDirectory()
      Returns a Path to a directory under which test results are stored.
      Returns:
      A path to a test result directory.

    • testOutputFilenameFor

      default Path testOutputFilenameFor(String fileName)
      Returns an absolute path to a test result file.
      Parameters:
      fileName - A file name under the test result directory.
      Returns:
      An absolute path to a test result file.

    • testResultDirectoryFor

      static Path testResultDirectoryFor(String testClassName, String displayName)

    • testResultDirectory

      static Path testResultDirectory(String baseLogDirectoryForTestSession, String... dirs)

    • baseLogDirectoryForTestSession

      static String baseLogDirectoryForTestSession()

    • testOutputFilenameFor

      default Path testOutputFilenameFor(String fileStem, String fileExtension)