/*
 * Copyright 2012-2017 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.vm.heap.analysis.command.internal;

import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.eq;
import static org.mockito.Matchers.isA;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.redhat.thermostat.storage.core.HostRef;
import com.redhat.thermostat.storage.model.VmInfo;
import com.redhat.thermostat.vm.heap.analysis.common.HeapDAO;
import com.redhat.thermostat.vm.heap.analysis.common.model.HeapInfo;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;

import com.redhat.thermostat.client.command.RequestQueue;
import com.redhat.thermostat.common.cli.CommandException;
import com.redhat.thermostat.common.cli.SimpleArguments;
import com.redhat.thermostat.shared.locale.Translate;
import com.redhat.thermostat.storage.core.VmRef;
import com.redhat.thermostat.storage.dao.AgentInfoDAO;
import com.redhat.thermostat.storage.dao.VmInfoDAO;
import com.redhat.thermostat.test.TestCommandContextFactory;
import com.redhat.thermostat.testutils.StubBundleContext;
import com.redhat.thermostat.vm.heap.analysis.command.locale.LocaleResources;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;

public class DumpHeapCommandTest {

    private static final Translate<LocaleResources> TRANSLATOR = LocaleResources
            .createLocalizer();

    @Test
    public void verifyAcuallyCallsWorker() throws CommandException {
        VmInfoDAO vmInfoDao = mock(VmInfoDAO.class);
        AgentInfoDAO agentInfoDao = mock(AgentInfoDAO.class);
        RequestQueue queue = mock(RequestQueue.class);
        HeapDAO heapDAO = mock(HeapDAO.class);
        StubBundleContext context = new StubBundleContext();
        context.registerService(VmInfoDAO.class, vmInfoDao, null);
        context.registerService(AgentInfoDAO.class, agentInfoDao, null);
        context.registerService(RequestQueue.class, queue, null);
        context.registerService(HeapDAO.class, heapDAO, null);

        DumpHeapHelper impl = mock(DumpHeapHelper.class);
        final ArgumentCaptor<Runnable> successHandler = ArgumentCaptor
                .forClass(Runnable.class);
        doAnswer(new Answer<Void>() {

            @Override
            public Void answer(InvocationOnMock invocation) throws Throwable {
                successHandler.getValue().run();
                return null;
            }
        }).when(impl).execute(eq(vmInfoDao), eq(agentInfoDao), any(VmRef.class), eq(queue),
                successHandler.capture(), any(Runnable.class));

        HeapInfo heapInfo = new HeapInfo();
        heapInfo.setHeapDumpId("0001");
        heapInfo.setHeapId("0001-0002");
        when(heapDAO.getAllHeapInfo(any(VmRef.class))).thenReturn(Collections.singleton(heapInfo));

        DumpHeapCommand command = new DumpHeapCommand(context, impl);

        TestCommandContextFactory factory = new TestCommandContextFactory();

        SimpleArguments args = new SimpleArguments();
        args.addArgument("hostId", "foo");
        args.addArgument("vmId", "bar");

        command.run(factory.createContext(args));

        verify(impl).execute(eq(vmInfoDao), eq(agentInfoDao), isA(VmRef.class), eq(queue),
                any(Runnable.class), any(Runnable.class));
        assertEquals("Heap dump ID: 0001-0002\n", factory.getOutput());
    }

    @Test
    public void verifyEchosNoIdMessageWhenNoResultFromStorageAfterDumpCompletes() throws CommandException {
        VmInfoDAO vmInfoDao = mock(VmInfoDAO.class);
        AgentInfoDAO agentInfoDao = mock(AgentInfoDAO.class);
        HeapDAO heapDao = mock(HeapDAO.class);
        RequestQueue queue = mock(RequestQueue.class);
        HostRef hostRef = new HostRef("myAgent", "dummy");
        VmInfo vmInfo = new VmInfo("myAgent", "foo", 123, 0, 0, null, null, null, null, null, null, null, null, null,
                null, null,0, "myUsername");
        when(vmInfoDao.getVmInfo(new VmRef(hostRef, vmInfo))).thenReturn(vmInfo);

        when(heapDao.getAllHeapInfo(any(VmRef.class))).thenReturn(Collections.<HeapInfo>emptyList());

        DumpHeapHelper impl = mock(DumpHeapHelper.class);
        final ArgumentCaptor<Runnable> successHandler = ArgumentCaptor
                .forClass(Runnable.class);
        doAnswer(new Answer<Void>() {

            @Override
            public Void answer(InvocationOnMock invocation) throws Throwable {
                successHandler.getValue().run();
                return null;
            }
        }).when(impl).execute(eq(vmInfoDao), eq(agentInfoDao), any(VmRef.class), eq(queue),
                successHandler.capture(), any(Runnable.class));

        StubBundleContext context = new StubBundleContext();
        context.registerService(VmInfoDAO.class, vmInfoDao, null);
        context.registerService(AgentInfoDAO.class, agentInfoDao, null);
        context.registerService(RequestQueue.class, queue, null);
        context.registerService(HeapDAO.class, heapDao, null);

        DumpHeapCommand command = new DumpHeapCommand(context, impl);

        TestCommandContextFactory factory = new TestCommandContextFactory();

        SimpleArguments args = new SimpleArguments();
        args.addArgument("hostId", "dummy");
        args.addArgument("vmId", "foo");

        command.run(factory.createContext(args));

        verify(impl).execute(eq(vmInfoDao), eq(agentInfoDao), isA(VmRef.class), eq(queue),
                any(Runnable.class), any(Runnable.class));
        assertThat(factory.getOutput(), is(equalTo("Heap dump completed\n")));
    }


    @Test
    public void verifyNeedsHostAndVmId() throws CommandException {
        VmInfoDAO vmInfoDao = mock(VmInfoDAO.class);
        AgentInfoDAO agentInfoDao = mock(AgentInfoDAO.class);
        RequestQueue queue = mock(RequestQueue.class);
        HeapDAO heapDAO = mock(HeapDAO.class);
        StubBundleContext context = new StubBundleContext();
        context.registerService(VmInfoDAO.class, vmInfoDao, null);
        context.registerService(AgentInfoDAO.class, agentInfoDao, null);
        context.registerService(RequestQueue.class, queue, null);
        context.registerService(HeapDAO.class, heapDAO, null);

        DumpHeapHelper impl = mock(DumpHeapHelper.class);
        DumpHeapCommand command = new DumpHeapCommand(context, impl);

        TestCommandContextFactory factory = new TestCommandContextFactory();

        SimpleArguments args = new SimpleArguments();

        try {
            command.run(factory.createContext(args));
            assertTrue("should not reach here", false);
        } catch (CommandException ce) {
            assertEquals("a hostId is required", ce.getMessage());
        }
    }

    @Test
    public void verifyFailsIfAgentDaoIsNotAvailable() {
        VmInfoDAO vmInfoDao = mock(VmInfoDAO.class);
        RequestQueue queue = mock(RequestQueue.class);
        HeapDAO heapDAO = mock(HeapDAO.class);
        StubBundleContext context = new StubBundleContext();
        context.registerService(VmInfoDAO.class, vmInfoDao, null);
        context.registerService(RequestQueue.class, queue, null);
        context.registerService(HeapDAO.class, heapDAO, null);

        DumpHeapHelper impl = mock(DumpHeapHelper.class);
        DumpHeapCommand command = new DumpHeapCommand(context, impl);

        TestCommandContextFactory factory = new TestCommandContextFactory();

        SimpleArguments args = new SimpleArguments();
        args.addArgument("hostId", "foo");
        args.addArgument("vmId", "bar");

        try {
            command.run(factory.createContext(args));
            assertTrue("should not reach here", false);
        } catch (CommandException ce) {
            assertEquals(TRANSLATOR.localize(LocaleResources.AGENT_SERVICE_UNAVAILABLE).getContents(), ce.getMessage());
        }
    }
    
    @Test
    public void verifyFailsIfRequestQueueIsNotAvailable() {
        VmInfoDAO vmInfoDao = mock(VmInfoDAO.class);
        AgentInfoDAO agentInfoDao = mock(AgentInfoDAO.class);
        HeapDAO heapDAO = mock(HeapDAO.class);
        StubBundleContext context = new StubBundleContext();
        context.registerService(VmInfoDAO.class, vmInfoDao, null);
        context.registerService(AgentInfoDAO.class, agentInfoDao, null);
        context.registerService(HeapDAO.class, heapDAO, null);

        DumpHeapHelper impl = mock(DumpHeapHelper.class);
        DumpHeapCommand command = new DumpHeapCommand(context, impl);

        TestCommandContextFactory factory = new TestCommandContextFactory();

        SimpleArguments args = new SimpleArguments();
        args.addArgument("hostId", "foo");
        args.addArgument("vmId", "bar");
        args.addArgument("vmPid", "123");

        try {
            command.run(factory.createContext(args));
            fail();
        } catch (CommandException ce) {
            assertEquals(TRANSLATOR.localize(LocaleResources.REQUEST_QUEUE_UNAVAILABLE).getContents(), ce.getMessage());
        }
    }
    
    @Test
    public void verifyFailsIfVmDaoIsNotAvailable() {
        AgentInfoDAO agentInfoDao = mock(AgentInfoDAO.class);
        RequestQueue queue = mock(RequestQueue.class);
        HeapDAO heapDAO = mock(HeapDAO.class);
        StubBundleContext context = new StubBundleContext();
        context.registerService(AgentInfoDAO.class, agentInfoDao, null);
        context.registerService(RequestQueue.class, queue, null);
        context.registerService(HeapDAO.class, heapDAO, null);

        DumpHeapHelper impl = mock(DumpHeapHelper.class);
        DumpHeapCommand command = new DumpHeapCommand(context, impl);

        TestCommandContextFactory factory = new TestCommandContextFactory();

        SimpleArguments args = new SimpleArguments();
        args.addArgument("hostId", "foo");
        args.addArgument("vmId", "bar");

        try {
            command.run(factory.createContext(args));
            fail();
        } catch (CommandException ce) {
            assertEquals(TRANSLATOR.localize(LocaleResources.VM_SERVICE_UNAVAILABLE).getContents(), ce.getMessage());
        }
    }

    @Test
    public void verifyErrorMessage() {
        final String HOST_ID = "myHost";
        final String VM_ID = "myVm";
        VmInfoDAO vmInfoDao = mock(VmInfoDAO.class);
        AgentInfoDAO agentInfoDao = mock(AgentInfoDAO.class);
        HeapDAO heapDAO = mock(HeapDAO.class);
        RequestQueue queue = mock(RequestQueue.class);
        StubBundleContext context = new StubBundleContext();
        context.registerService(VmInfoDAO.class, vmInfoDao, null);
        context.registerService(AgentInfoDAO.class, agentInfoDao, null);
        context.registerService(RequestQueue.class, queue, null);
        context.registerService(HeapDAO.class, heapDAO, null);

        DumpHeapHelper impl = mock(DumpHeapHelper.class);
        DumpHeapCommand command = new DumpHeapCommand(context, impl);
        TestCommandContextFactory factory = new TestCommandContextFactory();

        SimpleArguments args = new SimpleArguments();
        args.addArgument("hostId", HOST_ID);
        args.addArgument("vmId", VM_ID);

        doAnswer(new Answer<Object>() {

            @Override
            public Object answer(InvocationOnMock invocation) throws Throwable {
                Runnable failRunnable = (Runnable) invocation.getArguments()[5];
                failRunnable.run();
                return null;
            }
        }).when(impl).execute(any(VmInfoDAO.class), any(AgentInfoDAO.class), any(VmRef.class), 
                any(RequestQueue.class), any(Runnable.class), any(Runnable.class));

        try {
            command.run(factory.createContext(args));
            fail("CommandException expected");
        } catch (CommandException e) {
            assertEquals(TRANSLATOR.localize(LocaleResources.HEAP_DUMP_ERROR,
                    HOST_ID, VM_ID).getContents(), e.getMessage());
        }
    }

    @Test
    public void testGetLatestHeapId() {
        HeapInfo heapInfo1 = new HeapInfo();
        heapInfo1.setHeapId("heap1");
        heapInfo1.setTimeStamp(300L);
        HeapInfo heapInfo2 = new HeapInfo();
        heapInfo2.setHeapId("heap2");
        heapInfo2.setTimeStamp(200L);
        HeapInfo heapInfo3 = new HeapInfo();
        heapInfo3.setHeapId("heap3");
        heapInfo3.setTimeStamp(100L);
        Collection<HeapInfo> heapInfos = Arrays.asList(heapInfo2, heapInfo1, heapInfo3);

        HeapDAO heapDao = mock(HeapDAO.class);
        when(heapDao.getAllHeapInfo(any(VmRef.class))).thenReturn(heapInfos);

        HostRef hostRef = new HostRef("agent", "dummy");
        VmRef vmRef = new VmRef(hostRef, new VmInfo());

        String result = DumpHeapCommand.getLatestHeapId(heapDao, vmRef);
        assertThat(result, is(heapInfo1.getHeapId()));
    }

}