Java tutorial
/** * Copyright 2009, 2010 The Regents of the University of California * Licensed under the Educational Community License, Version 2.0 * (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.osedu.org/licenses/ECL-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an "AS IS" * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing * permissions and limitations under the License. * */ package org.opencastproject.remotetest.server; import static org.opencastproject.remotetest.Main.BASE_URL; import org.opencastproject.remotetest.Main; import org.opencastproject.remotetest.util.TrustedHttpClient; import junit.framework.Assert; import org.apache.commons.io.IOUtils; import org.apache.http.HttpResponse; import org.apache.http.NameValuePair; import org.apache.http.client.entity.UrlEncodedFormEntity; import org.apache.http.client.methods.HttpGet; import org.apache.http.client.methods.HttpPost; import org.apache.http.message.BasicNameValuePair; import org.apache.http.util.EntityUtils; import org.json.simple.JSONObject; import org.json.simple.JSONValue; import org.junit.After; import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.w3c.dom.Element; import java.util.ArrayList; import java.util.List; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.xpath.XPathConstants; import javax.xml.xpath.XPathFactory; /** * Tests the functionality of a remote workflow service rest endpoint */ public class WorkflowRestEndpointTest { private static final Logger logger = LoggerFactory.getLogger(WorkflowRestEndpointTest.class); private TrustedHttpClient client; @BeforeClass public static void setupClass() throws Exception { logger.info("Running " + WorkflowRestEndpointTest.class.getName()); } @Before public void setUp() throws Exception { client = Main.getClient(); } @After public void tearDown() throws Exception { Main.returnClient(client); } @Test public void testStartAndRetrieveWorkflowInstance() throws Exception { // Start a workflow instance via the rest endpoint HttpPost postStart = new HttpPost(BASE_URL + "/workflow/start"); List<NameValuePair> formParams = new ArrayList<NameValuePair>(); formParams.add(new BasicNameValuePair("definition", getSampleWorkflowDefinition())); formParams.add(new BasicNameValuePair("mediapackage", getSampleMediaPackage())); formParams.add(new BasicNameValuePair("properties", "this=that")); postStart.setEntity(new UrlEncodedFormEntity(formParams, "UTF-8")); // Grab the new workflow instance from the response HttpResponse r = client.execute(postStart); Assert.assertEquals(200, r.getStatusLine().getStatusCode()); String postResponse = EntityUtils.toString(r.getEntity()); String id = getWorkflowInstanceId(postResponse); // Ensure we can retrieve the workflow instance from the rest endpoint HttpGet getWorkflowMethod = new HttpGet(BASE_URL + "/workflow/instance/" + id + ".xml"); String getResponse = EntityUtils.toString(client.execute(getWorkflowMethod).getEntity()); Assert.assertEquals(id, getWorkflowInstanceId(getResponse)); // Make sure we can retrieve it via json, too HttpGet getWorkflowJson = new HttpGet(BASE_URL + "/workflow/instance/" + id + ".json"); String jsonResponse = EntityUtils.toString(client.execute(getWorkflowJson).getEntity()); JSONObject json = (JSONObject) JSONValue.parse(jsonResponse); if (json == null) Assert.fail("JSON response should not be null, but is " + jsonResponse); JSONObject workflowAsJson = (JSONObject) json.get("workflow"); Assert.assertEquals(id, workflowAsJson.get("id")); // Make sure we can retrieve it as part of a set of workflows as json HttpGet getWorkflowsJson = new HttpGet(BASE_URL + "/workflow/instances.json"); String workflowsResponse = EntityUtils.toString(client.execute(getWorkflowsJson).getEntity()); JSONObject workflowsJson = (JSONObject) JSONValue.parse(workflowsResponse); if (workflowsJson == null) Assert.fail("JSON response should not be null, but is " + jsonResponse); JSONObject workflows = (JSONObject) workflowsJson.get("workflows"); Assert.assertTrue(Integer.parseInt((String) workflows.get("totalCount")) > 0); // Ensure that the workflow finishes successfully int attempts = 0; while (true) { if (++attempts == 20) Assert.fail("workflow rest endpoint test has hung"); getWorkflowMethod = new HttpGet(BASE_URL + "/workflow/instance/" + id + ".xml"); getResponse = EntityUtils.toString(client.execute(getWorkflowMethod).getEntity()); String state = getWorkflowInstanceStatus(getResponse); if ("FAILED".equals(state)) Assert.fail("workflow instance " + id + " failed"); if ("SUCCEEDED".equals(state)) break; System.out.println("workflow " + id + " is " + state); Thread.sleep(5000); } } protected String getWorkflowInstanceId(String xml) throws Exception { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); factory.setNamespaceAware(true); DocumentBuilder builder = factory.newDocumentBuilder(); Document doc = builder.parse(IOUtils.toInputStream(xml, "UTF-8")); return ((Element) XPathFactory.newInstance().newXPath().compile("/*").evaluate(doc, XPathConstants.NODE)) .getAttribute("id"); } protected String getWorkflowInstanceStatus(String xml) throws Exception { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); factory.setNamespaceAware(true); DocumentBuilder builder = factory.newDocumentBuilder(); Document doc = builder.parse(IOUtils.toInputStream(xml, "UTF-8")); return ((Element) XPathFactory.newInstance().newXPath().compile("/*").evaluate(doc, XPathConstants.NODE)) .getAttribute("state"); } protected String getSampleMediaPackage() throws Exception { String template = IOUtils.toString(getClass().getClassLoader().getResourceAsStream("mediapackage-1.xml"), "UTF-8"); return template.replaceAll("@SAMPLES_URL@", BASE_URL + "/workflow/samples"); } protected String getSampleWorkflowDefinition() throws Exception { return IOUtils.toString(getClass().getClassLoader().getResourceAsStream("workflow-definition-1.xml"), "UTF-8"); } }