|
| 1 | +/* |
| 2 | + * Copyright 2026 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.cloudfoundry; |
| 18 | + |
| 19 | +import java.lang.annotation.Documented; |
| 20 | +import java.lang.annotation.ElementType; |
| 21 | +import java.lang.annotation.Inherited; |
| 22 | +import java.lang.annotation.Retention; |
| 23 | +import java.lang.annotation.RetentionPolicy; |
| 24 | +import java.lang.annotation.Target; |
| 25 | +import org.junit.jupiter.api.extension.ConditionEvaluationResult; |
| 26 | +import org.junit.jupiter.api.extension.ExecutionCondition; |
| 27 | +import org.junit.jupiter.api.extension.ExtendWith; |
| 28 | +import org.junit.jupiter.api.extension.ExtensionContext; |
| 29 | + |
| 30 | +/** |
| 31 | + * Annotation to mark tests that require TCP routing to be configured. |
| 32 | + * |
| 33 | + * <p>Tests annotated with this (or test classes containing this annotation) |
| 34 | + * will be skipped if the {@code SKIP_TCP_ROUTING_TESTS} environment variable |
| 35 | + * is set to "true". |
| 36 | + * |
| 37 | + * <p>Use this when your Cloud Foundry instance does not have TCP routing |
| 38 | + * configured (i.e., when the info payload does not contain a 'routing_endpoint' key). |
| 39 | + * |
| 40 | + * <p>Example usage: |
| 41 | + * <pre> |
| 42 | + * @RequiresTcpRouting |
| 43 | + * public class TcpRoutesTest extends AbstractIntegrationTest { |
| 44 | + * // tests that require TCP routing |
| 45 | + * } |
| 46 | + * </pre> |
| 47 | + */ |
| 48 | +@Target({ElementType.METHOD, ElementType.TYPE}) |
| 49 | +@Retention(RetentionPolicy.RUNTIME) |
| 50 | +@Documented |
| 51 | +@Inherited |
| 52 | +@ExtendWith(RequiresTcpRouting.SkipTcpRoutingCondition.class) |
| 53 | +public @interface RequiresTcpRouting { |
| 54 | + |
| 55 | + /** |
| 56 | + * JUnit 5 ExecutionCondition that checks if tcp routing tests should be skipped. |
| 57 | + */ |
| 58 | + class SkipTcpRoutingCondition implements ExecutionCondition { |
| 59 | + |
| 60 | + private static final String ENV_VAR = "SKIP_TCP_ROUTING_TESTS"; |
| 61 | + |
| 62 | + @Override |
| 63 | + public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) { |
| 64 | + String envValue = System.getenv(ENV_VAR); |
| 65 | + |
| 66 | + if ("true".equalsIgnoreCase(envValue)) { |
| 67 | + return ConditionEvaluationResult.disabled( |
| 68 | + "TCP routing tests are disabled via " |
| 69 | + + ENV_VAR |
| 70 | + + " environment variable" |
| 71 | + + ". TCP routing may not be configured on the target CF instance."); |
| 72 | + } |
| 73 | + |
| 74 | + return ConditionEvaluationResult.enabled("TCP routing tests are enabled"); |
| 75 | + } |
| 76 | + } |
| 77 | +} |
0 commit comments