car-test-lib/src/android/car/test/mocks/JavaMockitoHelper.java

/*
 * Copyright (C) 2020 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 android.car.test.mocks;

import android.annotation.NonNull;
import android.util.Log;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;

/**
 * Provides common Mockito calls for core Java classes.
 */
public final class JavaMockitoHelper {

    private static final String TAG = JavaMockitoHelper.class.getSimpleName();

    /**
     * Waits for a latch to be counted down.
     *
     * @param timeoutMs how long to wait for
     *
     * @throws {@link IllegalStateException} if it times out.
     */
    public static void await(@NonNull CountDownLatch latch, long timeoutMs)
            throws InterruptedException {
        if (!latch.await(timeoutMs, TimeUnit.MILLISECONDS)) {
            throw new IllegalStateException(latch + " not called in " + timeoutMs + " ms");
        }
    }

    /**
     * Waits for a semaphore.
     *
     * @param timeoutMs how long to wait for
     *
     * @throws {@link IllegalStateException} if it times out.
     */
    public static void await(@NonNull Semaphore semaphore, long timeoutMs)
            throws InterruptedException {
        if (!semaphore.tryAcquire(timeoutMs, TimeUnit.MILLISECONDS)) {
            throw new IllegalStateException(semaphore + " not released in " + timeoutMs + " ms");
        }
    }

    /**
     * Silently waits for a latch to be counted down, without throwing any exception if it isn't.
     *
     * @param timeoutMs how long to wait for
     *
     * @return whether the latch was counted down.
     */
    public static boolean silentAwait(@NonNull CountDownLatch latch, long timeoutMs) {
        boolean called;
        try {
            called = latch.await(timeoutMs, TimeUnit.MILLISECONDS);
            if (!called) {
                Log.w(TAG, latch + " not called in " + timeoutMs + " ms");
            }
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
            Log.w(TAG, latch + " interrupted", e);
            return false;
        }
        return called;
    }

    private JavaMockitoHelper() {
        throw new UnsupportedOperationException("contains only static methods");
    }
}