hadoop-submarine/hadoop-submarine-core/src/main/java/org/apache/hadoop/yarn/submarine/client/cli/param/Localization.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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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.submarine.client.cli.param;

import org.apache.commons.cli.ParseException;

import java.util.Arrays;
import java.util.List;

/**
 * Localization parameter.
 * */
public class Localization {

  private String mountPermissionPattern = "(wr|rw)$";
  /**
   * Regex for directory/file path in container.
   * YARN only support absolute path for mount, but we can
   * support some relative path.
   * For relative path, we only allow ".", "./","./name".
   * relative path like "./a/b" is not allowed.
   * "." and "./" means original dir/file name in container working directory
   * "./name" means use same or new "name" in container working directory
   * A absolute path means same path in container filesystem
   */
  private String localPathPattern = "((^\\.$)|(^\\./$)|(^\\./[^/]+)|(^/.*))";
  private String remoteUri;
  private String localPath;

  // Read write by default
  private String mountPermission = "rw";

  private static final List<String> SUPPORTED_SCHEME = Arrays.asList(
      "hdfs", "oss", "s3a", "s3n", "wasb",
      "wasbs", "abfs", "abfss", "adl", "har",
      "ftp", "http", "https", "viewfs", "swebhdfs",
      "webhdfs", "swift");

  public void parse(String arg) throws ParseException {
    String[] tokens = arg.split(":");
    int minimum = "a:b".split(":").length;
    int minimumWithPermission = "a:b:rw".split(":").length;
    int minimumParts = minimum;
    int miniPartsWithRemoteScheme = "scheme://a:b".split(":").length;
    int maximumParts = "scheme://a:b:rw".split(":").length;
    // If remote uri starts with a remote scheme
    if (isSupportedScheme(tokens[0])) {
      minimumParts = miniPartsWithRemoteScheme;
    }
    if (tokens.length < minimumParts
        || tokens.length > maximumParts) {
      throw new ParseException("Invalid parameter,"
          + "should be \"remoteUri:localPath[:rw|:wr]\" "
          + "format for --localizations");
    }

    /**
     * RemoteUri starts with remote scheme.
     * Merge part 0 and 1 to build a hdfs path in token[0].
     * toke[1] will be localPath to ease following logic
     * */
    if (minimumParts == miniPartsWithRemoteScheme) {
      tokens[0] = tokens[0] + ":" + tokens[1];
      tokens[1] = tokens[2];
      if (tokens.length == maximumParts) {
        // Has permission part
        mountPermission = tokens[maximumParts - 1];
      }
    }
    // RemoteUri starts with linux file path
    if (minimumParts == minimum
        && tokens.length == minimumWithPermission) {
      // Has permission part
      mountPermission = tokens[minimumWithPermission - 1];
    }
    remoteUri = tokens[0];
    localPath = tokens[1];
    if (!localPath.matches(localPathPattern)) {
      throw new ParseException("Invalid local file path:"
          + localPath
          + ", it only support \".\", \"./\", \"./name\" and "
          + "absolute path.");
    }
    if (!mountPermission.matches(mountPermissionPattern)) {
      throw new ParseException("Invalid mount permission (ro is not "
          + "supported yet), " + mountPermission);
    }
  }

  public String getRemoteUri() {
    return remoteUri;
  }

  public void setRemoteUri(String rUti) {
    this.remoteUri = rUti;
  }

  public String getLocalPath() {
    return localPath;
  }

  public void setLocalPath(String lPath) {
    this.localPath = lPath;
  }

  public String getMountPermission() {
    return mountPermission;
  }

  public void setMountPermission(String mPermission) {
    this.mountPermission = mPermission;
  }

  private boolean isSupportedScheme(String scheme) {
    return SUPPORTED_SCHEME.contains(scheme);
  }
}