hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/placement/MappingRuleValidationHelper.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 */

package org.apache.hadoop.yarn.server.resourcemanager.placement;

import org.apache.hadoop.yarn.exceptions.YarnException;
import org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CSQueue;
import org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CapacitySchedulerQueueManager;
import org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.ManagedParentQueue;
import org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.ParentQueue;

import java.util.ArrayList;
import java.util.Collections;

import static org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CapacitySchedulerConfiguration.DOT;

/**
 * This class' functionality needs to be merged into CapacityScheduler
 * or CapacitySchedulerQueueManager, but that will include a lot of testcase
 * changes, so temporarily the logic is extracted to this class.
 */
public final class MappingRuleValidationHelper {
  public enum ValidationResult {
    CREATABLE,
    QUEUE_EXISTS,
    NO_PARENT_PROVIDED,
    NO_DYNAMIC_PARENT,
    AMBIGUOUS_PARENT,
    AMBIGUOUS_QUEUE,
    EMPTY_PATH
  }

  /**
   * Utility class hidden constructor.
   */
  private MappingRuleValidationHelper() {

  }

  public static String normalizeQueuePathRoot(
      CapacitySchedulerQueueManager queueManager, String fullPath)
      throws YarnException {
    //Normalizing the root of the path
    ArrayList<String> parts = new ArrayList<>();
    Collections.addAll(parts, fullPath.split("\\."));

    //the first element of the path is the path root
    String pathRoot = parts.get(0);
    CSQueue pathRootQueue = queueManager.getQueue(pathRoot);
    if (pathRootQueue == null) {
      if (queueManager.isAmbiguous(pathRoot)) {
        throw new YarnException("Path root '" + pathRoot +
            "' is ambiguous. Path '" + fullPath + "' is invalid");
      } else {
        throw new YarnException("Path root '" + pathRoot +
            "' does not exist. Path '" + fullPath + "' is invalid");
      }
    }

    //Normalizing the root
    parts.set(0, pathRootQueue.getQueuePath());
    return String.join(DOT, parts);
  }

  public static ValidationResult validateQueuePathAutoCreation(
      CapacitySchedulerQueueManager queueManager, String path) {
    //Some sanity checks, the empty path and existing queue can be checked easy
    if (path == null || path.isEmpty()) {
      return ValidationResult.EMPTY_PATH;
    }

    if (queueManager.getQueue(path) != null) {
      return ValidationResult.QUEUE_EXISTS;
    }

    if (queueManager.isAmbiguous(path)) {
      return ValidationResult.AMBIGUOUS_QUEUE;
    }

    //Creating the path of the parent queue and grand parent queue
    ArrayList<String> parts = new ArrayList<>();
    Collections.addAll(parts, path.split("\\."));

    //dropping leaf name part of the path
    parts.remove(parts.size() - 1);
    String parentPath = parts.size() >= 1 ? String.join(".", parts) : "";
    //dropping parent name part of the path
    parts.remove(parts.size() - 1);
    String grandParentPath = parts.size() >= 1 ? String.join(".", parts) : "";

    if (parentPath.isEmpty()) {
      return ValidationResult.NO_PARENT_PROVIDED;
    }

    if (queueManager.isAmbiguous(parentPath)) {
      return ValidationResult.AMBIGUOUS_PARENT;
    }
    CSQueue parentQueue = queueManager.getQueue(parentPath);
    if (parentQueue == null) {
      if (grandParentPath.isEmpty()) {
        return ValidationResult.NO_PARENT_PROVIDED;
      }

      if (queueManager.isAmbiguous(grandParentPath)) {
        return ValidationResult.AMBIGUOUS_PARENT;
      }
      //if we don't have a valid parent queue, we need to check the grandparent
      //if the grandparent allows new dynamic creation, the dynamic parent and
      //the dynamic leaf queue can be created as well
      CSQueue grandParentQueue = queueManager.getQueue(grandParentPath);
      if (grandParentQueue != null && grandParentQueue instanceof ParentQueue &&
          ((ParentQueue)grandParentQueue).isEligibleForAutoQueueCreation()) {
        //Grandparent is a new dynamic parent queue, which allows deep queue
        //creation
        return ValidationResult.CREATABLE;
      }

      return ValidationResult.NO_DYNAMIC_PARENT;
    }

    //at this point we know we have a parent queue we just need to make sure
    //it allows queue creation
    if (parentQueue instanceof ManagedParentQueue) {
      //Managed parent is the legacy way, so it will allow creation
      return ValidationResult.CREATABLE;
    }
    if (parentQueue instanceof ParentQueue) {
      //the new way of dynamic queue creation uses ParentQueues so we need to
      //check if those queues allow dynamic queue creation
      if (((ParentQueue)parentQueue).isEligibleForAutoQueueCreation()) {
        return ValidationResult.CREATABLE;
      }
    }
    //at this point we can be sure the parent does not support auto queue
    //creation it's either being a leaf queue or a non-dynamic parent queue
    return ValidationResult.NO_DYNAMIC_PARENT;
  }
}