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

com.testfabrik.webmate.javasdk.packagemgmt.PackageMgmtClient Maven / Gradle / Ivy

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

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableMap;
import com.testfabrik.webmate.javasdk.*;
import com.testfabrik.webmate.javasdk.blobs.BlobClient;
import com.testfabrik.webmate.javasdk.blobs.BlobId;
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.Map;

/**
 * Facade to webmate's Package Management (e.g. App) subsystem.
 */
public class PackageMgmtClient {

    private WebmateAPISession session;
    private PackageMgmtApiClient apiClient;
    private BlobClient blobClient;


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

    private static class PackageMgmtApiClient extends WebmateApiClient {

        private final static UriTemplate createPackageTemplate = new UriTemplate("/projects/${projectId}/packages");

        private final static UriTemplate updatePackageTemplate = new UriTemplate("/package/packages/${packageId}");

        private final static UriTemplate getPackageTemplate = new UriTemplate("/package/packages/${packageId}");

        private final static UriTemplate deletePackageTemplate = new UriTemplate("/package/packages/${packageId}");


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

        public PackageMgmtApiClient(WebmateAuthInfo authInfo, WebmateEnvironment environment, HttpClientBuilder httpClientBuilder) {
            super(authInfo, environment, httpClientBuilder);
        }


        public Package createPackage(ProjectId projectId, BlobId blobId, String packageName, String extension) {
            Map packageData = ImmutableMap.of("blobId", blobId.toString(), "name", packageName, "extension", extension);
            ObjectMapper mapper = new ObjectMapper();
            mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
            Optional r = sendPOST(createPackageTemplate, ImmutableMap.of("projectId", projectId.toString()), mapper.valueToTree(packageData)).getOptHttpResponse();

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

            return buildPackageFromResponse(r);
        }

        public Package updatePackage(PackageId packageId, BlobId blobId, String packageName, String extension) {
            Map packageData = ImmutableMap.of("blobId", blobId.toString(), "name", packageName, "extension", extension);
            ObjectMapper mapper = new ObjectMapper();
            mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
            Optional r = sendPUT(updatePackageTemplate, ImmutableMap.of("packageId", packageId.toString()), mapper.valueToTree(packageData)).getOptHttpResponse();

            if (!r.isPresent()) {
                throw new WebmateApiClientException("Could not update package. Got no response");
            }

            return buildPackageFromResponse(r);
        }

        public void deletePackage(PackageId packageId) {
            sendDELETE(deletePackageTemplate, ImmutableMap.of("packageId", packageId.toString()));
        }

        private Package buildPackageFromResponse(Optional httpResponse) {
            Package appPackage;
            try {
                String packageJson = EntityUtils.toString(httpResponse.get().getEntity());
                ObjectMapper pMapper = JacksonMapper.getInstance();
                appPackage = pMapper.readValue(packageJson, Package.class);
            } catch (IOException e) {
                throw new WebmateApiClientException("Error reading Package data: " + e.getMessage(), e);
            }
            return appPackage;
        }

        public Package getPackage(PackageId packageId) {
            Optional r = sendGET(getPackageTemplate, ImmutableMap.of("packageId", packageId.toString())).getOptHttpResponse();

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

            Package aPackage;
            try {
                String packageJson = EntityUtils.toString(r.get().getEntity());
                ObjectMapper pMapper = JacksonMapper.getInstance();
                pMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
                aPackage = pMapper.readValue(packageJson, Package.class);
            } catch (IOException e) {
                throw new WebmateApiClientException("Error reading Package data: " + e.getMessage(), e);
            }
            return aPackage;
        }

        public Package waitForPackage(PackageId packageId) {
            return waitForPackage(packageId, MAX_LONG_WAITING_TIME_MILLIS);
        }

        public Package waitForPackage(PackageId packageId, long maxWaitingTimeInMilliSeconds) {
            long startTime = System.currentTimeMillis();
            Package pckg = null;
            boolean success = false;
            WebmateApiClientException exception = null;
            try {
                do {
                    Thread.sleep(WAITING_POLLING_INTERVAL_MILLIS);
                    try {
                        pckg = this.getPackage(packageId);
                    } catch (WebmateApiClientException e) {
                        e.printStackTrace();
                        exception = e;
                    }

                    if (pckg != null) {
                        success = true;
                    }

                } while (!success && System.currentTimeMillis() - startTime < maxWaitingTimeInMilliSeconds);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            if (exception != null && !success) {
                System.err.println(exception.getMessage());
            }
            if (success) {
                return pckg;
            } else {
                throw exception;
            }
        }

    }

    /**
     * Creates a PackageMgmtClient based on a WebmateApiSession.
     *
     * @param session The WebmateApiSession the PackageMgmtClient is supposed to be based on.
     */
    public PackageMgmtClient(WebmateAPISession session) {
        this.session = session;
        this.apiClient = new PackageMgmtApiClient(session.authInfo, session.environment);
        this.blobClient = new BlobClient(session);
    }

    /**
     * Creates a PackageMgmtClient based on a WebmateApiSession and a custom HttpClientBuilder.
     *
     * @param session The WebmateApiSession the PackageMgmtClient is supposed to be based on.
     * @param httpClientBuilder The HttpClientBuilder that is used for building the underlying connection.
     */
    public PackageMgmtClient(WebmateAPISession session, HttpClientBuilder httpClientBuilder) {
        this.session = session;
        this.apiClient = new PackageMgmtApiClient(session.authInfo, session.environment, httpClientBuilder);
        this.blobClient = new BlobClient(session, httpClientBuilder);
    }


    /**
     * Creates a new package in a Project from an existing webmate Blob.
     *
     * @param projectId Project the package will be uploaded to
     * @param blobId Blob where the data is saved
     * @param packageName The name of the package
     * @param extension The package file format, e.g. ipa or apk
     */
    public Package createPackage(ProjectId projectId, BlobId blobId, String packageName, String extension) {
        return this.apiClient.createPackage(projectId, blobId, packageName, extension);
    }

    /**
     * Updates an existing package in a Project based on an existing webmate Blob.
     *
     * @param packageId The package to be updated
     * @param blobId Blob where the data is saved
     * @param packageName The name of the package
     * @param extension The package file format, e.g. ipa or apk
     */
    public Package updatePackage(PackageId packageId, BlobId blobId, String packageName, String extension) {
        return this.apiClient.updatePackage(packageId, blobId, packageName, extension);
    }

    /**
     * Get package information for a given PackageId.
     *
     * @param packageId  Id of the package
     * @return Package information
     */
    public Package getPackage(PackageId packageId){
        return this.apiClient.getPackage(packageId);
    }

    /**
     * Delete a package with a given PackageId
     *
     * @param packageId ID of the package
     */
    public void deletePackage(PackageId packageId){
     this.apiClient.deletePackage(packageId);
    }

    /**
     * Upload a package to webmate.
     *
     * @param projectId ProjectId where the package is uploaded to
     * @param appPackage Package to be uploaded as byte array
     * @param packageName Name of the package
     * @param extension file extension, e.g. apk or ipa
     * @return Package information for new package
     */
    public Package uploadApplicationPackage(ProjectId projectId, byte[] appPackage, String packageName, String extension) {
        String contentType = extension.equals("apk") ? "application/vnd.android.package-archive" : "application/x-ios-app";
        BlobId blobId = this.blobClient.putBlob(projectId, appPackage, Optional.of(contentType));
        return this.createPackage(projectId, blobId, packageName, extension);
    }

    /**
     * Upload a package to webmate.
     *
     * @param appPackage Package to be uploaded as byte array
     * @param packageName Name of the package
     * @param extension file extension, e.g. apk or ipa
     * @return Package information for new package
     */
    public Package uploadApplicationPackage(byte[] appPackage, String packageName, String extension) {
        Optional projectId = this.session.getProjectId();
        if (!projectId.isPresent()) {
            throw new WebmateApiClientException("No project id associated with webmate session.");
        }

        return this.uploadApplicationPackage(projectId.get(), appPackage, packageName, extension);
    }

    /**
     * Update a package in webmate with a new file.
     *
     * @param projectId ProjectId where the package is uploaded to
     * @param packageId PackageId of the package to update
     * @param appPackage Package to be uploaded as byte array
     * @param packageName Name of the package
     * @param extension file extension, e.g. apk or ipa
     * @return Package information for new package
     */
    public Package updateApplicationPackage(ProjectId projectId, PackageId packageId, byte[] appPackage, String packageName, String extension) {
        String contentType = extension.equals("apk") ? "application/vnd.android.package-archive" : "application/x-ios-app";
        BlobId blobId = this.blobClient.putBlob(projectId, appPackage, Optional.of(contentType));
        return this.updatePackage(packageId, blobId, packageName, extension);
    }

    /**
     * Update a package in webmate with a new file.
     *
     * @param packageId PackageId of the package to update
     * @param appPackage Package to be uploaded as byte array
     * @param packageName Name of the package
     * @param extension file extension, e.g. apk or ipa
     * @return Package information for new package
     */
    public Package updateApplicationPackage(PackageId packageId, byte[] appPackage, String packageName, String extension) {
        Optional projectId = this.session.getProjectId();
        if (!projectId.isPresent()) {
            throw new WebmateApiClientException("No project id associated with webmate session.");
        }

        return this.updateApplicationPackage(projectId.get(), packageId, appPackage, packageName, extension);
    }


    /**
     * Wait for a newly created package to be usable. Timeouts after 10 minutes.
     *
     * @param packageId PackageId of the package
     * @return the package that is being waited for
     */
    public Package waitForPackage(PackageId packageId) {
        return this.apiClient.waitForPackage(packageId);
    }

    /**
     * Wait for a newly created package to be usable.
     *
     * @param packageId PackageId of the package
     * @param maxWaitingTimeInMilliSeconds How long to wait before timeout
     * @return the package that is being waited for
     */
    public Package waitForPackage(PackageId packageId, long maxWaitingTimeInMilliSeconds) {
        return this.apiClient.waitForPackage(packageId, maxWaitingTimeInMilliSeconds);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy