All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.testfabrik.webmate.javasdk.testmgmt.TestMgmtClient Maven / Gradle / Ivy

There is a newer version: 0.56
Show newest version
package com.testfabrik.webmate.javasdk.testmgmt;

import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableMap;
import com.testfabrik.webmate.javasdk.*;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.testfabrik.webmate.javasdk.commonutils.HttpHelpers;
import com.testfabrik.webmate.javasdk.jobs.WMValue;
import com.testfabrik.webmate.javasdk.testmgmt.spec.TestExecutionSpec;
import com.testfabrik.webmate.javasdk.utils.JsonUtils;
import org.apache.http.HttpResponse;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.*;

/**
 * Facade to webmate's TestMgmt subsystem.
 */
public class TestMgmtClient {

    private WebmateAPISession session;
    private TestMgmtApiClient apiClient;

    private static final Logger LOG = LoggerFactory.getLogger(TestMgmtClient.class);

    public static class SingleTestRunCreationSpec {

        private Map parameterAssignments;

        public SingleTestRunCreationSpec(Map parameterAssignments) {
            this.parameterAssignments = parameterAssignments;
        }

        @JsonValue
        public JsonNode asJson() {
            ObjectMapper om = new ObjectMapper();
            ObjectNode paramAssignments = ((ObjectNode)om.valueToTree(parameterAssignments));
            ObjectNode root = om.createObjectNode();
            return root
                    .put("type", "SingleTestRunCreationSpec")
                    .set("assignmentSpec", paramAssignments);
        }
    }

    private static class TestMgmtApiClient extends WebmateApiClient {

        private final static UriTemplate getTestTemplatesTemplate =
                new UriTemplate("GetTestTemplates", "/projects/${projectId}/tests");

        private final static UriTemplate getTestTemplate =
                new UriTemplate("GetTestTemplate", "/testmgmt/tests/${testId}");

        private final static UriTemplate getTestResultsTemplate =
                new UriTemplate("GetTestResults", "/testmgmt/testruns/${testRunId}/results");

        private final static UriTemplate createTestSessionTemplate =
                new UriTemplate("CreateTestSession", "/projects/${projectId}/testsessions");

        private final static UriTemplate createTestExecutionTemplate =
                new UriTemplate("CreateTestExecution", "/projects/${projectId}/testexecutions");

        private final static UriTemplate startTestExecutionTemplate =
                new UriTemplate("StartTestExecution", "/testmgmt/testexecutions/${testExecutionId}");

        private final static UriTemplate getTestExecutionTemplate =
                new UriTemplate("GetTestExecution", "/testmgmt/testexecutions/${testExecutionId}");

        private final static UriTemplate finishTestRunTemplate =
                new UriTemplate("FinishTestRun", "/testmgmt/testruns/${testRunId}/finish");

        private final static UriTemplate setTestRunNameTemplate =
                new UriTemplate("SetTestRunName", "/testmgmt/testruns/${testRunId}/name");

        private final static UriTemplate getTestRunTemplate =
                new UriTemplate("GetTestRun", "/testmgmt/testruns/${testRunId}");

        public TestMgmtApiClient(WebmateAuthInfo authInfo, WebmateEnvironment environment) {
            super(authInfo, environment);
        }

        public TestMgmtApiClient(WebmateAuthInfo authInfo, WebmateEnvironment environment, HttpClientBuilder clientBuilder) {
            super(authInfo, environment, clientBuilder);
        }

        private CreateTestExecutionResponse handleCreateTestExecutionResponse(Optional response) {
            if (!response.isPresent()) {
                throw new WebmateApiClientException("Could not create TestExecution. Got no response");
            }
            return HttpHelpers.getObjectFromJsonEntity(response.get(), CreateTestExecutionResponse.class);
        }

        public CreateTestExecutionResponse createTestExecution(ProjectId projectId, TestExecutionSpec spec) {
            Optional optHttpResponse = sendPOST(createTestExecutionTemplate, ImmutableMap.of(
                    "projectId", projectId.toString()), spec.asJson()).getOptHttpResponse();

            return handleCreateTestExecutionResponse(optHttpResponse);
        }

        public CreateTestExecutionResponse createAndStartTestExecution(ProjectId projectId, TestExecutionSpec spec) {
            Optional optHttpResponse = sendPOST(createTestExecutionTemplate, ImmutableMap.of(
                    "projectId", projectId.toString()), "start=true", spec.asJson()).getOptHttpResponse();

            return handleCreateTestExecutionResponse(optHttpResponse);
        }

        public TestSessionId createTestSession(ProjectId projectId, String name) {
            ObjectMapper om = JacksonMapper.getInstance();
            ObjectNode root = om.createObjectNode();
            root.put("name", name);

            Optional optHttpResponse = sendPOST(createTestSessionTemplate, ImmutableMap.of(
                    "projectId", projectId.toString()), root).getOptHttpResponse();

            if (!optHttpResponse.isPresent()) {
                throw new WebmateApiClientException("Could not create TestSession. Got no response");
            }

            return HttpHelpers.getObjectFromJsonEntity(optHttpResponse.get(), TestSessionId.class);
        }

        public TestRunId startTestExecution(TestExecutionId id) {
            Optional optHttpResponse = sendPOST(startTestExecutionTemplate, ImmutableMap.of(
                    "testExecutionId", id.toString())).getOptHttpResponse();

            if (!optHttpResponse.isPresent()) {
                throw new WebmateApiClientException("Could not start TestExecution. Got no response");
            }

            return HttpHelpers.getObjectFromJsonEntity(optHttpResponse.get(), TestRunId.class);
        }

        public TestExecutionSummary getTestExecution(TestExecutionId id) {
            Optional optHttpResponse = sendGET(getTestExecutionTemplate, ImmutableMap.of(
                    "testExecutionId", id.toString())).getOptHttpResponse();

            if (!optHttpResponse.isPresent()) {
                throw new WebmateApiClientException("Could not get TestExecution. Got no response");
            }

            return HttpHelpers.getObjectFromJsonEntity(optHttpResponse.get(), TestExecutionSummary.class);
        }

        public TestRunInfo getTestRun(TestRunId id) {
            Optional optHttpResponse = sendGET(getTestRunTemplate, ImmutableMap.of(
                    "testRunId", id.toString())).getOptHttpResponse();

            if (!optHttpResponse.isPresent()) {
                throw new WebmateApiClientException("Could not get TestRun. Got no response");
            }

            return HttpHelpers.getObjectFromJsonEntity(optHttpResponse.get(), TestRunInfo.class);
        }

        public void setTestRunName(TestRunId id, String name) {
            Map  params = ImmutableMap.of("name", name);
            Optional optHttpResponse = sendPOST(setTestRunNameTemplate, ImmutableMap.of(
                    "testRunId", id.toString()), JsonUtils.getJsonFromData(params)).getOptHttpResponse();

            if (!optHttpResponse.isPresent()) {
                throw new WebmateApiClientException("Could not finish TestRun. Got no response");
            }
        }

        public void finishTestRun(TestRunId id, TestRunFinishData data) {
            JsonNode dataJson = JsonUtils.getJsonFromData(data);

            Optional optHttpResponse = sendPOST(finishTestRunTemplate, ImmutableMap.of(
                    "testRunId", id.toString()), dataJson).getOptHttpResponse();

            if (!optHttpResponse.isPresent()) {
                throw new WebmateApiClientException("Could not finish TestRun. Got no response");
            }
        }

        public List getTestTemplates(ProjectId projectId) {
            Optional optHttpResponse = sendGET(getTestTemplatesTemplate, ImmutableMap.of("projectId", projectId.toString())).getOptHttpResponse();
            List testTemplates;
            try {
                if (!optHttpResponse.isPresent()) {
                    testTemplates = new ArrayList<>();
                } else {
                    String testInfosJson = EntityUtils.toString(optHttpResponse.get().getEntity());
                    ObjectMapper mapper = JacksonMapper.getInstance();
                    mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);


                    ApiDataResult testResults = mapper.readValue(testInfosJson, new TypeReference>() {});
                    testTemplates = Arrays.asList(testResults.data);
                }
            } catch (IOException e) {
                throw new WebmateApiClientException("Error reading data: " + e.getMessage(), e);
            }
            return testTemplates;
        }

        public Optional getTest(TestTemplateId id) {
            Optional optHttpResponse = sendGET(getTestTemplate, ImmutableMap.of("testId", id.toString())).getOptHttpResponse();
            if (!optHttpResponse.isPresent()) {
                return Optional.absent();
            }

            Test test;
            try {
                String testJson = EntityUtils.toString(optHttpResponse.get().getEntity());

                ObjectMapper mapper = JacksonMapper.getInstance();
                test = mapper.readValue(testJson, Test.class);
            } catch (IOException e) {
                throw new WebmateApiClientException("Error reading Test data: " + e.getMessage(), e);
            }
            return Optional.fromNullable(test);
        }

        /**
         * Get TestResults of Test with given id and testrun index.
         *
         * @param id Id of TestRun.
         * @return Optional with list of TestResults or Optional.absent if there was no such Test or TestRun. If there
         * were no TestResults, the result is Optional of empty list.
         */
        public Optional> getTestResults(TestRunId id) {
            if (id == null) {
                throw new WebmateApiClientException("TestRun id must not be null");
            }
            Optional optHttpResponse = sendGET(getTestResultsTemplate, ImmutableMap.of("testRunId", id.toString())).getOptHttpResponse();
            if (!optHttpResponse.isPresent()) {
                return Optional.absent();
            }

            List result;
            try {
                String testJson = EntityUtils.toString(optHttpResponse.get().getEntity());

                ObjectMapper mapper = JacksonMapper.getInstance();
                ApiDataResult testResults = mapper.readValue(testJson, new TypeReference>() {});
                result = Arrays.asList(testResults.data);
            } catch (IOException e) {
                throw new WebmateApiClientException("Error reading TestResult data: " + e.getMessage(), e);
            }
            return Optional.fromNullable(result);
        }
    }

    /**
     * Creates a TestMgmtClient based on a WebmateApiSession.
     *
     * @param session The WebmateApiSession used by the TestMgmtClient
     */
    public TestMgmtClient(WebmateAPISession session) {
        this.session = session;
        this.apiClient = new TestMgmtApiClient(session.authInfo, session.environment);
    }

    /**
     * Creates a TestMgmtClient based on a WebmateApiSession and a custom HttpClientBuilder.
     *
     * @param session The WebmateApiSession used by the TestMgmtClient
     * @param httpClientBuilder The HttpClientBuilder that is used for building the underlying connection.
     */
    public TestMgmtClient(WebmateAPISession session,  HttpClientBuilder httpClientBuilder) {
        this.session = session;
        this.apiClient = new TestMgmtApiClient(session.authInfo, session.environment, httpClientBuilder);
    }

    public List getTestTemplates(ProjectId projectId) {
        return this.apiClient.getTestTemplates(projectId);
    }

    /**
     * Retrieve Test with id.
     *
     * @param id Id of Test.
     * @return Test
     */
    public Optional getTest(TestTemplateId id) {
        return this.apiClient.getTest(id);
    }

    /**
     * Retrieve list of TestResults for given test and test run.
     *
     * @param id Id of TestRun.
     * @return List of TestResults. Optional.absent if there was no such Test or TestRun.
     */
    public Optional> getTestResults(TestRunId id) {
        return this.apiClient.getTestResults(id);
    }

    /**
     * Retrieve information about TestRun.
     *
     * @param testRunId Id of TestRun.
     * @return TestRun information
     */
    public TestRunInfo getTestRun(TestRunId testRunId) {
        return this.apiClient.getTestRun(testRunId);
    }

    /**
     * Set the name for a given test run.
     *
     * @param testRunId Id of TestRun.
     * @param name New TestRun name.
     */
    public void setTestRunName(TestRunId testRunId, String name) {
        this.apiClient.setTestRunName(testRunId, name);
    }

//    /**
//     * Get Id of TestRun associated with a Selenium session.
//     *
//     * @param opaqueSeleniumSessionIdString selenium session id
//     * @return test run id
//     */
//    public TestRunId getTestRunIdForSessionId(String opaqueSeleniumSessionIdString) {
//        return new TestRunId(UUID.randomUUID());
//    }

    public CreateTestExecutionResponse startExecution(TestExecutionSpec spec, ProjectId projectId) {
        CreateTestExecutionResponse executionAndRun = apiClient.createAndStartTestExecution(projectId, spec);
        if (!executionAndRun.optTestRunId.isPresent()) {
            throw new WebmateApiClientException("Got no testrun id for new execution.");
        }
        return executionAndRun;
    }

    /**
     * Create and start a TestExecution.
     *
     * @param specBuilder A builder providing the required information for that test type, e.g. {@code Story}
     */
    public TestRun startExecutionWithBuilder(TestExecutionSpecBuilder specBuilder) {
        if (!session.getProjectId().isPresent()) {
            throw new WebmateApiClientException("A TestExecution must be associated with a project and none is provided or associated with the API session");
        }
        TestExecutionSpec spec = specBuilder.setApiSession(this.session).build();
        CreateTestExecutionResponse createTestExecutionResponse = startExecution(spec, session.getProjectId().get());
        return new TestRun(createTestExecutionResponse.optTestRunId.get(), this.session);
    }

    public TestExecutionSummary getTestExecutionSummary(TestExecutionId testExecutionId) {
        return apiClient.getTestExecution(testExecutionId);
    }

    /**
     * Create new TestSession in current project with given name.
     */
    public TestSession createTestSession(String name) {
        if (!session.getProjectId().isPresent()) {
            throw new WebmateApiClientException("A TestSession must be associated with a project and none is provided or associated with the API session");
        }
        return new TestSession(apiClient.createTestSession(session.getProjectId().get(), name), this.session);
    }

    /**
     * Finish a running TestRun.
     */
    public void finishTestRun(TestRunId id, TestRunEvaluationStatus status) {
       apiClient.finishTestRun(id, new TestRunFinishData(status));
    }

    /**
     * Finish a running TestRun with message.
     */
    public void finishTestRun(TestRunId id, TestRunEvaluationStatus status, String msg) {
        apiClient.finishTestRun(id, new TestRunFinishData(status, msg));
    }

    /**
     * Finish a running TestRun with message and detail information.
     */
    public void finishTestRun(TestRunId id, TestRunEvaluationStatus status, String msg, String detail) {
        apiClient.finishTestRun(id, new TestRunFinishData(status, msg, detail));
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy