From bcd75a08e366e8739718fca09528e08bc2b94dfc Mon Sep 17 00:00:00 2001
From: Jeff Ching <chingor@google.com>
Date: Mon, 16 Mar 2020 15:17:22 -0700
Subject: [PATCH] feat(java_templates): add sample pom files (#430)

Co-authored-by: Justin Beckwith <justin.beckwith@gmail.com>
---
 .../samples/install-without-bom/pom.xml       | 51 +++++++++++
 .../templates/java_library/samples/pom.xml    | 56 +++++++++++++
 .../java_library/samples/snapshot/pom.xml     | 84 +++++++++++++++++++
 .../java_library/samples/snippets/pom.xml     | 62 ++++++++++++++
 synthtool/languages/java.py                   | 15 +++-
 5 files changed, 267 insertions(+), 1 deletion(-)
 create mode 100644 synthtool/gcp/templates/java_library/samples/install-without-bom/pom.xml
 create mode 100644 synthtool/gcp/templates/java_library/samples/pom.xml
 create mode 100644 synthtool/gcp/templates/java_library/samples/snapshot/pom.xml
 create mode 100644 synthtool/gcp/templates/java_library/samples/snippets/pom.xml

diff --git a/synthtool/gcp/templates/java_library/samples/install-without-bom/pom.xml b/synthtool/gcp/templates/java_library/samples/install-without-bom/pom.xml
new file mode 100644
index 000000000..35ddcc4cb
--- /dev/null
+++ b/synthtool/gcp/templates/java_library/samples/install-without-bom/pom.xml
@@ -0,0 +1,51 @@
+{% set group_id = metadata['repo']['distribution_name'].split(':')|first -%}
+{% set artifact_id = metadata['repo']['distribution_name'].split(':')|last -%}
+<?xml version='1.0' encoding='UTF-8'?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.google.cloud</groupId>
+  <artifactId>{{metadata['repo']['name']}}-snapshot</artifactId>
+  <packaging>jar</packaging>
+  <name>Google {{metadata['repo']['name_pretty']}} Install Without Bom</name>
+  <url>https://github.com/{{metadata['repo']['repo']}}</url>
+
+  <!--
+    The parent pom defines common style checks and testing strategies for our samples.
+    Removing or replacing it should not affect the execution of the samples in anyway.
+  -->
+  <parent>
+    <groupId>com.google.cloud.samples</groupId>
+    <artifactId>shared-configuration</artifactId>
+    <version>1.0.12</version>
+  </parent>
+
+  <properties>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+
+  <dependencies>
+    <!-- [START {{metadata['repo']['name']}}_install_without_bom] -->
+    <dependency>
+      <groupId>{{ group_id }}</groupId>
+      <artifactId>{{ artifact_id }}</artifactId>
+      <version>{{ metadata['latest_version'] }}</version>
+    </dependency>
+    <!-- [END {{metadata['repo']['name']}}_install_with_bom] -->
+
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.13</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.truth</groupId>
+      <artifactId>truth</artifactId>
+      <version>1.0.1</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>
diff --git a/synthtool/gcp/templates/java_library/samples/pom.xml b/synthtool/gcp/templates/java_library/samples/pom.xml
new file mode 100644
index 000000000..b2443d2ca
--- /dev/null
+++ b/synthtool/gcp/templates/java_library/samples/pom.xml
@@ -0,0 +1,56 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.google.cloud</groupId>
+  <artifactId>google-cloud-{{metadata['repo']['name']}}-samples</artifactId>
+  <version>0.0.1-SNAPSHOT</version><!-- This artifact should not be released -->
+  <packaging>pom</packaging>
+  <name>Google {{metadata['repo']['name_pretty']}} Samples Parent</name>
+  <url>https://github.com/{{metadata['repo']['repo']}}</url>
+  <description>
+    Java idiomatic client for Google Cloud Platform services.
+  </description>
+
+  <!--
+    The parent pom defines common style checks and testing strategies for our samples.
+    Removing or replacing it should not affect the execution of the samples in anyway.
+  -->
+  <parent>
+    <groupId>com.google.cloud.samples</groupId>
+    <artifactId>shared-configuration</artifactId>
+    <version>1.0.12</version>
+  </parent>
+
+  <properties>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <modules>
+    <module>install-without-bom</module>
+    <module>snapshot</module>
+    <module>snippets</module>
+  </modules>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-deploy-plugin</artifactId>
+        <version>2.8.2</version>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.sonatype.plugins</groupId>
+        <artifactId>nexus-staging-maven-plugin</artifactId>
+        <version>1.6.8</version>
+        <configuration>
+          <skipNexusStagingDeployMojo>true</skipNexusStagingDeployMojo>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project> 
diff --git a/synthtool/gcp/templates/java_library/samples/snapshot/pom.xml b/synthtool/gcp/templates/java_library/samples/snapshot/pom.xml
new file mode 100644
index 000000000..cd443205a
--- /dev/null
+++ b/synthtool/gcp/templates/java_library/samples/snapshot/pom.xml
@@ -0,0 +1,84 @@
+{% set group_id = metadata['repo']['distribution_name'].split(':')|first -%}
+{% set artifact_id = metadata['repo']['distribution_name'].split(':')|last -%}
+<?xml version='1.0' encoding='UTF-8'?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.google.cloud</groupId>
+  <artifactId>{{metadata['repo']['name']}}-snapshot</artifactId>
+  <packaging>jar</packaging>
+  <name>Google {{metadata['repo']['name_pretty']}} Snapshot Samples</name>
+  <url>https://github.com/{{metadata['repo']['repo']}}</url>
+
+  <!--
+    The parent pom defines common style checks and testing strategies for our samples.
+    Removing or replacing it should not affect the execution of the samples in anyway.
+  -->
+  <parent>
+    <groupId>com.google.cloud.samples</groupId>
+    <artifactId>shared-configuration</artifactId>
+    <version>1.0.12</version>
+  </parent>
+
+  <properties>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <!-- {x-version-update-start:{{ artifactId }}:current} -->
+  <dependencies>
+    <dependency>
+      <groupId>{{ group_id }}</groupId>
+      <artifactId>{{ artifact_id }}</artifactId>
+      <version>{{ metadata['latest_version'] }}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.13</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.truth</groupId>
+      <artifactId>truth</artifactId>
+      <version>1.0.1</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+  <!-- {x-version-update-end} -->
+
+  <!-- compile and run all snippet tests -->
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>add-snippets-source</id>
+            <goals>
+              <goal>add-source</goal>
+            </goals>
+            <configuration>
+              <sources>
+                <source>../snippets/src/main/java</source>
+              </sources>
+            </configuration>
+          </execution>
+          <execution>
+            <id>add-snippets-tests</id>
+            <goals>
+              <goal>add-test-source</goal>
+            </goals>
+            <configuration>
+              <sources>
+                <source>../snippets/src/test/java</source>
+              </sources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>
\ No newline at end of file
diff --git a/synthtool/gcp/templates/java_library/samples/snippets/pom.xml b/synthtool/gcp/templates/java_library/samples/snippets/pom.xml
new file mode 100644
index 000000000..1c14e6ff3
--- /dev/null
+++ b/synthtool/gcp/templates/java_library/samples/snippets/pom.xml
@@ -0,0 +1,62 @@
+{% set group_id = metadata['repo']['distribution_name'].split(':')|first -%}
+{% set artifact_id = metadata['repo']['distribution_name'].split(':')|last -%}
+<?xml version='1.0' encoding='UTF-8'?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.google.cloud</groupId>
+  <artifactId>{{metadata['repo']['name']}}-snippets</artifactId>
+  <packaging>jar</packaging>
+  <name>Google {{metadata['repo']['name_pretty']}} Snippets</name>
+  <url>https://github.com/{{metadata['repo']['repo']}}</url>
+
+  <!--
+    The parent pom defines common style checks and testing strategies for our samples.
+    Removing or replacing it should not affect the execution of the samples in anyway.
+  -->
+  <parent>
+    <groupId>com.google.cloud.samples</groupId>
+    <artifactId>shared-configuration</artifactId>
+    <version>1.0.12</version>
+  </parent>
+
+  <properties>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+
+  <!-- [START {{metadata['repo']['name']}}_install_with_bom] -->
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>com.google.cloud</groupId>
+        <artifactId>libraries-bom</artifactId>
+        <version>{{ metadata['latest_bom_version'] }}</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
+  <dependencies>
+    <dependency>
+      <groupId>{{ group_id }}</groupId>
+      <artifactId>{{ artifact_id }}</artifactId>
+    </dependency>
+    <!-- [END {{metadata['repo']['name']}}_install_with_bom] -->
+
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.13</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.truth</groupId>
+      <artifactId>truth</artifactId>
+      <version>1.0.1</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>
diff --git a/synthtool/languages/java.py b/synthtool/languages/java.py
index a55aa477a..dff873987 100644
--- a/synthtool/languages/java.py
+++ b/synthtool/languages/java.py
@@ -321,6 +321,19 @@ def bazel_library(
     return library
 
 
+def _merge_common_templates(
+    source_text: str, destination_text: str, file_path: Path
+) -> str:
+    log.debug(f"merge: {file_path}")
+    # keep any existing pom.xml
+    if file_path.match("pom.xml"):
+        log.info(f"existing pom file found ({file_path}) - keeping the existing")
+        return destination_text
+
+    # by default return the newly generated content
+    return source_text
+
+
 def common_templates(excludes: List[str] = [], **kwargs) -> None:
     """Generate common templates for a Java Library
 
@@ -353,4 +366,4 @@ def common_templates(excludes: List[str] = [], **kwargs) -> None:
 
     kwargs["metadata"] = metadata
     templates = gcp.CommonTemplates().java_library(**kwargs)
-    s.copy([templates], excludes=excludes)
+    s.copy([templates], excludes=excludes, merge=_merge_common_templates)