/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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
 *
 *    https://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 org.apache.cayenne.access;

import org.apache.cayenne.ObjectContext;
import org.apache.cayenne.di.Inject;
import org.apache.cayenne.query.EJBQLQuery;
import org.apache.cayenne.test.jdbc.DBHelper;
import org.apache.cayenne.test.jdbc.TableHelper;
import org.apache.cayenne.testdo.testmap.Artist;
import org.apache.cayenne.testdo.testmap.Gallery;
import org.apache.cayenne.unit.di.server.CayenneProjects;
import org.apache.cayenne.unit.di.server.ServerCase;
import org.apache.cayenne.unit.di.server.UseServerRuntime;
import org.junit.Before;
import org.junit.Test;

import java.math.BigDecimal;
import java.sql.Types;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

@UseServerRuntime(CayenneProjects.TESTMAP_PROJECT)
public class DataContextEJBQLGroupByHavingIT extends ServerCase {

    @Inject
    protected ObjectContext context;

    @Inject
    protected DBHelper dbHelper;

    protected TableHelper tArtist;
    protected TableHelper tPainting;
    protected TableHelper tGallery;

    @Before
    public void setUp() throws Exception {
        tArtist = new TableHelper(dbHelper, "ARTIST");
        tArtist.setColumns("ARTIST_ID", "ARTIST_NAME");

        tPainting = new TableHelper(dbHelper, "PAINTING");
        tPainting.setColumns(
                "PAINTING_ID",
                "ARTIST_ID",
                "GALLERY_ID",
                "PAINTING_TITLE",
                "ESTIMATED_PRICE").setColumnTypes(
                Types.INTEGER,
                Types.BIGINT,
                Types.INTEGER,
                Types.VARCHAR,
                Types.DECIMAL);

        tGallery = new TableHelper(dbHelper, "GALLERY");
        tGallery.setColumns("GALLERY_ID", "GALLERY_NAME");
    }

    private void createFivePaintings() throws Exception {
        tPainting.insert(33001, null, null, "PX", 1);
        tPainting.insert(33002, null, null, "PY", 2);
        tPainting.insert(33003, null, null, "PY", 2);
        tPainting.insert(33004, null, null, "PZ", 1);
        tPainting.insert(33005, null, null, "PZ", 1);
    }

    private void createFourArtistsAndTwoPaintings() throws Exception {
        tArtist.insert(33001, "AA1");
        tArtist.insert(33002, "AA2");
        tArtist.insert(33003, "BB1");
        tArtist.insert(33004, "BB2");
        tPainting.insert(33007, 33001, null, "P1", 3000);
        tPainting.insert(33008, 33002, null, "P2", 5000);
    }

    private void createArtistsPaintingGalleries() throws Exception {
        tArtist.insert(33001, "AA1");
        tArtist.insert(33002, "AA2");
        tArtist.insert(33003, "BB1");
        tArtist.insert(33004, "BB2");

        tGallery.insert(33001, "gallery1");
        tGallery.insert(33002, "gallery2");

        tPainting.insert(33001, null, null, "PX", 1);
        tPainting.insert(33002, null, null, "PY", 2);
        tPainting.insert(33003, null, null, "PY", 2);
        tPainting.insert(33007, 33001, null, "P1", 3000);
        tPainting.insert(33008, 33002, null, "P2", 5000);
        tPainting.insert(33009, 33002, 33001, "P111", 5000);
        tPainting.insert(33010, 33001, 33002, "P112", 5000);
    }

    @Test
    public void testGroupBy() throws Exception {
        createFivePaintings();

        String ejbql = "SELECT p.estimatedPrice, count(p) FROM Painting p"
                + " GROUP BY p.estimatedPrice"
                + " ORDER BY p.estimatedPrice";
        EJBQLQuery query = new EJBQLQuery(ejbql);

        List<?> data = context.performQuery(query);
        assertEquals(2, data.size());
        assertTrue(data.get(0) instanceof Object[]);

        Object[] row0 = (Object[]) data.get(0);
        assertEquals(1d, ((BigDecimal) row0[0]).doubleValue(), 0.00001d);
        assertEquals(3L, row0[1]);

        Object[] row1 = (Object[]) data.get(1);
        assertEquals(2d, ((BigDecimal) row1[0]).doubleValue(), 0.00001d);
        assertEquals(2L, row1[1]);
    }

    @Test
    public void testGroupByMultipleItems() throws Exception {
        createFivePaintings();

        String ejbql = "SELECT p.estimatedPrice, p.paintingTitle, count(p) FROM Painting p"
                + " GROUP BY p.estimatedPrice, p.paintingTitle"
                + " ORDER BY p.estimatedPrice, p.paintingTitle";
        EJBQLQuery query = new EJBQLQuery(ejbql);

        List<?> data = context.performQuery(query);
        assertEquals(3, data.size());
        assertTrue(data.get(0) instanceof Object[]);

        Object[] row0 = (Object[]) data.get(0);
        assertEquals(1d, ((BigDecimal) row0[0]).doubleValue(), 0.00001d);
        assertEquals("PX", row0[1]);
        assertEquals(1L, row0[2]);

        Object[] row1 = (Object[]) data.get(1);
        assertEquals(1d, ((BigDecimal) row1[0]).doubleValue(), 0.00001d);
        assertEquals("PZ", row1[1]);
        assertEquals(2L, row1[2]);

        Object[] row2 = (Object[]) data.get(2);
        assertEquals(2d, ((BigDecimal) row2[0]).doubleValue(), 0.00001d);
        assertEquals("PY", row2[1]);
        assertEquals(2L, row2[2]);
    }

    @Test
    public void testGroupByRelatedEntity() throws Exception {

        createFourArtistsAndTwoPaintings();

        String ejbql = "SELECT COUNT(p), a, a.artistName "
                + "FROM Painting p INNER JOIN p.toArtist a GROUP BY a, a.artistName "
                + "ORDER BY a.artistName";
        EJBQLQuery query = new EJBQLQuery(ejbql);

        List<?> data = context.performQuery(query);
        assertEquals(2, data.size());

        assertTrue(data.get(0) instanceof Object[]);
        Object[] row0 = (Object[]) data.get(0);
        assertEquals(3, row0.length);
        assertEquals(1L, row0[0]);
        assertEquals("AA1", row0[2]);
        assertTrue(row0[1] instanceof Artist);
    }

    @Test
    public void testGroupByIdVariable() throws Exception {
        createFivePaintings();

        String ejbql = "SELECT count(p), p FROM Painting p GROUP BY p";
        EJBQLQuery query = new EJBQLQuery(ejbql);

        List<?> data = context.performQuery(query);
        assertEquals(5, data.size());

        // TODO: andrus, 8/3/2007 the rest of the unit test fails as currently Cayenne
        // does not allow mixed object and scalar results (see CAY-839)

        // assertTrue(data.get(0) instanceof Object[]);
        //
        // for(int i = 0; i < data.size(); i++) {
        // Object[] row = (Object[]) data.get(i);
        // assertEquals(1L, row[0]);
        // }
    }

    @Test
    public void testGroupByHavingOnColumn() throws Exception {
        createFivePaintings();

        String ejbql = "SELECT p.estimatedPrice, count(p) FROM Painting p"
                + " GROUP BY p.estimatedPrice"
                + " HAVING p.estimatedPrice > 1";
        EJBQLQuery query = new EJBQLQuery(ejbql);

        List<?> data = context.performQuery(query);
        assertEquals(1, data.size());
        assertTrue(data.get(0) instanceof Object[]);

        Object[] row0 = (Object[]) data.get(0);
        assertEquals(2d, ((BigDecimal) row0[0]).doubleValue(), 0.00001d);
        assertEquals(2L, row0[1]);
    }

    @Test
    public void testGroupByHavingOnAggregate() throws Exception {
        createFivePaintings();

        String ejbql = "SELECT p.estimatedPrice, count(p) FROM Painting p"
                + " GROUP BY p.estimatedPrice"
                + " HAVING count(p) > 2";
        EJBQLQuery query = new EJBQLQuery(ejbql);

        List<?> data = context.performQuery(query);
        assertEquals(1, data.size());
        assertTrue(data.get(0) instanceof Object[]);

        Object[] row0 = (Object[]) data.get(0);
        assertEquals(1d, ((BigDecimal) row0[0]).doubleValue(), 0.00001d);
        assertEquals(3L, row0[1]);
    }

    @Test
    public void testGroupByHavingOnAggregateMultipleConditions() throws Exception {
        createFivePaintings();

        String ejbql = "SELECT p.estimatedPrice, count(p) FROM Painting p"
                + " GROUP BY p.estimatedPrice"
                + " HAVING count(p) > 2 AND p.estimatedPrice < 10";
        EJBQLQuery query = new EJBQLQuery(ejbql);

        List<?> data = context.performQuery(query);
        assertEquals(1, data.size());
        assertTrue(data.get(0) instanceof Object[]);

        Object[] row0 = (Object[]) data.get(0);
        assertEquals(1d, ((BigDecimal) row0[0]).doubleValue(), 0.00001d);
        assertEquals(3L, row0[1]);
    }

    @Test
    public void testGroupByJoinedRelatedEntities() throws Exception {
        createFourArtistsAndTwoPaintings();

        EJBQLQuery query = new EJBQLQuery(
                "SELECT COUNT(p), p.toArtist FROM Painting p GROUP BY p.toArtist ");
        List<Object[]> data = context.performQuery(query);
        assertNotNull(data);
        assertEquals(2, data.size());

        List<String> expectedArtists = new ArrayList<String>();
        expectedArtists.add("AA1");
        expectedArtists.add("AA2");

        Object[] row = data.get(0);
        String artistName = ((Artist) row[1]).getArtistName();
        assertEquals(1L, row[0]);
        assertTrue("error artistName:" + artistName, expectedArtists.contains(artistName));

        row = data.get(1);
        artistName = ((Artist) row[1]).getArtistName();
        assertEquals(1L, row[0]);
        assertTrue("error artistName:" + artistName, expectedArtists.contains(artistName));
    }

    @Test
    public void testGroupByJoinedEntities() throws Exception {
        createArtistsPaintingGalleries();
        EJBQLQuery query = new EJBQLQuery(
                "SELECT COUNT(p), p.toArtist, p.toGallery FROM Painting p "
                        + "GROUP BY p.toGallery, p.toArtist ");
        List<Object[]> data = context.performQuery(query);
        assertNotNull(data);
        assertEquals(2, data.size());

        HashSet<List<?>> expectedResults = new HashSet<List<?>>();
        expectedResults.add(Arrays.asList(1L, "AA2", "gallery1"));
        expectedResults.add(Arrays.asList(1L, "AA1", "gallery2"));

        for (Object[] row : data) {
            assertFalse(expectedResults.add(Arrays.asList(row[0], row[1] == null
                    ? null
                    : ((Artist) row[1]).getArtistName(), row[2] == null
                    ? null
                    : ((Gallery) row[2]).getGalleryName())));
        }
    }

    @Test
    public void testGroupByJoinedEntityInCount() throws Exception {
        createArtistsPaintingGalleries();

        EJBQLQuery query = new EJBQLQuery(
                "SELECT COUNT(p.toArtist), p.paintingTitle FROM Painting p "
                        + "GROUP BY p.paintingTitle "
                        + "HAVING p.paintingTitle LIKE 'P1%'");
        List<Object[]> data = context.performQuery(query);
        assertNotNull(data);
        assertEquals(3, data.size());

        HashSet<List<?>> expectedResults = new HashSet<List<?>>();
        expectedResults.add(Arrays.asList(1L, "P1"));
        expectedResults.add(Arrays.asList(1L, "P111"));
        expectedResults.add(Arrays.asList(1L, "P112"));

        for (Object[] row : data) {
            assertFalse(expectedResults.add(Arrays.asList(row[0], row[1])));
        }
    }

    @Test
    public void testGroupByChainedJoins() throws Exception {
        createFivePaintings();

        String ejbql = "SELECT p.painting.toArtist.paintingArray FROM PaintingInfo p"
                + " GROUP BY p.painting.toArtist.paintingArray";
        EJBQLQuery query = new EJBQLQuery(ejbql);
        context.performQuery(query);

        ejbql = "SELECT p.painting.toArtist FROM PaintingInfo p"
                + " GROUP BY p.painting.toArtist";
        query = new EJBQLQuery(ejbql);
        context.performQuery(query);
    }

}
