com.intuit.karate.http.Response Maven / Gradle / Ivy
The newest version!
/*
* The MIT License
*
* Copyright 2022 Karate Labs Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.intuit.karate.http;
import com.intuit.karate.FileUtils;
import com.intuit.karate.StringUtils;
import com.intuit.karate.Json;
import com.intuit.karate.JsonUtils;
import com.intuit.karate.graal.JsArray;
import com.intuit.karate.graal.JsValue;
import com.intuit.karate.graal.Methods;
import io.netty.handler.codec.http.cookie.ClientCookieDecoder;
import io.netty.handler.codec.http.cookie.Cookie;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import org.graalvm.polyglot.Value;
import org.graalvm.polyglot.proxy.ProxyObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
*
* @author pthomas3
*/
public class Response implements ProxyObject {
private static final Logger logger = LoggerFactory.getLogger(Response.class);
public static final Response OK = new Response(200);
private static final String BODY = "body";
private static final String BODY_BYTES = "bodyBytes";
private static final String STATUS = "status";
private static final String HEADER = "header";
private static final String HEADERS = "headers";
private static final String HEADER_VALUES = "headerValues";
private static final String DATA_TYPE = "dataType";
private static final String RESPONSE_TIME = "responseTime";
private static final String[] KEYS = new String[]{STATUS, HEADER, HEADERS, HEADER_VALUES, BODY, DATA_TYPE, BODY_BYTES, RESPONSE_TIME};
private static final Set KEY_SET = new HashSet(Arrays.asList(KEYS));
private static final JsArray KEY_ARRAY = new JsArray(KEYS);
private int status;
private Map> headers;
private Object body;
private ResourceType resourceType;
private int delay;
private long responseTime;
public Response(int status) {
this.status = status;
}
public Response(int status, Map> headers, byte[] body) {
this(status, headers, body, null);
}
public Response(int status, Map> headers, byte[] body, ResourceType resourceType) {
this.status = status;
this.headers = headers;
this.body = body;
this.resourceType = resourceType;
}
public int getStatus() {
return status;
}
public void setStatus(int status) {
this.status = status;
}
public int getDelay() {
return delay;
}
public void setDelay(int delay) {
this.delay = delay;
}
public void setResponseTime(long responseTime) {
this.responseTime = responseTime;
}
public long getResponseTime() {
return responseTime;
}
public Map> getHeaders() {
return headers;
}
public Map> getHeadersWithLowerCaseNames() {
Map> map = new HashMap(headers.size());
headers.forEach((k, v) -> map.put(k.toLowerCase(), v));
return map;
}
public Map getCookies() {
List values = getHeaderValues(HttpConstants.HDR_SET_COOKIE);
if (values == null) {
return null;
}
Map map = new HashMap();
for (String value : values) {
Cookie cookie = ClientCookieDecoder.LAX.decode(value);
if (cookie != null) { // can be null if cookie contains invalid characters
map.put(cookie.name(), Cookies.toMap(cookie));
}
}
return map;
}
public byte[] getBody() {
if (body instanceof byte[]) {
return (byte[]) body;
}
return JsonUtils.toBytes(body);
}
public void setBody(byte[] body) {
this.body = body;
}
public void setBody(String value) {
body = FileUtils.toBytes(value);
}
public String getBodyAsString() {
return body == null ? null : FileUtils.toString(getBody());
}
public Object getBodyConverted() {
if (body instanceof byte[]) {
ResourceType rt = getResourceType(); // derive if needed
if (rt != null && rt.isBinary()) {
return body;
}
return JsonUtils.fromBytes((byte[]) body, false, rt);
} else {
return body;
}
}
public Json json() {
return body == null ? null : Json.of(getBodyConverted());
}
public boolean isBinary() {
ResourceType rt = getResourceType();
return rt == null ? false : rt.isBinary();
}
public ResourceType getResourceType() {
if (resourceType == null) {
String contentType = getContentType();
if (contentType != null) {
resourceType = ResourceType.fromContentType(contentType);
}
}
return resourceType;
}
public void setResourceType(ResourceType resourceType) {
this.resourceType = resourceType;
}
public List getHeaderValues(String name) { // TOTO optimize
return StringUtils.getIgnoreKeyCase(headers, name);
}
public String getHeader(String name) {
List values = getHeaderValues(name);
return values == null || values.isEmpty() ? null : values.get(0);
}
public String getContentType() {
return getHeader(HttpConstants.HDR_CONTENT_TYPE);
}
public void setContentType(String contentType) {
setHeader(HttpConstants.HDR_CONTENT_TYPE, contentType);
}
public void setHeader(String name, List values) {
if (headers == null) {
headers = new HashMap();
}
headers.put(name, values);
}
public void setHeader(String name, String... values) {
setHeader(name, Arrays.asList(values));
}
public void setHeaders(Map map) {
if (map == null) {
return;
}
map.forEach((k, v) -> {
if (v instanceof List) {
setHeader(k, (List) v);
} else if (v != null) {
setHeader(k, v.toString());
}
});
}
private static String toString(Object o) {
return o == null ? null : o.toString();
}
private final Methods.FunVar HEADER_FUNCTION = args -> {
if (args.length == 1) {
return getHeader(toString(args[0]));
} else {
setHeader(toString(args[0]), toString(args[1]));
return Response.this;
}
};
@Override
public Object getMember(String key) {
switch (key) {
case STATUS:
return status;
case HEADER:
return HEADER_FUNCTION;
case HEADERS:
return JsValue.fromJava(JsonUtils.simplify(headers));
case BODY:
if (body instanceof byte[]) {
return JsValue.fromJava(getBodyConverted());
} else {
return JsValue.fromJava(body);
}
case DATA_TYPE:
ResourceType rt = getResourceType();
if (rt == null || rt == ResourceType.BINARY) {
return null;
}
return rt.name().toLowerCase();
case HEADER_VALUES:
return (Function>) this::getHeaderValues;
case BODY_BYTES:
return getBody();
case RESPONSE_TIME:
return responseTime;
default:
logger.warn("no such property on response object: {}", key);
return null;
}
}
public Map toMap() {
Map map = new HashMap();
map.put(STATUS, status);
map.put(HEADERS, JsonUtils.simplify(headers));
map.put(BODY, getBodyConverted());
return map;
}
@Override
public Object getMemberKeys() {
return KEY_ARRAY;
}
@Override
public boolean hasMember(String key) {
return KEY_SET.contains(key);
}
@Override
public void putMember(String key, Value value) {
switch (key) {
case BODY:
body = JsValue.toJava(value);
break;
case STATUS:
status = value.asInt();
break;
case HEADERS:
setHeaders((Map) JsValue.toJava(value));
break;
default:
logger.warn("put not supported on response object: {} - {}", key, value);
}
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("[status: ").append(status);
sb.append(", responseTime: ").append(responseTime);
if (resourceType != null && resourceType != ResourceType.BINARY) {
sb.append(", type: ").append(resourceType);
}
if (body instanceof byte[]) {
sb.append(", length: ").append(((byte[]) body).length);
}
if (headers != null) {
sb.append(", headers: ").append(headers);
}
sb.append(']');
return sb.toString();
}
}