1 /*
2  * Copyright (C) 2008 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.test.mock;
18 
19 import android.content.ContentProvider;
20 import android.content.ContentResolver;
21 import android.content.Context;
22 import android.content.IContentProvider;
23 import android.database.ContentObserver;
24 import android.net.Uri;
25 
26 import com.google.android.collect.Maps;
27 
28 import java.util.Map;
29 
30 /**
31  * <p>
32  *      An extension of {@link android.content.ContentResolver} that is designed for
33  *      testing.
34  * </p>
35  * <p>
36  *      MockContentResolver overrides Android's normal way of resolving providers by
37  *      authority. To have access to a provider based on its authority, users of
38  *      MockContentResolver first instantiate the provider and
39  *      use {@link MockContentResolver#addProvider(String, ContentProvider)}. Resolution of an
40  *      authority occurs entirely within MockContentResolver.
41  * </p>
42  * <p>
43  *      Users can also set an authority's entry in the map to null, so that a provider is completely
44  *      mocked out.
45  * </p>
46  *
47  * <div class="special reference">
48  * <h3>Developer Guides</h3>
49  * <p>For more information about application testing, read the
50  * <a href="{@docRoot}guide/topics/testing/index.html">Testing</a> developer guide.</p>
51  * </div>
52  */
53 
54 public class MockContentResolver extends ContentResolver {
55     Map<String, ContentProvider> mProviders;
56 
57     /**
58      * Creates a local map of providers. This map is used instead of the global
59      * map when an API call tries to acquire a provider.
60      */
MockContentResolver()61     public MockContentResolver() {
62         this(null);
63     }
64 
65     /**
66      * Creates a local map of providers. This map is used instead of the global
67      * map when an API call tries to acquire a provider.
68      */
MockContentResolver(Context context)69     public MockContentResolver(Context context) {
70         super(context);
71         mProviders = Maps.newHashMap();
72     }
73 
74     /**
75      * Adds access to a provider based on its authority
76      *
77      * @param name The authority name associated with the provider.
78      * @param provider An instance of {@link android.content.ContentProvider} or one of its
79      * subclasses, or null.
80      */
addProvider(String name, ContentProvider provider)81     public void addProvider(String name, ContentProvider provider) {
82 
83         /*
84          * Maps the authority to the provider locally.
85          */
86         mProviders.put(name, provider);
87     }
88 
89     /** @hide */
90     @Override
acquireProvider(Context context, String name)91     protected IContentProvider acquireProvider(Context context, String name) {
92         return acquireExistingProvider(context, name);
93     }
94 
95     /** @hide */
96     @Override
acquireExistingProvider(Context context, String name)97     protected IContentProvider acquireExistingProvider(Context context, String name) {
98 
99         /*
100          * Gets the content provider from the local map
101          */
102         final ContentProvider provider = mProviders.get(name);
103 
104         if (provider != null) {
105             return provider.getIContentProvider();
106         } else {
107             return null;
108         }
109     }
110 
111     /** @hide */
112     @Override
releaseProvider(IContentProvider provider)113     public boolean releaseProvider(IContentProvider provider) {
114         return true;
115     }
116 
117     /** @hide */
118     @Override
acquireUnstableProvider(Context c, String name)119     protected IContentProvider acquireUnstableProvider(Context c, String name) {
120         return acquireProvider(c, name);
121     }
122 
123     /** @hide */
124     @Override
releaseUnstableProvider(IContentProvider icp)125     public boolean releaseUnstableProvider(IContentProvider icp) {
126         return releaseProvider(icp);
127     }
128 
129     /** @hide */
130     @Override
unstableProviderDied(IContentProvider icp)131     public void unstableProviderDied(IContentProvider icp) {
132     }
133 
134     /**
135      * Overrides {@link android.content.ContentResolver#notifyChange(Uri, ContentObserver, boolean)
136      * ContentResolver.notifChange(Uri, ContentObserver, boolean)}. All parameters are ignored.
137      * The method hides providers linked to MockContentResolver from other observers in the system.
138      *
139      * @param uri (Ignored) The uri of the content provider.
140      * @param observer (Ignored) The observer that originated the change.
141      * @param syncToNetwork (Ignored) If true, attempt to sync the change to the network.
142      */
143     @Override
notifyChange(Uri uri, ContentObserver observer, boolean syncToNetwork)144     public void notifyChange(Uri uri,
145             ContentObserver observer,
146             boolean syncToNetwork) {
147     }
148 }
149