Add Data Catalog createEntry quickstart samples and tests. (#1731)

mesmacosta · tswast · commit 43764f812037 · 2019-12-10T14:22:25.000-08:00
* ADD sample for create fileset entry quickstart

* RAN google java format

* CHANGE exception comment

* FIX lint issues

* Split quickstart into a new folder

* Rename files since class name will appear on samples

* Ran java formatter

* revert region tags change

* remove extra space

* change to real bucket name
diff --git a/datacatalog/cloud-client/src/main/java/com/example/datacatalog/CreateFilesetEntry.java b/datacatalog/cloud-client/src/main/java/com/example/datacatalog/CreateFilesetEntry.java
@@ -54,7 +54,7 @@ public static void createEntry(String projectId, String entryGroupId, String ent
               .setDisplayName("My Fileset")
               .setDescription("This fileset consists of ....")
               .setGcsFilesetSpec(
-                  GcsFilesetSpec.newBuilder().addFilePatterns("gs://my_bucket/*").build())
+                  GcsFilesetSpec.newBuilder().addFilePatterns("gs://cloud-samples-data/*").build())
               .setSchema(
                   Schema.newBuilder()
                       .addColumns(
diff --git a/datacatalog/cloud-client/src/test/java/com/example/datacatalog/CreateEntryTests.java b/datacatalog/cloud-client/src/test/java/com/example/datacatalog/CreateEntryTests.java
@@ -17,12 +17,15 @@
 package com.example.datacatalog;
 
 import static org.junit.Assert.assertThat;
+import static org.junit.Assert.fail;
 
 import com.google.cloud.datacatalog.EntryGroupName;
 import com.google.cloud.datacatalog.EntryName;
 import com.google.cloud.datacatalog.v1beta1.DataCatalogClient;
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.UUID;
 import org.hamcrest.CoreMatchers;
 import org.junit.After;
@@ -38,15 +41,12 @@ public class CreateEntryTests {
 
   private ByteArrayOutputStream bout;
 
-  private static String ENTRY_GROUP_ID_NO_CHILDREN =
-      "entry_group_no_children_" + UUID.randomUUID().toString().substring(0, 8);
-  private static String PARENT_ENTRY_GROUP_ID =
-      "fileset_entry_group_parent_" + UUID.randomUUID().toString().substring(0, 8);
-  private static String ENTRY_ID =
-      "fileset_entry_id_" + UUID.randomUUID().toString().substring(0, 8);
   private static String LOCATION = "us-central1";
   private static String PROJECT_ID = System.getenv().get("GOOGLE_CLOUD_PROJECT");
 
+  private static List<String> entryGroupsPendingDeletion = new ArrayList<>();
+  private static List<String> entriesPendingDeletion = new ArrayList<>();
+
   @Before
   public void setUp() {
     bout = new ByteArrayOutputStream();
@@ -62,45 +62,67 @@ public void tearDown() {
   @AfterClass
   public static void tearDownClass() {
     try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
-      dataCatalogClient.deleteEntryGroup(
-          EntryGroupName.of(PROJECT_ID, LOCATION, ENTRY_GROUP_ID_NO_CHILDREN).toString());
-
-      dataCatalogClient.deleteEntry(
-          EntryName.of(PROJECT_ID, LOCATION, PARENT_ENTRY_GROUP_ID, ENTRY_ID).toString());
-      dataCatalogClient.deleteEntryGroup(
-          EntryGroupName.of(PROJECT_ID, LOCATION, PARENT_ENTRY_GROUP_ID).toString());
+      // Must delete Entries before deleting the Entry Group.
+      if (entriesPendingDeletion.isEmpty() || entryGroupsPendingDeletion.isEmpty()) {
+        fail("Something went wrong, no entries were generated");
+      }
+
+      for (String entryName : entriesPendingDeletion) {
+        dataCatalogClient.deleteEntry(entryName);
+      }
+
+      for (String entryGroupName : entryGroupsPendingDeletion) {
+        dataCatalogClient.deleteEntryGroup(entryGroupName);
+      }
     } catch (Exception e) {
       System.out.println("Error in cleaning up test data:\n" + e.toString());
     }
   }
 
   @Test
   public void testCreateFilesetEntry() {
+    String entryGroupId = "fileset_entry_group_parent_" + getUuid8Chars();
+    String entryId = "fileset_entry_id_" + getUuid8Chars();
+
     // Must create a Entry Group before creating the entry.
-    CreateEntryGroup.createEntryGroup(PROJECT_ID, PARENT_ENTRY_GROUP_ID);
-    CreateFilesetEntry.createEntry(PROJECT_ID, PARENT_ENTRY_GROUP_ID, ENTRY_ID);
+    CreateEntryGroup.createEntryGroup(PROJECT_ID, entryGroupId);
+    CreateFilesetEntry.createEntry(PROJECT_ID, entryGroupId, entryId);
+
+    // Store names for clean up on teardown
+    String expectedEntryGroupName =
+        EntryGroupName.of(PROJECT_ID, LOCATION, entryGroupId).toString();
+    entryGroupsPendingDeletion.add(expectedEntryGroupName);
+
+    String expectedEntryName = EntryName.of(PROJECT_ID, LOCATION, entryGroupId, entryId).toString();
+    entriesPendingDeletion.add(expectedEntryName);
 
     String output = bout.toString();
 
-    String entryTemplate =
-        "Entry created with name: projects/%s/locations/us-central1/entryGroups/%s/entries/%s";
+    String entryTemplate = "Entry created with name: %s";
     assertThat(
-        output,
-        CoreMatchers.containsString(
-            String.format(entryTemplate, PROJECT_ID, PARENT_ENTRY_GROUP_ID, ENTRY_ID)));
+        output, CoreMatchers.containsString(String.format(entryTemplate, expectedEntryName)));
   }
 
   @Test
   public void testCreateEntryGroup() {
-    CreateEntryGroup.createEntryGroup(PROJECT_ID, ENTRY_GROUP_ID_NO_CHILDREN);
+    String entryGroupId = "entry_group_no_children_" + getUuid8Chars();
+
+    CreateEntryGroup.createEntryGroup(PROJECT_ID, entryGroupId);
+
+    // Store names for clean up on teardown
+    String expectedEntryGroupName =
+        EntryGroupName.of(PROJECT_ID, LOCATION, entryGroupId).toString();
+    entryGroupsPendingDeletion.add(expectedEntryGroupName);
 
     String output = bout.toString();
 
-    String entryGroupTemplate =
-        "Entry Group created with name: projects/%s/locations/us-central1/entryGroups/%s";
+    String entryGroupTemplate = "Entry Group created with name: %s";
     assertThat(
         output,
-        CoreMatchers.containsString(
-            String.format(entryGroupTemplate, PROJECT_ID, ENTRY_GROUP_ID_NO_CHILDREN)));
+        CoreMatchers.containsString(String.format(entryGroupTemplate, expectedEntryGroupName)));
+  }
+
+  private String getUuid8Chars() {
+    return UUID.randomUUID().toString().substring(0, 8);
   }
-}
+}
diff --git a/datacatalog/quickstart/README.md b/datacatalog/quickstart/README.md
@@ -0,0 +1,31 @@
+# Getting Started with Data Catalog and the Google Cloud Client libraries
+
+<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=datacatalog/cloud-client/README.md">
+<img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a>
+
+[Data Catalog][datacatalog] is a fully managed and scalable metadata management service that empowers organizations
+to quickly discover, manage, and understand all their data in Google Cloud.
+This sample Java application demonstrates how to access the Data Catalog API using
+the [Google Cloud Client Library for Java][google-cloud-java].
+
+[datacatalog]: https://cloud.google.com/data-catalog/
+[google-cloud-java]: https://github.com/GoogleCloudPlatform/google-cloud-java
+
+## Quickstart
+
+#### Setup
+- Install [Maven](http://maven.apache.org/).
+- [Enable](https://console.cloud.google.com/apis/api/datacatalog.googleapis.com/overview) Data Catalog API.
+- Set up [authentication](https://cloud.google.com/docs/authentication/getting-started).
+
+#### Build
+- Build your project with:
+```
+  mvn clean package -DskipTests
+```
+
+#### Testing
+Run the test with Maven.
+```
+  mvn verify
+```
diff --git a/datacatalog/quickstart/build.gradle b/datacatalog/quickstart/build.gradle
@@ -0,0 +1,41 @@
+// Copyright 2019 Google Inc.
+//
+//  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.
+
+apply plugin: 'java'
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    compile group: 'com.google.cloud', name: 'google-cloud-datacatalog-quickstart', version:'0.28.0-alpha'
+
+    testCompile group: 'com.google.truth', name: 'truth', version:'0.42'
+    testCompile group: 'junit', name: 'junit', version:'4.13-beta-2'
+}
+
+test {
+    useJUnit()
+    testLogging.showStandardStreams = true
+    beforeTest { descriptor ->
+        logger.lifecycle("test: " + descriptor + "  Running")
+    }
+
+    onOutput { descriptor, event ->
+        logger.lifecycle("test: " + descriptor + ": " + event.message )
+    }
+    afterTest { descriptor, result ->
+        logger.lifecycle("test: " + descriptor + ": " + result )
+    }
+}
diff --git a/datacatalog/quickstart/pom.xml b/datacatalog/quickstart/pom.xml
@@ -0,0 +1,59 @@
+<!--
+  Copyright 2019 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.
+ -->
+
+<project>
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.example.datacatalog</groupId>
+    <artifactId>datacatalog-google-cloud-quickstart</artifactId>
+    <packaging>jar</packaging>
+
+    <!--
+    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.11</version>
+    </parent>
+
+    <properties>
+        <maven.compiler.target>1.8</maven.compiler.target>
+        <maven.compiler.source>1.8</maven.compiler.source>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.google.cloud</groupId>
+            <artifactId>google-cloud-datacatalog</artifactId>
+            <version>0.29.0-alpha</version>
+        </dependency>
+
+        <!-- Test dependencies -->
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.13-beta-3</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.google.truth</groupId>
+            <artifactId>truth</artifactId>
+            <version>1.0</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/datacatalog/quickstart/src/main/java/com/example/datacatalog/CreateFilesetEntry.java b/datacatalog/quickstart/src/main/java/com/example/datacatalog/CreateFilesetEntry.java
diff --git a/datacatalog/quickstart/src/test/java/com/example/datacatalog/CreateFilesetEntryTests.java b/datacatalog/quickstart/src/test/java/com/example/datacatalog/CreateFilesetEntryTests.java
