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

Go to download
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.50.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.api.ResourceDescriptor;
import com.google.api.ResourceProto;
import com.google.api.generator.engine.ast.TypeNode;
import com.google.api.generator.gapic.model.ResourceName;
import com.google.api.generator.gapic.utils.ResourceNameConstants;
import com.google.api.pathtemplate.PathTemplate;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.protobuf.DescriptorProtos.FieldOptions;
import com.google.protobuf.DescriptorProtos.FileOptions;
import com.google.protobuf.DescriptorProtos.MessageOptions;
import com.google.protobuf.Descriptors.Descriptor;
import com.google.protobuf.Descriptors.FieldDescriptor;
import com.google.protobuf.Descriptors.FileDescriptor;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

public class ResourceNameParser {
  /** Returns a map of resource types (strings) to ResourceName POJOs. */
  public static Map parseResourceNames(
      FileDescriptor fileDescriptor, String javaPackage) {
    Map resourceNames =
        parseResourceNamesFromFile(fileDescriptor, javaPackage);
    String pakkage = fileDescriptor.getOptions().getJavaPackage();
    if (Strings.isNullOrEmpty(pakkage)) {
      pakkage = javaPackage;
    }
    resourceNames.putAll(parseResourceNamesFromMessages(fileDescriptor.getMessageTypes(), pakkage));
    return resourceNames;
  }

  // Convenience wrapper for uni tests. DO NOT ADD ANY NEW FUNCTIONALITY HERE.
  @VisibleForTesting
  public static Map parseResourceNames(FileDescriptor fileDescriptor) {
    String pakkage = TypeParser.getPackage(fileDescriptor);
    return parseResourceNames(fileDescriptor, pakkage);
  }

  // Convenience wrapper for uni tests. DO NOT ADD ANY NEW FUNCTIONALITY HERE.
  @VisibleForTesting
  static Map parseResourceNamesFromFile(FileDescriptor fileDescriptor) {
    String pakkage = TypeParser.getPackage(fileDescriptor);
    return parseResourceNamesFromFile(fileDescriptor, pakkage);
  }

  @VisibleForTesting
  static Map parseResourceNamesFromFile(
      FileDescriptor fileDescriptor, String javaPackage) {
    Map typeStringToResourceNames = new HashMap<>();
    FileOptions fileOptions = fileDescriptor.getOptions();
    if (fileOptions.getExtensionCount(ResourceProto.resourceDefinition) <= 0) {
      return typeStringToResourceNames;
    }
    List protoResources =
        fileOptions.getExtension(ResourceProto.resourceDefinition);
    for (ResourceDescriptor protoResource : protoResources) {
      Optional resourceNameModelOpt = createResourceName(protoResource, javaPackage);
      if (!resourceNameModelOpt.isPresent()) {
        continue;
      }
      ResourceName resourceNameModel = resourceNameModelOpt.get();
      // Clobber anything if we're creating a new ResourceName from a proto.
      typeStringToResourceNames.put(resourceNameModel.resourceTypeString(), resourceNameModel);
    }
    return typeStringToResourceNames;
  }

  @VisibleForTesting
  static Map parseResourceNamesFromMessages(
      List messageTypeDescriptors, String pakkage) {
    Map resourceNames = new HashMap<>();
    for (Descriptor messageTypeDescriptor : messageTypeDescriptors) {
      Optional resourceNameModelOpt =
          parseResourceNameFromMessageType(messageTypeDescriptor, pakkage);
      if (resourceNameModelOpt.isPresent()) {
        ResourceName resourceName = resourceNameModelOpt.get();
        resourceNames.put(resourceName.resourceTypeString(), resourceName);
      }
    }
    return resourceNames;
  }

  @VisibleForTesting
  static Optional parseResourceNameFromMessageType(
      Descriptor messageTypeDescriptor, String pakkage) {
    MessageOptions messageOptions = messageTypeDescriptor.getOptions();
    if (!messageOptions.hasExtension(ResourceProto.resource)) {
      return Optional.empty();
    }

    ResourceDescriptor protoResource = messageOptions.getExtension(ResourceProto.resource);
    // Validation - check that a resource name field is present.
    if (Strings.isNullOrEmpty(protoResource.getNameField())) {
      // aip.dev/4231
      boolean resourceNameFieldFound =
          messageTypeDescriptor.findFieldByName(ResourceNameConstants.NAME_FIELD_NAME) != null;
      // If this is null, look for a field with a resource reference is found.
      // Example: AccountBudgetProposal.
      for (FieldDescriptor fieldDescriptor : messageTypeDescriptor.getFields()) {
        FieldOptions fieldOptions = fieldDescriptor.getOptions();
        if (fieldOptions.hasExtension(ResourceProto.resourceReference)) {
          resourceNameFieldFound = true;
          break;
        }
      }
      Preconditions.checkState(
          resourceNameFieldFound,
          String.format(
              "Message %s has a resource annotation but no field titled \"name\" or containing a"
                  + " resource reference",
              messageTypeDescriptor.getName()));
    }

    TypeNode javaMessageType = TypeParser.parseType(messageTypeDescriptor);
    return createResourceName(protoResource, pakkage, javaMessageType.reference().fullName());
  }

  private static Optional createResourceName(
      ResourceDescriptor protoResource, String pakkage) {
    return createResourceName(protoResource, pakkage, null);
  }

  private static Optional createResourceName(
      ResourceDescriptor protoResource, String pakkage, String parentMessageName) {
    // We may need to modify this list.
    List patterns = new ArrayList<>(protoResource.getPatternList());
    Preconditions.checkState(
        !patterns.isEmpty(),
        String.format(
            "Resource name definition for %s must have at least one pattern",
            protoResource.getType()));

    if (patterns.size() == 1 && patterns.get(0).equals(ResourceNameConstants.WILDCARD_PATTERN)) {
      return Optional.of(ResourceName.createWildcard(protoResource.getType(), pakkage));
    }

    // Assuming that both patterns end with the same variable name.
    Optional resourceVariableNameOpt = Optional.empty();
    for (int i = 0; i < patterns.size(); i++) {
      resourceVariableNameOpt = getVariableNameFromPattern(patterns.get(i));
      if (resourceVariableNameOpt.isPresent()) {
        break;
      }
    }
    Preconditions.checkState(
        resourceVariableNameOpt.isPresent(),
        String.format("Resource variable name not found in patterns %s", patterns));

    if (patterns.contains(ResourceNameConstants.WILDCARD_PATTERN)) {
      patterns.remove(ResourceNameConstants.WILDCARD_PATTERN);
    }

    return Optional.of(
        ResourceName.builder()
            .setVariableName(resourceVariableNameOpt.get())
            .setPakkage(pakkage)
            .setResourceTypeString(protoResource.getType())
            .setPatterns(patterns)
            .setParentMessageName(parentMessageName)
            .build());
  }

  @VisibleForTesting
  static Optional getVariableNameFromPattern(String pattern) {
    // Expected to be small (e.g. less than 10) most of the time.
    String resourceVariableName = null;
    String[] tokens = pattern.split("/");
    String lastToken = tokens[tokens.length - 1];
    if (lastToken.equals(ResourceNameConstants.DELETED_TOPIC_LITERAL)) {
      resourceVariableName = lastToken;
    } else if (lastToken.equals(ResourceNameConstants.WILDCARD_PATTERN)) {
      resourceVariableName = null;
    } else {
      // Allow singleton patterns like projects/{project}/cmekSettings.
      if (!lastToken.contains("{")) {
        resourceVariableName = lastToken;
      } else {
        Set variableNames = PathTemplate.create(pattern).vars();
        for (String variableName : variableNames) {
          if (lastToken.contains(variableName)) {
            resourceVariableName = variableName;
            break;
          }
        }
      }
    }
    return Strings.isNullOrEmpty(resourceVariableName)
        ? Optional.empty()
        : Optional.of(resourceVariableName);
  }
}