org.opensearch.gradle.precommit.TestingConventionRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of build-tools Show documentation
OpenSearch subproject :build-tools
There is a newer version: 2.18.0
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you 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.
 */
/*
 * Modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

package org.opensearch.gradle.precommit;

import java.io.Serializable;
import java.util.Collection;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import java.util.regex.Pattern;

/**
 * Represent rules for tests enforced by the @{link {@link TestingConventionsTasks}}
 * 
 * Rules are identified by name, tests must have this name as a suffix and implement one of the base classes
 * and be part of all the specified tasks.
 */
public class TestingConventionRule implements Serializable {

    private final String suffix;

    private Set baseClasses = new HashSet<>();

    private Set taskNames = new HashSet<>();

    public TestingConventionRule(String suffix) {
        this.suffix = suffix;
    }

    public String getSuffix() {
        return suffix;
    }

    /**
     * Alias for @{link getSuffix} as Gradle requires a name property
     *
     */
    public String getName() {
        return suffix;
    }

    public void baseClass(String clazz) {
        baseClasses.add(clazz);
    }

    public void setBaseClasses(Collection baseClasses) {
        this.baseClasses.clear();
        this.baseClasses.addAll(baseClasses);
    }

    public void taskName(Pattern expression) {
        taskNames.add(expression);
    }

    public void taskName(String expression) {
        taskNames.add(Pattern.compile(expression));
    }

    public void setTaskNames(Collection expressions) {
        taskNames.clear();
        taskNames.addAll(expressions);
    }

    public Set getBaseClasses() {
        return baseClasses;
    }

    public Set getTaskNames() {
        return taskNames;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        TestingConventionRule that = (TestingConventionRule) o;
        return Objects.equals(suffix, that.suffix);
    }

    @Override
    public int hashCode() {
        return Objects.hash(suffix);
    }
}