test: adds cleanup function for tests (#28)

* feat: adds cleanup function for tests

Author: telpirion

game-servers/snippets/get_realm.js

@@ -45,6 +45,11 @@ function main(
     console.log(`Realm name: ${realm.name}`);
     console.log(`Realm description: ${realm.description}`);
     console.log(`Realm time zone: ${realm.timeZone}`);
+
+    const createTime = realm.createTime;
+    const createDate = new Date(createTime.seconds * 1000);
+
+    console.log(`Realm created on: ${createDate.toLocaleDateString()}`);
     // [END cloud_game_servers_get_realm]
   }
 

game-servers/snippets/list_realms.js

@@ -38,7 +38,11 @@ function main(projectId = 'YOUR_PROJECT_ID', location = 'LOCATION_ID') {
     for (const realm of results.realms) {
       console.log(`Realm name: ${realm.name}`);
       console.log(`Realm description: ${realm.description}`);
-      console.log(`Realm time zone: ${realm.timeZone}\n`);
+      console.log(`Realm time zone: ${realm.timeZone}`);
+
+      const createTime = realm.createTime;
+      const createDate = new Date(createTime.seconds * 1000);
+      console.log(`Realm created on: ${createDate.toLocaleDateString()}\n`);
     }
     // [END cloud_game_servers_list_realms]
   }

game-servers/snippets/test/clean.js

@@ -0,0 +1,73 @@
+// Copyright 2020 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
+//
+//     https://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.
+
+const {GameServerClustersServiceClient} = require('@google-cloud/game-servers');
+const {RealmsServiceClient} = require('@google-cloud/game-servers');
+
+const gameServerClusterClient = new GameServerClustersServiceClient();
+const realmsClient = new RealmsServiceClient();
+
+/**
+ * Utility function for removing unneeded realms from project.
+ */
+module.exports = async () => {
+  const projectId = await realmsClient.getProjectId();
+  const location = 'us-central1';
+
+  const request = {
+    parent: `projects/${projectId}/locations/${location}`,
+  };
+
+  const MAX_REALM_LIFESPAN = 3600000; // One hour (in milliseconds)
+  const NOW = new Date();
+
+  const [results] = await realmsClient.listRealms(request);
+  for (const realm of results.realms) {
+    // Check age of realm. If older than maximum life span, delete.
+    const ageOfRealm = new Date(realm.createTime.seconds * 1000);
+    if (NOW - ageOfRealm > MAX_REALM_LIFESPAN) {
+      // First, delete all clusters associated with this realm.
+      const clustersRequest = {
+        parent: realm.name,
+      };
+
+      const clustersResult = await gameServerClusterClient.listGameServerClusters(
+        clustersRequest
+      );
+      const [clusters] = clustersResult;
+      for (const cluster of clusters.gameServerClusters) {
+        const deleteClusterRequest = {
+          name: cluster.name,
+        };
+
+        const [
+          deleteClusterOperation,
+        ] = await gameServerClusterClient.deleteGameServerCluster(
+          deleteClusterRequest
+        );
+        await deleteClusterOperation.promise();
+      }
+
+      // Then delete the realm itself.
+      const realmDeleteRequest = {
+        name: realm.name,
+      };
+
+      const [deleteRealmOperation] = await realmsClient.deleteRealm(
+        realmDeleteRequest
+      );
+      await deleteRealmOperation.promise();
+    }
+  }
+};

game-servers/snippets/test/create_realm.test.js

@@ -15,7 +15,8 @@
 'use strict';
 
 const {assert} = require('chai');
-const {describe, it, after} = require('mocha');
+const cleanup = require('./clean.js');
+const {describe, before, it, after} = require('mocha');
 const {RealmsServiceClient} = require('@google-cloud/game-servers');
 
 const cp = require('child_process');
@@ -29,6 +30,10 @@ describe('Game Servers Create Realm Test', () => {
   const client = new RealmsServiceClient();
   let realmId;
 
+  before(async () => {
+    await cleanup();
+  });
+
   it('should create a realm', async () => {
     const projectId = await client.getProjectId();
     realmId = `test-${uuid.v4()}`;

game-servers/snippets/test/delete_realm.test.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const {assert} = require('chai');
+const cleanup = require('./clean.js');
 const {describe, it, before} = require('mocha');
 const {RealmsServiceClient} = require('@google-cloud/game-servers');
 
@@ -31,6 +32,10 @@ describe('Game Servers Delete Realm Test', () => {
 
   before(async () => {
     const projectId = await client.getProjectId();
+
+    // Clean up any stray realms
+    await cleanup();
+
     realmId = `test-${uuid.v4()}`;
 
     await client.createRealm({

game-servers/snippets/test/get_realm.test.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const {assert} = require('chai');
+const cleanup = require('./clean.js');
 const {describe, it, before, after} = require('mocha');
 const {RealmsServiceClient} = require('@google-cloud/game-servers');
 
@@ -31,6 +32,10 @@ describe('Game Servers Get Realms Test', () => {
 
   before(async () => {
     const projectId = await client.getProjectId();
+
+    // Clean up any stray realms
+    await cleanup();
+
     realmId = `test-${uuid.v4()}`;
 
     await client.createRealm({

game-servers/snippets/test/list_realms.test.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const {assert} = require('chai');
+const cleanup = require('./clean.js');
 const {describe, it, before, after} = require('mocha');
 const {RealmsServiceClient} = require('@google-cloud/game-servers');
 
@@ -31,6 +32,10 @@ describe('Game Servers List Realms Test', () => {
 
   before(async () => {
     const projectId = await client.getProjectId();
+
+    // Clean up any stray realms
+    await cleanup();
+
     realmId = `test-${uuid.v4()}`;
 
     await client.createRealm({

game-servers/snippets/test/quickstart.test.js

@@ -15,7 +15,8 @@
 'use strict';
 
 const {assert} = require('chai');
-const {describe, it, after} = require('mocha');
+const cleanup = require('./clean.js');
+const {describe, it, before, after} = require('mocha');
 const {RealmsServiceClient} = require('@google-cloud/game-servers');
 
 const cp = require('child_process');
@@ -29,6 +30,10 @@ describe('Game Servers Quickstart Test', () => {
   const client = new RealmsServiceClient();
   let realmId;
 
+  before(async () => {
+    await cleanup();
+  });
+
   it('should create a realm', async () => {
     const projectId = await client.getProjectId();
     realmId = `test-${uuid.v4()}`;