jetty-deploy-manager-graph/src/test/java/org/eclipse/jetty/deploy/test/MavenTestingUtils.java

// ========================================================================
// Copyright (c) Webtide LLC
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at 
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.apache.org/licenses/LICENSE-2.0.txt
//
// You may elect to redistribute this code under either of these licenses. 
// ========================================================================
package org.eclipse.jetty.deploy.test;

import java.io.File;
import java.io.FileReader;
import java.io.IOException;

import junit.framework.TestCase;

import org.eclipse.jetty.util.IO;

/**
 * Common utility methods for working with JUnit tests cases in a maven friendly way.
 */
public class MavenTestingUtils
{
    private static File basedir;
    private static File testResourcesDir;
    private static File targetDir;

    // private static Boolean surefireRunning;

    public static File getBasedir()
    {
        if (basedir == null)
        {
            String cwd = System.getProperty("basedir");

            if (cwd == null)
            {
                cwd = System.getProperty("user.dir");
            }

            basedir = new File(cwd);
        }

        return basedir;
    }

    /**
     * Get the directory to the /target directory for this project.
     * 
     * @return the directory path to the target directory.
     */
    public static File getTargetDir()
    {
        if (targetDir == null)
        {
            targetDir = new File(basedir,"target");
            PathAssert.assertDirExists("Target Dir",targetDir);
        }
        return targetDir;
    }

    /**
     * Create a {@link File} object for a path in the /target directory.
     * 
     * @param path
     *            the path desired, no validation of existence is performed.
     * @return the File to the path.
     */
    public static File getTargetFile(String path)
    {
        return new File(getTargetDir(),path.replace("/",File.separator));
    }

    public static File getTargetTestingDir()
    {
        File dir = new File(getTargetDir(),"testing");
        if (!dir.exists())
        {
            dir.mkdirs();
        }
        return dir;
    }

    /**
     * Get a dir in /target/ that uses the JUnit 3.x {@link TestCase#getName()} to make itself unique.
     * 
     * @param test
     *            the junit 3.x testcase to base this new directory on.
     * @return
     */
    public static File getTargetTestingDir(TestCase test)
    {
        return getTargetTestingDir(test.getName());
    }

    /**
     * Get a dir in /target/ that uses the an arbitrary name.
     * 
     * @param testname
     *            the testname to create directory against.
     * @return
     */
    public static File getTargetTestingDir(String testname)
    {
        File dir = new File(getTargetDir(),"test-" + testname);
        if (!dir.exists())
        {
            dir.mkdirs();
        }
        return dir;
    }

    /**
     * Get a dir from the src/test/resource directory.
     * 
     * @param name
     *            the name of the path to get (it must exist as a dir)
     * @return the dir in src/test/resource
     */
    public static File getTestResourceDir(String name)
    {
        File dir = new File(getTestResourcesDir(),name);
        PathAssert.assertDirExists("Test Resource Dir",dir);
        return dir;
    }

    /**
     * Get a file from the src/test/resource directory.
     * 
     * @param name
     *            the name of the path to get (it must exist as a file)
     * @return the file in src/test/resource
     */
    public static File getTestResourceFile(String name)
    {
        File file = new File(getTestResourcesDir(),name);
        PathAssert.assertFileExists("Test Resource File",file);
        return file;
    }

    /**
     * Get a path resource (File or Dir) from the src/test/resource directory.
     * 
     * @param name
     *            the name of the path to get (it must exist)
     * @return the path in src/test/resource
     */
    public static File getTestResourcePath(String name)
    {
        File path = new File(getTestResourcesDir(),name);
        PathAssert.assertExists("Test Resource Path",path);
        return path;
    }

    /**
     * Get the directory to the src/test/resource directory
     * 
     * @return the directory {@link File} to the src/test/resources directory
     */
    public static File getTestResourcesDir()
    {
        if (testResourcesDir == null)
        {
            testResourcesDir = new File(basedir,"src/test/resources".replace("/",File.separator));
            PathAssert.assertDirExists("Test Resources Dir",testResourcesDir);
        }
        return testResourcesDir;
    }

    /**
     * Read the contents of a file into a String and return it.
     * 
     * @param file
     *            the file to read.
     * @return the contents of the file.
     * @throws IOException
     *             if unable to read the file.
     */
    public static String readToString(File file) throws IOException
    {
        FileReader reader = null;
        try
        {
            reader = new FileReader(file);
            return IO.toString(reader);
        }
        finally
        {
            IO.close(reader);
        }
    }

    /*
    public static boolean isSurefireExecuting()
    {
        if (surefireRunning == null)
        {
            String val = System.getProperty("surefire.test.class.path");
            if (val != null)
            {
                surefireRunning = Boolean.TRUE;
            }
            else
            {
                surefireRunning = Boolean.FALSE;
            }
        }
        
        return surefireRunning;
    }
    */
}