core/src/test/java/com/opensymphony/xwork2/interceptor/annotations/AnnotationParameterFilterInterceptorTest.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 com.opensymphony.xwork2.interceptor.annotations;

import com.mockobjects.dynamic.Mock;
import com.opensymphony.xwork2.Action;
import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.StubValueStack;
import com.opensymphony.xwork2.util.ValueStack;
import junit.framework.TestCase;
import org.apache.struts2.dispatcher.HttpParameters;

import java.util.HashMap;
import java.util.Map;

/**
 * @author martin.gilday
 * @author jafl
 */
public class AnnotationParameterFilterInterceptorTest extends TestCase {

    ValueStack stack;

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        stack = new StubValueStack();
    }

    /**
     * Only "name" should remain in the parameter map.  All others
     * should be removed
     */
    public void testBlockingByDefault() throws Exception {

		Map<String, Object> parameterMap = new HashMap<>();

        parameterMap.put("job", "Baker");
        parameterMap.put("name", "Martin");

        ActionContext actionContext = ActionContext.of().bind();
        actionContext.withParameters(HttpParameters.create(parameterMap).build());

        Action action = new BlockingByDefaultAction();
        stack.push(action);

        Mock mockInvocation = new Mock(ActionInvocation.class);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);
        mockInvocation.matchAndReturn("getAction", action);
        mockInvocation.matchAndReturn("getStack", stack);
        mockInvocation.expectAndReturn("invoke", Action.SUCCESS);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);

        ActionInvocation invocation = (ActionInvocation) mockInvocation.proxy();

        AnnotationParameterFilterInterceptor interceptor = new AnnotationParameterFilterInterceptor();
        interceptor.intercept(invocation);

        HttpParameters parameters = invocation.getInvocationContext().getParameters();
        assertEquals("Parameter map should contain one entry", 1, parameters.keySet().size());
        assertFalse(parameters.get("job").isDefined());
        assertTrue(parameters.get("name").isDefined());

    }

    /**
     * "name" should be removed from the map, as it is blocked.
     * All other parameters should remain
     */
    public void testAllowingByDefault() throws Exception {

        Map<String, Object> parameterMap = new HashMap<>();

        parameterMap.put("job", "Baker");
        parameterMap.put("name", "Martin");

        ActionContext actionContext = ActionContext.of().bind();
        actionContext.withParameters(HttpParameters.create(parameterMap).build());

        Action action = new AllowingByDefaultAction();
        stack.push(action);

        Mock mockInvocation = new Mock(ActionInvocation.class);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);
        mockInvocation.matchAndReturn("getAction", action);
        mockInvocation.matchAndReturn("getStack", stack);
        mockInvocation.expectAndReturn("invoke", Action.SUCCESS);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);

        ActionInvocation invocation = (ActionInvocation) mockInvocation.proxy();

        AnnotationParameterFilterInterceptor interceptor = new AnnotationParameterFilterInterceptor();
        interceptor.intercept(invocation);

        HttpParameters parameters = invocation.getInvocationContext().getParameters();
        assertEquals("Paramwter map should contain one entry", 1, parameters.keySet().size());
        assertTrue(parameters.get("job").isDefined());
        assertFalse(parameters.get("name").isDefined());

    }

    /**
     * Only "name" should remain in the parameter map.  All others
     * should be removed
     */
    public void testBlockingByDefaultWithModel() throws Exception {

		Map<String, Object> parameterMap = new HashMap<>();

        parameterMap.put("job", "Baker");
        parameterMap.put("name", "Martin");
        parameterMap.put("m1", "s1");
        parameterMap.put("m2", "s2");

        ActionContext actionContext = ActionContext.of().bind();
        actionContext.withParameters(HttpParameters.create(parameterMap).build());
        stack.push(new BlockingByDefaultModel());

        Mock mockInvocation = new Mock(ActionInvocation.class);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);
        mockInvocation.matchAndReturn("getAction", new BlockingByDefaultAction());
        mockInvocation.matchAndReturn("getStack", stack);
        mockInvocation.expectAndReturn("invoke", Action.SUCCESS);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);

        ActionInvocation invocation = (ActionInvocation) mockInvocation.proxy();

        AnnotationParameterFilterInterceptor interceptor = new AnnotationParameterFilterInterceptor();
        interceptor.intercept(invocation);

        HttpParameters parameters = invocation.getInvocationContext().getParameters();
        assertEquals("Parameter map should contain two entries", 2, parameters.keySet().size());
        assertFalse(parameters.get("job").isDefined());
        assertTrue(parameters.get("name").isDefined());
        assertTrue(parameters.get("m1").isDefined());
        assertFalse(parameters.get("m2").isDefined());

    }

    /**
     * "name" should be removed from the map, as it is blocked.
     * All other parameters should remain
     */
    public void testAllowingByDefaultWithModel() throws Exception {

		Map<String, Object> parameterMap = new HashMap<>();

        parameterMap.put("job", "Baker");
        parameterMap.put("name", "Martin");
        parameterMap.put("m1", "s1");
        parameterMap.put("m2", "s2");

        ActionContext actionContext = ActionContext.of().bind();
        actionContext.withParameters(HttpParameters.create(parameterMap).build());
        stack.push(new AllowingByDefaultModel());

        Mock mockInvocation = new Mock(ActionInvocation.class);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);
        mockInvocation.matchAndReturn("getAction", new AllowingByDefaultAction());
        mockInvocation.matchAndReturn("getStack", stack);
        mockInvocation.expectAndReturn("invoke", Action.SUCCESS);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);
        mockInvocation.expectAndReturn("getInvocationContext", actionContext);

        ActionInvocation invocation = (ActionInvocation) mockInvocation.proxy();

        AnnotationParameterFilterInterceptor interceptor = new AnnotationParameterFilterInterceptor();
        interceptor.intercept(invocation);

        HttpParameters parameters = invocation.getInvocationContext().getParameters();
        assertEquals("Parameter map should contain two entries", 2, parameters.keySet().size());
        assertTrue(parameters.get("job").isDefined());
        assertFalse(parameters.get("name").isDefined());
        assertFalse(parameters.get("m1").isDefined());
        assertTrue(parameters.get("m2").isDefined());

    }

}