/*
* Copyright 2014 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.nativeplatform.test.cunit.plugins;
import org.gradle.api.Incubating;
import org.gradle.api.NamedDomainObjectSet;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.plugins.ExtensionAware;
import org.gradle.api.specs.Spec;
import org.gradle.api.tasks.TaskContainer;
import org.gradle.internal.reflect.Instantiator;
import org.gradle.internal.service.ServiceRegistry;
import org.gradle.language.base.FunctionalSourceSet;
import org.gradle.language.base.ProjectSourceSet;
import org.gradle.language.c.CSourceSet;
import org.gradle.language.c.plugins.CLangPlugin;
import org.gradle.language.nativeplatform.internal.DefaultPreprocessingTool;
import org.gradle.model.Mutate;
import org.gradle.model.Path;
import org.gradle.model.RuleSource;
import org.gradle.nativeplatform.NativeBinarySpec;
import org.gradle.nativeplatform.NativeComponentSpec;
import org.gradle.nativeplatform.internal.NativeBinarySpecInternal;
import org.gradle.nativeplatform.internal.resolve.NativeDependencyResolver;
import org.gradle.nativeplatform.test.TestSuiteContainer;
import org.gradle.nativeplatform.test.cunit.CUnitTestSuiteSpec;
import org.gradle.nativeplatform.test.cunit.internal.DefaultCUnitTestSuiteBinary;
import org.gradle.nativeplatform.test.cunit.internal.DefaultCUnitTestSuiteSpec;
import org.gradle.nativeplatform.test.cunit.tasks.GenerateCUnitLauncher;
import org.gradle.nativeplatform.test.plugins.NativeBinariesTestPlugin;
import org.gradle.nativeplatform.toolchain.internal.PlatformToolProvider;
import org.gradle.platform.base.BinaryContainer;
import org.gradle.platform.base.ComponentSpecIdentifier;
import org.gradle.platform.base.internal.BinaryNamingScheme;
import org.gradle.platform.base.internal.DefaultBinaryNamingSchemeBuilder;
import org.gradle.platform.base.internal.DefaultComponentSpecIdentifier;
import java.io.File;
import java.util.Collections;
/**
* A plugin that sets up the infrastructure for testing native binaries with CUnit.
*/
@Incubating
public class CUnitPlugin implements Plugin<Project> {
public void apply(final Project project) {
project.apply(Collections.singletonMap("plugin", NativeBinariesTestPlugin.class));
project.apply(Collections.singletonMap("plugin", CLangPlugin.class));
}
/**
* Model rules.
*/
@SuppressWarnings("UnusedDeclaration")
@RuleSource
public static class Rules {
private static final String CUNIT_LAUNCHER_SOURCE_SET = "cunitLauncher";
@Mutate
public void createCUnitTestSuitePerComponent(TestSuiteContainer testSuites, NamedDomainObjectSet<NativeComponentSpec> components, ProjectSourceSet projectSourceSet, ServiceRegistry serviceRegistry) {
Instantiator instantiator = serviceRegistry.get(Instantiator.class);
for (NativeComponentSpec component : components) {
testSuites.add(createCUnitTestSuite(component, instantiator, projectSourceSet));
}
}
private CUnitTestSuiteSpec createCUnitTestSuite(final NativeComponentSpec testedComponent, Instantiator instantiator, ProjectSourceSet projectSourceSet) {
String suiteName = String.format("%sTest", testedComponent.getName());
String path = testedComponent.getProjectPath();
ComponentSpecIdentifier id = new DefaultComponentSpecIdentifier(path, suiteName);
FunctionalSourceSet testSuiteSourceSet = projectSourceSet.maybeCreate(suiteName);
return instantiator.newInstance(DefaultCUnitTestSuiteSpec.class, id, testedComponent, testSuiteSourceSet);
}
@Mutate
public void configureCUnitTestSuiteSources(ProjectSourceSet projectSourceSet, TestSuiteContainer testSuites, @Path("buildDir") File buildDir) {
for (final CUnitTestSuiteSpec suite : testSuites.withType(CUnitTestSuiteSpec.class)) {
FunctionalSourceSet suiteSourceSet = suite.getSources();
CSourceSet launcherSources = suiteSourceSet.maybeCreate(CUNIT_LAUNCHER_SOURCE_SET, CSourceSet.class);
File baseDir = new File(buildDir, String.format("src/%s/cunitLauncher", suite.getName()));
launcherSources.getSource().srcDir(new File(baseDir, "c"));
launcherSources.getExportedHeaders().srcDir(new File(baseDir, "headers"));
CSourceSet testSources = suiteSourceSet.maybeCreate("c", CSourceSet.class);
testSources.lib(launcherSources);
}
}
@Mutate
public void createCUnitLauncherTasks(TaskContainer tasks, TestSuiteContainer testSuites, ProjectSourceSet sources) {
for (final CUnitTestSuiteSpec suite : testSuites.withType(CUnitTestSuiteSpec.class)) {
String taskName = suite.getName() + "CUnitLauncher";
GenerateCUnitLauncher skeletonTask = tasks.create(taskName, GenerateCUnitLauncher.class);
CSourceSet launcherSources = findLaucherSources(suite);
skeletonTask.setSourceDir(launcherSources.getSource().getSrcDirs().iterator().next());
skeletonTask.setHeaderDir(launcherSources.getExportedHeaders().getSrcDirs().iterator().next());
launcherSources.builtBy(skeletonTask);
}
}
private CSourceSet findLaucherSources(CUnitTestSuiteSpec suite) {
return suite.getSource().withType(CSourceSet.class).matching(new Spec<CSourceSet>() {
public boolean isSatisfiedBy(CSourceSet element) {
return element.getName().equals(CUNIT_LAUNCHER_SOURCE_SET);
}
}).iterator().next();
}
@Mutate
public void createCUnitTestBinaries(final BinaryContainer binaries, TestSuiteContainer testSuites, @Path("buildDir") File buildDir, ServiceRegistry serviceRegistry) {
for (final CUnitTestSuiteSpec cUnitTestSuite : testSuites.withType(CUnitTestSuiteSpec.class)) {
for (NativeBinarySpec testedBinary : cUnitTestSuite.getTestedComponent().getNativeBinaries()) {
DefaultCUnitTestSuiteBinary testBinary = createTestBinary(serviceRegistry, cUnitTestSuite, testedBinary);
configure(testBinary, buildDir);
cUnitTestSuite.getBinaries().add(testBinary);
binaries.add(testBinary);
}
}
}
private DefaultCUnitTestSuiteBinary createTestBinary(ServiceRegistry serviceRegistry, CUnitTestSuiteSpec cUnitTestSuite, NativeBinarySpec testedBinary) {
BinaryNamingScheme namingScheme = new DefaultBinaryNamingSchemeBuilder(((NativeBinarySpecInternal) testedBinary).getNamingScheme())
.withComponentName(cUnitTestSuite.getBaseName())
.withTypeString("CUnitExe").build();
Instantiator instantiator = serviceRegistry.get(Instantiator.class);
NativeDependencyResolver resolver = serviceRegistry.get(NativeDependencyResolver.class);
return instantiator.newInstance(DefaultCUnitTestSuiteBinary.class, cUnitTestSuite, testedBinary, namingScheme, resolver);
}
private void configure(DefaultCUnitTestSuiteBinary testBinary, File buildDir) {
BinaryNamingScheme namingScheme = testBinary.getNamingScheme();
PlatformToolProvider toolProvider = testBinary.getPlatformToolProvider();
File binaryOutputDir = new File(new File(buildDir, "binaries"), namingScheme.getOutputDirectoryBase());
String baseName = testBinary.getComponent().getBaseName();
testBinary.setExecutableFile(new File(binaryOutputDir, toolProvider.getExecutableName(baseName)));
((ExtensionAware) testBinary).getExtensions().create("cCompiler", DefaultPreprocessingTool.class);
}
}
}