/*
 * Copyright 2015-2020 the original author or authors.
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v2.0 which
 * accompanies this distribution and is available at
 *
 * https://www.eclipse.org/legal/epl-v20.html
 */

package org.junit.jupiter.api.condition;

import static java.lang.String.format;
import static org.junit.jupiter.api.extension.ConditionEvaluationResult.disabled;
import static org.junit.jupiter.api.extension.ConditionEvaluationResult.enabled;

import org.junit.jupiter.api.extension.ConditionEvaluationResult;
import org.junit.jupiter.api.extension.ExecutionCondition;
import org.junit.platform.commons.util.Preconditions;

See Also:
Since:5.1
/** * {@link ExecutionCondition} for {@link EnabledIfEnvironmentVariable @EnabledIfEnvironmentVariable}. * * @since 5.1 * @see EnabledIfEnvironmentVariable */
class EnabledIfEnvironmentVariableCondition extends AbstractRepeatableAnnotationCondition<EnabledIfEnvironmentVariable> { private static final ConditionEvaluationResult ENABLED = ConditionEvaluationResult.enabled( "No @EnabledIfEnvironmentVariable conditions resulting in 'disabled' execution encountered"); EnabledIfEnvironmentVariableCondition() { super(EnabledIfEnvironmentVariable.class); } @Override protected ConditionEvaluationResult getNoDisabledConditionsEncounteredResult() { return ENABLED; } @Override protected ConditionEvaluationResult evaluate(EnabledIfEnvironmentVariable annotation) { String name = annotation.named().trim(); String regex = annotation.matches(); Preconditions.notBlank(name, () -> "The 'named' attribute must not be blank in " + annotation); Preconditions.notBlank(regex, () -> "The 'matches' attribute must not be blank in " + annotation); String actual = getEnvironmentVariable(name); // Nothing to match against? if (actual == null) { return disabled(format("Environment variable [%s] does not exist", name), annotation.disabledReason()); } if (actual.matches(regex)) { return enabled(format("Environment variable [%s] with value [%s] matches regular expression [%s]", name, actual, regex)); } return disabled(format("Environment variable [%s] with value [%s] does not match regular expression [%s]", name, actual, regex), annotation.disabledReason()); }
Get the value of the named environment variable.

The default implementation simply delegates to System.getenv(String). Can be overridden in a subclass for testing purposes.

/** * Get the value of the named environment variable. * * <p>The default implementation simply delegates to * {@link System#getenv(String)}. Can be overridden in a subclass for * testing purposes. */
protected String getEnvironmentVariable(String name) { return System.getenv(name); } }