ddmlib/src/test/java/com/android/ddmlib/PropertyFetcherTest.java

/*
 * 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.ddmlib;

import com.android.ddmlib.PropertyFetcher.GetPropReceiver;

import junit.framework.TestCase;

import org.easymock.EasyMock;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

public class PropertyFetcherTest extends TestCase {
    static final String GETPROP_RESPONSE =
            "\n[ro.sf.lcd_density]: [480]\n" +
            "[ro.secure]: [1]\r\n";

    /**
     * Simple test to ensure parsing result of 'shell getprop' works as expected
     */
    public void testGetPropReceiver() {
        GetPropReceiver receiver = new GetPropReceiver();
        byte[] byteData = GETPROP_RESPONSE.getBytes();
        receiver.addOutput(byteData, 0, byteData.length);
        assertEquals("480", receiver.getCollectedProperties().get("ro.sf.lcd_density"));
    }

    /**
     * Test that getProperty works as expected when queries made in different states
     */
    public void testGetProperty() throws Exception {
        IDevice mockDevice = DeviceTest.createMockDevice();
        DeviceTest.injectShellResponse(mockDevice, GETPROP_RESPONSE);
        EasyMock.replay(mockDevice);

        PropertyFetcher fetcher = new PropertyFetcher(mockDevice);
        // do query in unpopulated state
        Future<String> unpopulatedFuture = fetcher.getProperty("ro.sf.lcd_density");
        // do query in fetching state
        Future<String> fetchingFuture = fetcher.getProperty("ro.secure");

        assertEquals("480", unpopulatedFuture.get());
        // do queries with short timeout to ensure props already available
        assertEquals("1", fetchingFuture.get(1, TimeUnit.MILLISECONDS));
        assertEquals("480", fetcher.getProperty("ro.sf.lcd_density").get(1,
                TimeUnit.MILLISECONDS));
    }

    /**
     * Test that getProperty always does a getprop query when requested prop is not
     * read only aka volatile
     */
    public void testGetProperty_volatile() throws Exception {
        IDevice mockDevice = DeviceTest.createMockDevice();
        DeviceTest.injectShellResponse(mockDevice, "[dev.bootcomplete]: [0]\r\n");
        DeviceTest.injectShellResponse(mockDevice, "[dev.bootcomplete]: [1]\r\n");
        EasyMock.replay(mockDevice);

        PropertyFetcher fetcher = new PropertyFetcher(mockDevice);
        assertEquals("0", fetcher.getProperty("dev.bootcomplete").get());
        assertEquals("1", fetcher.getProperty("dev.bootcomplete").get());
    }

    /**
     * Test that getProperty returns when the 'shell getprop' command response is invalid
     */
    public void testGetProperty_badResponse() throws Exception {
        IDevice mockDevice = DeviceTest.createMockDevice();
        DeviceTest.injectShellResponse(mockDevice, "blargh");
        EasyMock.replay(mockDevice);

        PropertyFetcher fetcher = new PropertyFetcher(mockDevice);
        assertNull(fetcher.getProperty("dev.bootcomplete").get());
    }

    /**
     * Test that null is returned when querying an unknown property
     */
    public void testGetProperty_unknown() throws Exception {
        IDevice mockDevice = DeviceTest.createMockDevice();
        DeviceTest.injectShellResponse(mockDevice, GETPROP_RESPONSE);
        EasyMock.replay(mockDevice);

        PropertyFetcher fetcher = new PropertyFetcher(mockDevice);
        assertNull(fetcher.getProperty("unknown").get());
    }

    /**
     * Test that getProperty propagates exception thrown by 'shell getprop'
     */
    public void testGetProperty_shellException() throws Exception {
        IDevice mockDevice = DeviceTest.createMockDevice();
        DeviceTest.injectShellExceptionResponse(mockDevice, new ShellCommandUnresponsiveException());
        EasyMock.replay(mockDevice);

        PropertyFetcher fetcher = new PropertyFetcher(mockDevice);
        try {
            fetcher.getProperty("dev.bootcomplete").get();
            fail("ExecutionException not thrown");
        } catch (ExecutionException e) {
            // expected
            assertTrue(e.getCause() instanceof ShellCommandUnresponsiveException);
        }
    }

    /**
     * Tests that property fetcher works under the following scenario:
     * <ol>
     * <li>first fetch fails due to a shell exception</li>
     * <li>subsequent fetches should work fine</li>
     * </ol>
     */
    public void testGetProperty_FetchAfterException() throws Exception {
        IDevice mockDevice = DeviceTest.createMockDevice();
        DeviceTest.injectShellExceptionResponse(mockDevice, new ShellCommandUnresponsiveException());
        DeviceTest.injectShellResponse(mockDevice, GETPROP_RESPONSE);
        EasyMock.replay(mockDevice);

        PropertyFetcher fetcher = new PropertyFetcher(mockDevice);
        try {
            fetcher.getProperty("dev.bootcomplete").get(2, TimeUnit.SECONDS);
            fail("ExecutionException not thrown");
        } catch (ExecutionException e) {
            // expected
            assertTrue(e.getCause() instanceof ShellCommandUnresponsiveException);
        }

        assertEquals("480", fetcher.getProperty("ro.sf.lcd_density").get(2, TimeUnit.SECONDS));
    }

    /**
     * Tests that property fetcher works under the following scenario:
     * <ol>
     * <li>first fetch succeeds, but receives an empty response</li>
     * <li>subsequent fetches should work fine</li>
     * </ol>
     */
    public void testGetProperty_FetchAfterEmptyResponse() throws Exception {
        IDevice mockDevice = DeviceTest.createMockDevice();
        DeviceTest.injectShellResponse(mockDevice, "");
        DeviceTest.injectShellResponse(mockDevice, GETPROP_RESPONSE);
        EasyMock.replay(mockDevice);

        PropertyFetcher fetcher = new PropertyFetcher(mockDevice);
        assertNull(fetcher.getProperty("ro.sf.lcd_density").get(2, TimeUnit.SECONDS));
        assertEquals("480", fetcher.getProperty("ro.sf.lcd_density").get(2, TimeUnit.SECONDS));
    }
}