Java tutorial
/* * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0 * (the "License"). You may not use this work except in compliance with the License, which is * available at www.apache.org/licenses/LICENSE-2.0 * * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, * either express or implied, as more fully set forth in the License. * * See the NOTICE file distributed with this work for information regarding copyright ownership. */ package alluxio.client.rest; import alluxio.Constants; import alluxio.exception.status.InvalidArgumentException; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.SerializationFeature; import com.fasterxml.jackson.dataformat.xml.XmlMapper; import com.google.common.io.ByteStreams; import org.apache.commons.io.IOUtils; import org.junit.Assert; import java.io.BufferedReader; import java.io.InputStream; import java.io.InputStreamReader; import java.io.OutputStream; import java.net.HttpURLConnection; import java.net.URL; import java.util.Map; import javax.annotation.concurrent.NotThreadSafe; import javax.ws.rs.core.Response; /** * Represents a REST API test case. */ @NotThreadSafe public final class TestCase { private String mHostname; private int mPort; private String mEndpoint; private Map<String, String> mParameters; private String mMethod; private Object mExpectedResult; private TestCaseOptions mOptions; private String mPrefix; /** * Creates a new instance of {@link TestCase}. * * @param hostname the hostname to use * @param port the port to use * @param endpoint the endpoint to use * @param parameters the parameters to use * @param method the method to use * @param expectedResult the expected result to use */ public TestCase(String hostname, int port, String endpoint, Map<String, String> parameters, String method, Object expectedResult) { this(hostname, port, endpoint, parameters, method, expectedResult, TestCaseOptions.defaults()); } /** * Creates a new instance of {@link TestCase} with JSON data. * * @param hostname the hostname to use * @param port the port to use * @param endpoint the endpoint to use * @param parameters the parameters to use * @param method the method to use * @param expectedResult the expected result to use * @param options the test case options to use */ public TestCase(String hostname, int port, String endpoint, Map<String, String> parameters, String method, Object expectedResult, TestCaseOptions options) { this(hostname, port, endpoint, parameters, method, expectedResult, options, Constants.REST_API_PREFIX); } /** * Creates a new instance of {@link TestCase}. * * @param hostname the hostname to use * @param port the port to use * @param endpoint the endpoint to use * @param parameters the parameters to use * @param method the method to use * @param expectedResult the expected result to use * @param options the test case options to use * @param prefix the endpoint prefix to use */ public TestCase(String hostname, int port, String endpoint, Map<String, String> parameters, String method, Object expectedResult, TestCaseOptions options, String prefix) { mHostname = hostname; mPort = port; mEndpoint = endpoint; mParameters = parameters; mMethod = method; mExpectedResult = expectedResult; mOptions = options; mPrefix = prefix; } /** * @return the endpoint */ public String getEndpoint() { return mEndpoint; } /** * @return the method */ public String getMethod() { return mMethod; } /** * @return The URL which is created */ public URL createURL() throws Exception { StringBuilder sb = new StringBuilder(); for (Map.Entry<String, String> parameter : mParameters.entrySet()) { if (parameter.getValue() == null || parameter.getValue().isEmpty()) { sb.append(parameter.getKey()); } else { sb.append(parameter.getKey() + "=" + parameter.getValue() + "&"); } } return new URL("http://" + mHostname + ":" + mPort + mPrefix + "/" + mEndpoint + "?" + sb.toString()); } /** * @param connection the HttpURLConnection * @return the String from the InputStream of HttpURLConnection */ public String getResponse(HttpURLConnection connection) throws Exception { StringBuilder sb = new StringBuilder(); BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream())); char[] buffer = new char[1024]; int len; while ((len = br.read(buffer)) > 0) { sb.append(buffer, 0, len); } br.close(); return sb.toString(); } /** * Runs the test case and returns the {@link HttpURLConnection}. */ public HttpURLConnection execute() throws Exception { HttpURLConnection connection = (HttpURLConnection) createURL().openConnection(); connection.setRequestMethod(mMethod); if (mOptions.getMD5() != null) { connection.setRequestProperty("Content-MD5", mOptions.getMD5()); } if (mOptions.getInputStream() != null) { connection.setDoOutput(true); connection.setRequestProperty("Content-Type", "application/octet-stream"); ByteStreams.copy(mOptions.getInputStream(), connection.getOutputStream()); } if (mOptions.getBody() != null) { connection.setDoOutput(true); connection.setRequestProperty("Content-Type", mOptions.getContentType()); ObjectMapper mapper = new ObjectMapper(); // make sure that serialization of empty objects does not fail mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false); OutputStream os = connection.getOutputStream(); os.write(mapper.writeValueAsString(mOptions.getBody()).getBytes()); os.close(); } connection.connect(); if (Response.Status.Family.familyOf(connection.getResponseCode()) != Response.Status.Family.SUCCESSFUL) { InputStream errorStream = connection.getErrorStream(); if (errorStream != null) { Assert.fail("Request failed: " + IOUtils.toString(errorStream)); } Assert.fail("Request failed with status code " + connection.getResponseCode()); } return connection; } /** * Runs the test case and returns the output. */ public String call() throws Exception { return getResponse(execute()); } /** * Runs the test case. */ public void run() throws Exception { String expected = ""; if (mExpectedResult != null) { if (mOptions.getContentType().equals(TestCaseOptions.JSON_CONTENT_TYPE)) { ObjectMapper mapper = new ObjectMapper(); if (mOptions.isPrettyPrint()) { expected = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(mExpectedResult); } else { expected = mapper.writeValueAsString(mExpectedResult); } } else if (mOptions.getContentType().equals(TestCaseOptions.XML_CONTENT_TYPE)) { XmlMapper mapper = new XmlMapper(); if (mOptions.isPrettyPrint()) { expected = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(mExpectedResult); } else { expected = mapper.writeValueAsString(mExpectedResult); } } else { throw new InvalidArgumentException("Invalid content type in TestCaseOptions!"); } } String result = call(); Assert.assertEquals(mEndpoint, expected, result); } }