StringReaderTest.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.jersey.impl.methodparams;

import com.sun.jersey.api.ParamException;
import com.sun.jersey.api.ParamException.CookieParamException;
import com.sun.jersey.api.ParamException.FormParamException;
import com.sun.jersey.api.ParamException.HeaderParamException;
import com.sun.jersey.api.ParamException.MatrixParamException;
import com.sun.jersey.api.ParamException.PathParamException;
import com.sun.jersey.api.ParamException.QueryParamException;
import com.sun.jersey.api.ParamException.URIParamException;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.representation.Form;
import com.sun.jersey.spi.StringReader;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import javax.ws.rs.Path;
import com.sun.jersey.impl.AbstractResourceTester;
import com.sun.jersey.spi.StringReader.ValidateDefaultValue;
import com.sun.jersey.spi.StringReaderProvider;
import com.sun.jersey.spi.inject.Errors;
import java.lang.reflect.ParameterizedType;
import java.net.URI;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import javax.ws.rs.Consumes;
import javax.ws.rs.CookieParam;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.MatrixParam;
import javax.ws.rs.POST;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Cookie;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;

/**
 *
 * @author Paul.Sandoz@Sun.Com
 */
@SuppressWarnings("unchecked")
public class StringReaderTest extends AbstractResourceTester {

    public StringReaderTest(String testName) {
        super(testName);
    }

    @Path("/")
    public static class BadDateResource {
        @GET
        public String doGet(@QueryParam("d") Date d) {
            return "DATE";
        }
    }

    public void testBadDateResource() {
        initiateWebApplication(BadDateResource.class);
        ClientResponse cr = resource("/", false).queryParam("d", "123").
                get(ClientResponse.class);
        assertEquals(404, cr.getStatus());
    }


    @Path("/")
    public static class BadEnumResource {
        public enum ABC {
            A, B, C;
        };

        @GET
        public String doGet(@QueryParam("d") ABC d) {
            return "ENUM";
        }
    }

    public void testBadEnumResource() {
        initiateWebApplication(BadEnumResource.class);
        ClientResponse cr = resource("/", false).queryParam("d", "123").
                get(ClientResponse.class);
        assertEquals(404, cr.getStatus());
    }


    public static class URIStringReaderProvider implements StringReaderProvider<URI> {

        public StringReader<URI> getStringReader(Class<?> type, Type genericType, Annotation[] annotations) {
            if (type != URI.class) return null;

            return new StringReader<URI>() {
                public URI fromString(String value) {
                    return URI.create(value);
                }
            };
        }

    }

    @Path("/")
    public static class BadURIResource {
        @GET
        public String doGet(@QueryParam("d") URI d) {
            return "URI";
        }
    }

    public void testBadURIResource() {
        initiateWebApplication(BadURIResource.class, URIStringReaderProvider.class);
        ClientResponse cr = resource("/", false).queryParam("d", " 123 ").
                get(ClientResponse.class);
        assertEquals(404, cr.getStatus());
    }


    public static class ListOfStringReaderProvider implements StringReaderProvider<List<String>> {

        @Override
        public StringReader<List<String>> getStringReader(Class<?> type,
                Type genericType, Annotation[] annotations) {
            if (type != List.class) return null;

            if (genericType instanceof ParameterizedType) {
                ParameterizedType parameterizedType = (ParameterizedType)genericType;
                if (parameterizedType.getActualTypeArguments().length != 1) return null;

                if (parameterizedType.getActualTypeArguments()[0] != String.class) return null;
            } else {
                return null;
            }

            return new StringReader<List<String>>() {
                @Override
                public List<String> fromString(String value) {
                    return Arrays.asList(value.split(","));
                }
            };
        }
    }

    @Path("/")
    public static class ListOfStringResource {
        @GET
        public String doGet(@QueryParam("l") List<List<String>> l) {
            return l.toString();
        }
    }

    public void testListOfStringReaderProvider() {
        initiateWebApplication(ListOfStringResource.class, ListOfStringReaderProvider.class);
        String s = resource("/", false).queryParam("l", "1,2,3").
                get(String.class);

        assertEquals(Collections.singletonList(Arrays.asList("1", "2", "3")).toString(), s);
    }


    public static abstract class BaseExceptionMapper<T extends ParamException> implements ExceptionMapper<T> {
        public Response toResponse(T exception, String entity) {
            assertEquals("x", exception.getParameterName());
            if (exception.getParameterType() != PathParam.class) {
                assertEquals("default", exception.getDefaultStringValue());
            }
            return Response.fromResponse(exception.getResponse()).entity(entity).build();
        }
    }

    public static class ParamExceptionMapper extends BaseExceptionMapper<ParamException> {
        public Response toResponse(ParamException exception) {
            return toResponse(exception, "param");
        }
    }

    public static class URIExceptionMapper extends BaseExceptionMapper<URIParamException> {
        public Response toResponse(URIParamException exception) {
            return toResponse(exception, "uri");
        }
    }

    public static class PathExceptionMapper extends BaseExceptionMapper<PathParamException> {
        public Response toResponse(PathParamException exception) {
            return toResponse(exception, "path");
        }
    }

    public static class MatrixExceptionMapper extends BaseExceptionMapper<MatrixParamException> {
        public Response toResponse(MatrixParamException exception) {
            return toResponse(exception, "matrix");
        }
    }

    public static class QueryExceptionMapper extends BaseExceptionMapper<QueryParamException> {
        public Response toResponse(QueryParamException exception) {
            return toResponse(exception, "query");
        }
    }

    public static class CookieExceptionMapper extends BaseExceptionMapper<CookieParamException> {
        public Response toResponse(CookieParamException exception) {
            return toResponse(exception, "cookie");
        }
    }

    public static class HeaderExceptionMapper extends BaseExceptionMapper<HeaderParamException> {
        public Response toResponse(HeaderParamException exception) {
            return toResponse(exception, "header");
        }
    }

    public static class FormExceptionMapper extends BaseExceptionMapper<FormParamException> {
        public Response toResponse(FormParamException exception) {
            return toResponse(exception, "form");
        }
    }

    @Path("/")
    public static class ParamExceptionMapperResource {
        @Path("path/{x}")
        @GET
        public String getPath(@PathParam("x") URI x) {
            return "";
        }

        @Path("matrix")
        @GET
        public String getMatrix(@DefaultValue("default") @MatrixParam("x") URI x) {
            return "";
        }

        @Path("query")
        @GET
        public String getQuery(@DefaultValue("default") @QueryParam("x") URI x) {
            return "";
        }

        @Path("cookie")
        @GET
        public String getCookie(@DefaultValue("default") @CookieParam("x") URI x) {
            return "";
        }

        @Path("header")
        @GET
        public String getHeader(@DefaultValue("default") @HeaderParam("x") URI x) {
            return "";
        }

        @Path("form")
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String postForm(@DefaultValue("default") @FormParam("x") URI x) {
            return "";
        }
    }

    public void testParamException() {
        initiateWebApplication(ParamExceptionMapperResource.class,
                PathExceptionMapper.class,
                MatrixExceptionMapper.class,
                QueryExceptionMapper.class,
                CookieExceptionMapper.class,
                HeaderExceptionMapper.class,
                FormExceptionMapper.class);

        ClientResponse cr = resource("/", false).path("path/ 123").
                get(ClientResponse.class);
        assertEquals("path", cr.getEntity(String.class));

        cr = resource("/", false).path("matrix;x= 123").
                get(ClientResponse.class);
        assertEquals("matrix", cr.getEntity(String.class));

        cr = resource("/query", false).queryParam("x", " 123").
                get(ClientResponse.class);
        assertEquals("query", cr.getEntity(String.class));

        cr = resource("/cookie", false).cookie(new Cookie("x", " 123")).
                get(ClientResponse.class);
        assertEquals("cookie", cr.getEntity(String.class));

        cr = resource("/header", false).header("x", " 123").
                get(ClientResponse.class);
        assertEquals("header", cr.getEntity(String.class));

        Form f = new Form();
        f.add("x", " 123");
        cr = resource("/form", false).
                post(ClientResponse.class, f);
        assertEquals("form", cr.getEntity(String.class));
    }

    public void testGeneralParamException() {
        initiateWebApplication(ParamExceptionMapperResource.class,
                ParamExceptionMapper.class);

        ClientResponse cr = resource("/", false).path("path/ 123").
                get(ClientResponse.class);
        assertEquals("param", cr.getEntity(String.class));

        cr = resource("/", false).path("matrix;x= 123").
                get(ClientResponse.class);
        assertEquals("param", cr.getEntity(String.class));

        cr = resource("/query", false).queryParam("x", " 123").
                get(ClientResponse.class);
        assertEquals("param", cr.getEntity(String.class));

        cr = resource("/cookie", false).cookie(new Cookie("x", " 123")).
                get(ClientResponse.class);
        assertEquals("param", cr.getEntity(String.class));

        cr = resource("/header", false).header("x", " 123").
                get(ClientResponse.class);
        assertEquals("param", cr.getEntity(String.class));

        Form f = new Form();
        f.add("x", " 123");
        cr = resource("/form", false).
                post(ClientResponse.class, f);
        assertEquals("param", cr.getEntity(String.class));
    }

    public void testURIParamException() {
        initiateWebApplication(ParamExceptionMapperResource.class,
                URIExceptionMapper.class);

        ClientResponse cr = resource("/", false).path("path/ 123").
                get(ClientResponse.class);
        assertEquals("uri", cr.getEntity(String.class));

        cr = resource("/", false).path("matrix;x= 123").
                get(ClientResponse.class);
        assertEquals("uri", cr.getEntity(String.class));

        cr = resource("/query", false).queryParam("x", " 123").
                get(ClientResponse.class);
        assertEquals("uri", cr.getEntity(String.class));
    }


    public static class ValidateParamReaderProvider implements StringReaderProvider<ValidateParam> {

        public StringReader<ValidateParam> getStringReader(Class<?> type,
                Type genericType, Annotation[] annotations) {
            if (type != ValidateParam.class) return null;

            return new StringReader<ValidateParam>() {
                public ValidateParam fromString(String value) {
                    return new ValidateParam(value);
                }
            };
        }
    }

    public static class ValidateTrueParamReaderProvider implements StringReaderProvider<ValidateParam> {

        @ValidateDefaultValue
        public static class NoValidateParamStringReader implements StringReader<ValidateParam> {
            @Override
            public ValidateParam fromString(String value) {
                return new ValidateParam(value);
            }
        }

        public StringReader<ValidateParam> getStringReader(Class<?> type,
                Type genericType, Annotation[] annotations) {
            if (type != ValidateParam.class) return null;

            return new NoValidateParamStringReader();
        }
    }

    public static class ValidateFalseParamReaderProvider implements StringReaderProvider<ValidateParam> {

        @ValidateDefaultValue(false)
        public static class NoValidateParamStringReader implements StringReader<ValidateParam> {
            @Override
            public ValidateParam fromString(String value) {
                return new ValidateParam(value);
            }
        }

        public StringReader<ValidateParam> getStringReader(Class<?> type,
                Type genericType, Annotation[] annotations) {
            if (type != ValidateParam.class) return null;

            return new NoValidateParamStringReader();
        }
    }

    public static class ValidateParam {
        public final String s;

        public ValidateParam(String s) {
            if (s.equals("invalid"))
                throw new IllegalArgumentException();
            this.s = s;
        }
    }

    @Path("/")
    public static class ValidateParamResource {
        @GET
        public String doGet(@DefaultValue("invalid") @QueryParam("x") ValidateParam d) {
            return d.s;
        }
    }

    private Errors.ErrorMessagesException catches(Closure c) {
        return catches(c, Errors.ErrorMessagesException.class);
    }

    public void testValidateParam() {
        List<Errors.ErrorMessage> messages = catches(new Closure() {
            @Override
            public void f() {
                initiateWebApplication(ValidateParamResource.class, ValidateParamReaderProvider.class);
            }
        }).messages;

        assertEquals(1, messages.size());
    }

    public void testValidateTrueParam() {
        List<Errors.ErrorMessage> messages = catches(new Closure() {
            @Override
            public void f() {
                initiateWebApplication(ValidateParamResource.class, ValidateTrueParamReaderProvider.class);
            }
        }).messages;

        assertEquals(1, messages.size());
    }

    public void testNoValidateFalseParam() {
        initiateWebApplication(ValidateParamResource.class, ValidateFalseParamReaderProvider.class);
        ClientResponse cr = resource("/", false).queryParam("x", "valid").
                get(ClientResponse.class);
        assertEquals("valid", cr.getEntity(String.class));

        cr = resource("/", false).queryParam("x", "invalid").
                get(ClientResponse.class);
        assertEquals(404, cr.getStatus());
    }
}