feat: Vertex AI Skill Registry - Create Skill method

PiperOrigin-RevId: 910161153

Author: vertex-sdk-bot

tests/unit/vertexai/genai/replays/test_skills_create.py

@@ -0,0 +1,38 @@
+# Copyright 2026 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.
+#
+"""Tests the skills.create() method against the Vertex AI endpoint using replays."""
+
+import os
+import tempfile
+
+from vertexai._genai import types
+
+
+def test_create_skill(client):
+    with tempfile.TemporaryDirectory() as tmpdir:
+        # Create a dummy skill structure (SKILL.md is required by the spec)
+        with open(os.path.join(tmpdir, "SKILL.md"), "w") as f:
+            f.write("# My Replay Skill\nThis is a test skill for replay tests.")
+
+        skill = client.skills.create(
+            display_name="My Replay Skill",
+            description="My Replay Skill Description",
+            local_path=tmpdir,
+            config=types.CreateSkillConfig(wait_for_completion=True),
+        )
+
+        assert skill.name is not None
+        assert skill.display_name == "My Replay Skill"
+        assert skill.description == "My Replay Skill Description"

tests/unit/vertexai/genai/replays/test_skills_get.py

@@ -0,0 +1,39 @@
+"""Tests the skills.get() method against the autopush endpoint."""
+
+from google.api_core import exceptions
+from tests.unit.vertexai.genai.replays import pytest_helper
+import pytest
+
+PROJECT_ID = "srbai-testing"
+REGION = "us-central1"
+# SKILL_ID = "5578834038405201920"
+SKILL_ID = "7184367305562783744"
+ENDPOINT = f"{REGION}-autopush-aiplatform.sandbox.googleapis.com"
+
+# # Configure HTTP options to target the autopush endpoint
+# my_http_options = genai_types.HttpOptions(
+#     api_version="v1beta1",
+#     base_url=f"https://{ENDPOINT}/v1beta1/"  # <---APPENDED /v1beta1/ here
+# )
+
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    # http_options=my_http_options,
+)
+
+
+def test_get_skill(client):  # client fixture is injected by pytest_helper.setup
+    """Tests the skills.get() method against the autopush endpoint."""
+
+    client._api_client._http_options.base_url = (
+        "https://us-central1-autopush-aiplatform.sandbox.googleapis.com"
+    )
+    skill_name = f"projects/{PROJECT_ID}/locations/{REGION}/skills/{SKILL_ID}"
+
+    try:
+        skill = client.skills.get(name=skill_name)
+        assert skill.name == skill_name
+
+    except exceptions.GoogleAPIError as e:
+        pytest.fail(f"Error calling client.skills.get(): {e}")

tests/unit/vertexai/genai/test_genai_skills.py

@@ -0,0 +1,200 @@
+# //third_party/py/google/cloud/aiplatform/tests/unit/vertexai/genai/test_genai_skills.py
+import importlib
+import json
+from unittest import mock
+from vertexai import _genai as genai
+from vertexai._genai import client as vertexai_client
+from google.genai import types as genai_types
+import pytest
+
+
+@pytest.fixture
+def skills_client():
+    creds = mock.MagicMock()
+    creds.token = "test_token"
+    client = vertexai_client.Client(
+        project="test-project", location="test-location", credentials=creds
+    )
+    return client.skills
+
+
+@pytest.fixture
+def async_skills_client():
+  creds = mock.MagicMock()
+  creds.token = "test_token"
+  client = vertexai_client.Client(
+      project="test-project", location="test-location", credentials=creds
+  )
+  return client.aio.skills
+
+
+class TestGenaiSkills:
+    mock_get_skill_response = {
+        "name": "projects/test-project/locations/test-location/skills/test-skill",
+        "displayName": "My Test Skill",
+    }
+
+    def test_get_skill(self, skills_client):
+        """Tests the get_skill method."""
+        with mock.patch.object(skills_client._api_client, "request") as request_mock:
+            request_mock.return_value = genai_types.HttpResponse(
+                body=json.dumps(self.mock_get_skill_response)
+            )
+            skill_name = (
+                "projects/test-project/locations/test-location/skills/test-skill"
+            )
+            skill = skills_client.get(name=skill_name)
+            request_mock.assert_called_with(
+                "get",
+                skill_name,
+                {"_url": {"name": skill_name}},
+                None,
+            )
+            assert isinstance(skill, genai.types.Skill)
+            assert skill.name == skill_name
+            assert skill.display_name == "My Test Skill"
+
+  def test_create_skill(self, skills_client):
+    """Tests the create_skill method with wait_for_completion=True."""
+    import tempfile
+    import os
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+      # Create a dummy file in tmpdir
+      with open(os.path.join(tmpdir, "SKILL.md"), "w") as f:
+        f.write("# Test Skill")
+
+      # Prepare mock responses
+      pending_op = {
+          "name": "projects/test-project/locations/test-location/skills/test-skill/operations/op-123",
+          "done": False,
+      }
+      finished_op = {
+          "name": "projects/test-project/locations/test-location/skills/test-skill/operations/op-123",
+          "done": True,
+          "response": {
+              "name": "projects/test-project/locations/test-location/skills/test-skill",
+              "displayName": "My Test Skill",
+              "description": "My Test Skill Description",
+          }
+      }
+
+      with mock.patch.object(skills_client._api_client, "request") as request_mock:
+        request_mock.side_effect = [
+            genai_types.HttpResponse(body=json.dumps(pending_op)),
+            genai_types.HttpResponse(body=json.dumps(finished_op)),
+        ]
+
+        # We mock time.sleep to speed up the test
+        with mock.patch("time.sleep", return_value=None):
+          skill = skills_client.create(
+              display_name="My Test Skill",
+              description="My Test Skill Description",
+              local_path=tmpdir,
+              config={"wait_for_completion": True}
+          )
+
+        # Assertions
+        assert request_mock.call_count == 2
+
+        # Verify POST request
+        post_call = request_mock.call_args_list[0]
+        assert post_call[0][0] == "post"
+        assert post_call[0][1] == "skills"
+
+        post_body = post_call[0][2]
+        assert post_body["skill"]["displayName"] == "My Test Skill"
+        assert post_body["skill"]["description"] == "My Test Skill Description"
+        assert isinstance(post_body["skill"]["zippedFilesystem"], str)
+
+        # Verify GET request (polling)
+        get_call = request_mock.call_args_list[1]
+        assert get_call[0][0] == "get"
+        assert get_call[0][1] == "projects/test-project/locations/test-location/skills/test-skill/operations/op-123"
+
+        # Verify returned skill
+        assert isinstance(skill, genai.types.Skill)
+        assert skill.name == "projects/test-project/locations/test-location/skills/test-skill"
+        assert skill.display_name == "My Test Skill"
+        assert skill.description == "My Test Skill Description"
+
+  def test_create_skill_no_wait(self, skills_client):
+    """Tests the create_skill method with wait_for_completion=False."""
+    import tempfile
+    import os
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+      with open(os.path.join(tmpdir, "SKILL.md"), "w") as f:
+        f.write("# Test Skill")
+
+      pending_op = {
+          "name": "projects/test-project/locations/test-location/skills/test-skill/operations/op-123",
+          "done": False,
+      }
+
+      with mock.patch.object(skills_client._api_client, "request") as request_mock:
+        request_mock.return_value = genai_types.HttpResponse(body=json.dumps(pending_op))
+
+        operation = skills_client.create(
+            display_name="My Test Skill",
+            description="My Test Skill Description",
+            local_path=tmpdir,
+            config={"wait_for_completion": False}
+        )
+
+        # Assertions
+        assert request_mock.call_count == 1
+        assert isinstance(operation, genai.types.SkillOperation)
+        assert operation.name == "projects/test-project/locations/test-location/skills/test-skill/operations/op-123"
+        assert not operation.done
+
+  @pytest.mark.asyncio
+  async def test_create_skill_async(self, async_skills_client):
+    """Tests the create_skill method asynchronously with wait_for_completion=True."""
+    import tempfile
+    import os
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+      with open(os.path.join(tmpdir, "SKILL.md"), "w") as f:
+        f.write("# Test Skill")
+
+      pending_op = {
+          "name": "projects/test-project/locations/test-location/skills/test-skill/operations/op-123",
+          "done": False,
+      }
+      finished_op = {
+          "name": "projects/test-project/locations/test-location/skills/test-skill/operations/op-123",
+          "done": True,
+          "response": {
+              "name": "projects/test-project/locations/test-location/skills/test-skill",
+              "displayName": "My Test Skill",
+              "description": "My Test Skill Description",
+          }
+      }
+
+      with mock.patch.object(async_skills_client._api_client, "async_request") as request_mock:
+        request_mock.side_effect = [
+            genai_types.HttpResponse(body=json.dumps(pending_op)),
+            genai_types.HttpResponse(body=json.dumps(finished_op)),
+        ]
+
+        with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock):
+          skill = await async_skills_client.create(
+              display_name="My Test Skill",
+              description="My Test Skill Description",
+              local_path=tmpdir,
+              config={"wait_for_completion": True}
+          )
+
+        # Assertions
+        assert request_mock.call_count == 2
+
+        # Verify POST request
+        post_call = request_mock.call_args_list[0]
+        assert post_call[0][0] == "post"
+        assert post_call[0][1] == "skills"
+
+        # Verify returned skill
+        assert isinstance(skill, genai.types.Skill)
+        assert skill.name == "projects/test-project/locations/test-location/skills/test-skill"
+

vertexai/_genai/_skills_utils.py

@@ -0,0 +1,106 @@
+# Copyright 2026 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.
+#
+"""Utility functions for Skills."""
+
+import asyncio
+import base64
+import io
+import os
+import time
+from typing import Any, Callable, Awaitable
+import zipfile
+
+
+def zip_directory(directory_path: str) -> bytes:
+    """Zips a directory into memory and returns the bytes.
+
+    Args:
+        directory_path (str): Required. The local path to the directory.
+
+    Returns:
+        bytes: The zipped directory content.
+    """
+    if not os.path.isdir(directory_path):
+        raise ValueError(f"Path is not a directory: {directory_path}")
+
+    zip_buffer = io.BytesIO()
+    with zipfile.ZipFile(zip_buffer, "w", zipfile.ZIP_DEFLATED) as zip_file:
+        for root, _, files in os.walk(directory_path):
+            for file in files:
+                file_path = os.path.join(root, file)
+                arcname = os.path.relpath(file_path, directory_path)
+                zip_file.write(file_path, arcname)
+    return zip_buffer.getvalue()
+
+
+def get_zipped_filesystem_payload(directory_path: str) -> str:
+    """Zips a directory and base64-encodes the result to a UTF-8 string.
+
+    Args:
+        directory_path (str): Required. The local path to the directory.
+
+    Returns:
+        str: The base64-encoded zipped directory.
+    """
+    zip_bytes = zip_directory(directory_path)
+    return base64.b64encode(zip_bytes).decode("utf-8")
+
+
+def await_operation(
+    *,
+    operation_name: str,
+    get_operation_fn: Callable[..., Any],
+    poll_interval_seconds: float = 10.0,
+) -> Any:
+    """Waits for a long running operation to complete.
+
+    Args:
+        operation_name (str): Required. The name of the operation.
+        get_operation_fn (Callable): Required. Function to get the operation
+          status.
+        poll_interval_seconds (float): The interval between polls in seconds.
+
+    Returns:
+        Any: The completed operation.
+    """
+    operation = get_operation_fn(operation_name=operation_name)
+    while not operation.done:
+        time.sleep(poll_interval_seconds)
+        operation = get_operation_fn(operation_name=operation.name)
+    return operation
+
+
+async def await_operation_async(
+    *,
+    operation_name: str,
+    get_operation_fn: Callable[..., Awaitable[Any]],
+    poll_interval_seconds: float = 10.0,
+) -> Any:
+    """Waits for a long running operation to complete asynchronously.
+
+    Args:
+        operation_name (str): Required. The name of the operation.
+        get_operation_fn (Callable): Required. Async function to get the
+          operation status.
+        poll_interval_seconds (float): The interval between polls in seconds.
+
+    Returns:
+        Any: The completed operation.
+    """
+    operation = await get_operation_fn(operation_name=operation_name)
+    while not operation.done:
+        await asyncio.sleep(poll_interval_seconds)
+        operation = await get_operation_fn(operation_name=operation.name)
+    return operation