UniqueDocumentFilterTest.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * 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.xwiki.query.internal;

import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;

import java.util.Arrays;
import java.util.List;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.xwiki.query.Query;
import org.xwiki.query.QueryFilter;
import org.xwiki.test.mockito.MockitoComponentMockingRule;

/**
 * Tests for {@link org.xwiki.query.internal.UniqueDocumentFilter}
 *
 * @version $Id: 8f7dcc7f0dc2ccf2e41e108cbfdb5597600d6702 $
 */
public class UniqueDocumentFilterTest
{
    @Rule
    public MockitoComponentMockingRule<UniqueDocumentFilter> mocker =
        new MockitoComponentMockingRule<UniqueDocumentFilter>(UniqueDocumentFilter.class);

    private QueryFilter filter;

    @Before
    public void setUp() throws Exception
    {
        this.filter = this.mocker.getComponentUnderTest();
    }

    @Test
    public void filterSelectStatement() throws Exception
    {
        assertEquals("select distinct doc.fullName from XWikiDocument doc",
            filter.filterStatement("select doc.fullName from XWikiDocument doc", Query.HQL));

        List<String> items = Arrays.asList("doc1", "doc2");
        assertThat((List<String>) filter.filterResults(items), is(items));

        // Verify it works with keywords in uppercase
        assertEquals("select distinct doc.fullName FROM XWikiDocument doc",
            filter.filterStatement("SELECT doc.fullName FROM XWikiDocument doc", Query.HQL));
    }

    @Test
    public void filterSelectWithAsStatement() throws Exception
    {
        assertEquals("select distinct doc.fullName from XWikiDocument as doc",
                filter.filterStatement("select doc.fullName from XWikiDocument as doc", Query.HQL));
    }

    @Test
    public void filterSelectStatementWithMismatchingDocAlias() throws Exception
    {
        assertEquals("select mydoc.fullName from XWikiDocument mydoc",
                filter.filterStatement("select mydoc.fullName from XWikiDocument mydoc", Query.HQL));
    }

    @Test
    public void filterStatementWhenStatementAlreadyContainsDistinct() throws Exception
    {
        assertEquals("select distinct doc.fullName from XWikiDocument doc",
                filter.filterStatement("select distinct doc.fullName from XWikiDocument doc", Query.HQL));
    }

    @Test
    public void filterStatementWhenStatementContainsAnotherOrderBy() throws Exception
    {
        assertEquals("select distinct doc.fullName, doc.name from XWikiDocument doc order by doc.name asc",
            filter.filterStatement("select doc.fullName from XWikiDocument doc order by doc.name asc", Query.HQL));

        List<Object[]> results = filter.filterResults(
            Arrays.asList(new Object[] {"full1", "name1"}, new Object[] {"full2", "name2"}));
        assertEquals(2, results.size());
        assertEquals("full1", results.get(0));
        assertEquals("full2", results.get(1));
    }

    @Test
    public void filterStatementWhenTheFirstSelectColumnIsNotFullName() throws Exception
    {
        assertEquals("select distinct doc.fullName, doc.name from XWikiDocument doc order by doc.name asc",
            filter.filterStatement("select doc.name, doc.fullName from XWikiDocument doc order by doc.name asc",
                Query.HQL));

        List<Object[]> results = filter.filterResults(
            Arrays.asList(new Object[] {"full1", "name1"}, new Object[] {"full2", "name2"}));
        assertEquals(2, results.size());
        assertEquals(2, results.get(0).length);
        assertEquals("full1", results.get(0)[0]);
        assertEquals("name1", results.get(0)[1]);
        assertEquals(2, results.get(1).length);
        assertEquals("full2", results.get(1)[0]);
        assertEquals("name2", results.get(1)[1]);
    }
}