BaseTestClass.java

/**
 * 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.falcon.regression.testHelper;

import org.apache.falcon.regression.core.bundle.Bundle;
import org.apache.falcon.regression.core.enumsAndConstants.MerlinConstants;
import org.apache.falcon.regression.core.helpers.ColoHelper;
import org.apache.falcon.regression.core.util.CleanupUtil;
import org.apache.falcon.regression.core.util.Config;
import org.apache.falcon.regression.core.util.HadoopUtil;
import org.apache.hadoop.fs.FileSystem;
import org.apache.log4j.Logger;
import org.apache.oozie.client.OozieClient;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * Base class for test classes.
 */
public class BaseTestClass {
    private static String[] serverNames;
    private static final Logger LOGGER = Logger.getLogger(BaseTestClass.class);

    static {
        prepareProperties();
    }

    protected ColoHelper prism;
    protected List<ColoHelper> servers;
    protected List<FileSystem> serverFS;
    protected List<OozieClient> serverOC;
    private String baseHDFSDir = "/tmp/falcon-regression";
    public static final String PRISM_PREFIX = "prism";
    protected Bundle[] bundles;
    public static final String MINUTE_DATE_PATTERN = "/${YEAR}/${MONTH}/${DAY}/${HOUR}/${MINUTE}";


    public BaseTestClass() {
        // loginFromKeytab as the current user
        prism = new ColoHelper(PRISM_PREFIX);
        servers = getServers();
        serverFS = new ArrayList<>();
        serverOC = new ArrayList<>();
        try {
            for (ColoHelper server : servers) {
                serverFS.add(server.getClusterHelper().getHadoopFS());
                serverOC.add(server.getClusterHelper().getOozieClient());
            }
            cleanTestsDirs();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }

        bundles = new Bundle[serverNames.length];
        removeTestClassEntities();
    }

    protected final String cleanAndGetTestDir() {
        String dir = baseHDFSDir + '/' + this.getClass().getSimpleName();
        try {
            HadoopUtil.recreateDir(serverFS, dir);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return dir;
    }

    private static void prepareProperties() {

        serverNames = Config.getStringArray("servers");
        for (int i = 0; i < serverNames.length; i++) {
            serverNames[i] = serverNames[i].trim();
        }
    }

    private List<ColoHelper> getServers() {
        ArrayList<ColoHelper> returnList = new ArrayList<>();
        for (String serverName : serverNames) {
            returnList.add(new ColoHelper(serverName));
        }
        return returnList;
    }

    public void uploadDirToClusters(final String dstHdfsDir, final String localLocation)
        throws IOException {
        LOGGER.info(String.format("Uploading local dir: %s to all the clusters at: %s",
            localLocation, dstHdfsDir));
        for (FileSystem fs : serverFS) {
            HadoopUtil.uploadDir(fs, dstHdfsDir, localLocation);
        }
    }

    /**
     * Method removes test class entities which belong to default test user.
     */
    public final void removeTestClassEntities() {
        removeTestClassEntities(new String[]{null});
    }

    /**
     * This method removes all entities which name starts with prefix derived from test class name. As entities can
     * belong to different users, that users need to be listed as parameters. Note that null is a default test user.
     * @param users users whose entities should be removed.
     */
    public final void removeTestClassEntities(String...users) {
        for (String user : users) {
            for (Bundle bundle : this.bundles) {
                if (bundle != null) {
                    bundle.deleteBundle(prism);
                }
            }
            String className = this.getClass().getSimpleName();
            CleanupUtil.cleanEntitiesWithPrefix(prism, className, user);
            String deprecatedPrefix = 'A' + Integer.toHexString(className.hashCode());
            CleanupUtil.cleanEntitiesWithPrefix(prism, deprecatedPrefix, user);
        }
    }


    public final void cleanTestsDirs() throws IOException {
        if (MerlinConstants.CLEAN_TESTS_DIR) {
            for (FileSystem fs : serverFS) {
                HadoopUtil.deleteDirIfExists(baseHDFSDir, fs);
            }
        }
    }
}