Package de.interactive_instruments.etf.client

Interface TestRun

  • All Known Subinterfaces:
    TestRunCloseable
    public interface TestRun
    The information about a started test run is updated at regular intervals and the state can be queried using the methods of this interface. Except the other methods, the result() method blocks until the Test Run finishes.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void cancel()
      Cancels the Test Run on the remote instance Please note: if the Test Run has already finished, this will delete the Test Report from the remote instance.
      boolean finished()
      Returns true if the Test Run has finished.
      java.util.List<java.lang.String> logEntries()
      The non-blocking call returns the current entries of the log file
      double progress()
      Returns the progress as double in the in the [0.0,1.0] interval.
      java.util.Optional<java.net.URI> remoteRef()
      A reference to the test run on the remote ETF instance.
      TestRunResult result()
      The blocking call waits until the Test Run has finished and finally returns a Test Run Result.

    • Method Detail

      • progress

        double progress()
        Returns the progress as double in the in the [0.0,1.0] interval.
        Returns:
        in the [0.0,1.0] interval.

      • finished

        boolean finished()
        Returns true if the Test Run has finished. Non-blocking call.
        Returns:
        false if Test Run has not finished yet, true otherwise

      • logEntries

        java.util.List<java.lang.String> logEntries()
        The non-blocking call returns the current entries of the log file
        Returns:
        log file entries

      • result

        TestRunResult result()
              throws EtfIllegalStateException,
                     java.util.concurrent.ExecutionException
        The blocking call waits until the Test Run has finished and finally returns a Test Run Result.
        Returns:
        the Test Run Result when the Test Run finishes
        Throws:
        EtfIllegalStateException - if the Test Run has been cancelled
        java.util.concurrent.ExecutionException - if an exception occurred during the Test Run

      • remoteRef

        java.util.Optional<java.net.URI> remoteRef()
        A reference to the test run on the remote ETF instance. It serves as an entry point to retrieve additional information and resource of the test run from the ETF instance, like the test report in an HTML format. It must be supplemented with additional parameters and paths that can be found in the API documentation of the ETF instance.
        Returns:
        remote location of this Test Run or empty if the Test Run object is not (yet) initialized

      • cancel

        void cancel()
     throws RemoteInvocationException
        Cancels the Test Run on the remote instance Please note: if the Test Run has already finished, this will delete the Test Report from the remote instance.
        Throws:
        RemoteInvocationException - if the ETF instance returned an error