fix: make grpc deps common-protos and iam-v1 test-scoped

Author: diegomarquezp

library_generation/owlbot/src/fix_poms.py

@@ -92,7 +92,10 @@ def _is_cloud_client(existing_modules: List[module.Module]) -> bool:
 
 
 def update_cloud_pom(
-    filename: str, proto_modules: List[module.Module], grpc_modules: List[module.Module]
+    filename: str,
+    proto_modules: List[module.Module],
+    grpc_modules: List[module.Module],
+    repo_metadata: dict,
 ):
     tree = etree.parse(filename)
     root = tree.getroot()
@@ -104,6 +107,39 @@ def update_cloud_pom(
         if m.find("{http://maven.apache.org/POM/4.0.0}artifactId") is not None
     ]
 
+    # as of July 2024, we have two dependencies that should be declared as
+    # test-scoped: grpc-google-common-protos and grpc-google-iam-v1. Only in
+    # java-storage and java-spanner we keep them as they are
+    TEST_SCOPED_DEPENDENCIES = ["grpc-google-common-protos", "grpc-google-iam-v1"]
+    print(
+        'converting old dependencies "grpc-google-common-protos" and "grpc-google-iam-v1" to test-scoped'
+    )
+    for d in dependencies:
+        if repo_metadata["repo_short"] in ["java-spanner", "java-storage"]:
+            print(
+                f"skipping test-scoped-dependency fix for special case repo: {repo_metadata['repo_short']}"
+            )
+            continue
+        artifact_query = "{http://maven.apache.org/POM/4.0.0}artifactId"
+        scope_query = "{http://maven.apache.org/POM/4.0.0}scope"
+        current_scope = d.find(scope_query)
+        artifact_id_elem = d.find(artifact_query)
+        if artifact_id_elem is None:
+            continue
+        artifact_id = artifact_id_elem.text
+        is_test_scoped = (
+            current_scope.text == "test" if current_scope is not None else False
+        )
+        if artifact_id in TEST_SCOPED_DEPENDENCIES and not is_test_scoped:
+            new_scope = etree.Element(scope_query)
+            new_scope.text = "test"
+            if current_scope is not None:
+                d.replace(current_scope, new_scope)
+            else:
+                d.append(new_scope)
+            new_scope.tail = "\n    "
+            new_scope.getprevious().tail = "\n      "
+
     try:
         grpc_index = _find_dependency_index(
             dependencies, "com.google.api.grpc", "grpc-"
@@ -492,7 +528,9 @@ def main(versions_file, monorepo):
     if os.path.isfile(f"{artifact_id}/pom.xml"):
         print("updating modules in cloud pom.xml")
         if artifact_id not in excluded_poms_list:
-            update_cloud_pom(f"{artifact_id}/pom.xml", proto_modules, grpc_modules)
+            update_cloud_pom(
+                f"{artifact_id}/pom.xml", proto_modules, grpc_modules, repo_metadata
+            )
     elif artifact_id not in excluded_poms_list:
         print("creating missing cloud pom.xml")
         templates.render(

library_generation/owlbot/templates/poms/cloud_pom.xml.j2

@@ -39,10 +39,12 @@
       <groupId>com.google.protobuf</groupId>
       <artifactId>protobuf-java</artifactId>
     </dependency>
+{%- if repo in ['java-storage', 'java-spanner'] %}
     <dependency>
       <groupId>com.google.api.grpc</groupId>
       <artifactId>proto-google-common-protos</artifactId>
     </dependency>
+{%- endif %}
 {% for module in proto_modules %}
     <dependency>
       <groupId>{{module.group_id}}</groupId>
@@ -72,16 +74,30 @@
       <groupId>com.google.api.grpc</groupId>
       <artifactId>proto-google-iam-v1</artifactId>
     </dependency>
+{%- if repo not in ['java-storage', 'java-spanner'] %}
     <dependency>
       <groupId>com.google.api.grpc</groupId>
       <artifactId>grpc-google-iam-v1</artifactId>
     </dependency>
+{%- endif %}
     <dependency>
       <groupId>org.threeten</groupId>
       <artifactId>threetenbp</artifactId>
     </dependency>
 
     <!-- Test dependencies -->
+{%- if repo not in ['java-storage', 'java-spanner'] %}
+    <dependency>
+      <groupId>com.google.api.grpc</groupId>
+      <artifactId>proto-google-common-protos</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.api.grpc</groupId>
+      <artifactId>grpc-google-iam-v1</artifactId>
+      <scope>test</scope>
+    </dependency>
+{%- endif %}
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>