/**
* Copyright (c) 2010 Yahoo! Inc. All rights reserved.
* Licensed under the Apache 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.apache.org/licenses/LICENSE-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. See accompanying LICENSE file.
*/
package org.apache.oozie.client;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.Callable;
import org.apache.hadoop.fs.Path;
import org.apache.oozie.BuildInfo;
import org.apache.oozie.client.OozieClient.SYSTEM_MODE;
import org.apache.oozie.client.rest.RestConstants;
import org.apache.oozie.servlet.DagServletTestCase;
import org.apache.oozie.servlet.MockDagEngineService;
import org.apache.oozie.servlet.V0JobServlet;
import org.apache.oozie.servlet.V0JobsServlet;
import org.apache.oozie.servlet.V1AdminServlet;
public class TestWorkflowClient extends DagServletTestCase {
static {
new HeaderTestingVersionServlet();
new V0JobServlet();
new V0JobsServlet();
new V1AdminServlet();
}
private static final boolean IS_SECURITY_ENABLED = false;
static final String VERSION = "/v" + OozieClient.WS_PROTOCOL_VERSION;
static final String[] END_POINTS = {"/versions", VERSION + "/jobs", VERSION + "/job/*", VERSION + "/admin/*"};
static final Class[] SERVLET_CLASSES = {HeaderTestingVersionServlet.class, V0JobsServlet.class,
V0JobServlet.class, V1AdminServlet.class};
protected void setUp() throws Exception {
super.setUp();
MockDagEngineService.reset();
}
// UNCOMMENT TO QUICKLY RUN THE WS WITH MOCK engine
// public void testRunning() throws Exception {
// runTest(END_POINTS, SERVLET_CLASSES, new Callable<Void>() {
// public Void call() throws Exception {
// Thread.sleep(Long.MAX_VALUE);
// return null;
// }
// });
//
// }
public void testHeaders() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
HeaderTestingVersionServlet.OOZIE_HEADERS.clear();
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
wc.setHeader("header", "test");
wc.validateWSVersion();
assertTrue(HeaderTestingVersionServlet.OOZIE_HEADERS.containsKey("header"));
assertTrue(HeaderTestingVersionServlet.OOZIE_HEADERS.containsValue("test"));
return null;
}
});
}
public void testUrls() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
assertEquals(oozieUrl, wc.getOozieUrl().substring(0, wc.getOozieUrl().length() - 1));
assertTrue(wc.getProtocolUrl().startsWith(wc.getOozieUrl() + "v"));
return null;
}
});
}
public void testValidateVersion() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
wc.validateWSVersion();
return null;
}
});
}
public void testSubmit() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
MockDagEngineService.reset();
int wfCount = MockDagEngineService.INIT_WF_COUNT;
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
Properties conf = wc.createConfiguration();
Path appPath = new Path(getFsTestCaseDir(), "app");
getFileSystem().mkdirs(appPath);
getFileSystem().create(new Path(appPath, "workflow.xml")).close();
conf.setProperty(OozieClient.APP_PATH, appPath.toString());
injectKerberosInfo(conf);
assertEquals(MockDagEngineService.JOB_ID + wfCount, wc.submit(conf));
assertFalse(MockDagEngineService.started.get(wfCount));
return null;
}
});
}
public void testRun() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
int wfCount = MockDagEngineService.INIT_WF_COUNT;
OozieClient wc = new OozieClient(oozieUrl);
Properties conf = wc.createConfiguration();
Path appPath = new Path(getFsTestCaseDir(), "app");
getFileSystem().mkdirs(appPath);
getFileSystem().create(new Path(appPath, "workflow.xml")).close();
conf.setProperty(OozieClient.APP_PATH, appPath.toString());
injectKerberosInfo(conf);
assertEquals(MockDagEngineService.JOB_ID + wfCount, wc.run(conf));
assertTrue(MockDagEngineService.started.get(wfCount));
return null;
}
});
}
public void testStart() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
Properties conf = wc.createConfiguration();
conf.setProperty(OozieClient.USER_NAME, "x");
wc.start(MockDagEngineService.JOB_ID + 1);
assertEquals(RestConstants.JOB_ACTION_START, MockDagEngineService.did);
return null;
}
});
}
public void testSuspend() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
Properties conf = wc.createConfiguration();
conf.setProperty(OozieClient.USER_NAME, "x");
wc.suspend(MockDagEngineService.JOB_ID + 1);
assertEquals(RestConstants.JOB_ACTION_SUSPEND, MockDagEngineService.did);
return null;
}
});
}
public void testResume() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
Properties conf = wc.createConfiguration();
conf.setProperty(OozieClient.USER_NAME, "x");
wc.resume(MockDagEngineService.JOB_ID + 1);
assertEquals(RestConstants.JOB_ACTION_RESUME, MockDagEngineService.did);
return null;
}
});
}
public void testKill() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
Properties conf = wc.createConfiguration();
conf.setProperty(OozieClient.USER_NAME, "x");
wc.kill(MockDagEngineService.JOB_ID + 1);
assertEquals(RestConstants.JOB_ACTION_KILL, MockDagEngineService.did);
return null;
}
});
}
public void testReRun() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
Properties conf = wc.createConfiguration();
conf.setProperty(OozieClient.USER_NAME, getTestUser());
Path appPath = new Path(getFsTestCaseDir(), "app");
getFileSystem().mkdirs(appPath);
getFileSystem().create(new Path(appPath, "workflow.xml")).close();
conf.setProperty(OozieClient.APP_PATH, appPath.toString());
injectKerberosInfo(conf);
wc.reRun(MockDagEngineService.JOB_ID + 1, conf);
assertEquals(RestConstants.JOB_ACTION_RERUN, MockDagEngineService.did);
assertTrue(MockDagEngineService.started.get(1));
return null;
}
});
}
public void testJobStatus() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
WorkflowJob wf = wc.getJobInfo(MockDagEngineService.JOB_ID + 1);
assertEquals(RestConstants.JOB_SHOW_INFO, MockDagEngineService.did);
assertEquals(MockDagEngineService.JOB_ID + 1, wf.getId());
return null;
}
});
}
public void testJobsStatus() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
List<WorkflowJob> list = wc.getJobsInfo(null);
assertEquals(MockDagEngineService.INIT_WF_COUNT, list.size());
for (int i = 0; i < MockDagEngineService.INIT_WF_COUNT; i++) {
assertNotNull(list.get(i).getAppPath());
assertEquals(MockDagEngineService.JOB_ID + i, list.get(i).getId());
}
MockDagEngineService.reset();
list = wc.getJobsInfo("name=x", 3, 4);
assertEquals(MockDagEngineService.INIT_WF_COUNT, list.size());
for (int i = 0; i < MockDagEngineService.INIT_WF_COUNT; i++) {
assertNotNull(list.get(i).getAppPath());
assertEquals(MockDagEngineService.JOB_ID + i, list.get(i).getId());
}
return null;
}
});
}
public void testExternalId() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
assertEquals("id-valid", wc.getJobId("external-valid"));
assertEquals(RestConstants.JOBS_EXTERNAL_ID_PARAM, MockDagEngineService.did);
assertNull(wc.getJobId("external-invalid"));
return null;
}
});
}
public void testJobsStatusFilter() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
wc.getJobsInfo("name=x");
wc.getJobsInfo("user=x");
wc.getJobsInfo("group=x");
wc.getJobsInfo("status=RUNNING");
wc.getJobsInfo("name=x;name=y");
try {
wc.getJobsInfo("name=");
fail();
}
catch (OozieClientException ex) {
//nop
}
try {
wc.getJobsInfo("x=x");
fail();
}
catch (OozieClientException ex) {
//nop
}
try {
wc.getJobsInfo("status=X");
fail();
}
catch (OozieClientException ex) {
//nop
}
return null;
}
});
}
public void testSafeMode() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
SYSTEM_MODE systemMode = wc.getSystemMode();
assertEquals(systemMode, SYSTEM_MODE.NORMAL);
wc.setSystemMode(SYSTEM_MODE.SAFEMODE);
systemMode = wc.getSystemMode();
assertEquals(systemMode, SYSTEM_MODE.SAFEMODE);
wc.setSystemMode(SYSTEM_MODE.NOWEBSERVICE);
systemMode = wc.getSystemMode();
assertEquals(systemMode, SYSTEM_MODE.NOWEBSERVICE);
return null;
}
});
}
public void testWSErrors() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
@Override
public Void call() throws Exception {
String oozieUrl = getContextURL() + "dummy";
OozieClient wc = new OozieClient(oozieUrl);
try {
wc.getJobInfo(MockDagEngineService.JOB_ID + 1);
fail();
}
catch (OozieClientException e) {
assertNotNull(e.getErrorCode());
assertNotNull(e.getMessage());
}
return null;
}
});
}
public void testServerBuildVersion() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
assertEquals(BuildInfo.getBuildInfo().getProperty(BuildInfo.BUILD_VERSION),
wc.getServerBuildVersion());
return null;
}
});
}
public void testClientBuildVersion() throws Exception {
runTest(END_POINTS, SERVLET_CLASSES, IS_SECURITY_ENABLED, new Callable<Void>() {
public Void call() throws Exception {
String oozieUrl = getContextURL();
OozieClient wc = new OozieClient(oozieUrl);
assertEquals(BuildInfo.getBuildInfo().getProperty(BuildInfo.BUILD_VERSION),
wc.getClientBuildVersion());
return null;
}
});
}
}