177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk/* 277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * Copyright (C) 2017 The Android Open Source Project 377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * 477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * except in compliance with the License. You may obtain a copy of the License at 677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * 777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * http://www.apache.org/licenses/LICENSE-2.0 877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * 977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * Unless required by applicable law or agreed to in writing, software distributed under the 1077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 1177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * KIND, either express or implied. See the License for the specific language governing 1277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * permissions and limitations under the License. 1377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk */ 1477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 1577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkpackage android.testing; 1677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 1777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkimport static org.mockito.Mockito.mock; 1877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkimport static org.mockito.Mockito.withSettings; 1977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 2077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkimport android.content.Context; 2177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkimport android.content.res.Resources; 2277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkimport android.util.Log; 2377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkimport android.util.SparseArray; 2477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 2577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkimport org.mockito.invocation.InvocationOnMock; 2677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 2777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk/** 2877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * Provides a version of Resources that defaults to all existing resources, but can have ids 2977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * changed to return specific values. 3077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * <p> 3177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * TestableResources are lazily initialized, be sure to call 3277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * {@link TestableContext#ensureTestableResources} before your tested code has an opportunity 3377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * to cache {@link Context#getResources}. 3477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * </p> 3577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk */ 3677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monkpublic class TestableResources { 3777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 3877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk private static final String TAG = "TestableResources"; 3977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk private final Resources mResources; 4077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk private final SparseArray<Object> mOverrides = new SparseArray<>(); 4177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 42e1856fe710e0a0b88087269ac77db453d2f8337eAdrian Roos /** Creates a TestableResources instance that calls through to the given real Resources. */ 43e1856fe710e0a0b88087269ac77db453d2f8337eAdrian Roos public TestableResources(Resources realResources) { 4477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk mResources = mock(Resources.class, withSettings() 4577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk .spiedInstance(realResources) 4677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk .defaultAnswer(this::answer)); 4777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } 4877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 4977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk /** 5077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * Gets the implementation of Resources that will return overridden values when called. 5177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk */ 5277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk public Resources getResources() { 5377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk return mResources; 5477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } 5577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 5677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk /** 5777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * Sets the return value for the specified resource id. 5877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * <p> 5977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * Since resource ids are unique there is a single addOverride that will override the value 6077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * whenever it is gotten regardless of which method is used (i.e. getColor or getDrawable). 6177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * </p> 6277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * @param id The resource id to be overridden 6377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * @param value The value of the resource, null to cause a {@link Resources.NotFoundException} 6477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * when gotten. 6577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk */ 6677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk public void addOverride(int id, Object value) { 6777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk mOverrides.put(id, value); 6877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } 6977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 7077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk /** 7177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * Removes the override for the specified id. 7277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * <p> 7377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * This should be called over addOverride(id, null), because specifying a null value will 7477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * cause a {@link Resources.NotFoundException} whereas removing the override will actually 7577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * switch back to returning the default/real value of the resource. 7677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * </p> 7777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk * @param id 7877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk */ 7977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk public void removeOverride(int id) { 8077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk mOverrides.remove(id); 8177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } 8277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk 8377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk private Object answer(InvocationOnMock invocationOnMock) throws Throwable { 8477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk try { 8577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk int id = invocationOnMock.getArgument(0); 8677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk int index = mOverrides.indexOfKey(id); 8777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk if (index >= 0) { 8877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk Object value = mOverrides.valueAt(index); 8977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk if (value == null) throw new Resources.NotFoundException(); 9077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk return value; 9177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } 9277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } catch (Resources.NotFoundException e) { 9377f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk // Let through NotFoundException. 9477f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk throw e; 9577f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } catch (Throwable t) { 9677f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk // Generic catching for the many things that can go wrong, fall back to 9777f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk // the real implementation. 9877f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk Log.i(TAG, "Falling back to default resources call " + t); 9977f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } 10077f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk return invocationOnMock.callRealMethod(); 10177f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk } 10277f1b05fb0eb1b0f22eb91508a1a3bc0cfcda935Jason Monk} 103