org.zalando.gradle.plugins.swagger.SwaggerCodegenPlugin Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2015 Zalando SE (http://tech.zalando.com)
 *
 * 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.zalando.gradle.plugins.swagger;

import java.io.File;

import javax.inject.Inject;

import org.gradle.api.Action;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.internal.file.FileResolver;
import org.gradle.api.internal.plugins.DslObject;
import org.gradle.api.internal.tasks.DefaultSourceSet;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.plugins.JavaPluginConvention;
import org.gradle.api.tasks.SourceSet;

public class SwaggerCodegenPlugin implements Plugin {

    private final FileResolver fileResolver;

    @Inject
    public SwaggerCodegenPlugin(final FileResolver fileResolver) {
        this.fileResolver = fileResolver;
    }

    @Override
    public void apply(Project project) {
        project.getPlugins().apply(JavaPlugin.class);

        configureConfigurations(project);
        configureSourceSets(project);
    }

    private void configureConfigurations(final Project project) {
        final Configuration swaggerCodegenConfiguration = project.getConfigurations().create("swagger-codegen")
                .setVisible(false);

        project.getConfigurations().getByName(JavaPlugin.COMPILE_CONFIGURATION_NAME).extendsFrom(swaggerCodegenConfiguration);

    }

    private void configureSourceSets(final Project project) {
        project.getConvention().getPlugin(JavaPluginConvention.class).getSourceSets().all(new Action() {
            @Override
            public void execute(SourceSet sourceSet) {
                //
                // This logic borrowed from the antlr plugin.
                // 1. Add a new 'thrift' virtual directory mapping
                //
                // final ThriftSourceVirtualDirectoryImpl thriftSourceSet =
                // new ThriftSourceVirtualDirectoryImpl(((DefaultSourceSet)
                // sourceSet).getDisplayName(), fileResolver);

                final SwaggerCodegenSourceVirtualDirectoryImpl swaggerCodegenSourceSet = new SwaggerCodegenSourceVirtualDirectoryImpl(
                        ((DefaultSourceSet) sourceSet).getDisplayName(), fileResolver);

                new DslObject(sourceSet).getConvention().getPlugins().put("swagger-codegen", swaggerCodegenSourceSet);

                final String srcDir = String.format("src/%s/swagger-codegen", sourceSet.getName());
                // thriftSourceSet.getThrift().srcDir(srcDir);

                swaggerCodegenSourceSet.getSwaggerCodegen().srcDir(srcDir);
                // sourceSet.getAllSource().source(thriftSourceSet.getThrift());
                sourceSet.getAllSource().source(swaggerCodegenSourceSet.getSwaggerCodegen());

                //
                // 2. Create a ThriftTask for this sourceSet
                //
                final String taskName = sourceSet.getTaskName("swaggerCodegen", "");

                final SwaggerCodegenTask swaggerCodegenTask = project.getTasks().create(taskName,
                        SwaggerCodegenTask.class);

                swaggerCodegenTask
                        .setDescription(String.format("Processes the %s Open-API definition.", sourceSet.getName()));

                //
                // 3. Set up convention mapping for default sources (allows user to not have to specify)
                //
                swaggerCodegenTask.setSource(swaggerCodegenSourceSet.getSwaggerCodegen());

                //
                // 4. Set up the swagger-codegen output directory (adding to
                // javac inputs)
                //
                final String outputDirectoryName =
                        String.format("%s/generated-src/swagger-codegen/%s", project.getBuildDir(),
                                sourceSet.getName());
                final File outputDirectory = new File(outputDirectoryName);
                swaggerCodegenTask.out(outputDirectory);
                sourceSet.getJava().srcDir(outputDirectory);


                //
                // 5. Register the fact that swagger-codegen should run before
                // compiling.
                //
                project.getTasks().getByName(sourceSet.getCompileJavaTaskName()).dependsOn(taskName);
            }
        });
    }


}