/*
* Copyright 2010 the original author or authors.
*
* Licensed 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.gradle.integtests.fixtures;
import org.gradle.integtests.fixtures.executer.IntegrationTestBuildContext;
import org.gradle.test.fixtures.file.TestDirectoryProvider;
import org.gradle.test.fixtures.file.TestFile;
import org.junit.rules.MethodRule;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.Statement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* A Junit rule which copies a sample into the test directory before the test executes. Looks for a
* {@link org.gradle.integtests.fixtures.UsesSample} annotation on the test method to determine which sample the
* test requires. If not found, uses the default sample provided in the constructor.
*/
public class Sample implements MethodRule {
private final Logger logger = LoggerFactory.getLogger(Sample.class);
private final String defaultSampleName;
private final String testSampleDirName;
private TestFile sampleDir;
private TestDirectoryProvider testDirectoryProvider;
public Sample(TestDirectoryProvider testDirectoryProvider) {
this(testDirectoryProvider, null);
}
public Sample(TestDirectoryProvider testDirectoryProvider, String defaultSampleName) {
this(testDirectoryProvider, defaultSampleName, null);
}
public Sample(TestDirectoryProvider testDirectoryProvider, String defaultSampleName, String testSampleDirName) {
this.testDirectoryProvider = testDirectoryProvider;
this.defaultSampleName = defaultSampleName;
this.testSampleDirName = testSampleDirName;
}
public Statement apply(final Statement base, FrameworkMethod method, Object target) {
final String sampleName = getSampleName(method);
if (testSampleDirName != null) {
sampleDir = testDirectoryProvider.getTestDirectory().file(testSampleDirName);
} else {
sampleDir = sampleName == null ? null : testDirectoryProvider.getTestDirectory().file(sampleName);
}
return new Statement() {
@Override
public void evaluate() throws Throwable {
if (sampleName != null) {
TestFile srcDir = new IntegrationTestBuildContext().getSamplesDir().file(sampleName).assertIsDir();
logger.debug("Copying sample '{}' to test directory.", sampleName);
srcDir.copyTo(sampleDir);
} else {
logger.debug("No sample specified for this test, skipping.");
}
base.evaluate();
}
};
}
private String getSampleName(FrameworkMethod method) {
String sampleName;
UsesSample annotation = method.getAnnotation(UsesSample.class);
if (annotation == null) {
sampleName = defaultSampleName;
} else {
sampleName = annotation.value();
}
return sampleName;
}
public TestFile getDir() {
return sampleDir;
}
}