enforcer.rules.RequireEnvironmentVariable.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of enforcer-rules Show documentation
Provides Enforcer rules
The newest version!
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2020-2024 The author and/or 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 enforcer.rules

import groovy.transform.CompileStatic
import org.gradle.api.model.ObjectFactory
import org.gradle.api.provider.Property
import org.kordamp.gradle.plugin.enforcer.api.EnforcerContext
import org.kordamp.gradle.plugin.enforcer.api.EnforcerPhase
import org.kordamp.gradle.plugin.enforcer.api.EnforcerRuleException

import javax.inject.Inject

import static org.kordamp.gradle.plugin.enforcer.api.EnforcerPhase.AFTER_PROJECT
import static org.kordamp.gradle.plugin.enforcer.api.EnforcerPhase.BEFORE_BUILD

/**
 * @author Andres Almiray
 * @since 0.1.0
 */
@CompileStatic
class RequireEnvironmentVariable extends AbstractPropertyEnforcerRule {
    final Property variableName

    @Inject
    RequireEnvironmentVariable(ObjectFactory objects) throws EnforcerRuleException {
        super(objects, [BEFORE_BUILD, AFTER_PROJECT] as EnforcerPhase[])
        variableName = objects.property(String)
    }

    @Override
    protected String getName() {
        return 'Environment variable'
    }

    @Override
    protected String getPropertyName() {
        return variableName.orNull
    }

    @Override
    protected void doValidate(EnforcerContext context) throws EnforcerRuleException {
        super.doValidate(context);

        if (!variableName.present) {
            throw fail("Missing value for 'variableName'.")
        }
    }

    @Override
    protected void doExecute(EnforcerContext context) throws EnforcerRuleException {
        enforceValue(System.getenv(variableName.get()))
    }
}