DatastoreTestBase.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.test.capedwarf.datastore.test;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import com.google.appengine.api.datastore.DatastoreService;
import com.google.appengine.api.datastore.DatastoreServiceFactory;
import com.google.appengine.api.datastore.Entity;
import com.google.appengine.api.datastore.EntityNotFoundException;
import com.google.appengine.api.datastore.FetchOptions;
import com.google.appengine.api.datastore.Key;
import com.google.appengine.api.datastore.KeyFactory;
import com.google.appengine.api.datastore.PreparedQuery;
import com.google.appengine.api.datastore.Query;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.jboss.test.capedwarf.common.test.TestBase;
import org.jboss.test.capedwarf.common.test.TestContext;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;

import static org.junit.Assert.fail;

/**
 * @author <a href="mailto:ales.justin@jboss.org">Ales Justin</a>
 * @author <a href="mailto:marko.luksa@gmail.com">Marko Luksa</a>
 */
public abstract class DatastoreTestBase extends TestBase {

    protected DatastoreService service;

    protected static WebArchive getDefaultDeployment() {
        return getCapedwarfDeployment().addClass(DatastoreTestBase.class);
    }

    protected static WebArchive getDefaultDeployment(TestContext context) {
        return getCapedwarfDeployment(context).addClass(DatastoreTestBase.class);
    }

    @Before
    public void setUp() {
        service = DatastoreServiceFactory.getDatastoreService();
    }

    @After
    public void tearDown() {
        List<Entity> entities = service.prepare(new Query().setKeysOnly()).asList(withDefaults());
        for (Entity entity : entities) {
            service.delete(entity.getKey());
        }
        service = null;
    }

    protected FetchOptions withDefaults() {
        return FetchOptions.Builder.withDefaults();
    }

    protected Collection<Key> extractKeys(Collection<Entity> entities) {
        List<Key> keys = new ArrayList<Key>();
        for (Entity entity : entities) {
            keys.add(entity.getKey());
        }
        return keys;
    }

    protected Collection<Entity> createTestEntities() {
        return Arrays.asList(createTestEntity("One", 1), createTestEntity("Two", 2), createTestEntity("Three", 3));
    }

    protected void assertStoreContainsAll(Collection<Entity> entities) throws EntityNotFoundException {
        for (Entity entity : entities) {
            assertStoreContains(entity);
        }
    }

    protected void assertStoreContains(Entity entity) throws EntityNotFoundException {
        Entity lookup = service.get(entity.getKey());
        Assert.assertNotNull(lookup);
        Assert.assertEquals(entity, lookup);
    }

    protected void assertStoreDoesNotContain(Entity entity) throws EntityNotFoundException {
        assertStoreDoesNotContain(entity.getKey());
    }

    protected void assertStoreDoesNotContain(Collection<Key> keys) throws EntityNotFoundException {
        for (Key key : keys) {
            assertStoreDoesNotContain(key);
        }
    }

    protected void assertStoreDoesNotContain(Key key) throws EntityNotFoundException {
        try {
            Entity storedEntity = service.get(key);
            Assert.fail("expected the datastore not to contain anything under key " + key + ", but it contained the entity " + storedEntity);
        } catch (EntityNotFoundException e) {
            // pass
        }
    }

    protected Entity createTestEntity() {
        return createTestEntity("KIND");
    }

    protected Entity createTestEntity(String kind) {
        return createTestEntity(kind, 1);
    }

    protected Entity createTestEntity(String kind, int id) {
        Key key = KeyFactory.createKey(kind, id);
        Entity entity = new Entity(key);
        entity.setProperty("text", "Some text.");
        return entity;
    }

    protected void assertIAEWhenAccessingResult(PreparedQuery preparedQuery) {
        assertIAEWhenAccessingList(preparedQuery);
        assertIAEWhenAccessingIterator(preparedQuery);
        assertIAEWhenAccessingIterable(preparedQuery);
        assertIAEWhenGettingSingleEntity(preparedQuery);
    }

    private void assertIAEWhenAccessingList(PreparedQuery preparedQuery) {
        List<Entity> list = preparedQuery.asList(withDefaults());
        try {
            list.size();
            fail("Expected IllegalArgumentException");
        } catch (IllegalArgumentException ex) {
            // pass
        }
    }

    private void assertIAEWhenAccessingIterator(PreparedQuery preparedQuery) {
        Iterator<Entity> iterator = preparedQuery.asIterator();
        try {
            iterator.hasNext();
            fail("Expected IllegalArgumentException");
        } catch (IllegalArgumentException ex) {
            // pass
        }
    }

    private void assertIAEWhenAccessingIterable(PreparedQuery preparedQuery) {
        Iterator<Entity> iterator2 = preparedQuery.asIterable().iterator();
        try {
            iterator2.hasNext();
            fail("Expected IllegalArgumentException");
        } catch (IllegalArgumentException ex) {
            // pass
        }
    }

    private void assertIAEWhenGettingSingleEntity(PreparedQuery preparedQuery) {
        try {
            preparedQuery.asSingleEntity();
            fail("Expected IllegalArgumentException");
        } catch (IllegalArgumentException ex) {
            // pass
        }
    }
}