All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.api.generator.gapic.composer.Composer Maven / Gradle / Ivy

There is a newer version: 2.45.0
Show newest version
// 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.composer;

import com.google.api.generator.engine.ast.ClassDefinition;
import com.google.api.generator.engine.ast.CommentStatement;
import com.google.api.generator.gapic.composer.comment.CommentComposer;
import com.google.api.generator.gapic.composer.grpc.GrpcServiceCallableFactoryClassComposer;
import com.google.api.generator.gapic.composer.grpc.GrpcServiceStubClassComposer;
import com.google.api.generator.gapic.composer.grpc.MockServiceClassComposer;
import com.google.api.generator.gapic.composer.grpc.MockServiceImplClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceClientClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceClientTestClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceSettingsClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceStubClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceStubSettingsClassComposer;
import com.google.api.generator.gapic.composer.grpcrest.HttpJsonServiceClientTestClassComposer;
import com.google.api.generator.gapic.composer.resourcename.ResourceNameHelperClassComposer;
import com.google.api.generator.gapic.composer.rest.HttpJsonServiceCallableFactoryClassComposer;
import com.google.api.generator.gapic.composer.rest.HttpJsonServiceStubClassComposer;
import com.google.api.generator.gapic.model.GapicClass;
import com.google.api.generator.gapic.model.GapicContext;
import com.google.api.generator.gapic.model.GapicPackageInfo;
import com.google.api.generator.gapic.model.ReflectConfig;
import com.google.api.generator.gapic.model.Sample;
import com.google.api.generator.gapic.model.Service;
import com.google.api.generator.gapic.model.Transport;
import com.google.common.annotations.VisibleForTesting;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

public class Composer {
  public static List composeServiceClasses(GapicContext context) {
    List clazzes = new ArrayList<>();
    clazzes.addAll(generateServiceClasses(context));
    clazzes.addAll(generateMockClasses(context, context.mixinServices()));
    clazzes.addAll(generateResourceNameHelperClasses(context));
    return addApacheLicense(prepareExecutableSamples(clazzes));
  }

  public static GapicPackageInfo composePackageInfo(GapicContext context) {
    if (!context.containsServices()) {
      return null;
    }
    return addApacheLicense(ClientLibraryPackageInfoComposer.generatePackageInfo(context));
  }

  public static List composeNativeReflectConfig(GapicContext context) {
    return ClientLibraryReflectConfigComposer.generateReflectConfig(context);
  }

  public static List generateServiceClasses(GapicContext context) {
    List clazzes = new ArrayList<>();
    clazzes.addAll(generateStubClasses(context));
    clazzes.addAll(generateClientSettingsClasses(context));
    clazzes.addAll(generateMockClasses(context, context.services()));
    clazzes.addAll(generateTestClasses(context));
    return clazzes;
  }

  public static List generateResourceNameHelperClasses(GapicContext context) {
    return context.helperResourceNames().values().stream()
        .distinct()
        .filter(r -> !r.isOnlyWildcard())
        .map(r -> ResourceNameHelperClassComposer.instance().generate(r, context))
        .collect(Collectors.toList());
  }

  public static List generateStubClasses(GapicContext context) {
    List clazzes = new ArrayList<>();
    context
        .services()
        .forEach(
            s -> {
              if (context.transport() == Transport.REST) {
                clazzes.add(
                    com.google.api.generator.gapic.composer.rest.ServiceStubClassComposer.instance()
                        .generate(context, s));
                clazzes.add(
                    com.google.api.generator.gapic.composer.rest.ServiceStubSettingsClassComposer
                        .instance()
                        .generate(context, s));
                clazzes.add(
                    HttpJsonServiceCallableFactoryClassComposer.instance().generate(context, s));
                clazzes.add(HttpJsonServiceStubClassComposer.instance().generate(context, s));
              } else if (context.transport() == Transport.GRPC) {
                clazzes.add(ServiceStubClassComposer.instance().generate(context, s));
                clazzes.add(ServiceStubSettingsClassComposer.instance().generate(context, s));
                clazzes.add(
                    GrpcServiceCallableFactoryClassComposer.instance().generate(context, s));
                clazzes.add(GrpcServiceStubClassComposer.instance().generate(context, s));
              } else if (context.transport() == Transport.GRPC_REST) {
                clazzes.add(
                    com.google.api.generator.gapic.composer.grpcrest.ServiceStubClassComposer
                        .instance()
                        .generate(context, s));
                clazzes.add(
                    com.google.api.generator.gapic.composer.grpcrest
                        .ServiceStubSettingsClassComposer.instance()
                        .generate(context, s));
                clazzes.add(
                    GrpcServiceCallableFactoryClassComposer.instance().generate(context, s));
                clazzes.add(GrpcServiceStubClassComposer.instance().generate(context, s));
                clazzes.add(
                    HttpJsonServiceCallableFactoryClassComposer.instance().generate(context, s));
                clazzes.add(
                    com.google.api.generator.gapic.composer.grpcrest
                        .HttpJsonServiceStubClassComposer.instance()
                        .generate(context, s));
              }
            });
    return clazzes;
  }

  public static List generateClientSettingsClasses(GapicContext context) {
    List clazzes = new ArrayList<>();
    context
        .services()
        .forEach(
            s -> {
              if (context.transport() == Transport.REST) {
                clazzes.add(
                    com.google.api.generator.gapic.composer.rest.ServiceClientClassComposer
                        .instance()
                        .generate(context, s));
                clazzes.add(
                    com.google.api.generator.gapic.composer.rest.ServiceSettingsClassComposer
                        .instance()
                        .generate(context, s));
              } else if (context.transport() == Transport.GRPC) {
                clazzes.add(ServiceClientClassComposer.instance().generate(context, s));
                clazzes.add(ServiceSettingsClassComposer.instance().generate(context, s));
              } else if (context.transport() == Transport.GRPC_REST) {
                clazzes.add(
                    com.google.api.generator.gapic.composer.grpcrest.ServiceClientClassComposer
                        .instance()
                        .generate(context, s));
                clazzes.add(
                    com.google.api.generator.gapic.composer.grpcrest.ServiceSettingsClassComposer
                        .instance()
                        .generate(context, s));
              }
            });
    return clazzes;
  }

  public static List generateMockClasses(GapicContext context, List services) {
    List clazzes = new ArrayList<>();
    services.forEach(
        s -> {
          if (context.transport() == Transport.REST) {
            // REST transport tests do not use mock services.
          } else if (context.transport() == Transport.GRPC) {
            clazzes.add(MockServiceClassComposer.instance().generate(context, s));
            clazzes.add(MockServiceImplClassComposer.instance().generate(context, s));
          } else if (context.transport() == Transport.GRPC_REST) {
            clazzes.add(MockServiceClassComposer.instance().generate(context, s));
            clazzes.add(MockServiceImplClassComposer.instance().generate(context, s));
          }
        });
    return clazzes;
  }

  public static List generateTestClasses(GapicContext context) {
    List clazzes = new ArrayList<>();
    context
        .services()
        .forEach(
            s -> {
              if (context.transport() == Transport.REST) {
                clazzes.add(
                    com.google.api.generator.gapic.composer.rest.ServiceClientTestClassComposer
                        .instance()
                        .generate(context, s));
              } else if (context.transport() == Transport.GRPC) {
                clazzes.add(ServiceClientTestClassComposer.instance().generate(context, s));
              } else if (context.transport() == Transport.GRPC_REST) {
                clazzes.add(ServiceClientTestClassComposer.instance().generate(context, s));
                clazzes.add(HttpJsonServiceClientTestClassComposer.instance().generate(context, s));
              }
            });

    return clazzes;
  }

  @VisibleForTesting
  static List prepareExecutableSamples(List clazzes) {
    // Include license header, apiShortName, and apiVersion
    List clazzesWithSamples = new ArrayList<>();
    clazzes.forEach(
        gapicClass -> {
          List samples = new ArrayList<>();
          gapicClass
              .samples()
              .forEach(
                  sample ->
                      samples.add(
                          addRegionTagAndHeaderToSample(
                              sample, gapicClass.apiShortName(), gapicClass.packageVersion())));
          clazzesWithSamples.add(gapicClass.withSamples(samples));
        });
    return clazzesWithSamples;
  }

  @VisibleForTesting
  protected static Sample addRegionTagAndHeaderToSample(
      Sample sample, String apiShortName, String apiVersion) {
    final List header = Arrays.asList(CommentComposer.APACHE_LICENSE_COMMENT);
    return sample
        .withHeader(header)
        .withRegionTag(
            sample.regionTag().withApiVersion(apiVersion).withApiShortName(apiShortName));
  }

  @VisibleForTesting
  protected static List addApacheLicense(List gapicClassList) {
    return gapicClassList.stream()
        .map(
            gapicClass -> {
              ClassDefinition classWithHeader =
                  gapicClass
                      .classDefinition()
                      .toBuilder()
                      .setFileHeader(CommentComposer.APACHE_LICENSE_COMMENT)
                      .build();
              return GapicClass.create(gapicClass.kind(), classWithHeader, gapicClass.samples());
            })
        .collect(Collectors.toList());
  }

  private static GapicPackageInfo addApacheLicense(GapicPackageInfo gapicPackageInfo) {
    return GapicPackageInfo.with(
        gapicPackageInfo
            .packageInfo()
            .toBuilder()
            .setFileHeader(CommentComposer.APACHE_LICENSE_COMMENT)
            .build());
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy