/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.apache.flink.api.java.record.io;
import java.io.IOException;
import org.junit.Assert;
import org.apache.flink.api.common.io.DefaultInputSplitAssigner;
import org.apache.flink.api.common.io.statistics.BaseStatistics;
import org.apache.flink.api.java.record.io.ExternalProcessInputFormat;
import org.apache.flink.api.java.record.io.ExternalProcessInputSplit;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.core.io.GenericInputSplit;
import org.apache.flink.types.IntValue;
import org.apache.flink.types.Record;
import org.apache.flink.util.OperatingSystem;
import org.junit.Before;
import org.junit.Test;
public class ExternalProcessInputFormatTest {
private ExternalProcessInputFormat<ExternalProcessInputSplit> format;
private final String neverEndingCommand = "cat /dev/urandom";
private final String thousandRecordsCommand = "dd if=/dev/zero bs=8 count=1000";
private final String failingCommand = "ls /I/do/not/exist";
@Before
public void prepare() {
format = new MyExternalProcessTestInputFormat();
}
@Test
public void testOpen() {
if(OperatingSystem.isWindows()) {
return;
}
Configuration config = new Configuration();
ExternalProcessInputSplit split = new ExternalProcessInputSplit(1, 1, this.neverEndingCommand);
boolean processDestroyed = false;
try {
format.configure(config);
format.open(split);
String[] cmd = {"/bin/sh","-c","ps aux | grep -v grep | grep \"cat /dev/urandom\" | wc -l"};
byte[] wcOut = new byte[128];
Process p = Runtime.getRuntime().exec(cmd);
p.getInputStream().read(wcOut);
int pCnt = Integer.parseInt(new String(wcOut).trim());
Assert.assertTrue(pCnt > 0);
format.close();
} catch (IOException e) {
Assert.fail();
} catch (RuntimeException e) {
if(e.getMessage().equals("External process was destroyed although stream was not fully read.")) {
processDestroyed = true;
}
} finally {
Assert.assertTrue(processDestroyed);
}
}
@Test
public void testCheckExitCode() {
if(OperatingSystem.isWindows()) {
return;
}
Configuration config = new Configuration();
ExternalProcessInputSplit split = new ExternalProcessInputSplit(1, 1, failingCommand);
format.configure(config);
boolean invalidExitCode = false;
try {
format.open(split);
format.waitForProcessToFinish();
format.close();
} catch (IOException e) {
Assert.fail();
} catch (InterruptedException e) {
Assert.fail();
} catch (RuntimeException e) {
if(e.getMessage().startsWith("External process did not finish with an allowed exit code:")) {
invalidExitCode = true;
}
}
Assert.assertTrue(invalidExitCode);
invalidExitCode = false;
config.setString(ExternalProcessInputFormat.ALLOWEDEXITCODES_PARAMETER_KEY,"0,1,2");
format.configure(config);
try {
format.open(split);
format.waitForProcessToFinish();
format.close();
} catch (IOException e) {
Assert.fail();
} catch (InterruptedException e) {
Assert.fail();
} catch (RuntimeException e) {
if(e.getMessage().startsWith("External process did not finish with an allowed exit code:")) {
invalidExitCode = true;
}
}
Assert.assertTrue(!invalidExitCode);
}
@Test
public void testUserCodeTermination() {
if(OperatingSystem.isWindows()) {
return;
}
Configuration config = new Configuration();
config.setInteger(MyExternalProcessTestInputFormat.FAILCOUNT_PARAMETER_KEY, 100);
ExternalProcessInputSplit split = new ExternalProcessInputSplit(1, 1, this.neverEndingCommand);
Record record = new Record();
boolean userException = false;
boolean processDestroyed = false;
try {
format.configure(config);
format.open(split);
while(!format.reachedEnd()) {
try {
format.nextRecord(record);
} catch(RuntimeException re) {
userException = true;
break;
}
}
format.close();
} catch (IOException e) {
Assert.fail();
} catch (RuntimeException e) {
if(e.getMessage().equals("External process was destroyed although stream was not fully read.")) {
processDestroyed = true;
}
} finally {
Assert.assertTrue(userException && processDestroyed);
}
}
@Test
public void testReadStream() {
if(OperatingSystem.isWindows()) {
return;
}
Configuration config = new Configuration();
ExternalProcessInputSplit split = new ExternalProcessInputSplit(1, 1, this.thousandRecordsCommand);
Record record = new Record();
int cnt = 0;
try {
format.configure(config);
format.open(split);
while(!format.reachedEnd()) {
if (format.nextRecord(record) != null) {
cnt++;
}
}
format.close();
} catch (IOException e) {
Assert.fail();
} catch (RuntimeException e) {
Assert.fail(e.getMessage());
}
Assert.assertTrue("Expected read count was 1000, actual read count was "+cnt, cnt == 1000);
}
private final class MyExternalProcessTestInputFormat extends ExternalProcessInputFormat<ExternalProcessInputSplit> {
private static final long serialVersionUID = 1L;
public static final String FAILCOUNT_PARAMETER_KEY = "test.failingCount";
private byte[] buf = new byte[8];
private long cnt = 0;
private int failCnt;
private boolean end;
@Override
public void configure(Configuration parameters) {
super.configure(parameters);
failCnt = parameters.getInteger(FAILCOUNT_PARAMETER_KEY, Integer.MAX_VALUE);
}
@Override
public void open(GenericInputSplit split) throws IOException {
super.open(split);
this.end = false;
}
@Override
public ExternalProcessInputSplit[] createInputSplits(int minNumSplits) {
return null;
}
@Override
public DefaultInputSplitAssigner getInputSplitAssigner(GenericInputSplit[] splits) {
return new DefaultInputSplitAssigner(splits);
}
@Override
public BaseStatistics getStatistics(BaseStatistics cachedStatistics) {
return null;
}
@Override
public Record nextRecord(Record reuse) throws IOException {
if(cnt > failCnt) {
throw new RuntimeException("This is a test exception!");
}
int totalReadCnt = 0;
do {
int readCnt = super.extProcOutStream.read(buf, totalReadCnt, buf.length-totalReadCnt);
if(readCnt == -1) {
this.end = true;
return null;
} else {
totalReadCnt += readCnt;
}
} while(totalReadCnt != 8);
int v1 = 0;
v1 = v1 | (0xFF & buf[0]);
v1 = (v1 << 8) | (0xFF & buf[1]);
v1 = (v1 << 8) | (0xFF & buf[2]);
v1 = (v1 << 8) | (0xFF & buf[3]);
int v2 = 0;
v2 = v2 | (0xFF & buf[4]);
v2 = (v2 << 8) | (0xFF & buf[5]);
v2 = (v2 << 8) | (0xFF & buf[6]);
v2 = (v2 << 8) | (0xFF & buf[7]);
reuse.setField(0,new IntValue(v1));
reuse.setField(1,new IntValue(v2));
this.cnt++;
return reuse;
}
@Override
public boolean reachedEnd() throws IOException {
return this.end;
}
}
}