feat: generate with artifact_name

Author: diegomarquezp

hermetic_build/library_generation/generate_composed_library.py

@@ -44,7 +44,7 @@
 def generate_composed_library(
     config: GenerationConfig,
     library_path: str,
-    library: LibraryConfig,
+    library_config: LibraryConfig,
     repo_config: RepoConfig,
 ) -> None:
     """
@@ -53,15 +53,15 @@ def generate_composed_library(
     :param config: a GenerationConfig object representing a parsed configuration
     yaml
     :param library_path: the path to which the generated file goes
-    :param library: a LibraryConfig object contained inside config, passed here
+    :param library_config: a LibraryConfig object contained inside config, passed here
     for convenience and to prevent all libraries to be processed
     :param repo_config:
     :return None
     """
     output_folder = repo_config.output_folder
     owlbot_cli_source_folder = util.sh_util("mktemp -d")
     os.makedirs(f"{library_path}", exist_ok=True)
-    for gapic in library.get_sorted_gapic_configs():
+    for gapic in library_config.get_sorted_gapic_configs():
         build_file_folder = Path(f"{output_folder}/{gapic.proto_path}").resolve()
         print(f"build_file_folder: {build_file_folder}")
         gapic_inputs = parse_build_file(build_file_folder, gapic.proto_path)
@@ -73,16 +73,17 @@ def generate_composed_library(
         # generating postprocessing files such as README.
         util.generate_postprocessing_prerequisite_files(
             config=config,
-            library=library,
+            library=library_config,
             proto_path=util.remove_version_from(gapic.proto_path),
             library_path=library_path,
-            transport=library.get_transport(gapic_inputs),
+            transport=library_config.get_transport(gapic_inputs),
         )
         temp_destination_path = f"java-{gapic.proto_path.replace('/','-')}"
-        effective_arguments = __construct_effective_arg(
+        effective_arguments = __construct_effective_args(
             base_arguments=[],
             gapic=gapic,
             gapic_inputs=gapic_inputs,
+            library_config=library_config,
             temp_destination_path=temp_destination_path,
         )
         print("arguments: ")
@@ -101,7 +102,7 @@ def generate_composed_library(
         )
 
     library_version = repo_config.get_library_version(
-        artifact_id=library.get_artifact_id()
+        artifact_id=library_config.get_artifact_id()
     )
     # call postprocess library
     util.run_process_and_print_output(
@@ -119,10 +120,11 @@ def generate_composed_library(
     )
 
 
-def __construct_effective_arg(
+def __construct_effective_args(
     base_arguments: List[str],
     gapic: GapicConfig,
     gapic_inputs: GapicInputs,
+    library_config: LibraryConfig,
     temp_destination_path: str,
 ) -> List[str]:
     """
@@ -153,6 +155,8 @@ def __construct_effective_arg(
         gapic_inputs.service_yaml,
         "--include_samples",
         gapic_inputs.include_samples,
+        "--artifact_name",
+        library_config.get_maven_coordinate(),
     ]
     arguments += ["--destination_path", temp_destination_path]
 

hermetic_build/library_generation/generate_library.sh

@@ -49,6 +49,9 @@ case $key in
   --os_architecture)
     os_architecture="$2"
     shift
+  --artifact_name)
+    artifact_name="$2"
+    shift
     ;;
   *)
     echo "Invalid option: [$1]"
@@ -179,7 +182,7 @@ if [[ "${proto_only}" == "false" ]]; then
   "$protoc_path"/protoc --experimental_allow_proto3_optional \
   "--plugin=protoc-gen-java_gapic=${script_dir}/gapic-generator-java-wrapper" \
   "--java_gapic_out=metadata:${temp_destination_path}/java_gapic_srcjar_raw.srcjar.zip" \
-  "--java_gapic_opt=$(get_gapic_opts "${transport}" "${rest_numeric_enums}" "${gapic_yaml}" "${service_config}" "${service_yaml}")" \
+  "--java_gapic_opt=$(get_gapic_opts "${transport}" "${rest_numeric_enums}" "${gapic_yaml}" "${service_config}" "${service_yaml}" "${artifact_name}")" \
   ${proto_files} ${gapic_additional_protos}
 
   unzip -o -q "${temp_destination_path}/java_gapic_srcjar_raw.srcjar.zip" -d "${temp_destination_path}"

hermetic_build/library_generation/generate_repo.py

@@ -62,7 +62,7 @@ def generate_from_yaml(
         generate_composed_library(
             config=config,
             library_path=library_path,
-            library=library,
+            library_config=library,
             repo_config=repo_config,
         )
 

hermetic_build/library_generation/tests/generate_library_unit_tests.sh

@@ -56,6 +56,18 @@ get_gapic_opts_with_non_default_test() {
   "$gapic_opts"
 }
 
+get_gapic_opts_with_artifact_name_test() {
+  local proto_path="${script_dir}/resources/gapic_options"
+  local transport="grpc"
+  local rest_numeric_enums="false"
+  local artifact_name="com.google.cloud:google-cloud-library"
+  local gapic_opts
+  gapic_opts="$(get_gapic_opts "${transport}" "${rest_numeric_enums}" "" "" "" "${artifact_name}")"
+  assertEquals \
+  "transport=grpc,,grpc-service-config=${proto_path}/example_grpc_service_config.json,gapic-config=${proto_path}/example_gapic.yaml,api-service-config=${proto_path}/example.yaml,artifact-name=${artifact_name}" \
+  "$gapic_opts"
+}
+
 remove_grpc_version_test() {
   local destination_path="${script_dir}/resources/gapic_options"
   cp "${destination_path}/QueryServiceGrpc_copy.java" "${destination_path}/QueryServiceGrpc.java"
@@ -214,6 +226,7 @@ test_list=(
   get_gapic_opts_with_rest_test
   get_gapic_opts_without_rest_test
   get_gapic_opts_with_non_default_test
+  get_gapic_opts_with_artifact_name_test
   remove_grpc_version_test
   download_protoc_succeed_with_valid_version_linux_test
   download_protoc_succeed_with_valid_version_macos_test

hermetic_build/library_generation/utils/utilities.sh

@@ -70,6 +70,7 @@ get_gapic_opts() {
   local gapic_yaml=$3
   local service_config=$4
   local service_yaml=$5
+  local artifact_name=$6
   if [ "${rest_numeric_enums}" == "true" ]; then
     rest_numeric_enums="rest-numeric-enums"
   else
@@ -88,7 +89,10 @@ get_gapic_opts() {
   if [[ "${service_yaml}" == "" ]]; then
     service_yaml=$(find "${proto_path}" -maxdepth 1 -type f \( -name "*.yaml" ! -name "*gapic*.yaml" \))
   fi
-  echo "transport=${transport},${rest_numeric_enums},grpc-service-config=${service_config},gapic-config=${gapic_yaml},api-service-config=${service_yaml}"
+  if [[ -n "${artifact_name}" ]]; then
+    artifact_name_opt=",artifact-name=${artifact_name}"
+  fi
+  echo "transport=${transport},${rest_numeric_enums},grpc-service-config=${service_config},gapic-config=${gapic_yaml},api-service-config=${service_yaml}${artifact_name_opt}"
 }
 
 remove_grpc_version() {