org.glassfish.admin.rest.testing.Common Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
* Portions Copyright [2017-2021] Payara Foundation and/or affiliates
*/
package org.glassfish.admin.rest.testing;
import jakarta.json.JsonArray;
import jakarta.json.JsonObject;
import jakarta.ws.rs.core.Response.Status;
public class Common {
public static final int SC_OK = Status.OK.getStatusCode();
public static final int SC_CREATED = Status.CREATED.getStatusCode();
public static final int SC_ACCEPTED = Status.ACCEPTED.getStatusCode();
public static final int SC_NOT_FOUND = Status.NOT_FOUND.getStatusCode();
public static final int SC_BAD_REQUEST = Status.BAD_REQUEST.getStatusCode();
public static final int SC_UNAUTHORIZED = Status.UNAUTHORIZED.getStatusCode();
public static final int SC_ANY = -1;
// Commonly used property names:
public static final String PROP_ITEM = "item";
public static final String PROP_ITEMS = "items";
public static final String PROP_RESOURCES = "resources";
public static final String PROP_MESSAGES = "messages";
// Commonly used resource relationship names:
public static final String REL_ACTION = "action";
public static final String REL_PARENT = "parent";
// Commonly used query parameter names:
public static final String QUERY_DETACHED = "__detached";
public static final String QUERY_INCLUDE = "__includeFields";
public static final String QUERY_EXCLUDE = "__excludeFields";
public static final String HEADER_LOCATION = "Location";
public static final String HEADER_X_LOCATION = "X-Location";
public static boolean haveValue(String val) {
return (val != null && val.length() > 0);
}
public static ObjectValue objectVal() {
return new ObjectValue();
}
public static ArrayValue arrayVal() {
return new ArrayValue();
}
public static StringValue stringVal() {
return new StringValue();
}
public static StringValue stringVal(String value) {
return (StringValue) stringVal().value(value);
}
public static StringValue stringRegexp(String regexp) {
return (StringValue) stringVal().regexp(regexp);
}
public static StringValue anyString() {
return stringRegexp(".*");
}
public static StringValue regexp(String regexp) {
return stringRegexp(regexp);
} // Most of the time regular expressions are used for strings
public static LongValue longVal() {
return new LongValue();
}
public static LongValue longVal(long value) {
return (LongValue) longVal().value(value);
}
public static LongValue longRegexp(String regexp) {
return (LongValue) longVal().regexp(regexp);
}
public static LongValue anyLong() {
return longRegexp(".*");
} // TBD - write a better regexp
public static IntValue intVal() {
return new IntValue();
}
public static IntValue intVal(int value) {
return (IntValue) intVal().value(value);
}
public static IntValue intRegexp(String regexp) {
return (IntValue) intVal().regexp(regexp);
}
public static IntValue anyInt() {
return intRegexp(".*");
} // TBD - write a better regexp
public static DoubleValue doubleVal() {
return new DoubleValue();
}
public static DoubleValue doubleVal(double value) {
return (DoubleValue) doubleVal().value(value);
}
public static DoubleValue doubleRegexp(String regexp) {
return (DoubleValue) doubleVal().regexp(regexp);
}
public static DoubleValue anyDouble() {
return doubleRegexp(".*");
} // TBD - write a better regexp
public static BooleanValue booleanVal() {
return new BooleanValue();
}
public static BooleanValue booleanVal(boolean value) {
return (BooleanValue) booleanVal().value(value);
}
public static BooleanValue booleanRegexp(String regexp) {
return (BooleanValue) booleanVal().regexp(regexp);
}
public static BooleanValue anyBoolean() {
return booleanRegexp(".*");
} // TBD - write a better regexp
public static BooleanValue trueVal() {
return booleanVal(true);
}
public static BooleanValue falseVal() {
return booleanVal(false);
}
public static NilValue nilVal() {
return new NilValue();
}
public static ObjectValue anySuccessMessage() {
return successMessage(".*");
}
public static ObjectValue anySuccessMessage(String field) {
return successMessage(field, ".*");
}
public static ArrayValue oneSuccessMessage() {
return arrayVal().add(anySuccessMessage());
}
public static ObjectValue anyFailureMessage() {
return failureMessage(".*");
}
public static ObjectValue anyFailureMessage(String field) {
return failureMessage(field, ".*");
}
public static ArrayValue oneFailureMessage() {
return arrayVal().add(anyFailureMessage());
}
public static ObjectValue anyWarningMessage() {
return warningMessage(".*");
}
public static ObjectValue anyWarningMessage(String field) {
return warningMessage(field, ".*");
}
public static ArrayValue oneWarningMessage() {
return arrayVal().add(anyWarningMessage());
}
public static ObjectValue successMessage(String message) {
return message("SUCCESS", message);
}
public static ObjectValue successMessage(String field, String message) {
return message("SUCCESS", field, message);
}
public static ObjectValue failureMessage(String message) {
return message("FAILURE", message);
}
public static ObjectValue failureMessage(String field, String message) {
return message("FAILURE", field, message);
}
public static ObjectValue warningMessage(String message) {
return message("WARNING", message);
}
public static ObjectValue warningMessage(String field, String message) {
return message("WARNING", field, message);
}
public static ObjectValue message(String severity, String message) {
return objectVal()
.put("severity", stringVal(severity))
.put("message", stringRegexp(message));
}
public static ObjectValue message(String severity, String field, String message) {
return objectVal()
.put("severity", severity)
.put("field", field)
.put("message", stringRegexp(message));
}
public static ObjectValue rootResource(String rel) {
return objectVal().put("rel", rel).put("uri", anyString());
}
public static ObjectValue resource(String rel, String title, String uri) {
return resource(rel, uri).put("title", stringVal(title));
}
public static ObjectValue resource(String rel, String uri) {
return objectVal().put("rel", rel).put("uri", stringRegexp(".*/" + uri));
}
public static String print(Value value) {
IndentingStringBuffer sb = new IndentingStringBuffer();
value.print(sb);
return sb.toString();
}
public static ResponseBody responseBody() {
return new ResponseBody();
}
public static ResponseVerifier verifier(Environment environment, Response response) {
return new ResponseVerifier(environment, response);
}
public static ResponseVerifier verify(ResponseVerifier verifier, ObjectValue body, int... statuses) throws Exception {
return verifier.status(statuses).body(body);
}
public static ResponseVerifier verify(ResponseVerifier verifier, StringValue body, int... statuses) throws Exception {
return verifier.status(statuses).body(body);
}
public static ResponseVerifier verify(ResponseVerifier verifier, int... statuses) throws Exception {
return verifier.status(statuses);
}
public static void verify(Environment environment, ObjectValue want, JsonObject have) throws Exception {
DataVerifier.verify(environment, want, have);
}
public static ObjectValue cloneObjectVal(ObjectValue v) throws Exception {
return toObjectVal(v.toJsonObject());
}
public static ObjectValue toObjectVal(JsonObject j) throws Exception {
return (ObjectValue) toValue(j);
}
public static ArrayValue toArrayVal(JsonArray j) throws Exception {
return (ArrayValue) toValue(j);
}
private static Value toValue(Object j) throws Exception {
if (j instanceof String) {
return stringVal().value((String) j);
}
if (j instanceof Long) {
return longVal().value((Long) j);
}
if (j instanceof Integer) {
return intVal().value((Integer) j);
}
if (j instanceof Double) {
return doubleVal().value((Double) j);
}
if (j instanceof Boolean) {
return booleanVal().value((Boolean) j);
}
if (JsonObject.NULL == j) {
return nilVal();
}
if (j instanceof JsonObject) {
JsonObject jo = (JsonObject) j;
ObjectValue ov = objectVal();
for (String key : jo.keySet()) {
ov.put(key, toValue(jo.get(key)));
}
return ov;
}
if (j instanceof JsonArray) {
JsonArray ja = (JsonArray) j;
ArrayValue av = arrayVal();
for (int i = 0; i < ja.size(); i++) {
av.add(toValue(ja.get(i)));
}
return av;
}
throw new IllegalArgumentException("Cannot convert " + j + " to a Value");
}
}