java/com/google/gerrit/plugins/codeowners/validation/SkipCodeOwnerConfigValidationCapability.java

// Copyright (C) 2021 The Android Open Source Project
//
// 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.google.gerrit.plugins.codeowners.validation;

import com.google.gerrit.extensions.annotations.PluginName;
import com.google.gerrit.extensions.api.access.PluginPermission;
import com.google.gerrit.extensions.config.CapabilityDefinition;
import com.google.inject.Inject;
import com.google.inject.Singleton;

/**
 * Global capability that allows a user to skip the code owner config validation on push via the
 * {@code code-owners~skip-validation} push option.
 */
@Singleton
public class SkipCodeOwnerConfigValidationCapability extends CapabilityDefinition {
  public static final String ID = "canSkipCodeOwnerConfigValidation";

  private final String pluginName;

  @Inject
  SkipCodeOwnerConfigValidationCapability(@PluginName String pluginName) {
    this.pluginName = pluginName;
  }

  @Override
  public String getDescription() {
    return "Can Skip Code Owner Config Validation";
  }

  public PluginPermission getPermission() {
    return new PluginPermission(pluginName, ID, /* fallBackToAdmin= */ true);
  }
}