view storage/core/src/test/java/com/redhat/thermostat/storage/internal/statement/PreparedStatementImplTest.java @ 1263:ac5c298a9dae

Implement support for prepared writes. Reviewed-by: omajid Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-September/008174.html
author Severin Gehwolf <sgehwolf@redhat.com>
date Tue, 03 Sep 2013 14:19:10 +0200
parents b4637cac2cbc
children e103fd511693
line wrap: on
line source

/*
 * Copyright 2012, 2013 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.storage.internal.statement;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import java.util.ArrayList;
import java.util.List;

import org.junit.Test;

import com.redhat.thermostat.common.Pair;
import com.redhat.thermostat.storage.core.Add;
import com.redhat.thermostat.storage.core.BackingStorage;
import com.redhat.thermostat.storage.core.Category;
import com.redhat.thermostat.storage.core.Cursor;
import com.redhat.thermostat.storage.core.Key;
import com.redhat.thermostat.storage.core.PreparedStatement;
import com.redhat.thermostat.storage.core.Query;
import com.redhat.thermostat.storage.core.Remove;
import com.redhat.thermostat.storage.core.Replace;
import com.redhat.thermostat.storage.core.StatementDescriptor;
import com.redhat.thermostat.storage.core.StatementExecutionException;
import com.redhat.thermostat.storage.core.Update;
import com.redhat.thermostat.storage.model.Pojo;
import com.redhat.thermostat.storage.query.BinaryComparisonExpression;
import com.redhat.thermostat.storage.query.BinaryComparisonOperator;
import com.redhat.thermostat.storage.query.Expression;
import com.redhat.thermostat.storage.query.LiteralExpression;

public class PreparedStatementImplTest {

    @Test
    public void failToSetIndexOutOfBounds() {
        PreparedStatementImpl<?> preparedStatement = new PreparedStatementImpl<>(2);
        preparedStatement.setInt(1, 3);
        preparedStatement.setString(0, "testing");
        try {
            preparedStatement.setLong(3, 1);
            fail("should have thrown exception");
        } catch (IllegalArgumentException e) {
            // pass
        }
        try {
            preparedStatement.setInt(4, 1);
            fail("should have thrown exception");
        } catch (IllegalArgumentException e) {
            // pass
        }
        try {
            preparedStatement.setString(10, "ignored");
            fail("should have thrown exception");
        } catch (IllegalArgumentException e) {
            // pass
        }
        try {
            preparedStatement.setStringList(3, new String[] { "ignored" });
            fail("should have thrown exception");
        } catch (IllegalArgumentException e) {
            // pass
        }
    }
    
    @Test
    public void canDoParsingPatchingAndExecution() throws Exception {
        String queryString = "QUERY foo WHERE 'a' = ?s";
        @SuppressWarnings("unchecked")
        StatementDescriptor<Pojo> desc = (StatementDescriptor<Pojo>) mock(StatementDescriptor.class);
        when(desc.getDescriptor()).thenReturn(queryString);
        @SuppressWarnings("unchecked")
        Category<Pojo> mockCategory = (Category<Pojo>) mock(Category.class);
        when(desc.getCategory()).thenReturn(mockCategory);
        when(mockCategory.getName()).thenReturn("foo");
        BackingStorage storage = mock(BackingStorage.class);
        StubQuery stmt = new StubQuery();
        when(storage.createQuery(mockCategory)).thenReturn(stmt);
        PreparedStatementImpl<Pojo> preparedStatement = new PreparedStatementImpl<>(storage, desc);
        preparedStatement.setString(0, "foo");
        preparedStatement.executeQuery();
        assertTrue(stmt.called);
        LiteralExpression<Key<String>> o1 = new LiteralExpression<>(new Key<String>("a"));
        LiteralExpression<String> o2 = new LiteralExpression<>("foo"); 
        BinaryComparisonExpression<String> binComp = new BinaryComparisonExpression<>(
                o1, BinaryComparisonOperator.EQUALS, o2);
        assertEquals(binComp, stmt.expr);
    }
    
    @Test
    public void canDoParsingPatchingAndExecutionForAdd() throws Exception {
        String addString = "ADD foo-table SET 'foo' = ?s";
        @SuppressWarnings("unchecked")
        StatementDescriptor<FooPojo> desc = (StatementDescriptor<FooPojo>) mock(StatementDescriptor.class);
        when(desc.getDescriptor()).thenReturn(addString);
        @SuppressWarnings("unchecked")
        Category<FooPojo> mockCategory = (Category<FooPojo>) mock(Category.class);
        when(desc.getCategory()).thenReturn(mockCategory);
        when(mockCategory.getDataClass()).thenReturn(FooPojo.class);
        when(mockCategory.getName()).thenReturn("foo-table");
        BackingStorage storage = mock(BackingStorage.class);
        TestAdd add = new TestAdd();
        when(storage.createAdd(mockCategory)).thenReturn(add);
        PreparedStatement<FooPojo> preparedStatement = new PreparedStatementImpl<FooPojo>(storage, desc);
        preparedStatement.setString(0, "foo-val");
        assertFalse(add.executed);
        try {
            // this should call add.apply();
            preparedStatement.execute();
        } catch (StatementExecutionException e) {
            fail(e.getMessage());
        }
        assertTrue(add.pojo != null);
        assertTrue(add.pojo instanceof FooPojo);
        assertTrue(add.executed);
        FooPojo fooPojo = (FooPojo)add.pojo;
        assertEquals("foo-val", fooPojo.getFoo());
    }
    
    @Test
    public void canDoParsingPatchingAndExecutionForUpdate() throws Exception {
        String addString = "UPDATE foo-table SET 'foo' = ?s WHERE 'foo' = ?s";
        @SuppressWarnings("unchecked")
        StatementDescriptor<FooPojo> desc = (StatementDescriptor<FooPojo>) mock(StatementDescriptor.class);
        when(desc.getDescriptor()).thenReturn(addString);
        @SuppressWarnings("unchecked")
        Category<FooPojo> mockCategory = (Category<FooPojo>) mock(Category.class);
        when(desc.getCategory()).thenReturn(mockCategory);
        when(mockCategory.getDataClass()).thenReturn(FooPojo.class);
        when(mockCategory.getName()).thenReturn("foo-table");
        BackingStorage storage = mock(BackingStorage.class);
        TestUpdate update = new TestUpdate();
        when(storage.createUpdate(mockCategory)).thenReturn(update);
        PreparedStatement<FooPojo> preparedStatement = new PreparedStatementImpl<FooPojo>(storage, desc);
        preparedStatement.setString(0, "foo-val");
        preparedStatement.setString(1, "nice");
        assertFalse(update.executed);
        try {
            // this should call apply();
            preparedStatement.execute();
        } catch (StatementExecutionException e) {
            fail(e.getMessage());
        }
        assertTrue(update.executed);
        assertEquals(1, update.updates.size());
        Pair<Key<Object>, Object> item = update.updates.get(0);
        assertEquals(new Key<>("foo"), item.getFirst());
        assertEquals("foo-val", item.getSecond());
        LiteralExpression<Key<String>> o1 = new LiteralExpression<>(new Key<String>("foo"));
        LiteralExpression<String> o2 = new LiteralExpression<>("nice"); 
        BinaryComparisonExpression<String> binComp = new BinaryComparisonExpression<>(
                o1, BinaryComparisonOperator.EQUALS, o2);
        assertEquals(binComp, update.where);
    }
    
    @Test
    public void canDoParsingPatchingAndExecutionForReplace() throws Exception {
        String addString = "REPLACE foo-table SET 'foo' = ?s WHERE 'foo' = ?s";
        @SuppressWarnings("unchecked")
        StatementDescriptor<FooPojo> desc = (StatementDescriptor<FooPojo>) mock(StatementDescriptor.class);
        when(desc.getDescriptor()).thenReturn(addString);
        @SuppressWarnings("unchecked")
        Category<FooPojo> mockCategory = (Category<FooPojo>) mock(Category.class);
        when(desc.getCategory()).thenReturn(mockCategory);
        when(mockCategory.getDataClass()).thenReturn(FooPojo.class);
        when(mockCategory.getName()).thenReturn("foo-table");
        BackingStorage storage = mock(BackingStorage.class);
        TestReplace replace = new TestReplace();
        when(storage.createReplace(mockCategory)).thenReturn(replace);
        PreparedStatement<FooPojo> preparedStatement = new PreparedStatementImpl<FooPojo>(storage, desc);
        preparedStatement.setString(0, "foo-val");
        preparedStatement.setString(1, "bar");
        assertFalse(replace.executed);
        try {
            // this should call apply();
            preparedStatement.execute();
        } catch (StatementExecutionException e) {
            fail(e.getMessage());
        }
        assertTrue(replace.pojo != null);
        assertTrue(replace.pojo instanceof FooPojo);
        assertTrue(replace.executed);
        FooPojo fooPojo = (FooPojo)replace.pojo;
        assertEquals("foo-val", fooPojo.getFoo());
        LiteralExpression<Key<String>> o1 = new LiteralExpression<>(new Key<String>("foo"));
        LiteralExpression<String> o2 = new LiteralExpression<>("bar"); 
        BinaryComparisonExpression<String> binComp = new BinaryComparisonExpression<>(
                o1, BinaryComparisonOperator.EQUALS, o2);
        assertEquals(binComp, replace.where);
    }
    
    @Test
    public void canDoParsingPatchingAndExecutionForRemove() throws Exception {
        String addString = "REMOVE foo-table WHERE 'fooRem' = ?s";
        @SuppressWarnings("unchecked")
        StatementDescriptor<FooPojo> desc = (StatementDescriptor<FooPojo>) mock(StatementDescriptor.class);
        when(desc.getDescriptor()).thenReturn(addString);
        @SuppressWarnings("unchecked")
        Category<FooPojo> mockCategory = (Category<FooPojo>) mock(Category.class);
        when(desc.getCategory()).thenReturn(mockCategory);
        when(mockCategory.getDataClass()).thenReturn(FooPojo.class);
        when(mockCategory.getName()).thenReturn("foo-table");
        BackingStorage storage = mock(BackingStorage.class);
        TestRemove remove = new TestRemove();
        when(storage.createRemove(mockCategory)).thenReturn(remove);
        PreparedStatement<FooPojo> preparedStatement = new PreparedStatementImpl<FooPojo>(storage, desc);
        preparedStatement.setString(0, "bar");
        assertFalse(remove.executed);
        try {
            // this should call apply();
            preparedStatement.execute();
        } catch (StatementExecutionException e) {
            fail(e.getMessage());
        }
        assertTrue(remove.executed);
        LiteralExpression<Key<String>> o1 = new LiteralExpression<>(new Key<String>("fooRem"));
        LiteralExpression<String> o2 = new LiteralExpression<>("bar"); 
        BinaryComparisonExpression<String> binComp = new BinaryComparisonExpression<>(
                o1, BinaryComparisonOperator.EQUALS, o2);
        assertEquals(binComp, remove.where);
    }
    
    @Test
    public void failExecutionWithWronglyTypedParams() throws Exception {
        String queryString = "QUERY foo WHERE 'a' = ?b";
        @SuppressWarnings("unchecked")
        StatementDescriptor<Pojo> desc = (StatementDescriptor<Pojo>) mock(StatementDescriptor.class);
        when(desc.getDescriptor()).thenReturn(queryString);
        @SuppressWarnings("unchecked")
        Category<Pojo> mockCategory = (Category<Pojo>) mock(Category.class);
        when(desc.getCategory()).thenReturn(mockCategory);
        when(mockCategory.getName()).thenReturn("foo");
        BackingStorage storage = mock(BackingStorage.class);
        StubQuery stmt = new StubQuery();
        when(storage.createQuery(mockCategory)).thenReturn(stmt);
        PreparedStatementImpl<Pojo> preparedStatement = new PreparedStatementImpl<>(storage, desc);
        preparedStatement.setString(0, "foo");
        try {
            preparedStatement.executeQuery();
            fail("Should have thrown SEE due to type mismatch. boolean vs. string");
        } catch (StatementExecutionException e) {
            // pass
            assertTrue(e.getMessage().contains("invalid type when attempting to patch"));
        }
    }
    
    private static class TestAdd implements Add<FooPojo> {

        private Pojo pojo;
        private boolean executed = false;
        
        @Override
        public void setPojo(Pojo pojo) {
            this.pojo = pojo;
        }

        @Override
        public int apply() {
            executed = true;
            return 0;
        }

    }
    
    private static class TestReplace implements Replace<FooPojo> {

        private Pojo pojo;
        private boolean executed = false;
        private Expression where;
        
        @Override
        public void setPojo(Pojo pojo) {
            this.pojo = pojo;
        }

        @Override
        public void where(Expression expression) {
            this.where = expression;
        }

        @Override
        public int apply() {
            this.executed = true;
            return 0;
        }
        
    }
    
    private static class TestUpdate implements Update<FooPojo> {

        private Expression where;
        private List<Pair<Key<Object>, Object>> updates = new ArrayList<>();
        private boolean executed = false;
        
        @Override
        public void where(Expression expr) {
            this.where = expr;
        }

        @Override
        public <S> void set(Key<S> key, S value) {
            @SuppressWarnings("unchecked")
            Pair<Key<Object>, Object> item = new Pair<>((Key<Object>) key, (Object)value);
            updates.add(item);
        }

        @Override
        public int apply() {
            this.executed = true;
            return 0;
        }
        
    }
    
    private static class TestRemove implements Remove<FooPojo> {

        private Expression where;
        private boolean executed = false;
        
        @Override
        public void where(Expression where) {
            this.where = where;
        }

        @Override
        public int apply() {
            this.executed = true;
            return 0;
        }
        
    }
    
    public static class FooPojo implements Pojo {
        
        String foo;
        
        public void setFoo(String foo) {
            this.foo = foo;
        }
        
        public String getFoo() {
            return this.foo;
        }
    }
    
    private static class StubQuery implements Query<Pojo> {

        private Expression expr;
        private boolean called = false;
        
        @Override
        public void where(Expression expr) {
            this.expr = expr;
        }

        @Override
        public void sort(Key<?> key, SortDirection direction) {
            // nothing
        }

        @Override
        public void limit(int n) {
            // nothing
        }

        @Override
        public Cursor<Pojo> execute() {
            called = true;
            return null;
        }

        @Override
        public Expression getWhereExpression() {
            // not implemented
            return null;
        }
        
    }
}