DeviceFarmUtils.java

/*
 * Copyright 2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.amazonaws.devicefarm;

import com.amazonaws.devicefarm.extension.DeviceFarmExtension;
import com.amazonaws.services.devicefarm.AWSDeviceFarmClient;
import com.amazonaws.services.devicefarm.model.*;

import java.util.ArrayList;
import java.util.List;

/**
 * Contains collection of helper functions for common AWS Device Farm actions.
 */
public class DeviceFarmUtils {

    private final DeviceFarmExtension extension;
    private final AWSDeviceFarmClient api;

    public DeviceFarmUtils(final AWSDeviceFarmClient api, final DeviceFarmExtension extension) {
        this.extension = extension;
        this.api = api;
    }

    /**
     * Get all Device Farm projects.
     * @return A List of the Device Farm projects.
     */
    public List<Project> getProjects() {

        final ListProjectsResult result = api.listProjects(new ListProjectsRequest());

        if (result == null) {
            return new ArrayList<>();
        } else {
            return result.getProjects();
        }
    }

    /**
     * Get Device Farm project by name.
     * @param projectName String name of the Device Farm project.
     * @return The Device Farm project.
     */
    public Project findProjectByName(final String projectName) {

        for (Project p : getProjects()) {
            if (p.getName().equals(projectName)) {
                return p;
            }
        }

        throw new DeviceFarmException(String.format("Project '%s' not found.", projectName));
    }

    /**
     * Get Device Farm device pools for a given Device Farm project.
     * @param project Device Farm Project.
     * @return A List of the Device Farm device pools.
     */
    public List<DevicePool> getDevicePools(final Project project) {

        final ListDevicePoolsResult poolsResult = api.listDevicePools(new ListDevicePoolsRequest().withArn(project.getArn()));

        return poolsResult.getDevicePools();
    }

    /**
     * Get Device Farm device pool by Device Farm project and device pool name.
     * @param project The Device Farm project.
     * @param devicePoolName String name of the device pool.
     * @return The Device Farm device pool.
     */
    public DevicePool findDevicePoolByName(final Project project, final String devicePoolName) {

        final List<DevicePool> pools = getDevicePools(project);

        for (DevicePool dp : pools) {
            if (dp.getName().equals(devicePoolName)) {
                return dp;
            }
        }

        throw new DeviceFarmException(String.format("DevicePool '%s' not found.", devicePoolName));
    }


    /**
     * Get the Device Farm run URL from the Device Farm run ARN.
     * @param arn The Device Farm run ARN.
     * @return The Device Farm run URL.
     */
    public String getRunUrlFromArn(String arn) {
        String projectId = getProjectIdFromArn(arn);
        String runId = getRunIdFromArn(arn);
        return String.format(extension.getConsoleUrl(), projectId, runId);

    }

    /**
     * Get the Device Farm run ID from the Device Farm run ARN.
     * @param arn The Device Farm run ARN.
     * @return The Device Farm run ID.
     */
    public static String getRunIdFromArn(String arn) {
        String[] projectRunId = splitRunArn(arn);
        return projectRunId[1];
    }

    /**
     * Get the Device Farm project ID from the Device Farm run ARN.
     * @param arn The Device Farm run ARN.
     * @return The Device Farm project ID.
     */
    public static String getProjectIdFromArn(String arn) {
        String[] projectRunId = splitRunArn(arn);
        return projectRunId[0];
    }

    /**
     * Split the run ARN into Device Farm run and project IDs.
     * @param arn The Device Farm run ARN.
     * @return An array containing the run and project IDs.
     */
    public static String[] splitRunArn(String arn) {
        // The stuff we care about is in the 7th slot (index = 6)
        return arn.split(":")[6].split("/");
    }
}