Interface TestAutomationApi


  • public interface TestAutomationApi
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.TestRun> finishTestRun​(String profileid, String testrunid)
      Mark test run as finished Returns all test run details (including test executions) of a finished test run.
      retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.TestRun> getTestrunById​(String profileid, String testrunid)
      Get test run by id Get all test run details including test executions.
      retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.TestRun> markTestExecutionAsFailed​(String profileid, String testrunid, String testId)
      Set test execution's state to FAILED Test execution is located using testRunId (UUID) and full test name (including package and class).
      retrofit2.Call<Void> postExternalTestData​(String profileid, String testrunid, ExternalTest body)
      Post test result Post a test result for a registered test run of category 'external'.
      retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.TestRun> postTestRun​(String profileid, TestRunDefinition body)
      Register test run Register a test run with provided parameters.
    • Method Detail

      • finishTestRun

        @POST("api/v2/profiles/{profileid}/testruns/{testrunid}/finish")
        retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.TestRun> finishTestRun​(@Path("profileid")
                                                                                                       String profileid,
                                                                                                       @Path("testrunid")
                                                                                                       String testrunid)
        Mark test run as finished Returns all test run details (including test executions) of a finished test run.
        Parameters:
        profileid - System profile id (required)
        testrunid - UUID of the test run (required)
        Returns:
        Call<TestRun>
      • getTestrunById

        @GET("api/v2/profiles/{profileid}/testruns/{testrunid}")
        retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.TestRun> getTestrunById​(@Path("profileid")
                                                                                                        String profileid,
                                                                                                        @Path("testrunid")
                                                                                                        String testrunid)
        Get test run by id Get all test run details including test executions.
        Parameters:
        profileid - System profile id (required)
        testrunid - UUID of the test run (required)
        Returns:
        Call<TestRun>
      • markTestExecutionAsFailed

        @POST("api/v2/profiles/{profileid}/testruns/{testrunid}/markAsFailed")
        retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.TestRun> markTestExecutionAsFailed​(@Path("profileid")
                                                                                                                   String profileid,
                                                                                                                   @Path("testrunid")
                                                                                                                   String testrunid,
                                                                                                                   @Query("testId")
                                                                                                                   String testId)
        Set test execution's state to FAILED Test execution is located using testRunId (UUID) and full test name (including package and class). Returns all details of a test run which is bound with marked test execution.
        Parameters:
        profileid - System profile id (required)
        testrunid - UUID of the test run (required)
        testId - Full test name including package description and class name (if applicable) (required)
        Returns:
        Call<TestRun>
      • postExternalTestData

        @Headers("Content-Type:application/json")
        @POST("api/v2/profiles/{profileid}/testruns/{testrunid}")
        retrofit2.Call<Void> postExternalTestData​(@Path("profileid")
                                                  String profileid,
                                                  @Path("testrunid")
                                                  String testrunid,
                                                  @Body
                                                  ExternalTest body)
        Post test result Post a test result for a registered test run of category 'external'.
        Parameters:
        profileid - System profile id (required)
        testrunid - UUID of the test run (required)
        body - Test result (required)
        Returns:
        Call<Void>
      • postTestRun

        @Headers("Content-Type:application/json")
        @POST("api/v2/profiles/{profileid}/testruns")
        retrofit2.Call<de.tsystems.mms.apm.performancesignature.dynatrace.model.TestRun> postTestRun​(@Path("profileid")
                                                                                                     String profileid,
                                                                                                     @Body
                                                                                                     TestRunDefinition body)
        Register test run Register a test run with provided parameters. The reply contains all test run's details including the UUID. - **category** is limited to one of the following values: 'unit' (default), 'uidriven', 'performance', 'webapi' or 'external'. - **marker** is a label used in the Test Automation dashlet charts. - if the **platform** is left blank, the agent will detect it automatically. - if the **includedMetrics** is provided, only test results for these metrics will be collected in this test run. In order to collect all test results for a given metric group you can pass just the group name or leave the metric name blank. - **additionalMetaData** can be used to provide additional data stored in Test Run, like Jenkins build ID, list of commiters, etc. Example Value: ``` \"additionalMetaData\": [{ \"key1\": \"value1\", \"key2\": \"value2\" }] ```
        Parameters:
        profileid - System profile id (required)
        body - Test run parameters (required)
        Returns:
        Call<TestRun>