Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use HttpClientRequestActionBuilder method of com.consol.citrus.dsl.builder.HttpClientRequestActionBuilder class

Best Citrus code snippet using com.consol.citrus.dsl.builder.HttpClientRequestActionBuilder.HttpClientRequestActionBuilder

Source:TestActionUtil.java

1package org.sunbird.common.action;2import com.consol.citrus.TestAction;3import com.consol.citrus.context.TestContext;4import com.consol.citrus.dsl.builder.HttpActionBuilder;5import com.consol.citrus.dsl.builder.HttpClientRequestActionBuilder;6import com.consol.citrus.exceptions.CitrusRuntimeException;7import com.consol.citrus.message.MessageType;8import com.consol.citrus.validation.json.JsonMappingValidationCallback;9import com.fasterxml.jackson.databind.ObjectMapper;10import java.io.File;11import java.io.IOException;12import java.text.MessageFormat;13import java.util.HashMap;14import java.util.Map;15import java.util.Scanner;16import javax.ws.rs.core.MediaType;17import org.apache.commons.lang3.StringUtils;18import org.springframework.core.io.ClassPathResource;19import org.springframework.http.HttpStatus;20import org.springframework.util.LinkedMultiValueMap;21import org.springframework.util.MultiValueMap;22import org.sunbird.common.util.Constant;23import org.sunbird.integration.test.user.EndpointConfig.TestGlobalProperty;24public class TestActionUtil {25  public static TestAction getTokenRequestTestAction(26      HttpActionBuilder builder, String endpointName) {27    String userName = System.getenv("sunbird_username");28    String password = System.getenv("sunbird_user_password");29    return getTokenRequestTestAction(builder, endpointName, userName, password);30  }31  public static TestAction getTokenRequestTestAction(32      HttpActionBuilder builder, String endpointName, String userName, String password) {33    String urlPath =34        "/realms/" + System.getenv("sunbird_sso_realm") + "/protocol/openid-connect/token";35    return builder36        .client(endpointName)37        .send()38        .post(urlPath)39        .contentType("application/x-www-form-urlencoded")40        .payload(41            "client_id="42                + System.getenv("sunbird_sso_client_id")43                + "&username="44                + userName45                + "&password="46                + password47                + "&grant_type=password");48  }49  public static TestAction getPutRequestTestAction(50      HttpActionBuilder builder,51      String endPoint,52      String url,53      Map<String, Object> headers,54      String payLoad) {55    HttpClientRequestActionBuilder requestActionBuilder = builder.client(endPoint).send().put(url);56    addHeaders(requestActionBuilder, headers);57    requestActionBuilder.contentType(Constant.CONTENT_TYPE_APPLICATION_JSON);58    requestActionBuilder.payload(payLoad);59    return requestActionBuilder;60  }61  public static TestAction getTokenResponseTestAction(62      HttpActionBuilder builder, String endpointName) {63    return builder64        .client(endpointName)65        .receive()66        .response(HttpStatus.OK)67        .messageType(MessageType.JSON)68        .extractFromPayload("$.access_token", "accessToken");69  }70  public static TestAction getPostRequestTestAction(71      HttpActionBuilder builder,72      String endpointName,73      String testTemplateDir,74      String testName,75      String url,76      String requestFile,77      String contentType,78      Map<String, Object> headers) {79    String requestFilePath =80        MessageFormat.format("{0}/{1}/{2}", testTemplateDir, testName, requestFile);81    System.out.println("requestFilePath = " + requestFilePath);82    HttpClientRequestActionBuilder requestActionBuilder =83        builder.client(endpointName).send().post(url).messageType(MessageType.JSON);84    if (StringUtils.isNotBlank(contentType)) {85      requestActionBuilder.contentType(contentType);86    }87    requestActionBuilder = addHeaders(requestActionBuilder, headers);88    return requestActionBuilder.payload(new ClassPathResource(requestFilePath));89  }90  public static TestAction getPatchRequestTestAction(91      HttpActionBuilder builder,92      String endpointName,93      String testTemplateDir,94      String testName,95      String url,96      String requestFile,97      String contentType,98      Map<String, Object> headers) {99    String requestFilePath =100        MessageFormat.format("{0}/{1}/{2}", testTemplateDir, testName, requestFile);101    HttpClientRequestActionBuilder requestActionBuilder =102        builder.client(endpointName).send().patch(url).messageType(MessageType.JSON);103    if (StringUtils.isNotBlank(contentType)) {104      requestActionBuilder.contentType(contentType);105    }106    requestActionBuilder = addHeaders(requestActionBuilder, headers);107    return requestActionBuilder.payload(new ClassPathResource(requestFilePath));108  }109  public static TestAction getDeleteRequestTestAction(110      HttpActionBuilder builder,111      String endpointName,112      String testTemplateDir,113      String testName,114      String url,115      String requestFile,116      String contentType,117      Map<String, Object> headers) {118    HttpClientRequestActionBuilder requestActionBuilder =119        builder.client(endpointName).send().delete(url).messageType(MessageType.JSON);120    if (StringUtils.isNotBlank(contentType)) {121      requestActionBuilder.contentType(contentType);122    }123    requestActionBuilder = addHeaders(requestActionBuilder, headers);124    if (StringUtils.isNotBlank(requestFile)) {125      String requestFilePath =126          MessageFormat.format("{0}/{1}/{2}", testTemplateDir, testName, requestFile);127      return requestActionBuilder.payload(new ClassPathResource(requestFilePath));128    }129    return requestActionBuilder;130  }131  public static TestAction getMultipartRequestTestAction(132      TestContext context,133      HttpActionBuilder builder,134      String endpointName,135      String testTemplateDir,136      String testName,137      String requestUrl,138      String requestFile,139      Map<String, Object> headers,140      ClassLoader classLoader,141      TestGlobalProperty config) {142    String formDataFileFolderPath = MessageFormat.format("{0}/{1}", testTemplateDir, testName);143    String formDataFile =144        MessageFormat.format("{0}/{1}/{2}", testTemplateDir, testName, requestFile);145    System.out.println("formDataFile = " + formDataFile);146    MultiValueMap<String, Object> formData = new LinkedMultiValueMap<>();147    try (Scanner scanner = new Scanner(new File(classLoader.getResource(formDataFile).getFile()))) {148      while (scanner.hasNext()) {149        String[] param = scanner.nextLine().split(Constant.EQUAL_SIGN);150        if (param != null && param.length == 2) {151          if (param[0].equalsIgnoreCase(Constant.MULTIPART_FILE_NAME)) {152            formData.add(153                Constant.MULTIPART_FILE_NAME,154                new ClassPathResource(formDataFileFolderPath + "/" + param[1]));155          } else {156            formData.add(param[0], TestActionUtil.getVariable(context, param[1]));157          }158        }159      }160    } catch (IOException e) {161      e.printStackTrace();162    }163    HttpClientRequestActionBuilder actionBuilder =164        builder165            .client(endpointName)166            .send()167            .post(requestUrl)168            .contentType(MediaType.MULTIPART_FORM_DATA)169            .header(Constant.AUTHORIZATION, Constant.BEARER + config.getApiKey());170    if (null != headers) {171      actionBuilder = addHeaders(actionBuilder, headers);172    }173    return actionBuilder.payload(formData);174  }175  public static TestAction getResponseTestAction(176      HttpActionBuilder builder,177      String endpointName,178      String testTemplateDir,179      String testName,180      HttpStatus responseCode,181      String responseFile) {182    if (StringUtils.isBlank(responseFile)) {183      return getResponseTestAction(builder, endpointName, testName, responseCode);184    }185    String responseFilePath =186        MessageFormat.format("{0}/{1}/{2}", testTemplateDir, testName, responseFile);187    return builder188        .client(endpointName)189        .receive()190        .response(responseCode)191        .validator("defaultJsonMessageValidator")192        .messageType(MessageType.JSON)193        .payload(new ClassPathResource(responseFilePath));194  }195  public static TestAction getExtractFromResponseTestAction(196      TestContext testContext,197      HttpActionBuilder builder,198      String endpointName,199      HttpStatus responseCode,200      String extractFieldPath,201      String extractVariable) {202    ObjectMapper mapper = new ObjectMapper();203    return builder204        .client(endpointName)205        .receive()206        .response(responseCode)207        .validator("defaultJsonMessageValidator")208        .messageType(MessageType.JSON)209        .extractFromPayload(extractFieldPath, extractVariable)210        .validationCallback(211            new JsonMappingValidationCallback<Map>(Map.class, mapper) {212              @Override213              public void validate(Map response, Map<String, Object> headers, TestContext context) {214                String extractValue =215                    (String) context.getVariables().getOrDefault(extractVariable, extractVariable);216                testContext.getVariables().put(extractVariable, extractValue);217                System.out.println("extractVariable = " + extractValue);218              }219            });220  }221  public static Map<String, Object> getHeaders(boolean isAuthRequired) {222    Map<String, Object> headers = new HashMap<>();223    if (isAuthRequired) {224      headers.put(Constant.X_AUTHENTICATED_USER_TOKEN, "${accessToken}");225    }226    headers.put("X-Channel-Id", "channel");227    headers.put(Constant.AUTHORIZATION, Constant.BEARER + System.getenv("sunbird_api_key"));228    return headers;229  }230  public static Map<String, Object> getHeaders(231      boolean isAuthRequired, Map<String, Object> additionalHeaders) {232    if (null == additionalHeaders) {233      additionalHeaders = new HashMap<>();234    }235    additionalHeaders.putAll(getHeaders(isAuthRequired));236    return additionalHeaders;237  }238  private static HttpClientRequestActionBuilder addHeaders(239      HttpClientRequestActionBuilder actionBuilder, Map<String, Object> headers) {240    if (headers != null) {241      for (Map.Entry<String, Object> entry : headers.entrySet()) {242        actionBuilder = actionBuilder.header(entry.getKey(), entry.getValue());243      }244    }245    return actionBuilder;246  }247  public static String getVariable(TestContext testContext, String variableName) {248    String value;249    try {250      value = testContext.getVariable(variableName);251    } catch (CitrusRuntimeException exception) {252      value = variableName;253    }254    return value;255  }256  public static TestAction performGetTest(257      HttpActionBuilder builder,258      String endpointName,259      String testName,260      String requestUrl,261      Map<String, Object> headers,262      TestGlobalProperty config) {263    HttpClientRequestActionBuilder actionBuilder =264        builder265            .client(endpointName)266            .send()267            .get(requestUrl)268            .messageType(MessageType.JSON)269            .header(Constant.AUTHORIZATION, Constant.BEARER + config.getApiKey());270    if (null != headers) {271      actionBuilder = addHeaders(actionBuilder, headers);272    }273    return actionBuilder;274  }275  public static TestAction getResponseTestAction(276      HttpActionBuilder builder, String endpointName, String testName, HttpStatus responseCode) {277    return builder...

Source:HttpClientActionBuilder.java

...64     * @param method65     * @param path66     * @return67     */68    private HttpClientRequestActionBuilder request(HttpMethod method, String path) {69        HttpClientRequestActionBuilder httpClientRequestActionBuilder;70        if (httpClient != null) {71            httpClientRequestActionBuilder = new HttpClientRequestActionBuilder(action, httpClient);72        } else {73            httpClientRequestActionBuilder = new HttpClientRequestActionBuilder(action, httpClientUri);74        }75        httpClientRequestActionBuilder.withApplicationContext(applicationContext);76        httpClientRequestActionBuilder.method(method);77        if (StringUtils.hasText(path)) {78            httpClientRequestActionBuilder.path(path);79        }80        return httpClientRequestActionBuilder;81    }82    /**83     * Sets the Spring bean application context.84     * @param applicationContext85     */86    public HttpClientActionBuilder withApplicationContext(ApplicationContext applicationContext) {87        this.applicationContext = applicationContext;88        return this;89    }90    /**91     * Provides send request action methods.92     */93    public class HttpClientSendActionBuilder {94        /**95         * Sends Http GET request as client to server.96         */97        public HttpClientRequestActionBuilder get() {98            return request(HttpMethod.GET, null);99        }100        /**101         * Sends Http GET request as client to server.102         */103        public HttpClientRequestActionBuilder get(String path) {104            return request(HttpMethod.GET, path);105        }106        /**107         * Sends Http POST request as client to server.108         */109        public HttpClientRequestActionBuilder post() {110            return request(HttpMethod.POST, null);111        }112        /**113         * Sends Http POST request as client to server.114         */115        public HttpClientRequestActionBuilder post(String path) {116            return request(HttpMethod.POST, path);117        }118        /**119         * Sends Http PUT request as client to server.120         */121        public HttpClientRequestActionBuilder put() {122            return request(HttpMethod.PUT, null);123        }124        /**125         * Sends Http PUT request as client to server.126         */127        public HttpClientRequestActionBuilder put(String path) {128            return request(HttpMethod.PUT, path);129        }130        /**131         * Sends Http DELETE request as client to server.132         */133        public HttpClientRequestActionBuilder delete() {134            return request(HttpMethod.DELETE, null);135        }136        /**137         * Sends Http DELETE request as client to server.138         */139        public HttpClientRequestActionBuilder delete(String path) {140            return request(HttpMethod.DELETE, path);141        }142        /**143         * Sends Http HEAD request as client to server.144         */145        public HttpClientRequestActionBuilder head() {146            return request(HttpMethod.HEAD, null);147        }148        /**149         * Sends Http HEAD request as client to server.150         */151        public HttpClientRequestActionBuilder head(String path) {152            return request(HttpMethod.HEAD, path);153        }154        /**155         * Sends Http OPTIONS request as client to server.156         */157        public HttpClientRequestActionBuilder options() {158            return request(HttpMethod.OPTIONS, null);159        }160        /**161         * Sends Http OPTIONS request as client to server.162         */163        public HttpClientRequestActionBuilder options(String path) {164            return request(HttpMethod.OPTIONS, path);165        }166        /**167         * Sends Http TRACE request as client to server.168         */169        public HttpClientRequestActionBuilder trace() {170            return request(HttpMethod.TRACE, null);171        }172        /**173         * Sends Http TRACE request as client to server.174         */175        public HttpClientRequestActionBuilder trace(String path) {176            return request(HttpMethod.TRACE, path);177        }178        /**179         * Sends Http PATCH request as client to server.180         */181        public HttpClientRequestActionBuilder patch() {182            return request(HttpMethod.PATCH, null);183        }184        /**185         * Sends Http PATCH request as client to server.186         */187        public HttpClientRequestActionBuilder patch(String path) {188            return request(HttpMethod.PATCH, path);189        }190    }191    /**192     * Provides receive response action methods.193     */194    public class HttpClientReceiveActionBuilder {195        /**196         * Generic response builder for expecting response messages on client.197         * @return198         */199        public HttpClientResponseActionBuilder response() {200            HttpClientResponseActionBuilder httpClientResponseActionBuilder;201            if (httpClient != null) {...

Source:HttpClientRequestActionBuilder.java

...27/**28 * @author Christoph Deppisch29 * @since 2.430 */31public class HttpClientRequestActionBuilder extends SendMessageBuilder<SendMessageAction, HttpClientRequestActionBuilder> {32    /** Http message to send or receive */33    private HttpMessage httpMessage = new HttpMessage();34    /**35     * Default constructor using http client endpoint.36     * @param delegate37     * @param httpClient38     */39    public HttpClientRequestActionBuilder(DelegatingTestAction<TestAction> delegate, Endpoint httpClient) {40        super(delegate);41        delegate.setDelegate(new SendMessageAction());42        getAction().setEndpoint(httpClient);43        initMessage(httpMessage);44    }45    /**46     * Default constructor using http client uri.47     * @param delegate48     * @param httpClientUri49     */50    public HttpClientRequestActionBuilder(DelegatingTestAction<TestAction> delegate, String httpClientUri) {51        super(delegate);52        delegate.setDelegate(new SendMessageAction());53        getAction().setEndpointUri(httpClientUri);54        initMessage(httpMessage);55    }56    /**57     * Initialize message builder.58     * @param message59     */60    private void initMessage(HttpMessage message) {61        StaticMessageContentBuilder staticMessageContentBuilder = StaticMessageContentBuilder.withMessage(message);62        staticMessageContentBuilder.setMessageHeaders(message.getHeaders());63        getAction().setMessageBuilder(new HttpMessageContentBuilder(message, staticMessageContentBuilder));64    }65    @Override66    protected void setPayload(String payload) {67        httpMessage.setPayload(payload);68    }69    /**70     * Adds message payload multi value map data to this builder. This is used when using multipart file upload via71     * Spring RestTemplate.72     * @param payload73     * @return74     */75    public HttpClientRequestActionBuilder payload(MultiValueMap<String,Object> payload) {76        httpMessage.setPayload(payload);77        return this;78    }79    @Override80    public HttpClientRequestActionBuilder name(String name) {81        httpMessage.setName(name);82        return super.name(name);83    }84    /**85     * Sets the request path.86     * @param path87     * @return88     */89    public HttpClientRequestActionBuilder path(String path) {90        httpMessage.path(path);91        return this;92    }93    /**94     * Sets the request method.95     * @param method96     * @return97     */98    public HttpClientRequestActionBuilder method(HttpMethod method) {99        httpMessage.method(method);100        return this;101    }102    /**103     * Set the endpoint URI for the request. This works only if the HTTP endpoint used104     * doesn't provide an own endpoint URI resolver.105     *106     * @param uri absolute URI to use for the endpoint107     * @return self108     */109    public HttpClientRequestActionBuilder uri(String uri) {110        httpMessage.uri(uri);111        return this;112    }113    /**114     * Adds a query param to the request uri.115     * @param name116     * @return117     */118    public HttpClientRequestActionBuilder queryParam(String name) {119        httpMessage.queryParam(name, null);120        return this;121    }122    /**123     * Adds a query param to the request uri.124     * @param name125     * @param value126     * @return127     */128    public HttpClientRequestActionBuilder queryParam(String name, String value) {129        httpMessage.queryParam(name, value);130        return this;131    }132    /**133     * Sets the http version.134     * @param version135     * @return136     */137    public HttpClientRequestActionBuilder version(String version) {138        httpMessage.version(version);139        return this;140    }141    /**142     * Sets the request content type header.143     * @param contentType144     * @return145     */146    public HttpClientRequestActionBuilder contentType(String contentType) {147        httpMessage.contentType(contentType);148        return this;149    }150    /**151     * Sets the request accept header.152     * @param accept153     * @return154     */155    public HttpClientRequestActionBuilder accept(String accept) {156        httpMessage.accept(accept);157        return this;158    }159    /**160     * Adds cookie to response by "Cookie" header.161     * @param cookie162     * @return163     */164    public HttpClientRequestActionBuilder cookie(Cookie cookie) {165        httpMessage.cookie(cookie);166        return this;167    }168    @Override169    public HttpClientRequestActionBuilder message(Message message) {170        HttpMessageUtils.copy(message, httpMessage);171        return this;172    }173}...