Merge branch 'main' of https://github.com/doraemonlove/veadk-python into fix/verc

Author: wangjiaju.716

.github/workflows/push-preview-image-to-vecr.yaml

@@ -0,0 +1,67 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+name: Push Preview Image to Volcengine Container Registry
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    
+    # To avoid forked repo execute this workflow
+    if: github.repository == 'volcengine/veadk-python'
+    
+    # Set global environments
+    env:
+      CR_URL: veadk-cn-beijing.cr.volces.com
+      CR_NAMESPACE: veadk
+      CR_REPO: veadk-python
+      DOCKERFILE: docker/Dockerfile.preview
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Volcengine Container Registry
+        run: |
+          echo "${{ secrets.VE_CR_PASSWORD }}" | \
+          docker login veadk-cn-beijing.cr.volces.com \
+          -u "${{ secrets.VE_CR_USERNAME }}" \
+          --password-stdin
+
+      # Specify a platform, as VeFaaS required `linux/amd64`
+      - name: Build and push
+        run: |
+          IMAGE_TAG=$CR_URL/$CR_NAMESPACE/$CR_REPO:preview
+          docker buildx build \
+            --file $DOCKERFILE \
+            --tag $IMAGE_TAG \
+            --platform linux/amd64 \
+            --push \
+            --cache-from=type=gha \
+            --cache-to=type=gha,mode=max \
+            .

.github/workflows/push-stable-image-to-vecr.yaml

@@ -0,0 +1,70 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+name: Push Stable Image to Volcengine Container Registry
+
+on:
+  push:
+    # Trigger only when creating tags
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    
+    # To avoid forked repo execute this workflow
+    if: github.repository == 'volcengine/veadk-python'
+
+    # Set global environments
+    env:
+      CR_URL: veadk-cn-beijing.cr.volces.com
+      CR_NAMESPACE: veadk
+      CR_REPO: veadk-python
+      DOCKERFILE: docker/Dockerfile.stable
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Volcengine Container Registry
+        run: |
+          echo "${{ secrets.VE_CR_PASSWORD }}" | \
+          docker login veadk-cn-beijing.cr.volces.com \
+          -u "${{ secrets.VE_CR_USERNAME }}" \
+          --password-stdin
+
+      # Specify a platform, as VeFaaS required `linux/amd64`
+      # push 2 tags (x.x.x and latest) in one push
+      - name: Build and push
+        run: |
+          LATEST_TAG=$CR_URL/$CR_NAMESPACE/$CR_REPO:latest
+          VERSION_TAG=$CR_URL/$CR_NAMESPACE/$CR_REPO:$GITHUB_REF_NAME
+          docker buildx build \
+            --file $DOCKERFILE \
+            --tag $VERSION_TAG \
+            --tag $LATEST_TAG \
+            --platform linux/amd64 \
+            --push \
+            --cache-from=type=gha \
+            --cache-to=type=gha,mode=max \
+            .

docker/Dockerfile.preview

@@ -0,0 +1,20 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+FROM python:3.12
+
+# Install git and install veadk-python via git
+RUN apt-get install -y git && \
+    pip3 install --no-cache-dir git+https://github.com/volcengine/veadk-python.git && \
+    apt-get clean && rm -rf /var/lib/apt/lists/*

docker/Dockerfile.stable

@@ -0,0 +1,22 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+FROM python:3.12
+
+# In order to avoid PyPI not update VeADK new package,
+# we still use git code to build image here.
+# TODO: use PyPI source
+RUN apt-get install -y git && \
+    pip3 install --no-cache-dir git+https://github.com/volcengine/veadk-python.git && \
+    apt-get clean && rm -rf /var/lib/apt/lists/*

pyproject.toml

@@ -74,5 +74,6 @@ include-package-data = true
 
 [tool.ruff]
 exclude = [
-    "veadk/integrations/ve_faas/template/*"
+    "veadk/integrations/ve_faas/template/*",
+    "veadk/integrations/ve_faas/web_template/*"
 ]

tests/test_tos.py

@@ -108,7 +108,7 @@ async def test_upload_bytes_success(tos_client, mock_client):
     data = b"hello world"
 
     result = await tos_client.upload("obj-key", data)
-    assert result is True
+    assert result is None
     mock_client.put_object.assert_called_once()
     mock_client.close.assert_called_once()
 
@@ -121,7 +121,7 @@ async def test_upload_file_success(tmp_path, tos_client, mock_client):
     file_path.write_text("hello file")
 
     result = await tos_client.upload("obj-key", str(file_path))
-    assert result is True
+    assert result is None
     mock_client.put_object_from_file.assert_called_once()
     mock_client.close.assert_called_once()
 

veadk/cli/cli_init.py

@@ -18,6 +18,7 @@
 import click
 from veadk.version import VERSION
 
+
 warnings.filterwarnings(
     "ignore", category=UserWarning, module="pydantic._internal._fields"
 )
@@ -64,18 +65,31 @@ def _render_prompts() -> dict[str, Any]:
 
 
 @click.command()
-def init() -> None:
-    """Init a veadk project that can be deployed to Volcengine VeFaaS."""
+@click.option(
+    "--vefaas-template-type", default="template", help="Expected template type"
+)
+def init(
+    vefaas_template_type: str,
+) -> None:
+    """Init a veadk project that can be deployed to Volcengine VeFaaS.
+
+    `template` is A2A/MCP/Web server template, `web_template` is for web applications (i.e., a simple blog).
+    """
     import shutil
     from pathlib import Path
 
     from cookiecutter.main import cookiecutter
 
     import veadk.integrations.ve_faas as vefaas
 
-    click.echo(
-        "Welcome use VeADK to create your project. We will generate a `weather-reporter` application for you."
-    )
+    if vefaas_template_type == "web_template":
+        click.echo(
+            "Welcome use VeADK to create your project. We will generate a `simple-blog` web application for you."
+        )
+    else:
+        click.echo(
+            "Welcome use VeADK to create your project. We will generate a `weather-reporter` application for you."
+        )
 
     cwd = Path.cwd()
     local_dir_name = click.prompt("Local directory name", default="veadk-cloud-proj")
@@ -91,7 +105,10 @@ def init() -> None:
     settings = _render_prompts()
     settings["local_dir_name"] = local_dir_name
 
-    template_dir_path = Path(vefaas.__file__).parent / "template"
+    if not vefaas_template_type:
+        vefaas_template_type = "template"
+
+    template_dir_path = Path(vefaas.__file__).parent / vefaas_template_type
 
     cookiecutter(
         template=str(template_dir_path),

veadk/database/database_adapter.py

@@ -54,6 +54,33 @@ def query(self, query: str, index: str, top_k: int = 0) -> list:
             logger.error(f"Failed to search from Redis: index={index} error={e}")
             raise e
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        logger.debug(f"Deleting document from Redis database: index={index} id={id}")
+        try:
+            # For Redis, we need to handle deletion differently since RedisDatabase.delete_doc
+            # takes a key and a single id
+            result = self.client.delete_doc(key=index, id=id)
+            return result
+        except Exception as e:
+            logger.error(
+                f"Failed to delete document from Redis database: index={index} id={id} error={e}"
+            )
+            return False
+
+    def list_docs(self, index: str, offset: int = 0, limit: int = 100) -> list[dict]:
+        logger.debug(f"Listing documents from Redis database: index={index}")
+        try:
+            # Get all documents from Redis
+            docs = self.client.list_docs(key=index)
+
+            # Apply offset and limit for pagination
+            return docs[offset : offset + limit]
+        except Exception as e:
+            logger.error(
+                f"Failed to list documents from Redis database: index={index} error={e}"
+            )
+            return []
+
 
 class RelationalDatabaseAdapter:
     def __init__(self, client):
@@ -108,6 +135,28 @@ def query(self, query: str, index: str, top_k: int) -> list[str]:
 
         return [item["data"] for item in results]
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        logger.debug(f"Deleting document from SQL database: table_name={index} id={id}")
+        try:
+            # Convert single id to list for the client method
+            result = self.client.delete_doc(table=index, ids=[int(id)])
+            return result
+        except Exception as e:
+            logger.error(
+                f"Failed to delete document from SQL database: table_name={index} id={id} error={e}"
+            )
+            return False
+
+    def list_docs(self, index: str, offset: int = 0, limit: int = 100) -> list[dict]:
+        logger.debug(f"Listing documents from SQL database: table_name={index}")
+        try:
+            return self.client.list_docs(table=index, offset=offset, limit=limit)
+        except Exception as e:
+            logger.error(
+                f"Failed to list documents from SQL database: table_name={index} error={e}"
+            )
+            return []
+
 
 class VectorDatabaseAdapter:
     def __init__(self, client):
@@ -152,6 +201,23 @@ def query(self, query: str, index: str, top_k: int) -> list[str]:
             top_k=top_k,
         )
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        self._validate_index(index)
+        logger.debug(f"Deleting documents from vector database: index={index} id={id}")
+        try:
+            self.client.delete_by_id(collection_name=index, id=id)
+            return True
+        except Exception as e:
+            logger.error(
+                f"Failed to delete document from vector database: index={index} id={id} error={e}"
+            )
+            return False
+
+    def list_docs(self, index: str, offset: int = 0, limit: int = 1000) -> list[dict]:
+        self._validate_index(index)
+        logger.debug(f"Listing documents from vector database: index={index}")
+        return self.client.list_docs(collection_name=index, offset=offset, limit=limit)
+
 
 class VikingDatabaseAdapter:
     def __init__(self, client):
@@ -212,6 +278,16 @@ def query(self, query: str, index: str, top_k: int) -> list[str]:
 
         return self.client.query(query, collection_name=index, top_k=top_k)
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        self._validate_index(index)
+        logger.debug(f"Deleting documents from vector database: index={index} id={id}")
+        return self.client.delete_by_id(collection_name=index, id=id)
+
+    def list_docs(self, index: str, offset: int, limit: int) -> list[dict]:
+        self._validate_index(index)
+        logger.debug(f"Listing documents from vector database: index={index}")
+        return self.client.list_docs(collection_name=index, offset=offset, limit=limit)
+
 
 class VikingMemoryDatabaseAdapter:
     def __init__(self, client):
@@ -248,6 +324,12 @@ def query(self, query: str, index: str, top_k: int, **kwargs):
         result = self.client.query(query, collection_name=index, top_k=top_k, **kwargs)
         return result
 
+    def delete_docs(self, index: str, ids: list[int]):
+        raise NotImplementedError("VikingMemoryDatabase does not support delete_docs")
+
+    def list_docs(self, index: str):
+        raise NotImplementedError("VikingMemoryDatabase does not support list_docs")
+
 
 class LocalDatabaseAdapter:
     def __init__(self, client):
@@ -261,6 +343,12 @@ def add(self, data: list[str], **kwargs):
     def query(self, query: str, **kwargs):
         return self.client.query(query, **kwargs)
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        return self.client.delete_doc(id)
+
+    def list_docs(self, index: str, offset: int = 0, limit: int = 100) -> list[dict]:
+        return self.client.list_docs(offset=offset, limit=limit)
+
 
 MAPPING = {
     "RedisDatabase": KVDatabaseAdapter,