Implemented tpu_vm_create_spot sample, created test

Author: TetyanaYahodska

tpu/src/main/java/tpu/CreateSpotTpuVm.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2024 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.
+ */
+
+package tpu;
+
+//[START tpu_vm_create_spot]
+
+import com.google.cloud.tpu.v2.CreateNodeRequest;
+import com.google.cloud.tpu.v2.Node;
+import com.google.cloud.tpu.v2.SchedulingConfig;
+import com.google.cloud.tpu.v2.TpuClient;
+import java.io.IOException;
+import java.util.concurrent.ExecutionException;
+
+public class CreateSpotTpuVm {
+  public static void main(String[] args)
+      throws IOException, ExecutionException, InterruptedException {
+    // TODO(developer): Replace these variables before running the sample.
+    // Project ID or project number of the Google Cloud project you want to create a node.
+    String projectId = "YOUR_PROJECT_ID";
+    // The zone in which to create the TPU.
+    // For more information about supported TPU types for specific zones,
+    // see https://cloud.google.com/tpu/docs/regions-zones
+    String zone = "europe-west4-a";
+    // The name for your TPU.
+    String nodeName = "YOUR_TPY_NAME";
+    // The accelerator type that specifies the version and size of the Cloud TPU you want to create.
+    // For more information about supported accelerator types for each TPU version,
+    // see https://cloud.google.com/tpu/docs/system-architecture-tpu-vm#versions.
+    String tpuType = "v2-8";
+    // Software version that specifies the version of the TPU runtime to install.
+    // For more information see https://cloud.google.com/tpu/docs/runtimes
+    String tpuSoftwareVersion = "tpu-vm-tf-2.14.1";
+
+    createSpotTpuVm(projectId, zone, nodeName, tpuType, tpuSoftwareVersion);
+  }
+
+  // Creates a preemptible TPU VM with the specified name, zone, accelerator type, and version.
+  public static void createSpotTpuVm(
+      String projectId, String zone, String nodeName, String tpuType, String tpuSoftwareVersion)
+      throws IOException, ExecutionException, InterruptedException {
+    try (TpuClient tpuClient = TpuClient.create()) {
+      String parent = String.format("projects/%s/locations/%s", projectId, zone);
+
+      SchedulingConfig schedulingConfig = SchedulingConfig.newBuilder()
+          .setPreemptible(true)
+          .build();
+
+      Node tpuVm = Node.newBuilder()
+          .setName(nodeName)
+          .setAcceleratorType(tpuType)
+          .setRuntimeVersion(tpuSoftwareVersion)
+          .setSchedulingConfig(schedulingConfig)
+          .build();
+
+      CreateNodeRequest request = CreateNodeRequest.newBuilder()
+          .setParent(parent)
+          .setNodeId(nodeName)
+          .setNode(tpuVm)
+          .build();
+
+      Node response = tpuClient.createNodeAsync(request).get();
+      System.out.printf("Spot TPU VM created: %s\n", response.getName());
+    }
+  }
+}
+//[END tpu_vm_create_spot]

tpu/src/test/java/tpu/CreateSpotTpuVmIT.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2024 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.
+ */
+
+package tpu;
+
+import static com.google.common.truth.Truth.assertThat;
+import static com.google.common.truth.Truth.assertWithMessage;
+
+import com.google.api.gax.rpc.NotFoundException;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.PrintStream;
+import java.util.UUID;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.Timeout;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+@Timeout(value = 25, unit = TimeUnit.MINUTES)
+public class CreateSpotTpuVmIT {
+  private static final String PROJECT_ID = System.getenv("GOOGLE_CLOUD_PROJECT");
+  private static final String ZONE = "europe-west4-a";
+  static String javaVersion = System.getProperty("java.version").substring(0, 2);
+  private static final String TPU_VM_NAME = "test-spot-tpu-" + javaVersion + "-"
+      + UUID.randomUUID().toString().substring(0, 8);
+  private static final String ACCELERATOR_TYPE = "v2-8";
+  private static final String VERSION = "tpu-vm-tf-2.14.1";
+  private static final String TPU_VM_PATH_NAME =
+      String.format("projects/%s/locations/%s/nodes/%s", PROJECT_ID, ZONE, TPU_VM_NAME);
+
+  public static void requireEnvVar(String envVarName) {
+    assertWithMessage(String.format("Missing environment variable '%s' ", envVarName))
+        .that(System.getenv(envVarName)).isNotEmpty();
+  }
+
+  @BeforeAll
+  public static void setUp()
+      throws IOException, ExecutionException, InterruptedException {
+    requireEnvVar("GOOGLE_APPLICATION_CREDENTIALS");
+    requireEnvVar("GOOGLE_CLOUD_PROJECT");
+
+    // Cleanup existing stale resources.
+    Util.cleanUpExistingTpu("test-spot-tpu-" + javaVersion, PROJECT_ID, ZONE);
+  }
+
+  @AfterAll
+  public static void cleanup() throws Exception {
+    DeleteTpuVm.deleteTpuVm(PROJECT_ID, ZONE, TPU_VM_NAME);
+
+    // Test that TPUs is deleted
+    Assertions.assertThrows(
+        NotFoundException.class,
+        () -> GetTpuVm.getTpuVm(PROJECT_ID, ZONE, TPU_VM_NAME));
+  }
+
+  @Test
+  public void testCreateSpotTpuVm() throws IOException, ExecutionException, InterruptedException {
+    final PrintStream out = System.out;
+    ByteArrayOutputStream stdOut = new ByteArrayOutputStream();
+    System.setOut(new PrintStream(stdOut));
+    CreateSpotTpuVm.createSpotTpuVm(PROJECT_ID, ZONE, TPU_VM_NAME, ACCELERATOR_TYPE, VERSION);
+
+    assertThat(stdOut.toString()).contains("TPU VM created: " + TPU_VM_PATH_NAME);
+    stdOut.close();
+    System.setOut(out);
+  }
+}