aboutsummaryrefslogtreecommitdiff
path: root/src/com/android/tradefed/targetprep/companion/CompanionAllocator.java
blob: ad33ff9187d6cdb25bb84a6bc0e9d5bf56fda153 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * 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.android.tradefed.targetprep.companion;

import com.android.tradefed.build.IBuildInfo;
import com.android.tradefed.device.DeviceNotAvailableException;
import com.android.tradefed.device.DeviceSelectionOptions;
import com.android.tradefed.device.ITestDevice;
import com.android.tradefed.targetprep.BuildError;
import com.android.tradefed.targetprep.ITargetCleaner;
import com.android.tradefed.targetprep.TargetSetupError;

/**
 * Base class that takes care of allocating and freeing companion device
 * <p>
 * {@link #getCompanionDeviceSelectionOptions()} should be implemented to describe the criteria
 * needed to allocate the companion device
 */
public abstract class CompanionAllocator implements ITargetCleaner {

    /**
     * Sets up the device.
     * <p>
     * Internal implementation of this method will request a companion device, and allocate it.
     */
    @Override
    public void setUp(ITestDevice device, IBuildInfo buildInfo) throws TargetSetupError,
            BuildError, DeviceNotAvailableException {
        ITestDevice companionDevice = getCompanionDeviceTracker().allocateCompanionDevice(
                device, getCompanionDeviceSelectionOptions());
        if (companionDevice == null) {
            throw new TargetSetupError(String.format("failed to allocate companion device for %s",
                    device.getSerialNumber()), device.getDeviceDescriptor());
        }
    }

    /**
     * Describe the {@link DeviceSelectionOptions} for the companion device
     */
    protected abstract DeviceSelectionOptions getCompanionDeviceSelectionOptions();

    @Override
    public void tearDown(ITestDevice device, IBuildInfo buildInfo, Throwable e)
            throws DeviceNotAvailableException {
        getCompanionDeviceTracker().freeCompanionDevice(device);
    }

    private CompanionDeviceTracker getCompanionDeviceTracker() {
        return CompanionDeviceTracker.getInstance();
    }
}