feat(tpu): add tpu vm create startup script sample. (#9612)

* Changed package, added information to CODEOWNERS

* Added information to CODEOWNERS

* Added timeout

* Fixed parameters for test

* Fixed DeleteTpuVm and naming

* Added comment, created Util class

* Fixed naming

* Fixed whitespace

* Split PR into smaller, deleted redundant code

* Implemented tpu_vm_create_startup_script sample, created test

* Fixed tests and empty lines

* Changed zone

* Deleted redundant test classes

* Increased timeout

* Fixed code

tpu/src/main/java/tpu/CreateTpuVmWithStartupScript.java

@@ -0,0 +1,84 @@
+/*
+* 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_startup_script]
+import com.google.cloud.tpu.v2.CreateNodeRequest;
+import com.google.cloud.tpu.v2.Node;
+import com.google.cloud.tpu.v2.TpuClient;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.ExecutionException;
+
+public class CreateTpuVmWithStartupScript {
+  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 = "us-central1-f";
+    // The name for your TPU.
+    String nodeName = "YOUR_TPU_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 acceleratorType = "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";
+
+    createTpuVmWithStartupScript(projectId, zone, nodeName, acceleratorType, tpuSoftwareVersion);
+  }
+
+  // Create a TPU VM with a startup script.
+  public static Node createTpuVmWithStartupScript(String projectId, String zone,
+      String nodeName, String acceleratorType, String tpuSoftwareVersion)
+      throws IOException, ExecutionException, InterruptedException {
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests.
+    try (TpuClient tpuClient = TpuClient.create()) {
+      String parent = String.format("projects/%s/locations/%s", projectId, zone);
+
+      String startupScriptContent = "#!/bin/bash\necho \"Hello from the startup script!\"";
+      // Add startup script to metadata
+      Map<String, String> metadata = new HashMap<>();
+      metadata.put("startup-script", startupScriptContent);
+
+      Node tpuVm =
+          Node.newBuilder()
+             .setName(nodeName)
+             .setAcceleratorType(acceleratorType)
+             .setRuntimeVersion(tpuSoftwareVersion)
+             .putAllMetadata(metadata)
+             .build();
+
+      CreateNodeRequest request =
+          CreateNodeRequest.newBuilder()
+             .setParent(parent)
+             .setNodeId(nodeName)
+             .setNode(tpuVm)
+             .build();
+
+      return tpuClient.createNodeAsync(request).get();
+    }
+  }
+}
+//[END tpu_vm_create_startup_script]

tpu/src/test/java/tpu/TpuVmIT.java

@@ -233,4 +233,34 @@ public void testCreateSpotTpuVm() throws Exception {
       assertEquals(returnedNode, mockNode);
     }
   }
+
+  @Test
+  public void testCreateTpuVmWithStartupScript() throws Exception {
+    try (MockedStatic<TpuClient> mockedTpuClient = mockStatic(TpuClient.class)) {
+      Node mockNode = Node.newBuilder()
+              .setName("nodeName")
+              .setAcceleratorType("acceleratorType")
+              .setRuntimeVersion("runtimeVersion")
+              .build();
+
+      TpuClient mockTpuClient = mock(TpuClient.class);
+      OperationFuture mockFuture = mock(OperationFuture.class);
+
+      mockedTpuClient.when(TpuClient::create).thenReturn(mockTpuClient);
+      when(mockTpuClient.createNodeAsync(any(CreateNodeRequest.class)))
+              .thenReturn(mockFuture);
+      when(mockFuture.get()).thenReturn(mockNode);
+
+      Node returnedNode = CreateTpuVmWithStartupScript.createTpuVmWithStartupScript(
+              PROJECT_ID, ZONE, NODE_NAME,
+              TPU_TYPE, TPU_SOFTWARE_VERSION);
+
+      verify(mockTpuClient, times(1))
+              .createNodeAsync(any(CreateNodeRequest.class));
+      verify(mockFuture, times(1)).get();
+      assertEquals(returnedNode.getName(), mockNode.getName());
+      assertEquals(returnedNode.getAcceleratorType(), mockNode.getAcceleratorType());
+      assertEquals(returnedNode.getRuntimeVersion(), mockNode.getRuntimeVersion());
+    }
+  }
 }