DebugContextResolverThrowsExceptionTest.java

/*******************************************************************************
 * 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
 *  
 *   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.apache.wink.server.serviceability;

import java.util.ArrayList;
import java.util.List;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;

import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import org.apache.wink.common.internal.log.LogUtils;
import org.apache.wink.common.internal.providers.entity.xml.AbstractJAXBProvider;
import org.apache.wink.logging.InMemoryHandler;
import org.apache.wink.server.internal.RequestProcessor;
import org.apache.wink.server.internal.handlers.InvokeMethodHandler;
import org.apache.wink.server.internal.servlet.MockServletInvocationTest;
import org.apache.wink.test.mock.MockRequestConstructor;
import org.springframework.mock.web.MockHttpServletRequest;

/*
 * 
 * Test what is printed to the log when a resource class (from the developer's application) throws an exception.
 * An exception may be thrown on purpose from a resource as part of normal transactions for this particular app,
 * thus we don't want to report it to INFO due to the possibility of quickly filling up logs.  Instead, data is
 * logged when DEBUG is turned on, and logged only once.
 * 
 */

public class DebugContextResolverThrowsExceptionTest extends MockServletInvocationTest {
    
    @XmlAccessorType(XmlAccessType.FIELD)
    @XmlType(name = "", propOrder = {
        "arg0"
    })
    @XmlRootElement(name = "myJaxb")
    public static class MyJaxb {

        protected int arg0;

        /**
         * Gets the value of the arg0 property.
         * 
         */
        public int getArg0() {
            return arg0;
        }

        /**
         * Sets the value of the arg0 property.
         * 
         */
        public void setArg0(int value) {
            this.arg0 = value;
        }

    }
    
    @Provider
    @Produces( MediaType.APPLICATION_XML)
    public static class MyContextResolver implements ContextResolver<JAXBContext> {

        public JAXBContext getContext(Class<?> type) {
            throw new RuntimeException("getContext");
        }

    }
    
    @Override
    protected Class<?>[] getClasses() {
        return new Class<?>[] {Resource.class, MyContextResolver.class};
    }

    @Path("jaxbresource")
    public static class Resource {

        @POST
        @Path("jaxbelement")
        public String post(MyJaxb myJaxb) {
            return String.valueOf(myJaxb.getArg0());
        }
    }
    
    private InMemoryHandler handler;

    private Logger          winkLogger = Logger.getLogger("org.apache.wink");

    private Handler         consoleHandler;

    @Override
    protected void setUp() throws Exception {
        Handler[] defaultHandlers = Logger.getLogger("").getHandlers();
        if (defaultHandlers.length == 1) {
            consoleHandler = defaultHandlers[0];
            consoleHandler.setLevel(Level.FINE);
        }

        handler = new InMemoryHandler();
        handler.setLevel(Level.FINE);

        winkLogger.setLevel(Level.FINE);
        winkLogger.addHandler(handler);
        super.setUp();
    }

    @Override
    protected void tearDown() throws Exception {
        if (consoleHandler != null) {
            consoleHandler.setLevel(Level.INFO);
        }
        winkLogger.removeHandler(handler);
        winkLogger.setLevel(Level.INFO);
        super.tearDown();
    }
    
    public void testgetContextException() throws Exception {
        
        handler.getRecords().clear();
        List<LogRecord> records = handler.getRecords();

        MockHttpServletRequest request =
            MockRequestConstructor.constructMockRequest("POST",
                                                        "/jaxbresource/jaxbelement",
                                                        MediaType.TEXT_PLAIN,
                                                        MediaType.APPLICATION_XML,
                                                        "some_xml".getBytes());  // don't care what data this is, my context resolver is gonna throw exception anyway
        
        try {
            invoke(request);
        } catch (Throwable t) {
            // not checking what was thrown, just want to verify logs... so...
        }
        
        // keep a count of how many logRecords contain the stack trace from the exception that originated from a provider
        int logRecordsWithStackTrace = 0;

        List<LogRecord> logRecordsContainingAbstractJAXBProvider = new ArrayList<LogRecord>();
        
        for (LogRecord record : records) {
            // record does not originate from AbstractJAXBProvider
            if (record.getMessage().contains(AbstractJAXBProvider.class.getName())) {
                logRecordsContainingAbstractJAXBProvider.add(record);
                logRecordsWithStackTrace++;
            } else if ((record.getThrown() != null) && LogUtils.stackToDebugString(record.getThrown()).contains(InvokeMethodHandler.class.getName())) {
                logRecordsWithStackTrace++;
            }
        }
        
        // stack trace of an exception that originated in a resource should only be logged once:
        assertEquals(1, logRecordsWithStackTrace);
        
        assertEquals(1, logRecordsContainingAbstractJAXBProvider.size());
        assertEquals(Level.FINE, logRecordsContainingAbstractJAXBProvider.get(0).getLevel());
        String expectedString = "java.lang.RuntimeException with message \"getContext\" was encountered during invocation of method org.apache.wink.server.serviceability.DebugContextResolverThrowsExceptionTest$MyContextResolver.getContext( ";
        assertTrue(logRecordsContainingAbstractJAXBProvider.get(0).getMessage().startsWith(expectedString));
        assertTrue(logRecordsContainingAbstractJAXBProvider.get(0).getLoggerName().equals(RequestProcessor.class.getName()));  // make sure the RequestProcessor is who logged this record
        assertTrue(logRecordsContainingAbstractJAXBProvider.get(0).getMessage().contains("\tDEBUG_FRAME = "));  // make sure we have a stack printed with "DEBUG_FRAME = " instead of " at "
    }
}