SakuliExceptionHandlerTest.java

/*
 * Sakuli - Testing and Monitoring-Tool for Websites and common UIs.
 *
 * Copyright 2013 - 2015 the original author or authors.
 *
 * Licensed 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
 *
 *     http://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.sakuli.exceptions;

import net.sf.sahi.report.Report;
import net.sf.sahi.report.ResultType;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.sakuli.BaseTest;
import org.sakuli.actions.screenbased.RegionImpl;
import org.sakuli.actions.screenbased.ScreenshotActions;
import org.sakuli.datamodel.TestCase;
import org.sakuli.datamodel.TestCaseStep;
import org.sakuli.datamodel.TestSuite;
import org.sakuli.datamodel.properties.ActionProperties;
import org.sakuli.datamodel.properties.SakuliProperties;
import org.sakuli.datamodel.state.TestCaseState;
import org.sakuli.datamodel.state.TestSuiteState;
import org.sakuli.loader.ScreenActionLoader;
import org.springframework.test.util.ReflectionTestUtils;
import org.testng.Assert;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.*;

import static org.mockito.Matchers.any;
import static org.mockito.Matchers.anyString;
import static org.mockito.Mockito.*;
import static org.testng.Assert.*;

@SuppressWarnings("ThrowableResultOfMethodCallIgnored")
public class SakuliExceptionHandlerTest extends BaseTest {
    private TestSuite testSuite;
    private TestCase testCase;
    private String screenShotFolder = "src/test/resources/org/sakuli/exceptions/screenshots";
    private String testExcMessage = "TEST IT";
    private Path expectedScreenshotPath;

    @Mock
    private ScreenshotActions screenshotActionsMock;
    @Mock
    private ScreenActionLoader loader;
    @Mock
    private SakuliProperties sakuliProperties;
    @Mock
    private ActionProperties actionProperties;
    @Mock
    private Report sahiReport;

    @InjectMocks
    private SakuliExceptionHandler testling;

    @BeforeMethod
    public void init() {
        MockitoAnnotations.initMocks(this);
    }

    private void setUp() throws Exception {
        expectedScreenshotPath = Paths.get(screenShotFolder + "test.jpg");
        when(screenshotActionsMock.takeScreenshot(anyString(), any(Path.class))).thenReturn(expectedScreenshotPath);
        when(loader.getScreenshotActions()).thenReturn(screenshotActionsMock);
        testCase = new TestCase("testling", "1234_");
        HashMap<String, TestCase> testCases = new HashMap<>();
        testCases.put(testCase.getId(), testCase);
        testSuite = new TestSuite();
        testSuite.setState(TestSuiteState.RUNNING);
        ReflectionTestUtils.setField(testSuite, "testCases", testCases);
        when(loader.getActionProperties()).thenReturn(actionProperties);
        when(actionProperties.isTakeScreenshots()).thenReturn(true);
        when(loader.getSakuliProperties()).thenReturn(sakuliProperties);
        when(sakuliProperties.isSuppressResumedExceptions()).thenReturn(false);
        when(loader.getSahiReport()).thenReturn(sahiReport);
        when(loader.getTestSuite()).thenReturn(testSuite);
        when(loader.getCurrentTestCase()).thenReturn(testCase);

    }

    @Test
    public void testHandleException() throws Exception {
        setUp();
        when(loader.getCurrentTestCase()).thenReturn(null);
        testling.handleException(new Exception(testExcMessage));
        assertTrue(testSuite.getException() instanceof SakuliException);
        assertEquals(testSuite.getException().getMessage(), testExcMessage);
        assertEquals(testSuite.getScreenShotPath(), expectedScreenshotPath);

        //test Suppressed
        String excpMessage2 = "ExceptionSuppressed";
        testling.handleException(new Exception(excpMessage2));
        assertEquals(testSuite.getExceptionMessages(false), testExcMessage + "\n\t\tSuppressed EXCEPTION: " + excpMessage2);
        assertEquals(testSuite.getState(), TestSuiteState.ERRORS);
        assertTrue(testling.isAlreadyProcessed(testSuite.getException()));
    }

    @Test
    public void testHandleActionException() throws Exception {
        setUp();
        when(loader.getCurrentTestCase()).thenReturn(null);
        testling.handleException(new SakuliActionException(testExcMessage));
        assertTrue(testSuite.getException() instanceof SakuliException);
        assertEquals(testSuite.getException().getMessage(), testExcMessage);
        assertEquals(testSuite.getScreenShotPath(), expectedScreenshotPath);
    }

    @Test
    public void testHandleExceptionForTestCases() throws Exception {
        setUp();
        Exception testExc = new Exception(testExcMessage);
        testling.handleException(testExc);
        assertTrue(testCase.getException() instanceof SakuliExceptionWithScreenshot);
        assertEquals(testCase.getException().getMessage(), testExcMessage);
        assertEquals(testCase.getScreenShotPath(), expectedScreenshotPath);

        //test Suppressed
        String excpMessage2 = "ExceptionSuppressed";
        testling.handleException(new Exception(excpMessage2));
        assertEquals(testCase.getExceptionMessages(false), testExcMessage + "\n\t\tSuppressed EXCEPTION: " + excpMessage2);
        assertEquals(testCase.getState(), TestCaseState.ERRORS);
        assertEquals(testSuite.getState(), TestSuiteState.ERRORS);

        //test Proxy Exception
        when(loader.getCurrentTestCase()).thenReturn(null);
        testling.handleException(new SakuliInitException("FAILURE"));
        Assert.assertNull(testSuite.getException());
        assertTrue(testling.isAlreadyProcessed(testExc));
    }

    @Test
    public void testGetSuppressedExceptions() throws Exception {
        setUp();
        Exception testExc = new Exception(testExcMessage);
        testling.handleException(testExc, true);
        assertTrue(testCase.getException() instanceof SakuliExceptionWithScreenshot);
        assertEquals(testCase.getException().getMessage(), testExcMessage);
        assertEquals(testCase.getScreenShotPath(), expectedScreenshotPath);

        SakuliRuntimeException resumedExceptions = null;
        try {
            testling.throwCollectedResumedExceptions();
        } catch (SakuliRuntimeException e) {
            resumedExceptions = e;
        }
        assertNotNull(resumedExceptions, "exception is expected!");
        assertEquals(resumedExceptions.getMessage(), "test contains some suppressed resumed exceptions!");
        assertEquals(resumedExceptions.getSuppressed()[0].getMessage(), testExcMessage);
    }

    @Test
    public void testSakuliForwarderException() throws Exception {
        setUp();
        when(loader.getCurrentTestCase()).thenReturn(null);
        SakuliForwarderException forwarderException = new SakuliForwarderException("FORWARDER_EXCEPTION");

        testling.handleException(forwarderException, true);
        verify(screenshotActionsMock, never()).takeScreenshot(anyString(), any(Path.class));
        verify(screenshotActionsMock, never()).takeScreenshot(anyString(), any(Path.class), anyString());
        verify(sahiReport).addResult(anyString(), any(ResultType.class), anyString(), anyString());
        assertEquals(testSuite.getException(), forwarderException);
        assertTrue(testling.resumeToTestExcecution(testSuite.getException()));
        assertTrue(testling.isAlreadyProcessed(testSuite.getException()));
    }

    @Test
    public void testSakuliForwarderException2() throws Exception {
        setUp();
        when(loader.getCurrentTestCase()).thenReturn(null);
        SakuliForwarderException forwarderException = new SakuliForwarderException("FORWARDER_EXCEPTION");

        testling.handleException(forwarderException);
        verify(screenshotActionsMock, never()).takeScreenshot(anyString(), any(Path.class));
        verify(screenshotActionsMock, never()).takeScreenshot(anyString(), any(Path.class), anyString());
        verify(sahiReport).addResult(anyString(), any(ResultType.class), anyString(), anyString());
        assertEquals(testSuite.getException(), forwarderException);
        assertTrue(testling.isAlreadyProcessed(testSuite.getException()));
    }

    @Test
    public void testSakuliActionExceptionTakeUnsuccessfulScreenshotFromRegion() throws Exception {
        setUp();
        when(loader.getCurrentTestCase()).thenReturn(null);
        SakuliActionException sakuliActionException = new SakuliActionException("ACTION_EXCEPTION");

        testling.handleException(sakuliActionException, mock(RegionImpl.class), true);
        verify(screenshotActionsMock).takeScreenshot(anyString(), any(Path.class));
        verify(screenshotActionsMock, never()).takeScreenshot(anyString(), any(Path.class), anyString());
        verify(sahiReport).addResult(anyString(), any(ResultType.class), anyString(), anyString());
        assertTrue(testSuite.getException() instanceof SakuliExceptionWithScreenshot);
        assertEquals(((SakuliExceptionWithScreenshot) testSuite.getException()).getScreenshot(), expectedScreenshotPath);
        assertTrue(testling.resumeToTestExcecution(testSuite.getException()));
        assertTrue(testling.isAlreadyProcessed(testSuite.getException()));
    }

    @Test
    public void testSakuliActionExceptionTakeSuccessfulScreenshotFromRegion() throws Exception {
        setUp();
        when(loader.getCurrentTestCase()).thenReturn(null);
        when(screenshotActionsMock.takeScreenshot(anyString(), any(Path.class))).thenReturn(expectedScreenshotPath);
        SakuliActionException sakuliActionException = new SakuliActionException("ACTION_EXCEPTION");

        testling.handleException(sakuliActionException, mock(RegionImpl.class), true);
        verify(screenshotActionsMock).takeScreenshot(anyString(), any(Path.class));
        verify(screenshotActionsMock, never()).takeScreenshot(anyString(), any(Path.class), anyString());
        verify(sahiReport).addResult(anyString(), any(ResultType.class), anyString(), anyString());
        assertTrue(testSuite.getException() instanceof SakuliExceptionWithScreenshot);
        assertEquals(((SakuliExceptionWithScreenshot) testSuite.getException()).getScreenshot(), expectedScreenshotPath);
        assertTrue(testling.resumeToTestExcecution(testSuite.getException()));
        assertTrue(testling.isAlreadyProcessed(testSuite.getException()));
    }

    @Test
    public void testHandleSakuliProxyExceptionForTestCases() throws Exception {
        setUp();
        when(loader.getCurrentTestCase()).thenReturn(null);
        testling.handleException(new SakuliInitException(testExcMessage));
        assertTrue(testSuite.getException() instanceof NonScreenshotException);
        assertEquals(testSuite.getException().getMessage(), testExcMessage);
        assertEquals(testSuite.getState(), TestSuiteState.ERRORS);
        verify(loader, never()).getScreenshotActions();
    }

    @Test
    public void testSakuliValidationException() throws Exception {
        setUp();
        when(loader.getCurrentTestCase()).thenReturn(null);
        testling.handleException(new SakuliValidationException(testExcMessage));
        assertTrue(testSuite.getException() instanceof NonScreenshotException);
        assertEquals(testSuite.getException().getMessage(), testExcMessage);
        assertEquals(testSuite.getState(), TestSuiteState.ERRORS);
        verify(loader, never()).getScreenshotActions();
    }

    @Test
    public void testGetScreenshotFile() throws Exception {
        SakuliExceptionWithScreenshot ex = new SakuliExceptionWithScreenshot(testExcMessage, expectedScreenshotPath);
        assertEquals(SakuliExceptionHandler.getScreenshotFile(ex), expectedScreenshotPath);
        Path expectedScreenShotFolder2 = Paths.get(screenShotFolder);
        ex.setScreenshot(null);
        ex.addSuppressed(new SakuliExceptionWithScreenshot(testExcMessage, expectedScreenShotFolder2));
        assertEquals(SakuliExceptionHandler.getScreenshotFile(ex), expectedScreenShotFolder2);
    }

    @Test
    public void testGetAllExceptions() throws Exception {
        TestSuite ts = new TestSuite();
        ts.addException(new SakuliException("bla"));
        TestCase tc = new TestCase(null, null);
        tc.addException(new SakuliException("bla2"));
        ts.addTestCase(tc);

        TestCaseStep step = new TestCaseStep();
        step.addException(new SakuliException("bla3"));
        tc.addStep(step);
        List<Throwable> allExceptions = SakuliExceptionHandler.getAllExceptions(ts);
        assertEquals(allExceptions.size(), 3);
    }

    @Test
    public void testContainsExceptionsStep() throws Exception {
        TestSuite ts = new TestSuite();
        TestCase tc = new TestCase(null, null);
        ts.addTestCase(tc);
        TestCaseStep step = new TestCaseStep();
        step.addException(new SakuliException("bla3"));
        tc.addStep(step);
        assertTrue(SakuliExceptionHandler.containsException(ts));
    }

    @Test
    public void testContainsExceptionsCase() throws Exception {
        TestSuite ts = new TestSuite();
        TestCase tc = new TestCase(null, null);
        tc.addException(new SakuliException("bla2"));
        ts.addTestCase(tc);

        TestCaseStep step = new TestCaseStep();
        tc.addStep(step);
        assertTrue(SakuliExceptionHandler.containsException(ts));
    }

    @Test
    public void testContainsExceptionsSuite() throws Exception {
        TestSuite ts = new TestSuite();
        ts.addException(new SakuliException("bla"));
        TestCase tc = new TestCase(null, null);
        ts.addTestCase(tc);
        TestCaseStep step = new TestCaseStep();
        tc.addStep(step);
        assertTrue(SakuliExceptionHandler.containsException(ts));
    }

    @Test
    public void testSaveExceptionsInSuite() throws Exception {
        TestSuite ts = new TestSuite();
        when(loader.getTestSuite()).thenReturn(ts);
        testling.saveException(new SakuliException("test"));
        assertEquals(ts.getException().getMessage(), "test");
    }

    @Test
    public void testSaveExceptionsInCase() throws Exception {
        TestSuite ts = new TestSuite();
        when(loader.getTestSuite()).thenReturn(ts);
        TestCase tc = new TestCase(null, null);
        when(loader.getCurrentTestCase()).thenReturn(tc);
        testling.saveException(new SakuliException("test"));
        assertNull(ts.getException());
        assertEquals(tc.getException().getMessage(), "test");
    }

    @Test
    public void testSaveExceptionsInStep() throws Exception {
        TestSuite ts = new TestSuite();
        when(loader.getTestSuite()).thenReturn(ts);
        TestCase tc = new TestCase(null, null);
        when(loader.getCurrentTestCase()).thenReturn(tc);
        TestCaseStep step = new TestCaseStep();
        when(loader.getCurrentTestCaseStep()).thenReturn(step);
        testling.saveException(new SakuliException("test"));
        assertNull(ts.getException());
        assertNull(tc.getException());
        assertEquals(step.getException().getMessage(), "test");
    }
}