io.micronaut.starter.feature.testresources.TestResources Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-starter-core Show documentation
Generates Micronaut applications
There is a newer version: 4.7.0
Show newest version
/*
 * Copyright 2017-2022 original 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
 *
 * https://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 io.micronaut.starter.feature.testresources;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.util.StringUtils;
import io.micronaut.starter.application.ApplicationType;
import io.micronaut.starter.application.generator.GeneratorContext;
import io.micronaut.starter.build.BuildProperties;
import io.micronaut.starter.build.dependencies.Dependency;
import io.micronaut.starter.feature.Category;
import io.micronaut.starter.feature.Feature;
import io.micronaut.starter.feature.build.gradle.MicronautTestResourcesGradlePlugin;
import io.micronaut.starter.feature.database.DatabaseDriverFeature;
import io.micronaut.starter.feature.database.DatabaseDriverFeatureDependencies;
import io.micronaut.starter.feature.database.HibernateReactiveFeature;
import io.micronaut.starter.feature.database.r2dbc.R2dbc;
import io.micronaut.starter.feature.migration.MigrationFeature;
import jakarta.inject.Singleton;

@Singleton
public class TestResources implements Feature {

    public static final String MICRONAUT_TEST_RESOURCES_ENABLED = "micronaut.test.resources.enabled";
    public static final String NAME = "test-resources";

    @Override
    @NonNull
    public String getName() {
        return NAME;
    }

    @Override
    @NonNull
    public String getTitle() {
        return "Micronaut Test Resources";
    }

    @Override
    @NonNull
    public String getDescription() {
        return "Adds support for managing external resources which are required during development or testing.";
    }

    @Override
    public boolean supports(ApplicationType applicationType) {
        return true;
    }

    @Override
    public String getCategory() {
        return Category.DEV_TOOLS;
    }

    @Override
    public void apply(GeneratorContext generatorContext) {
        if (generatorContext.getBuildTool().isGradle()) {
            generatorContext.addBuildPlugin(MicronautTestResourcesGradlePlugin.builder().build());
            if (isReactive(generatorContext)
                    && generatorContext.isFeaturePresent(DatabaseDriverFeature.class)
                    && !generatorContext.isFeaturePresent(MigrationFeature.class)) {
                generatorContext.getFeature(DatabaseDriverFeature.class)
                        .flatMap(DatabaseDriverFeatureDependencies::getJavaClientDependency)
                        .map(Dependency.Builder::testResourcesService)
                        .ifPresent(generatorContext::addDependency);
            }
        } else {
            BuildProperties buildProperties = generatorContext.getBuildProperties();
            buildProperties.put(MICRONAUT_TEST_RESOURCES_ENABLED, StringUtils.TRUE);
            generatorContext.addDependency(Dependency.builder()
                    .groupId("io.micronaut.testresources")
                    .artifactId("micronaut-test-resources-client")
                    .developmentOnly());
        }
    }

    private boolean isReactive(GeneratorContext generatorContext) {
        return generatorContext.isFeaturePresent(HibernateReactiveFeature.class) || generatorContext.isFeaturePresent(R2dbc.class);
    }

    @Override
    public String getMicronautDocumentation() {
        return "https://micronaut-projects.github.io/micronaut-test-resources/latest/guide/";
    }
}