Create tests and improve docs on AttachmentProvider

No change in functionality.  Just getting a test infrastructure in place
before rewriting to use new EmailProvider.  Provides tests for:

* get type (raw & thumb)
* open file (raw)
* open file (thumb)
* query
* resolveAttachmentIdToContentUri
This commit is contained in:
Andrew Stadler 2009-07-27 11:20:15 -07:00
parent 9502c241a2
commit 301ac18bb7
2 changed files with 548 additions and 2 deletions

View File

@ -40,7 +40,9 @@ import java.util.List;
* A simple ContentProvider that allows file access to Email's attachments.
*/
public class AttachmentProvider extends ContentProvider {
public static final Uri CONTENT_URI = Uri.parse( "content://com.android.email.attachmentprovider");
public static final String AUTHORITY = "com.android.email.attachmentprovider";
public static final Uri CONTENT_URI = Uri.parse( "content://" + AUTHORITY);
private static final String FORMAT_RAW = "RAW";
private static final String FORMAT_THUMBNAIL = "THUMBNAIL";
@ -95,6 +97,12 @@ public class AttachmentProvider extends ContentProvider {
return true;
}
/**
* Returns the mime type for a given attachment. There are three possible results:
* - If thumbnail Uri, always returns "image/png" (even if there's no attachment)
* - If the attachment does not exist, returns null
* - Returns the mime type of the attachment
*/
@Override
public String getType(Uri uri) {
List<String> segments = uri.getPathSegments();
@ -137,6 +145,17 @@ public class AttachmentProvider extends ContentProvider {
}
}
/**
* Open an attachment file. There are two "modes" - "raw", which returns an actual file,
* and "thumbnail", which attempts to generate a thumbnail image.
*
* Thumbnails are cached for easy space recovery and cleanup.
*
* TODO: The thumbnail mode returns null for its failure cases, instead of throwing
* FileNotFoundException, and should be fixed for consistency.
*
* @throws FileNotFoundException
*/
@Override
public ParcelFileDescriptor openFile(Uri uri, String mode) throws FileNotFoundException {
List<String> segments = uri.getPathSegments();
@ -196,6 +215,16 @@ public class AttachmentProvider extends ContentProvider {
return null;
}
/**
* Returns a cursor based on the data in the attachments table, or null if the attachment
* is not recorded in the table.
*
* Supports REST Uri only, for a single row - selection, selection args, and sortOrder are
* ignored (non-null values should probably throw an exception....)
*
* TODO: Throws an SQLite exception on a missing DB file (e.g. unknown URI) instead of just
* returning null, as it should.
*/
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
String sortOrder) {
@ -295,10 +324,14 @@ public class AttachmentProvider extends ContentProvider {
}
}
/**
* Resolve attachment id to content URI.
* Resolve attachment id to content URI. Returns the resolved content URI (from the attachment
* DB) or, if not found, simply returns the incoming value.
*
* @param attachmentUri
* @return resolved content URI
*
* TODO: Throws an SQLite exception on a missing DB file (e.g. unknown URI) instead of just
* returning the incoming uri, as it should.
*/
public static Uri resolveAttachmentIdToContentUri(ContentResolver resolver, Uri attachmentUri) {
Cursor c = resolver.query(attachmentUri,

View File

@ -0,0 +1,513 @@
/*
* Copyright (C) 2009 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.email.provider;
import com.android.email.R;
import com.android.email.mail.MessagingException;
import com.android.email.mail.store.LocalStore;
import com.android.email.provider.AttachmentProvider.AttachmentProviderColumns;
import com.android.email.provider.EmailContent.Account;
import com.android.email.provider.EmailContent.Attachment;
import android.content.ContentResolver;
import android.content.ContentValues;
import android.content.Context;
import android.content.res.AssetFileDescriptor;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteException;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.net.Uri;
import android.test.ProviderTestCase2;
import android.test.mock.MockContentResolver;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
/**
* Tests of the Email Attachments provider.
*
* You can run this entire test case with:
* runtest -c com.android.email.provider.AttachmentProviderTests email
*/
public class AttachmentProviderTests extends ProviderTestCase2<AttachmentProvider> {
/*
* This switch will enable us to transition these tests, and the AttachmentProvider, from the
* "old" LocalStore model to the "new" provider model. After the transition is complete,
* this flag (and its associated code) can be removed.
*/
private final boolean USE_LOCALSTORE = true;
LocalStore mLocalStore = null;
EmailProvider mEmailProvider;
Context mMockContext;
ContentResolver mMockResolver;
public AttachmentProviderTests() {
super(AttachmentProvider.class, AttachmentProvider.AUTHORITY);
}
@Override
public void setUp() throws Exception {
super.setUp();
mMockContext = getMockContext();
mMockResolver = mMockContext.getContentResolver();
// Spin up an Email provider as well and put it under the same mock test framework
mEmailProvider = new EmailProvider();
mEmailProvider.attachInfo(mMockContext, null);
assertNotNull(mEmailProvider);
((MockContentResolver) mMockResolver)
.addProvider(EmailProvider.EMAIL_AUTHORITY, mEmailProvider);
}
@Override
public void tearDown() throws Exception {
super.tearDown();
if (mLocalStore != null) {
mLocalStore.delete();
}
}
/**
* test delete() - should do nothing
* test update() - should do nothing
* test insert() - should do nothing
*/
public void testUnimplemented() {
assertEquals(0, mMockResolver.delete(AttachmentProvider.CONTENT_URI, null, null));
assertEquals(0, mMockResolver.update(AttachmentProvider.CONTENT_URI, null, null, null));
assertEquals(null, mMockResolver.insert(AttachmentProvider.CONTENT_URI, null));
}
/**
* test query()
* - item found
* - item not found
* - permuted projection
*/
public void testQuery() throws MessagingException {
Account account1 = ProviderTestUtils.setupAccount("attachment-query", false, mMockContext);
account1.mCompatibilityUuid = "test-UUID";
account1.save(mMockContext);
final long message1Id = 1;
long attachment1Id = 1;
long attachment2Id = 2;
long attachment3Id = 3;
// Note: There is an implicit assumption in this test sequence that the first
// attachment we add will be id=1 and the 2nd will have id=2. This could fail on
// a legitimate implementation. Asserts below will catch this and fail the test
// if necessary.
Uri attachment1Uri = AttachmentProvider.getAttachmentUri(account1, attachment1Id);
Uri attachment2Uri = AttachmentProvider.getAttachmentUri(account1, attachment2Id);
Uri attachment3Uri = AttachmentProvider.getAttachmentUri(account1, attachment3Id);
// Test with no attached database - should return null, but throws SQLiteException
Cursor c;
try {
c = mMockResolver.query(attachment1Uri, (String[])null, null, (String[])null, null);
fail("Should throw an exception on a bad URI");
} catch (SQLiteException sqe) {
// expected
}
// Test with an attached database, but no attachment found - should return null
setupAttachmentDatabase(account1);
c = mMockResolver.query(attachment1Uri, (String[])null, null, (String[])null, null);
assertNull(c);
// Add a couple of attachment entries. Note, query() just uses the DB, and does not
// sample the files, so we won't bother creating the files
Attachment newAttachment1 = ProviderTestUtils.setupAttachment(message1Id, "file1", 100,
false, mMockContext);
newAttachment1.mContentUri =
AttachmentProvider.getAttachmentUri(account1, attachment1Id).toString();
attachment1Id = addAttachmentToDb(account1, newAttachment1);
assertEquals("Broken test: Unexpected id assignment", 1, attachment1Id);
Attachment newAttachment2 = ProviderTestUtils.setupAttachment(message1Id, "file2", 200,
false, mMockContext);
newAttachment2.mContentUri =
AttachmentProvider.getAttachmentUri(account1, attachment2Id).toString();
attachment2Id = addAttachmentToDb(account1, newAttachment2);
assertEquals("Broken test: Unexpected id assignment", 2, attachment2Id);
Attachment newAttachment3 = ProviderTestUtils.setupAttachment(message1Id, "file3", 300,
false, mMockContext);
newAttachment3.mContentUri =
AttachmentProvider.getAttachmentUri(account1, attachment3Id).toString();
attachment3Id = addAttachmentToDb(account1, newAttachment3);
assertEquals("Broken test: Unexpected id assignment", 3, attachment3Id);
// Return a row with all columns specified
attachment2Uri = AttachmentProvider.getAttachmentUri(account1, attachment2Id);
c = mMockResolver.query(
attachment2Uri,
new String[] { AttachmentProviderColumns._ID, AttachmentProviderColumns.DATA,
AttachmentProviderColumns.DISPLAY_NAME,
AttachmentProviderColumns.SIZE },
null, null, null);
assertEquals(1, c.getCount());
assertTrue(c.moveToFirst());
assertEquals(attachment2Id, c.getLong(0)); // id
assertEquals(attachment2Uri.toString(), c.getString(1)); // content URI
assertEquals("file2", c.getString(2)); // display name
assertEquals(200, c.getInt(3)); // size
// Return a row with permuted columns
attachment3Uri = AttachmentProvider.getAttachmentUri(account1, attachment3Id);
c = mMockResolver.query(
attachment3Uri,
new String[] { AttachmentProviderColumns.SIZE,
AttachmentProviderColumns.DISPLAY_NAME,
AttachmentProviderColumns.DATA, AttachmentProviderColumns._ID },
null, null, null);
assertEquals(1, c.getCount());
assertTrue(c.moveToFirst());
assertEquals(attachment3Id, c.getLong(3)); // id
assertEquals(attachment3Uri.toString(), c.getString(2)); // content URI
assertEquals("file3", c.getString(1)); // display name
assertEquals(300, c.getInt(0)); // size
}
/**
* test getType()
* - regular file
* - thumbnail
*/
public void testGetType() throws MessagingException {
Account account1 = ProviderTestUtils.setupAccount("get-type", false, mMockContext);
account1.mCompatibilityUuid = "test-UUID";
account1.save(mMockContext);
final long message1Id = 1;
long attachment1Id = 1;
long attachment2Id = 2;
long attachment3Id = 3;
Uri attachment1Uri = AttachmentProvider.getAttachmentUri(account1, attachment1Id);
// Test with no attached database - should return null
String type = mMockResolver.getType(attachment1Uri);
assertNull(type);
// Test with an attached database, but no attachment found - should return null
setupAttachmentDatabase(account1);
type = mMockResolver.getType(attachment1Uri);
assertNull(type);
// Add a couple of attachment entries. Note, getType() just uses the DB, and does not
// sample the files, so we won't bother creating the files
Attachment newAttachment2 = ProviderTestUtils.setupAttachment(message1Id, "file2", 100,
false, mMockContext);
newAttachment2.mMimeType = "image/jpg";
attachment2Id = addAttachmentToDb(account1, newAttachment2);
Attachment newAttachment3 = ProviderTestUtils.setupAttachment(message1Id, "file3", 100,
false, mMockContext);
newAttachment2.mMimeType = "text/plain";
attachment3Id = addAttachmentToDb(account1, newAttachment2);
// Check the returned filetypes
Uri uri = AttachmentProvider.getAttachmentUri(account1, attachment2Id);
type = mMockResolver.getType(uri);
assertEquals("image/jpg", type);
uri = AttachmentProvider.getAttachmentUri(account1, attachment3Id);
type = mMockResolver.getType(uri);
assertEquals("text/plain", type);
// Check the returned filetypes for the thumbnails
uri = AttachmentProvider.getAttachmentThumbnailUri(account1, attachment2Id, 62, 62);
type = mMockResolver.getType(uri);
assertEquals("image/png", type);
uri = AttachmentProvider.getAttachmentThumbnailUri(account1, attachment3Id, 62, 62);
type = mMockResolver.getType(uri);
assertEquals("image/png", type);
}
/**
* test openFile()
* - regular file
* - TODO: variations on the content URI
*/
public void testOpenFile() throws MessagingException, IOException {
Account account1 = ProviderTestUtils.setupAccount("open-file", false, mMockContext);
account1.mCompatibilityUuid = "test-UUID";
account1.save(mMockContext);
final long message1Id = 1;
long attachment1Id = 1;
long attachment2Id = 2;
// Note: There is an implicit assumption in this test sequence that the first
// attachment we add will be id=1 and the 2nd will have id=2. This could fail on
// a legitimate implementation. Asserts below will catch this and fail the test
// if necessary.
Uri file1Uri = AttachmentProvider.getAttachmentUri(account1, attachment1Id);
Uri file2Uri = AttachmentProvider.getAttachmentUri(account1, attachment2Id);
// Test with no attached database - should throw an exception
AssetFileDescriptor afd;
try {
afd = mMockResolver.openAssetFileDescriptor(file1Uri, "r");
fail("Should throw an exception on a bad URI");
} catch (FileNotFoundException fnf) {
// expected
}
// Test with an attached database, but no attachment found
setupAttachmentDatabase(account1);
try {
afd = mMockResolver.openAssetFileDescriptor(file1Uri, "r");
fail("Should throw an exception on a missing attachment entry");
} catch (FileNotFoundException fnf) {
// expected
}
// Add an attachment (but no associated file)
Attachment newAttachment = ProviderTestUtils.setupAttachment(message1Id, "file", 100,
false, mMockContext);
attachment1Id = addAttachmentToDb(account1, newAttachment);
assertEquals("Broken test: Unexpected id assignment", 1, attachment1Id);
// Test with an attached database, attachment entry found, but no attachment found
try {
afd = mMockResolver.openAssetFileDescriptor(file1Uri, "r");
fail("Should throw an exception on a missing attachment file");
} catch (FileNotFoundException fnf) {
// expected
}
// Create an "attachment" by copying an image resource into a file
/* String fileName = */ createAttachmentFile(account1, attachment2Id);
Attachment newAttachment2 = ProviderTestUtils.setupAttachment(message1Id, "file", 100,
false, mMockContext);
newAttachment2.mContentId = null;
newAttachment2.mContentUri =
AttachmentProvider.getAttachmentUri(account1, attachment2Id).toString();
newAttachment2.mMimeType = "image/png";
attachment2Id = addAttachmentToDb(account1, newAttachment2);
assertEquals("Broken test: Unexpected id assignment", 2, attachment2Id);
// Test with an attached database, attachment entry found - returns a file
afd = mMockResolver.openAssetFileDescriptor(file2Uri, "r");
assertNotNull(afd);
// TODO: Confirm it's the "right" file?
afd.close();
}
/**
* test openFile()
* - thumbnail
* @throws IOException
*
* TODO: The thumbnail mode returns null for its failure cases (and in one case, throws
* an SQLiteException). The ContentResolver contract requires throwing FileNotFoundException
* in all of the non-success cases, and the provider should be fixed for consistency.
*/
public void testOpenThumbnail() throws MessagingException, IOException {
Account account1 = ProviderTestUtils.setupAccount("open-thumbnail", false, mMockContext);
account1.mCompatibilityUuid = "test-UUID";
account1.save(mMockContext);
final long message1Id = 1;
long attachment1Id = 1;
long attachment2Id = 2;
// Note: There is an implicit assumption in this test sequence that the first
// attachment we add will be id=1 and the 2nd will have id=2. This could fail on
// a legitimate implementation. Asserts below will catch this and fail the test
// if necessary.
Uri thumb1Uri = AttachmentProvider.getAttachmentThumbnailUri(account1, attachment1Id,
62, 62);
Uri thumb2Uri = AttachmentProvider.getAttachmentThumbnailUri(account1, attachment2Id,
62, 62);
// Test with no attached database - should throw an exception
try {
/* AssetFileDescriptor afd = */ mMockResolver.openAssetFileDescriptor(thumb1Uri, "r");
fail("Should throw an exception on a bad URI");
} catch (SQLiteException sqe) {
// expected
}
// Test with an attached database, but no attachment found
setupAttachmentDatabase(account1);
AssetFileDescriptor afd = mMockResolver.openAssetFileDescriptor(thumb1Uri, "r");
assertNull(afd);
// Add an attachment (but no associated file)
Attachment newAttachment = ProviderTestUtils.setupAttachment(message1Id, "file", 100,
false, mMockContext);
attachment1Id = addAttachmentToDb(account1, newAttachment);
assertEquals("Broken test: Unexpected id assignment", 1, attachment1Id);
// Test with an attached database, attachment entry found, but no attachment found
afd = mMockResolver.openAssetFileDescriptor(thumb1Uri, "r");
assertNull(afd);
// Create an "attachment" by copying an image resource into a file
/* String fileName = */ createAttachmentFile(account1, attachment2Id);
Attachment newAttachment2 = ProviderTestUtils.setupAttachment(message1Id, "file", 100,
false, mMockContext);
newAttachment2.mContentId = null;
newAttachment2.mContentUri =
AttachmentProvider.getAttachmentUri(account1, attachment2Id).toString();
newAttachment2.mMimeType = "image/png";
attachment2Id = addAttachmentToDb(account1, newAttachment2);
assertEquals("Broken test: Unexpected id assignment", 2, attachment2Id);
// Test with an attached database, attachment entry found - returns a thumbnail
afd = mMockResolver.openAssetFileDescriptor(thumb2Uri, "r");
assertNotNull(afd);
// TODO: Confirm it's the "right" file?
afd.close();
}
/**
* test resolveAttachmentIdToContentUri()
* - not in DB
* - in DB
*/
public void testResolveAttachmentIdToContentUri() throws MessagingException {
Account account1 = ProviderTestUtils.setupAccount("attachment-query", false, mMockContext);
account1.mCompatibilityUuid = "test-UUID";
account1.save(mMockContext);
final long message1Id = 1;
long attachment1Id = 1;
// Note: There is an implicit assumption in this test sequence that the first
// attachment we add will be id=1 and the 2nd will have id=2. This could fail on
// a legitimate implementation. Asserts below will catch this and fail the test
// if necessary.
Uri attachment1Uri = AttachmentProvider.getAttachmentUri(account1, attachment1Id);
// Test with no attached database - should return null, but throws SQLiteException
try {
Uri result = AttachmentProvider.resolveAttachmentIdToContentUri(
mMockResolver, attachment1Uri);
fail("Expected an exception on a bad URI");
} catch (SQLiteException sqe) {
// expected
}
// Test with an attached database, but no attachment found - should return input
setupAttachmentDatabase(account1);
Uri result = AttachmentProvider.resolveAttachmentIdToContentUri(
mMockResolver, attachment1Uri);
assertEquals(attachment1Uri, result);
// Add an attachment entry. Note, resolveAttachmentIdToContentUri() just uses
// the DB, and does not sample the files, so we won't bother creating the files
Attachment newAttachment1 = ProviderTestUtils.setupAttachment(message1Id, "file1", 100,
false, mMockContext);
newAttachment1.mContentUri = "file:///path/to/file";
attachment1Id = addAttachmentToDb(account1, newAttachment1);
assertEquals("Broken test: Unexpected id assignment", 1, attachment1Id);
// When the attachment is found, return the stored content_uri value
result = AttachmentProvider.resolveAttachmentIdToContentUri(
mMockResolver, attachment1Uri);
assertEquals("file:///path/to/file", result.toString());
}
/**
* Create an attachment by copying an image resource into a file. Uses "real" resources
* to get a real image from Email
*/
private String createAttachmentFile(Account forAccount, long id) throws IOException {
File outFile = getAttachmentFile(forAccount, id);
Bitmap bitmap = BitmapFactory.decodeResource(getContext().getResources(),
R.drawable.ic_email_attachment);
FileOutputStream out = new FileOutputStream(outFile);
bitmap.compress(Bitmap.CompressFormat.PNG, 100, out);
out.close();
return outFile.getAbsolutePath();
}
/**
* Set up the attachments database.
*/
private void setupAttachmentDatabase(Account forAccount) throws MessagingException {
if (USE_LOCALSTORE) {
String localStoreUri = "local://localhost/" + dbName(forAccount);
mLocalStore = (LocalStore) LocalStore.newInstance(localStoreUri, mMockContext, null);
} else {
throw new java.lang.UnsupportedOperationException();
}
}
/**
* Record an attachment in the attachments database
* @return the id of the attachment just created
*/
private long addAttachmentToDb(Account forAccount, Attachment newAttachment) {
long attachmentId = -1;
if (USE_LOCALSTORE) {
ContentValues cv = new ContentValues();
cv.put("message_id", newAttachment.mMessageKey);
cv.put("content_uri", newAttachment.mContentUri);
cv.put("store_data", (String)null);
cv.put("size", newAttachment.mSize);
cv.put("name", newAttachment.mFileName);
cv.put("mime_type", newAttachment.mMimeType);
cv.put("content_id", newAttachment.mContentId);
SQLiteDatabase db = null;
try {
db = SQLiteDatabase.openDatabase(dbName(forAccount), null, 0);
attachmentId = db.insertOrThrow("attachments", "message_id", cv);
}
finally {
if (db != null) {
db.close();
}
}
} else {
throw new java.lang.UnsupportedOperationException();
}
return attachmentId;
}
/**
* Return the database path+name for a given account
*/
private String dbName(Account forAccount) {
if (USE_LOCALSTORE) {
return mMockContext.getDatabasePath(forAccount.mCompatibilityUuid + ".db").toString();
} else {
throw new java.lang.UnsupportedOperationException();
}
}
/**
* Map from account, attachment ID to attachment file
*/
private File getAttachmentFile(Account forAccount, long id) {
String idString = Long.toString(id);
if (USE_LOCALSTORE) {
return new File(mMockContext.getDatabasePath(forAccount.mCompatibilityUuid + ".db_att"),
idString);
} else {
throw new java.lang.UnsupportedOperationException();
}
}
}