com.google.api.generator.gapic.protoparser.PluginArgumentParser Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gapic-generator-java Show documentation
GAPIC generator Java
There is a newer version: 2.45.0
// Copyright 2020 Google LLC
//
// 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.api.generator.gapic.protoparser;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import com.google.protobuf.compiler.PluginProtos.CodeGeneratorRequest;
import java.util.Arrays;
import java.util.Optional;

// Parses the arguments from the protoc plugin.
public class PluginArgumentParser {
  private static final String COMMA = ",";
  private static final String EQUALS = "=";

  // Synced to rules_java_gapic/java_gapic.bzl.
  @VisibleForTesting static final String KEY_GRPC_SERVICE_CONFIG = "grpc-service-config";
  @VisibleForTesting static final String KEY_GAPIC_CONFIG = "gapic-config";
  @VisibleForTesting static final String KEY_METADATA = "metadata";
  @VisibleForTesting static final String KEY_NUMERIC_ENUM = "rest-numeric-enums";
  @VisibleForTesting static final String KEY_SERVICE_YAML_CONFIG = "api-service-config";
  @VisibleForTesting static final String KEY_TRANSPORT = "transport";

  private static final String JSON_FILE_ENDING = "grpc_service_config.json";
  private static final String GAPIC_YAML_FILE_ENDING = "gapic.yaml";
  private static final String SERVICE_YAML_FILE_ENDING = ".yaml";

  static Optional parseJsonConfigPath(CodeGeneratorRequest request) {
    return parseJsonConfigPath(request.getParameter());
  }

  static Optional parseGapicYamlConfigPath(CodeGeneratorRequest request) {
    return parseGapicYamlConfigPath(request.getParameter());
  }

  static Optional parseServiceYamlConfigPath(CodeGeneratorRequest request) {
    return parseServiceYamlConfigPath(request.getParameter());
  }

  static Optional parseTransport(CodeGeneratorRequest request) {
    return parseConfigArgument(request.getParameter(), KEY_TRANSPORT);
  }

  static boolean hasMetadataFlag(CodeGeneratorRequest request) {
    return hasFlag(request.getParameter(), KEY_METADATA);
  }

  static boolean hasNumericEnumFlag(CodeGeneratorRequest request) {
    return hasFlag(request.getParameter(), KEY_NUMERIC_ENUM);
  }

  /** Expects a comma-separated list of file paths. */
  @VisibleForTesting
  static Optional parseJsonConfigPath(String pluginProtocArgument) {
    return parseFileArgument(pluginProtocArgument, KEY_GRPC_SERVICE_CONFIG, JSON_FILE_ENDING);
  }

  @VisibleForTesting
  static Optional parseGapicYamlConfigPath(String pluginProtocArgument) {
    return parseFileArgument(pluginProtocArgument, KEY_GAPIC_CONFIG, GAPIC_YAML_FILE_ENDING);
  }

  @VisibleForTesting
  static Optional parseServiceYamlConfigPath(String pluginProtocArgument) {
    return parseFileArgument(
        pluginProtocArgument, KEY_SERVICE_YAML_CONFIG, SERVICE_YAML_FILE_ENDING);
  }

  @VisibleForTesting
  private static Optional parseConfigArgument(String pluginProtocArgument, String key) {
    if (Strings.isNullOrEmpty(pluginProtocArgument)) {
      return Optional.empty();
    }

    for (String argComponent : pluginProtocArgument.split(COMMA)) {
      String[] args = argComponent.trim().split(EQUALS);
      if (args.length == 2 && key.equals(args[0])) {
        return Optional.of(args[1]);
      }
    }
    return Optional.empty();
  }

  @VisibleForTesting
  static boolean hasFlag(String pluginProtocArgument, String flagKey) {
    return Arrays.stream(pluginProtocArgument.split(COMMA)).anyMatch(s -> s.equals(flagKey));
  }

  private static Optional parseFileArgument(
      String pluginProtocArgument, String key, String fileEnding) {
    if (Strings.isNullOrEmpty(pluginProtocArgument)) {
      return Optional.empty();
    }
    for (String argComponent : pluginProtocArgument.split(COMMA)) {
      String[] args = argComponent.trim().split(EQUALS);
      if (args.length < 2) {
        continue;
      }
      String keyVal = args[0];
      String valueVal = args[1];
      boolean valueMeetsCriteria = keyVal.equals(key) && valueVal.endsWith(fileEnding);
      if (fileEnding.equals(SERVICE_YAML_FILE_ENDING)) {
        valueMeetsCriteria &= !valueVal.endsWith(GAPIC_YAML_FILE_ENDING);
      }

      if (valueMeetsCriteria) {
        return Optional.of(valueVal);
      }
    }
    return Optional.empty();
  }
}