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

Copied to Clipboard!

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

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

Source:TestActionUtil.java

1package org.sunbird.integration.test.common;2import com.consol.citrus.TestAction;3import com.consol.citrus.TestCase;4import com.consol.citrus.dsl.builder.HttpClientActionBuilder;5import com.consol.citrus.dsl.builder.HttpClientRequestActionBuilder;6import com.consol.citrus.message.MessageType;7import java.io.File;8import java.io.IOException;9import java.text.MessageFormat;10import java.util.HashMap;11import java.util.Map;12import java.util.Scanner;13import javax.ws.rs.core.MediaType;14import org.apache.commons.lang3.StringUtils;15import org.springframework.core.io.ClassPathResource;16import org.springframework.http.HttpStatus;17import org.springframework.util.LinkedMultiValueMap;18import org.springframework.util.MultiValueMap;19import org.sunbird.common.util.Constant;20import org.sunbird.integration.test.user.EndpointConfig.TestGlobalProperty;21public class TestActionUtil {22  public static TestAction getTokenRequestTestAction(HttpClientActionBuilder builder) {23    String userName = System.getenv("sunbird_username");24    String password = System.getenv("sunbird_user_password");25    return getTokenRequestTestAction(builder, userName, password);26  }27  public static TestAction getTokenRequestTestAction(28      HttpClientActionBuilder builder, String userName, String password) {29    String urlPath =30        "/realms/" + System.getenv("sunbird_sso_realm") + "/protocol/openid-connect/token";31    return builder32        .send()33        .post(urlPath)34        .contentType("application/x-www-form-urlencoded")35        .payload(36            "client_id="37                + System.getenv("sunbird_sso_client_id")38                + "&username="39                + userName40                + "&password="41                + password42                + "&grant_type=password");43  }44  public static TestAction getTokenResponseTestAction(45      HttpClientActionBuilder builder, TestCase testCase) {46    return builder47        .receive()48        .response(HttpStatus.OK)49        .messageType(MessageType.JSON)50        .extractFromPayload("$.access_token", "accessToken");51  }52  public static TestAction getPostRequestTestAction(53      HttpClientActionBuilder builder,54      TestCase testCase,55      String testName,56      String testTemplateDir,57      String url,58      String contentType,59      String requestFile,60      Map<String, Object> headers) {61    testCase.setName(testName);62    String requestFilePath =63        MessageFormat.format("{0}/{1}/{2}", testTemplateDir, testName, requestFile);64    HttpClientRequestActionBuilder requestActionBuilder =65        builder.send().post(url).messageType(MessageType.JSON);66    if (StringUtils.isNotBlank(contentType)) {67      requestActionBuilder.contentType(contentType);68    }69    addHeaders(requestActionBuilder, headers);70    return requestActionBuilder.payload(new ClassPathResource(requestFilePath));71  }72  public static TestAction getMultipartRequestTestAction(73      HttpClientActionBuilder builder,74      TestCase testCase,75      String testName,76      String testTemplateDir,77      String url,78      String requestFile,79      Map<String, Object> headers,80      ClassLoader classLoader,81      TestGlobalProperty config) {82    testCase.setName(testName);83    String formDataFileFolderPath = MessageFormat.format("{0}/{1}", testTemplateDir, testName);84    String formDataFile =85        MessageFormat.format("{0}/{1}/{2}", testTemplateDir, testName, requestFile);86    MultiValueMap<String, Object> formData = new LinkedMultiValueMap<>();87    try (Scanner scanner = new Scanner(new File(classLoader.getResource(formDataFile).getFile()))) {88      while (scanner.hasNext()) {89        String[] param = scanner.nextLine().split(Constant.EQUAL_SIGN);90        if (param != null && param.length == 2) {91          if (param[0].equalsIgnoreCase(Constant.MULTIPART_FILE_NAME)) {92            formData.add(93                Constant.MULTIPART_FILE_NAME,94                new ClassPathResource(formDataFileFolderPath + "/" + param[1]));95          } else {96            formData.add(param[0], param[1]);97          }98        }99      }100    } catch (IOException e) {101      e.printStackTrace();102    }103    HttpClientRequestActionBuilder actionBuilder =104        builder105            .send()106            .post(url)107            .contentType(MediaType.MULTIPART_FORM_DATA)108            .header(Constant.AUTHORIZATION, Constant.BEARER + config.getApiKey());109    if (null != headers) {110      actionBuilder = addHeaders(actionBuilder, headers);111    }112    return actionBuilder.payload(formData);113  }114  public static TestAction getResponseTestAction(115      HttpClientActionBuilder builder,116      String testName,117      String testTemplateDir,118      HttpStatus responseCode,119      String responseFile) {120    String responseFilePath =121        MessageFormat.format("{0}/{1}/{2}", testTemplateDir, testName, responseFile);122    return builder123        .receive()124        .response(responseCode)125        .validator("defaultJsonMessageValidator")126        .messageType(MessageType.JSON)127        .payload(new ClassPathResource(responseFilePath));128  }129  public static Map<String, Object> getHeaders(boolean isAuthRequired) {130    Map<String, Object> headers = new HashMap<>();131    if (isAuthRequired) {132      headers.put(Constant.X_AUTHENTICATED_USER_TOKEN, "${accessToken}");133    }134    headers.put(Constant.AUTHORIZATION, Constant.BEARER + System.getenv("sunbird_api_key"));135    return headers;136  }137  private static HttpClientRequestActionBuilder addHeaders(138      HttpClientRequestActionBuilder actionBuilder, Map<String, Object> headers) {139    if (headers != null) {140      for (Map.Entry<String, Object> entry : headers.entrySet()) {141        actionBuilder = actionBuilder.header(entry.getKey(), entry.getValue());142      }143    }144    return actionBuilder;145  }146}...

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}...

HttpClientRequestActionBuilder

Using AI Code Generation

1import com.consol.citrus.dsl.builder.HttpClientRequestActionBuilder;2import com.consol.citrus.dsl.design.TestDesigner;3import com.consol.citrus.dsl.runner.TestRunner;4import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;5import org.testng.annotations.Test;6public class 3 extends TestNGCitrusTestDesigner {7    public void 3() {8        description("Test to check the functionality of 3");9        variable("requestBody", "{\"id\":1,\"name\":\"test\"}");10        variable("contentType", "application/json");11        http(httpActionBuilder -> httpActionBuilder.client("httpClient")12            .send()13            .post("${url}")14            .contentType("${contentType}")15            .payload("${requestBody}"));16        http(httpActionBuilder -> httpActionBuilder.client("httpClient")17            .receive()18            .response(HttpStatus.OK)19            .contentType("${contentType}"));20    }21}22import com.consol.citrus.dsl.builder.HttpActionBuilder;23import com.consol.citrus.dsl.design.TestDesigner;24import com.consol.citrus.dsl.runner.TestRunner;25import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;26import org.testng.annotations.Test;27public class 3 extends TestNGCitrusTestDesigner {28    public void 3() {29        description("Test to check the functionality of 3");30        variable("requestBody", "{\"id\":1,\"name\":\"test\"}");31        variable("contentType", "application/json");32        http(httpActionBuilder -> httpActionBuilder.client("httpClient")33            .send()34            .post("${url}")35            .contentType("${contentType}")36            .payload("${requestBody}"));37        http(httpActionBuilder -> httpActionBuilder.client("httpClient")38            .receive()39            .response(HttpStatus.OK)40            .contentType("${contentType}"));41    }42}43import com.consol.citrus.dsl.builder.HttpActionBuilder;44import com.consol.citrus.dsl.design.TestDesigner;45import com.consol.citrus.dsl.runner.TestRunner

HttpClientRequestActionBuilder

Using AI Code Generation

1import com.consol.citrus.dsl.builder.HttpClientRequestActionBuilder;2import com.consol.citrus.dsl.runner.TestRunner;3import com.consol.citrus.dsl.runner.TestRunnerSupport;4import com.consol.citrus.http.client.HttpClient;5import com.consol.citrus.message.MessageType;6import com.consol.citrus.testng.AbstractTestNGUnitTest;7import org.testng.annotations.Test;8public class HttpClientRequestActionBuilderTest extends AbstractTestNGUnitTest {9    private HttpClientRequestActionBuilder httpClientRequestActionBuilder;10    private HttpClient client = new HttpClient();11    private TestRunner runner = new TestRunnerSupport();12    public void testHttpClientRequestBuilder() {13        httpClientRequestActionBuilder = new HttpClientRequestActionBuilder(runner, client);14        httpClientRequestActionBuilder.endpoint(client)15                .messageType(MessageType.PLAINTEXT)16                .payload("Hello World!")17                .send();18    }19}20import com.consol.citrus.dsl.builder.HttpRequestActionBuilder;21import com.consol.citrus.dsl.runner.TestRunner;22import com.consol.citrus.dsl.runner.TestRunnerSupport;23import com.consol.citrus.http.message.HttpMessage;24import com.consol.citrus.message.MessageType;25import com.consol.citrus.testng.AbstractTestNGUnitTest;26import org.testng.annotations.Test;27public class HttpRequestActionBuilderTest extends AbstractTestNGUnitTest {28    private HttpRequestActionBuilder httpRequestActionBuilder;29    private TestRunner runner = new TestRunnerSupport();30    private HttpMessage message = new HttpMessage();31    public void testHttpRequestBuilder() {32        httpRequestActionBuilder = new HttpRequestActionBuilder(runner);33        httpRequestActionBuilder.message(message)34                .messageType(MessageType.PLAINTEXT)35                .payload("Hello World!")36                .send();37    }38}39import com.consol.citrus.dsl.builder.JmsActionBuilder;40import com.consol.citrus.dsl.runner.TestRunner;41import com.consol.citrus.dsl.runner.TestRunnerSupport;42import com.consol.citrus.jms.message.JmsMessage;43import com.consol.citrus.message.MessageType;44import com.consol.citrus.testng.AbstractTestNGUnitTest;45import org.testng.annotations.Test;

HttpClientRequestActionBuilder

Using AI Code Generation

1package com.consol.citrus.dsl.builder;2import com.consol.citrus.actions.AbstractTestAction;3import com.consol.citrus.context.TestContext;4import com.consol.citrus.dsl.builder.HttpClientRequestActionBuilder.HttpClientRequestAction;5import com.consol.citrus.dsl.builder.HttpClientResponseActionBuilder.HttpClientResponseAction;6import com.consol.citrus.http.client.HttpClient;7import com.consol.citrus.message.MessageType;8import org.springframework.http.HttpMethod;9import org.springframework.util.StringUtils;10import java.util.Map;

HttpClientRequestActionBuilder

Using AI Code Generation

1package com.consol.citrus.dsl.builder;2import com.consol.citrus.dsl.builder.HttpClientRequestActionBuilder.HttpClientRequestActionBuilderSupport;3import com.consol.citrus.http.client.HttpClient;4import com.consol.citrus.message.MessageType;5import com.consol.citrus.testng.AbstractTestNGUnitTest;6import com.consol.citrus.validation.builder.HeaderValidationBuilder;7import com.consol.citrus.validation.builder.PayloadTemplateValidationBuilder;8import org.testng.annotations.Test;9import java.util.Collections;10import static com.consol.citrus.actions.HttpClientRequestAction.Builder.httpClient;11import static com.consol.citrus.actions.SendMessageAction.Builder.send;12import static com.consol.citrus.http.actions.HttpActionBuilder.http;13public class HttpClientRequestActionBuilderTest extends AbstractTestNGUnitTest {14    private final HttpClient client = new HttpClient();15    public void testHttpClientRequestBuilder() {16        http().client(client)17                .send()18                .post("/test")19                .message()20                .body("<TestRequest><Message>Hello World!</Message></TestRequest>")21                .contentType("application/xml")22                .header("Operation", "sayHello")23                .build();24        http().client(client)25                .send()26                .get("/test")27                .message()28                .body("<TestRequest><Message>Hello World!</Message></TestRequest>")29                .contentType("application/xml")30                .header("Operation", "sayHello")31                .build();32        http().client(client)33                .send()34                .put("/test")35                .message()36                .body("<TestRequest><Message>Hello World!</Message></TestRequest>")37                .contentType("application/xml")38                .header("Operation", "sayHello")39                .build();40        http().client(client)41                .send()42                .delete("/test")43                .message()44                .body("<TestRequest><Message>Hello World!</Message></TestRequest>")45                .contentType("application/xml")46                .header("Operation", "sayHello")47                .build();48        http().client(client)49                .send()50                .head("/test")51                .message()52                .body("<TestRequest><Message>Hello World!</Message></TestRequest>")53                .contentType("application/xml")54                .header("Operation", "sayHello")55                .build();56        http().client(client)57                .send()58                .options("/test")59                .message()60                .body("<TestRequest><Message

HttpClientRequestActionBuilder

Using AI Code Generation

1public class 3 extends TestNGCitrusTestDesigner {2    public void configure() {3        http(httpActionBuilder -> httpActionBuilder4            .client("httpClient")5            .send()6            .post()7            .contentType("application/json")8            .payload("{ \"id\": \"123\", \"name\": \"citrus\" }")9            .header("operation", "create")10            .header("Accept", "application/json")11            .header("Content-Type", "application/json"));12        http(httpActionBuilder -> httpActionBuilder13            .client("httpClient")14            .receive()15            .response(HttpStatus.OK)16            .contentType("application/json")17            .payload("{ \"id\": \"123\", \"name\": \"citrus\" }")18            .header("operation", "create")19            .header("Accept", "application/json")20            .header("Content-Type", "application/json"));21    }22}23public class 4 extends TestNGCitrusTestDesigner {24    public void configure() {25        http(httpActionBuilder -> httpActionBuilder26            .client("httpClient")27            .send()28            .post()29            .contentType("application/json")30            .payload("{ \"id\": \"123\", \"name\": \"citrus\" }")31            .header("operation", "create")32            .header("Accept", "application/json")33            .header("Content-Type", "application/json"));34        http(httpActionBuilder -> httpActionBuilder35            .client("httpClient")36            .receive()37            .response(HttpStatus.OK)38            .contentType("application/json")39            .payload("{ \"id\": \"123\", \"name\": \"citrus\" }")40            .header("operation", "create")41            .header("Accept", "application/json")42            .header("Content-Type", "application/json"));43    }44}45public class 5 extends TestNGCitrusTestDesigner {46    public void configure() {47        http(httpActionBuilder -> httpActionBuilder48            .client("httpClient")49            .send()50            .post()51            .contentType("application/json")52            .payload("{ \"id\": \"123\", \"name\": \"citrus\"

HttpClientRequestActionBuilder

Using AI Code Generation

1package com.consol.citrus.samples;2import com.consol.citrus.dsl.testng.TestNGCitrusTestRunner;3import org.testng.annotations.Test;4public class 3 extends TestNGCitrusTestRunner {5public void test() {6http().client("httpClient")7.send()8.header("Accept", "text/plain");9http().client("httpClient")10.receive()11.response(HttpStatus.OK)12.payload("Hello Citrus!");13}14}

HttpClientRequestActionBuilder

Using AI Code Generation

1package com.consol.citrus.dsl.builder;2import com.consol.citrus.actions.EchoAction;3import com.consol.citrus.dsl.runner.TestRunner;4public class HttpClientRequestActionBuilder {5private TestRunner runner;6public HttpClientRequestActionBuilder(TestRunner runner) {7this.runner = runner;8}9public HttpClientRequestActionBuilder echo(String message) {10runner.run(new EchoAction(message));11return this;12}13}14package com.consol.citrus.dsl.builder;15import com.consol.citrus.actions.EchoAction;16import com.consol.citrus.dsl.runner.TestRunner;17public class HttpClientRequestActionBuilder {18private TestRunner runner;19public HttpClientRequestActionBuilder(TestRunner runner) {20this.runner = runner;21}22public HttpClientRequestActionBuilder echo(String message) {23runner.run(new EchoAction(message));24return this;25}26}27package com.consol.citrus.dsl.builder;28import com.consol.citrus.actions.EchoAction;29import com.consol.citrus.dsl.runner.TestRunner;30public class HttpClientRequestActionBuilder {31private TestRunner runner;32public HttpClientRequestActionBuilder(TestRunner runner) {33this.runner = runner;34}35public HttpClientRequestActionBuilder echo(String message) {36runner.run(new EchoAction(message));37return this;38}39}40package com.consol.citrus.dsl.builder;41import com.consol.citrus.actions.EchoAction;42import com.consol.citrus.dsl.runner.TestRunner;43public class HttpClientRequestActionBuilder {44private TestRunner runner;45public HttpClientRequestActionBuilder(TestRunner runner) {46this.runner = runner;47}48public HttpClientRequestActionBuilder echo(String message) {49runner.run(new EchoAction(message));50return this;51}52}53package com.consol.citrus.dsl.builder;54import com.consol.citrus.actions.EchoAction;55import com.consol.citrus.dsl.runner.TestRunner;56public class HttpClientRequestActionBuilder {57private TestRunner runner;58public HttpClientRequestActionBuilder(TestRunner runner

HttpClientRequestActionBuilder

Using AI Code Generation

1public class 3 extends TestNGCitrusTestDesigner {2    public void configure() {3        http(httpActionBuilder -> httpActionBuilder.client("httpClient")4            .send()5            .post()6            .payload("<Hello>World!</Hello>")7            .header("Content-Type", "text/xml")8            .header("Operation", "sayHello")9            .header("citrus_http_method_name", "POST")10            .header("citrus_http_request_uri", "/services/hello")11            .header("citrus_http_version", "HTTP/1.1")12            .header("citrus_http_protocol", "HTTP")13            .header("citrus_http_request_path", "/services/hello")14            .header("citrus_http_request_query_params", "")15            .header("citrus_http_request_query_param", "")16            .header("citrus_http_request_query_param_1", "")17            .header("citrus_http_request_query_param_2", "")18            .header("citrus_http_request_query_param_3", "")19            .header("citrus_http_request_query_param_4", "")20            .header("citrus_http_request_query_param_5", "")21            .header("citrus_http_request_query_param_6", "")22            .header("citrus_http_request_query_param_7", "")23            .header("citrus_http_request_query_param_8", "")24            .header("citrus_http_request_query_param_9", "")25            .header("citrus_http_request_query_param_10", "")26            .header("citrus_http_request_query_param_11", "")27            .header("citrus_http_request_query_param_12", "")28            .header("citrus_http_request_query_param_13", "")29            .header("citrus_http_request_query_param_14", "")30            .header("citrus_http_request_query_param_15", "")31            .header("citrus_http_request_query_param_16", "")32            .header("citrus_http_request_query_param_17", "")33            .header("citrus_http_request_query_param_18", "")34            .header("citrus_http_request_query_param_19", "")35            .header("citrus_http_request_query_param_20", "")36            .header("citrus_http_request_query_param_21", "")37            .header("citrus_http_request_query_param_22", "")38            .header("citrus_http_request_query_param_23", "")39            .header("citrus_http

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.