001/*
002 * SPDX-License-Identifier: Apache-2.0
003 *
004 * Copyright 2025-2026 The Enola <https://enola.dev> Authors
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 *     https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package dev.enola.common.context;
019
020import java.util.concurrent.atomic.AtomicBoolean;
021
022/**
023 * Utility to detect if it is running under a test, for example to disable some production features.
024 *
025 * <p>Tests should use <code>TestContextRule</code>.
026 */
027public final class TestContext {
028    private TestContext() {}
029
030    // This is a temporary fallback to support frameworks which cannot use ContextAwareThreadFactory
031    // TODO: Remove this when TestContextAwareWebSocketServerTest works without needing this
032    @Deprecated public static final AtomicBoolean UNDER_TEST = new AtomicBoolean(false);
033
034    public enum Keys implements Context.Key<Boolean> {
035        UNDER_TEST;
036    }
037
038    /** Returns true if running under a test, and false if not. */
039    public static boolean isUnderTest() {
040        return TLC.optional(Keys.UNDER_TEST).orElse(UNDER_TEST.get());
041    }
042}