org.apache.hadoop.mapreduce.MapReduceTestUtil.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.hadoop.mapreduce.MapReduceTestUtil.java

Source

/**
 * 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.hadoop.mapreduce;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.text.NumberFormat;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Random;

import org.apache.hadoop.conf.Configurable;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.FSDataOutputStream;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.FileUtil;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.io.LongWritable;
import org.apache.hadoop.io.NullWritable;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.io.Writable;
import org.apache.hadoop.io.WritableComparable;
import org.apache.hadoop.mapred.TaskLog;
import org.apache.hadoop.mapred.Utils;
import org.apache.hadoop.mapreduce.lib.input.FileInputFormat;
import org.apache.hadoop.mapreduce.lib.output.FileOutputFormat;
import org.apache.hadoop.mapreduce.task.TaskAttemptContextImpl;
import org.apache.hadoop.util.ReflectionUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Utility methods used in various Job Control unit tests.
 */
public class MapReduceTestUtil {
    public static final Logger LOG = LoggerFactory.getLogger(MapReduceTestUtil.class);

    static private Random rand = new Random();

    private static NumberFormat idFormat = NumberFormat.getInstance();

    static {
        idFormat.setMinimumIntegerDigits(4);
        idFormat.setGroupingUsed(false);
    }

    /**
     * Cleans the data from the passed Path in the passed FileSystem.
     * 
     * @param fs FileSystem to delete data from.
     * @param dirPath Path to be deleted.
     * @throws IOException If an error occurs cleaning the data.
     */
    public static void cleanData(FileSystem fs, Path dirPath) throws IOException {
        fs.delete(dirPath, true);
    }

    /**
     * Generates a string of random digits.
     * 
     * @return A random string.
     */
    public static String generateRandomWord() {
        return idFormat.format(rand.nextLong());
    }

    /**
     * Generates a line of random text.
     * 
     * @return A line of random text.
     */
    public static String generateRandomLine() {
        long r = rand.nextLong() % 7;
        long n = r + 20;
        StringBuffer sb = new StringBuffer();
        for (int i = 0; i < n; i++) {
            sb.append(generateRandomWord()).append(" ");
        }
        sb.append("\n");
        return sb.toString();
    }

    /**
     * Generates random data consisting of 10000 lines.
     * 
     * @param fs FileSystem to create data in.
     * @param dirPath Path to create the data in.
     * @throws IOException If an error occurs creating the data.
     */
    public static void generateData(FileSystem fs, Path dirPath) throws IOException {
        FSDataOutputStream out = fs.create(new Path(dirPath, "data.txt"));
        for (int i = 0; i < 10000; i++) {
            String line = generateRandomLine();
            out.write(line.getBytes("UTF-8"));
        }
        out.close();
    }

    /**
     * Creates a simple copy job.
     * 
     * @param conf Configuration object
     * @param outdir Output directory.
     * @param indirs Comma separated input directories.
     * @return Job initialized for a data copy job.
     * @throws Exception If an error occurs creating job configuration.
     */
    public static Job createCopyJob(Configuration conf, Path outdir, Path... indirs) throws Exception {
        conf.setInt(MRJobConfig.NUM_MAPS, 3);
        Job theJob = Job.getInstance(conf);
        theJob.setJobName("DataMoveJob");

        FileInputFormat.setInputPaths(theJob, indirs);
        theJob.setMapperClass(DataCopyMapper.class);
        FileOutputFormat.setOutputPath(theJob, outdir);
        theJob.setOutputKeyClass(Text.class);
        theJob.setOutputValueClass(Text.class);
        theJob.setReducerClass(DataCopyReducer.class);
        theJob.setNumReduceTasks(1);
        return theJob;
    }

    /**
     * Creates a simple fail job.
     * 
     * @param conf Configuration object
     * @param outdir Output directory.
     * @param indirs Comma separated input directories.
     * @return Job initialized for a simple fail job.
     * @throws Exception If an error occurs creating job configuration.
     */
    public static Job createFailJob(Configuration conf, Path outdir, Path... indirs) throws Exception {
        FileSystem fs = outdir.getFileSystem(conf);
        if (fs.exists(outdir)) {
            fs.delete(outdir, true);
        }
        conf.setInt(MRJobConfig.MAP_MAX_ATTEMPTS, 2);
        Job theJob = Job.getInstance(conf);
        theJob.setJobName("Fail-Job");

        FileInputFormat.setInputPaths(theJob, indirs);
        theJob.setMapperClass(FailMapper.class);
        theJob.setReducerClass(Reducer.class);
        theJob.setNumReduceTasks(0);
        FileOutputFormat.setOutputPath(theJob, outdir);
        theJob.setOutputKeyClass(Text.class);
        theJob.setOutputValueClass(Text.class);
        return theJob;
    }

    /**
     * Creates a simple fail job.
     * 
     * @param conf Configuration object
     * @param outdir Output directory.
     * @param indirs Comma separated input directories.
     * @return Job initialized for a simple kill job.
     * @throws Exception If an error occurs creating job configuration.
     */
    public static Job createKillJob(Configuration conf, Path outdir, Path... indirs) throws Exception {

        Job theJob = Job.getInstance(conf);
        theJob.setJobName("Kill-Job");

        FileInputFormat.setInputPaths(theJob, indirs);
        theJob.setMapperClass(KillMapper.class);
        theJob.setReducerClass(Reducer.class);
        theJob.setNumReduceTasks(0);
        FileOutputFormat.setOutputPath(theJob, outdir);
        theJob.setOutputKeyClass(Text.class);
        theJob.setOutputValueClass(Text.class);
        return theJob;
    }

    /**
     * Simple Mapper and Reducer implementation which copies data it reads in.
     */
    public static class DataCopyMapper extends Mapper<LongWritable, Text, Text, Text> {
        public void map(LongWritable key, Text value, Context context) throws IOException, InterruptedException {
            context.write(new Text(key.toString()), value);
        }
    }

    public static class DataCopyReducer extends Reducer<Text, Text, Text, Text> {
        public void reduce(Text key, Iterator<Text> values, Context context)
                throws IOException, InterruptedException {
            Text dumbKey = new Text("");
            while (values.hasNext()) {
                Text data = values.next();
                context.write(dumbKey, data);
            }
        }
    }

    // Mapper that fails
    public static class FailMapper
            extends Mapper<WritableComparable<?>, Writable, WritableComparable<?>, Writable> {

        public void map(WritableComparable<?> key, Writable value, Context context) throws IOException {
            throw new RuntimeException("failing map");
        }
    }

    // Mapper that sleeps for a long time.
    // Used for running a job that will be killed
    public static class KillMapper
            extends Mapper<WritableComparable<?>, Writable, WritableComparable<?>, Writable> {

        public void map(WritableComparable<?> key, Writable value, Context context) throws IOException {
            try {
                Thread.sleep(1000000);
            } catch (InterruptedException e) {
                // Do nothing
            }
        }
    }

    public static class IncomparableKey implements WritableComparable<Object> {
        public void write(DataOutput out) {
        }

        public void readFields(DataInput in) {
        }

        public int compareTo(Object o) {
            throw new RuntimeException("Should never see this.");
        }
    }

    public static class FakeSplit extends InputSplit implements Writable {
        public void write(DataOutput out) throws IOException {
        }

        public void readFields(DataInput in) throws IOException {
        }

        public long getLength() {
            return 0L;
        }

        public String[] getLocations() {
            return new String[0];
        }
    }

    public static class Fake_IF<K, V> extends InputFormat<K, V> implements Configurable {

        public Fake_IF() {
        }

        public List<InputSplit> getSplits(JobContext context) {
            List<InputSplit> ret = new ArrayList<InputSplit>();
            ret.add(new FakeSplit());
            return ret;
        }

        public static void setKeyClass(Configuration conf, Class<?> k) {
            conf.setClass("test.fakeif.keyclass", k, WritableComparable.class);
        }

        public static void setValClass(Configuration job, Class<?> v) {
            job.setClass("test.fakeif.valclass", v, Writable.class);
        }

        protected Class<? extends K> keyclass;
        protected Class<? extends V> valclass;
        Configuration conf = null;

        @SuppressWarnings("unchecked")
        public void setConf(Configuration conf) {
            this.conf = conf;
            keyclass = (Class<? extends K>) conf.getClass("test.fakeif.keyclass", NullWritable.class,
                    WritableComparable.class);
            valclass = (Class<? extends V>) conf.getClass("test.fakeif.valclass", NullWritable.class,
                    WritableComparable.class);
        }

        public Configuration getConf() {
            return conf;
        }

        public RecordReader<K, V> createRecordReader(InputSplit ignored, TaskAttemptContext context) {
            return new RecordReader<K, V>() {
                public boolean nextKeyValue() throws IOException {
                    return false;
                }

                public void initialize(InputSplit split, TaskAttemptContext context)
                        throws IOException, InterruptedException {
                }

                public K getCurrentKey() {
                    return null;
                }

                public V getCurrentValue() {
                    return null;
                }

                public void close() throws IOException {
                }

                public float getProgress() throws IOException {
                    return 0.0f;
                }
            };
        }
    }

    public static class Fake_RR<K, V> extends RecordReader<K, V> {
        private Class<? extends K> keyclass;
        private Class<? extends V> valclass;

        public boolean nextKeyValue() throws IOException {
            return false;
        }

        @SuppressWarnings("unchecked")
        public void initialize(InputSplit split, TaskAttemptContext context)
                throws IOException, InterruptedException {
            Configuration conf = context.getConfiguration();
            keyclass = (Class<? extends K>) conf.getClass("test.fakeif.keyclass", NullWritable.class,
                    WritableComparable.class);
            valclass = (Class<? extends V>) conf.getClass("test.fakeif.valclass", NullWritable.class,
                    WritableComparable.class);

        }

        public K getCurrentKey() {
            return ReflectionUtils.newInstance(keyclass, null);
        }

        public V getCurrentValue() {
            return ReflectionUtils.newInstance(valclass, null);
        }

        public void close() throws IOException {
        }

        public float getProgress() throws IOException {
            return 0.0f;
        }
    }

    public static Job createJob(Configuration conf, Path inDir, Path outDir, int numInputFiles, int numReds)
            throws IOException {
        String input = "The quick brown fox\n" + "has many silly\n" + "red fox sox\n";
        return createJob(conf, inDir, outDir, numInputFiles, numReds, input);
    }

    public static Job createJob(Configuration conf, Path inDir, Path outDir, int numInputFiles, int numReds,
            String input) throws IOException {
        Job job = Job.getInstance(conf);
        FileSystem fs = FileSystem.get(conf);
        if (fs.exists(outDir)) {
            fs.delete(outDir, true);
        }
        if (fs.exists(inDir)) {
            fs.delete(inDir, true);
        }
        fs.mkdirs(inDir);
        for (int i = 0; i < numInputFiles; ++i) {
            DataOutputStream file = fs.create(new Path(inDir, "part-" + i));
            file.writeBytes(input);
            file.close();
        }

        FileInputFormat.setInputPaths(job, inDir);
        FileOutputFormat.setOutputPath(job, outDir);
        job.setNumReduceTasks(numReds);
        return job;
    }

    public static TaskAttemptContext createDummyMapTaskAttemptContext(Configuration conf) {
        TaskAttemptID tid = new TaskAttemptID("jt", 1, TaskType.MAP, 0, 0);
        conf.set(MRJobConfig.TASK_ATTEMPT_ID, tid.toString());
        return new TaskAttemptContextImpl(conf, tid);
    }

    public static StatusReporter createDummyReporter() {
        return new StatusReporter() {
            public void setStatus(String s) {
            }

            public void progress() {
            }

            @Override
            public float getProgress() {
                return 0;
            }

            public Counter getCounter(Enum<?> name) {
                return new Counters().findCounter(name);
            }

            public Counter getCounter(String group, String name) {
                return new Counters().findCounter(group, name);
            }
        };
    }

    // Return output of MR job by reading from the given output directory
    public static String readOutput(Path outDir, Configuration conf) throws IOException {
        FileSystem fs = outDir.getFileSystem(conf);
        StringBuffer result = new StringBuffer();

        Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir, new Utils.OutputFileUtils.OutputFilesFilter()));
        for (Path outputFile : fileList) {
            LOG.info("Path" + ": " + outputFile);
            BufferedReader file = new BufferedReader(new InputStreamReader(fs.open(outputFile)));
            String line = file.readLine();
            while (line != null) {
                result.append(line);
                result.append("\n");
                line = file.readLine();
            }
            file.close();
        }
        return result.toString();
    }

    /**
     * Reads tasklog and returns it as string after trimming it.
     * 
     * @param filter
     *          Task log filter; can be STDOUT, STDERR, SYSLOG, DEBUGOUT, PROFILE
     * @param taskId
     *          The task id for which the log has to collected
     * @param isCleanup
     *          whether the task is a cleanup attempt or not.
     * @return task log as string
     * @throws IOException
     */
    public static String readTaskLog(TaskLog.LogName filter, org.apache.hadoop.mapred.TaskAttemptID taskId,
            boolean isCleanup) throws IOException {
        // string buffer to store task log
        StringBuffer result = new StringBuffer();
        int res;

        // reads the whole tasklog into inputstream
        InputStream taskLogReader = new TaskLog.Reader(taskId, filter, 0, -1, isCleanup);
        // construct string log from inputstream.
        byte[] b = new byte[65536];
        while (true) {
            res = taskLogReader.read(b);
            if (res > 0) {
                result.append(new String(b));
            } else {
                break;
            }
        }
        taskLogReader.close();

        // trim the string and return it
        String str = result.toString();
        str = str.trim();
        return str;
    }

}