com.thoughtworks.go.config.rules.AbstractDirective.java Source code

Introduction

Here is the source code for com.thoughtworks.go.config.rules.AbstractDirective.java

Source

/*
 * Copyright 2019 ThoughtWorks, Inc.
 *
 * 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.thoughtworks.go.config.rules;

import com.thoughtworks.go.config.ConfigAttribute;
import com.thoughtworks.go.config.ConfigValue;
import com.thoughtworks.go.config.Validatable;
import com.thoughtworks.go.config.ValidationContext;
import com.thoughtworks.go.domain.ConfigErrors;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.IOCase;

import java.util.List;
import java.util.Objects;

import static com.thoughtworks.go.config.rules.SupportedEntity.*;
import static java.lang.String.format;
import static org.apache.commons.lang3.StringUtils.equalsIgnoreCase;
import static org.apache.commons.lang3.StringUtils.isBlank;

public abstract class AbstractDirective implements Directive {
    @ConfigAttribute(value = "action", optional = false)
    protected String action;

    @ConfigAttribute(value = "type", optional = false)
    protected String type;

    @ConfigValue
    private String resource;

    private final ConfigErrors configErrors = new ConfigErrors();

    private DirectiveType directiveType;

    public AbstractDirective(DirectiveType allow) {
        this.directiveType = allow;
    }

    public AbstractDirective(DirectiveType allow, String action, String type, String resource) {
        this.directiveType = allow;
        this.action = action;
        this.type = type;
        this.resource = resource;
    }

    @Override
    public void validate(ValidationContext validationContext) {
        RulesValidationContext rulesValidationContext = validationContext.getRulesValidationContext();

        if (isInvalid(action, rulesValidationContext.getAllowedActions())) {
            this.addError("action",
                    format("Invalid action, must be one of %s.", rulesValidationContext.getAllowedActions()));
        }

        if (isInvalid(type, rulesValidationContext.getAllowedTypes())) {
            this.addError("type",
                    format("Invalid type, must be one of %s.", rulesValidationContext.getAllowedTypes()));
        }

        if (isBlank(resource)) {
            this.addError("resource", "Resource cannot be blank.");
        }
    }

    private boolean isInvalid(String actionOrType, List<String> allowedActions) {
        if ("*".equals(actionOrType)) {
            return false;
        }

        return allowedActions.stream().noneMatch(it -> equalsIgnoreCase(it, actionOrType));
    }

    protected boolean matchesAction(String action) {
        if (equalsIgnoreCase("*", this.action)) {
            return true;
        }

        return equalsIgnoreCase(action, this.action);
    }

    protected boolean matchesType(Class<? extends Validatable> entityType) {
        if (equalsIgnoreCase("*", this.type)) {
            return true;
        }

        return fromString(this.type).getEntityType().isAssignableFrom(entityType);
    }

    protected boolean matchesResource(String resource) {
        if (equalsIgnoreCase("*", this.resource)) {
            return true;
        }

        return FilenameUtils.wildcardMatch(resource, this.resource, IOCase.INSENSITIVE);
    }

    @Override
    public ConfigErrors errors() {
        return this.configErrors;
    }

    @Override
    public void addError(String fieldName, String message) {
        this.configErrors.add(fieldName, message);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (o == null || getClass() != o.getClass())
            return false;
        AbstractDirective directive = (AbstractDirective) o;
        return Objects.equals(action, directive.action) && Objects.equals(type, directive.type)
                && Objects.equals(resource, directive.resource);
    }

    @Override
    public String action() {
        return this.action;
    }

    @Override
    public String type() {
        return this.type;
    }

    @Override
    public String resource() {
        return this.resource;
    }

    @Override
    public int hashCode() {
        return Objects.hash(action, type, resource);
    }

    @Override
    public boolean hasErrors() {
        return !this.configErrors.isEmpty();
    }

    @Override
    public DirectiveType getDirectiveType() {
        return this.directiveType;
    }
}