com.github.yongchristophertang.engine.web.ResultActions Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-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 com.github.yongchristophertang.engine.web;

/**
 * Allows applying actions, such as expectations, on the result of an executed
 * request.
 * 
 * 
See static factory methods in
 * {@code HttpResultMatchers}
 * {@code HttpResultHandlers}
 * {@code HttpResultTransformers}
 *
 * @author Yong Tang
 * @since 0.4
 */
public interface ResultActions {

    /**
     * Provide an expectation. For example:
     * 
     * static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*
     *
     * mockMvc.perform(get("/person/1"))
     *   .andExpect(status().isOk())
     *   .andExpect(content().mimeType(MediaType.APPLICATION_JSON))
     *   .andExpect(jsonPath("$.person.name").equalTo("Jason"));
     *
     * mockMvc.perform(post("/form"))
     *   .andExpect(status().isOk())
     *   .andExpect(redirectedUrl("/person/1"))
     *   .andExpect(model().size(1))
     *   .andExpect(model().attributeExists("person"))
     *   .andExpect(flash().attributeCount(1))
     *   .andExpect(flash().attribute("message", "success!"));
     * 
     */
    ResultActions andExpect(ResultMatcher matcher) throws Exception;

    /**
     * Provide a general action. For example:
     *      * static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*
     *
     * mockMvc.perform(get("/form")).andDo(print());
     * 
     */
    ResultActions andDo(ResultHandler handler) throws Exception;

    /**
     * Provide a transformation of the result. It is a terminal method.
     *
     * @return the transformation of the result
     */
     T andTransform(ResultTransform transformer) throws Exception;

    /**
     * Return the result of the executed request for direct access to the results.
     *
     * @return the result of the request
     */
    HttpResult andReturn() throws Exception;

}