org.sonar.plugins.jacoco.TestUtils.java Source code

Java tutorial

Introduction

Here is the source code for org.sonar.plugins.jacoco.TestUtils.java

Source

/*
 * SonarQube Java
 * Copyright (C) 2010-2017 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plugins.jacoco;

import org.apache.commons.lang.StringUtils;

import javax.annotation.CheckForNull;

import java.io.File;
import java.net.URISyntaxException;
import java.net.URL;

public class TestUtils {

    private TestUtils() {
        // utility class
    }

    /**
     * Search for a test resource in the classpath. For example getResource("org/sonar/MyClass/foo.txt");
     *
     * @param path the starting slash is optional
     * @return the resource. Null if resource not found
     */
    @CheckForNull
    public static File getResource(String path) {
        String resourcePath = path;
        if (!resourcePath.startsWith("/")) {
            resourcePath = "/" + resourcePath;
        }
        URL url = TestUtils.class.getResource(resourcePath);
        if (url != null) {
            try {
                return new File(url.toURI());
            } catch (URISyntaxException e) {
                return null;
            }
        }
        return null;
    }

    /**
     * Search for a resource in the classpath. For example calling the method getResource(getClass(), "myTestName/foo.txt") from
     * the class org.sonar.Foo loads the file $basedir/src/test/resources/org/sonar/Foo/myTestName/foo.txt
     *
     * @return the resource. Null if resource not found
     */
    @CheckForNull
    public static File getResource(Class baseClass, String path) {
        String resourcePath = StringUtils.replaceChars(baseClass.getCanonicalName(), '.', '/');
        if (!path.startsWith("/")) {
            resourcePath += "/";
        }
        resourcePath += path;
        return getResource(resourcePath);
    }

}