Iot fix tests (#1487)

* Adds function for clearing registry
* Clean up registries in tests

Author: gguuss

iot/api-client/manager/pom.xml

@@ -62,7 +62,7 @@
     <dependency>
       <groupId>com.google.apis</groupId>
       <artifactId>google-api-services-cloudiot</artifactId>
-      <version>v1-rev20181120-1.27.0</version>
+      <version>v1-rev77-1.25.0</version>
     </dependency>
     <dependency>
       <groupId>com.google.cloud</groupId>

iot/api-client/manager/src/main/java/com/example/cloud/iot/examples/DeviceRegistryExample.java

@@ -35,6 +35,7 @@
 import com.google.api.services.cloudiot.v1.model.GatewayConfig;
 import com.google.api.services.cloudiot.v1.model.GetIamPolicyRequest;
 import com.google.api.services.cloudiot.v1.model.ListDeviceStatesResponse;
+import com.google.api.services.cloudiot.v1.model.ListDevicesResponse;
 import com.google.api.services.cloudiot.v1.model.ModifyCloudToDeviceConfigRequest;
 import com.google.api.services.cloudiot.v1.model.PublicKeyCredential;
 import com.google.api.services.cloudiot.v1.model.SendCommandToDeviceRequest;
@@ -166,13 +167,128 @@ public static void deleteRegistry(String cloudRegion, String projectId, String r
 
     final String registryPath =
         String.format(
-            "projects/%s/locations/%s/registries/%s", projectId, cloudRegion, registryName);
+          "projects/%s/locations/%s/registries/%s", projectId, cloudRegion, registryName);
 
     System.out.println("Deleting: " + registryPath);
     service.projects().locations().registries().delete(registryPath).execute();
   }
   // [END iot_delete_registry]
 
+  /**
+   * clearRegistry
+   *   <ul>
+   *    <li>Registries can't be deleted if they contain devices,</li>
+   *    <li>Gateways (a type of device) can't be deleted if they have bound devices</li>
+   *    <li>Devices can't be deleted if bound to gateways...</li>
+   *   </ul>
+   *   To completely remove a registry, you must unbind all devices from gateways,
+   *   then remove all devices in a registry before removing the registry.
+   *   As pseudocode:
+   *   <code>
+   *   ForAll gateways
+   *     ForAll devicesBoundToGateway
+   *       unbindDeviceFromGateway
+   *   ForAll devices
+   *     Delete device by ID
+   *   Delete registry
+   *  </code>
+   */
+  // [START iot_clear_registry]
+  public static void clearRegistry(String cloudRegion, String projectId, String registryName)
+      throws GeneralSecurityException, IOException {
+    GoogleCredential credential =
+        GoogleCredential.getApplicationDefault().createScoped(CloudIotScopes.all());
+    JsonFactory jsonFactory = JacksonFactory.getDefaultInstance();
+    HttpRequestInitializer init = new RetryHttpInitializerWrapper(credential);
+    final CloudIot service =
+        new CloudIot.Builder(GoogleNetHttpTransport.newTrustedTransport(), jsonFactory, init)
+            .setApplicationName(APP_NAME)
+            .build();
+    final String registryPath =
+        String.format(
+            "projects/%s/locations/%s/registries/%s", projectId, cloudRegion, registryName);
+
+    ListDevicesResponse listGatewaysRes =
+        service
+            .projects()
+            .locations()
+            .registries()
+            .devices()
+            .list(registryPath)
+            .setGatewayListOptionsGatewayType("GATEWAY")
+            .execute();
+    List<Device> gateways = listGatewaysRes.getDevices();
+
+    // Unbind all devices from all gateways
+    if (gateways != null) {
+      System.out.println("Found " + gateways.size() + " devices");
+      for (Device g : gateways) {
+        String gatewayId = g.getId();
+        System.out.println("Id: " + gatewayId);
+
+        ListDevicesResponse res = 
+            service
+                .projects()
+                .locations()
+                .registries()
+                .devices()
+                .list(registryPath)
+                .setGatewayListOptionsAssociationsGatewayId(gatewayId)
+                .execute();
+        List<Device> deviceNumIds = res.getDevices();
+
+        if (deviceNumIds != null) {
+          System.out.println("Found " + deviceNumIds.size() + " devices");
+          for (Device device : deviceNumIds) {
+            String deviceId = device.getId();
+            System.out.println(String.format("ID: %s", deviceId));
+
+            // Remove any bindings from the device
+            UnbindDeviceFromGatewayRequest request = new UnbindDeviceFromGatewayRequest();
+            request.setDeviceId(deviceId);
+            request.setGatewayId(gatewayId);
+            UnbindDeviceFromGatewayResponse response =
+                service
+                    .projects()
+                    .locations()
+                    .registries()
+                    .unbindDeviceFromGateway(registryPath, request)
+                    .execute();
+          }
+        } else {
+          System.out.println("Gateway has no bound devices.");
+        }
+      }
+    }
+
+    // Remove all devices from the regsitry
+    List<Device> devices =
+        service
+            .projects()
+            .locations()
+            .registries()
+            .devices()
+            .list(registryPath)
+            .execute()
+            .getDevices();
+
+    if (devices != null) {
+      System.out.println("Found " + devices.size() + " devices");
+      for (Device d : devices) {
+        String deviceId = d.getId();
+        String devicePath = String.format(
+            "%s/devices/%s", registryPath, deviceId);
+        service.projects().locations().registries().devices().delete(devicePath).execute();
+      }
+    }
+
+    // Delete the registry
+    service.projects().locations().registries().delete(registryPath).execute();
+
+  }
+  // [END iot_clear_registry]
+
+
   // [START iot_list_devices]
   /** Print all of the devices in this registry to standard out. */
   public static void listDevices(String projectId, String cloudRegion, String registryName)
@@ -1099,6 +1215,10 @@ public static void main(String[] args) throws Exception {
     }
 
     switch (options.command) {
+      case "clear-registry":
+        System.out.println("Clear registry");
+        clearRegistry(options.cloudRegion, options.projectId, options.registryName);
+        break;
       case "create-iot-topic":
         System.out.println("Create IoT Topic:");
         createIotTopic(options.projectId, options.pubsubTopic);

iot/api-client/manager/src/main/java/com/example/cloud/iot/examples/DeviceRegistryExampleOptions.java

@@ -52,6 +52,7 @@ public static DeviceRegistryExampleOptions fromFlags(String[] args) {
             .hasArg()
             .desc(
                 "Command to run:"
+                    + "\n\tclear-registry"
                     + "\n\tcreate-iot-topic" // TODO: Descriptions or too verbose?
                     + "\n\tcreate-rsa"
                     + "\n\tcreate-es"

iot/api-client/manager/src/test/java/com/example/cloud/iot/examples/ManagerIT.java

@@ -16,12 +16,22 @@
 
 package com.example.cloud.iot.examples;
 
+import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
+import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
+import com.google.api.client.http.HttpRequestInitializer;
+import com.google.api.client.json.JsonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
+import com.google.api.services.cloudiot.v1.CloudIot;
+import com.google.api.services.cloudiot.v1.CloudIotScopes;
+import com.google.api.services.cloudiot.v1.model.DeviceRegistry;
 import com.google.cloud.pubsub.v1.TopicAdminClient;
 import com.google.pubsub.v1.Topic;
 
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
 
+import java.util.List;
+
 import org.eclipse.paho.client.mqttv3.MqttClient;
 import org.junit.After;
 import org.junit.Assert;
@@ -30,6 +40,7 @@
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
 
+
 /** Tests for iot "Management" sample. */
 @RunWith(JUnit4.class)
 @SuppressWarnings("checkstyle:abbreviationaswordinname")
@@ -49,9 +60,15 @@ public class ManagerIT {
   private static final String ROLE = "roles/viewer";
 
   private static Topic topic;
+  private static boolean hasCleared = false;
 
   @Before
   public void setUp() throws Exception {
+    if (!hasCleared) {
+      clearTestRegistries(); // Remove old / unused registries
+      hasCleared = true;
+    }
+
     bout = new ByteArrayOutputStream();
     out = new PrintStream(bout);
     System.setOut(out);
@@ -62,6 +79,46 @@ public void tearDown() throws Exception {
     System.setOut(null);
   }
 
+  public void clearTestRegistries() throws Exception {
+    GoogleCredential credential =
+        GoogleCredential.getApplicationDefault().createScoped(CloudIotScopes.all());
+    JsonFactory jsonFactory = JacksonFactory.getDefaultInstance();
+    HttpRequestInitializer init = new RetryHttpInitializerWrapper(credential);
+    final CloudIot service =
+        new CloudIot.Builder(GoogleNetHttpTransport.newTrustedTransport(), jsonFactory, init)
+            .setApplicationName("TEST")
+            .build();
+
+    final String projectPath = "projects/" + PROJECT_ID + "/locations/" + CLOUD_REGION;
+
+    List<DeviceRegistry> registries =
+        service
+            .projects()
+            .locations()
+            .registries()
+            .list(projectPath)
+            .execute()
+            .getDeviceRegistries();
+
+    if (registries != null) {
+      for (DeviceRegistry r : registries) {
+        String registryId = r.getId();
+        if (registryId.startsWith("java-reg-")) {
+          long currSecs = System.currentTimeMillis() / 1000L;
+          long regSecs = Long.parseLong(registryId.substring(
+              "java-reg-".length(), registryId.length()));
+          long diffSecs = currSecs - regSecs;
+          if (diffSecs > (60 * 60 * 24 * 7)) { // tests from last week or older
+            System.out.println("Remove Id: " + r.getId());
+            DeviceRegistryExample.clearRegistry(CLOUD_REGION, PROJECT_ID, registryId);
+          }
+        }
+      }
+    } else {
+      System.out.println("Project has no registries.");
+    }
+  }
+
   @Test
   public void testPatchRsa() throws Exception {
     final String deviceName = "patchme-device-rsa";