com.apple.foundationdb.relational.yamltests.YamlTest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yaml-tests Show documentation
Tests of the Relational project driven off of YAML specifications.
The newest version!
/*
 * YamlTest.java
 *
 * This source file is part of the FoundationDB open source project
 *
 * Copyright 2015-2025 Apple Inc. and the FoundationDB project 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
 *
 *     http://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 com.apple.foundationdb.relational.yamltests;

import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.extension.ExtendWith;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * An annotation for test classes that run {@code .yamsql} files.
 * 
 *     Test classes annotated with this should have all their tests annotated with
 *     {@link org.junit.jupiter.api.TestTemplate}, instead of {@link org.junit.jupiter.api.Test}.
 *     Note: This doesn't work with {@link org.junit.jupiter.params.ParameterizedTest}.
 *     Each {@link org.junit.jupiter.api.TestTemplate} will be run with each of the varying
 *     {@link com.apple.foundationdb.relational.yamltests.configs.YamlTestConfig}, and passed in a parameter:
 *     {@link YamlTest.Runner} to run the {@code .yamsql} file.
 * 
 * 
 *     If a specific test cannot be run with a specific config due to a bug, it can be ignored by adding the
 *     annotation {@link ExcludeYamlTestConfig}. Ideally, these are short lived, primarily to support adding a config,
 *     and then fixing some tests that may fail with that config.
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@ExtendWith(YamlTestExtension.class)
// Right now these are the only tests that have the capability to run in mixed mode, but if we create other tests, this
// should be moved to a shared static location
@Tag("MixedMode")
public @interface YamlTest {
    /**
     * Simple interface to run a {@code .yamsql} file, based on the config.
     * 
     *     This is primarily a nested class because I couldn't figure out a better way to avoid a naming conflict with
     *     the existing {@link YamlRunner}.
     * 
     */
    interface Runner {
        /**
         * Run a {@code .yamsql} test.
         * @param fileName the filename of the {@code .yamsql} resource
         * @throws Exception if the test has issues
         */
        void runYamsql(String fileName) throws Exception;
    }
}