com.apple.foundationdb.relational.yamltests.server.SupportedVersionCheck 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!
/*
 * SupportedVersionCheck.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.server;

import com.apple.foundationdb.relational.yamltests.YamlExecutionContext;
import com.apple.foundationdb.relational.yamltests.block.FileOptions;

import javax.annotation.Nonnull;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Class to support the various places in a yaml file where you can have supported_version.
 */
public class SupportedVersionCheck {
    public static final String SUPPORTED_VERSION_OPTION = "supported_version";
    public static final SupportedVersionCheck SUPPORTED = new SupportedVersionCheck(true, "");

    private final boolean isSupported;
    private final String message;

    private SupportedVersionCheck(boolean isSupported, String message) {
        this.isSupported = isSupported;
        this.message = message;
    }

    public static SupportedVersionCheck parseOptions(Map options, YamlExecutionContext executionContext) {
        if (options.containsKey(SUPPORTED_VERSION_OPTION)) {
            return SupportedVersionCheck.parse(options.get(SUPPORTED_VERSION_OPTION), executionContext);
        } else {
            return SupportedVersionCheck.supported();
        }
    }

    public static SupportedVersionCheck parse(Object rawVersion, YamlExecutionContext executionContext) {
        SemanticVersion supportedVersion = FileOptions.parseVersion(rawVersion);
        final Set versionsUnderTest = executionContext.getConnectionFactory().getVersionsUnderTest();
        final List unsupportedVersions = supportedVersion.lesserVersions(versionsUnderTest);
        if (!unsupportedVersions.isEmpty()) {
            if (SemanticVersion.current().equals(supportedVersion)) {
                return SupportedVersionCheck.unsupported(
                        "Skipping test that only works against the current version, when we're running with these versions: " +
                                versionsUnderTest);
            } else {
                return SupportedVersionCheck.unsupported("Skipping test that only works against " + supportedVersion +
                        " and later, but we are running with these older versions: " + unsupportedVersions);
            }
        }
        return supported();
    }

    public boolean isSupported() {
        return isSupported;
    }

    public String getMessage() {
        return message;
    }

    public static SupportedVersionCheck supported() {
        return SUPPORTED;
    }

    public static SupportedVersionCheck unsupported(@Nonnull String message) {
        return new SupportedVersionCheck(false, message);
    }
}