fix deploy codes

Author: yaozheng-fang

.gitleaks.toml

@@ -0,0 +1,67 @@
+[extend]
+useDefault = true
+
+[[rules]]
+id = "aklt-key-pattern"
+description = "AKLT key pattern"
+regex = '''AKLT\w{40,70}'''
+
+[[rules]]
+id = "akap-key-pattern"
+description = "AKAP key pattern"
+regex = '''AKAP\w{40,70}'''
+
+[[rules]]
+id = "akip-key-pattern"
+description = "AKIP key pattern"
+regex = '''AKI\w{40,70}'''
+
+[[rules]]
+id = "token-transformer-id-pattern"
+description = "Tokenizer/Transformer/Token ID patterns"
+regex = '''(tokenizer|transformer|token_id|tokenid|attention_head).{0,20}'''
+
+[[rules]]
+id = "aws-style-key-pattern"
+description = "AWS-style key pattern"
+regex = '''(A3T[A-Z0-9]|AKIA|AGPA|AIDA|AROA|AIPA|ANPA|ANVA|ASIA)[A-Z0-9]{16}'''
+
+[[rules]]
+id = "alibaba-ltai-pattern"
+description = "Alibaba LTAI key pattern"
+regex = '''(LTAI)[a-z0-9]{20}'''
+
+[[rules]]
+id = "aktp-key-pattern"
+description = "AKTP key pattern"
+regex = '''AKTP\w{40,70}'''
+
+[[rules]]
+id = "app-id-pattern"
+description = "App ID patterns"
+regex = '''([^*<\s|:>]{0,7})(app_id|appid)([^]()!<>;/@&,]{0,10}[(=:]\s{0,6}["']{0,1}[0-9]{6,32}["']{0,1})'''
+
+[[rules]]
+id = "byted-org-domains"
+description = "byted.org domains"
+regex = '''.{0,15}\.?byted.org.{0,20}'''
+
+[[rules]]
+id = "bytedance-net-domains"
+description = "bytedance.net domains"
+regex = '''.{0,15}\.?bytedance.net.{0,20}'''
+
+[[rules]]
+id = "feishu-cn-domains"
+description = "bytedance.feishu.cn domains"
+regex = '''.{0,20}.bytedance\.feishu\.cn.{0,50}'''
+
+[[rules]]
+id = "larkoffice-com-domains"
+description = "bytedance.larkoffice.com domains"
+regex = '''.{0,20}.bytedance\.larkoffice\.com.{0,50}'''
+
+[[rules]]
+id = "private-ip-10-range"
+description = "Private IP address pattern (10.x.x.x)"
+regex = '''(10\.\d{1,3}\.\d{1,3}\.\d{1,3})'''

.pre-commit-config.yaml

@@ -9,4 +9,8 @@ repos:
       args: [ --fix ]
     # Run the formatter.
     - id: ruff-format
-      types_or: [ python, pyi ]
+      types_or: [ python, pyi ]
+- repo: https://github.com/gitleaks/gitleaks
+  rev: v8.24.2
+  hooks:
+    - id: gitleaks

tests/test_cloud.py

@@ -14,9 +14,9 @@
 
 import os
 import tempfile
-import pytest
+from unittest.mock import AsyncMock, Mock, patch
 
-from unittest.mock import Mock, patch, AsyncMock
+import pytest
 
 os.environ["VOLCENGINE_ACCESS_KEY"] = "test_access_key"
 os.environ["VOLCENGINE_SECRET_KEY"] = "test_secret_key"
@@ -110,7 +110,7 @@ async def test_cloud():
                 # Test CloudApp delete_self functionality
                 with patch("builtins.input", return_value="y"):
                     with patch(
-                        "veadk.cli.services.vefaas.vefaas.VeFaaS"
+                        "veadk.integrations.ve_faas.ve_faas.VeFaaS"
                     ) as mock_vefaas_in_app:
                         mock_vefaas_client = Mock()
                         mock_vefaas_in_app.return_value = mock_vefaas_client

veadk/cli/cli.py

@@ -1,19 +1,41 @@
+# 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.
+
 import click
 
 from veadk.cli.cli_deploy import deploy
 from veadk.cli.cli_init import init
 from veadk.cli.cli_prompt import prompt
+from veadk.cli.cli_studio import studio
+from veadk.cli.cli_web import web
+from veadk.version import VERSION
 
 
 @click.group()
+@click.version_option(
+    version=VERSION, prog_name="Volcengine Agent Development Kit (VeADK)"
+)
 def veadk():
     """Volcengine ADK command line tools"""
     pass
 
 
 veadk.add_command(deploy)
-veadk.add_command(prompt)
 veadk.add_command(init)
+veadk.add_command(prompt)
+veadk.add_command(studio)
+veadk.add_command(web)
 
 if __name__ == "__main__":
     veadk()

veadk/cli/cli_deploy.py

@@ -1,3 +1,17 @@
+# 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.
+
 import click
 
 

veadk/cli/cli_init.py

@@ -1,3 +1,17 @@
+# 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 typing import Any
 
 import click

veadk/cli/cli_prompt.py

@@ -1,3 +1,17 @@
+# 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.
+
 import click
 
 

veadk/cli/cli_studio.py

@@ -0,0 +1,55 @@
+# 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.
+
+import click
+
+
+@click.command()
+@click.option("--path", default=".", help="Path to the agent directory")
+def studio(path: str) -> None:
+    """Run VeADK Studio with the specified agent. The VeADK Studio will be deprecated soon."""
+    import os
+    from pathlib import Path
+
+    import uvicorn
+
+    from veadk.cli.studio.fast_api import get_fast_api_app
+    from veadk.utils.misc import load_module_from_file
+
+    path = str(Path(path).resolve())
+
+    agent_py_path = os.path.join(path, "agent.py")
+
+    module = load_module_from_file(
+        module_name="local_agent", file_path=str(agent_py_path)
+    )
+
+    agent = None
+    short_term_memory = None
+    try:
+        agent = module.agent
+        short_term_memory = module.short_term_memory
+    except AttributeError as e:
+        missing = str(e).split("'")[1] if "'" in str(e) else "unknown"
+        raise AttributeError(f"agent.py is missing required variable: {missing}")
+
+    app = get_fast_api_app(agent, short_term_memory)
+
+    uvicorn.run(
+        app,
+        host="127.0.0.1",
+        port=8000,
+        log_level="info",
+        loop="asyncio",  # for deepeval
+    )

veadk/cli/cli_web.py

@@ -1,2 +1,85 @@
-def web():
-    pass
+# 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.
+
+import click
+
+
+@click.command()
+@click.option("--host", default="127.0.0.1", help="Host to run the web server on")
+def web(host: str) -> None:
+    """Launch web with long term and short term memory."""
+    import os
+    from typing import Any
+
+    from google.adk.cli.utils.shared_value import SharedValue
+
+    from veadk.memory.short_term_memory import ShortTermMemory
+    from veadk.utils.logger import get_logger
+
+    logger = get_logger(__name__)
+
+    def init_for_veadk(
+        self,
+        *,
+        agent_loader: Any,
+        session_service: Any,
+        memory_service: Any,
+        artifact_service: Any,
+        credential_service: Any,
+        eval_sets_manager: Any,
+        eval_set_results_manager: Any,
+        agents_dir: str,
+    ):
+        self.agent_loader = agent_loader
+        self.artifact_service = artifact_service
+        self.credential_service = credential_service
+        self.eval_sets_manager = eval_sets_manager
+        self.eval_set_results_manager = eval_set_results_manager
+        self.agents_dir = agents_dir
+        self.runners_to_clean = set()
+        self.current_app_name_ref = SharedValue(value="")
+        self.runner_dict = {}
+
+        short_term_memory_backend = os.getenv("SHORT_TERM_MEMORY_BACKEND")
+        if not short_term_memory_backend:  # prevent None or empty string
+            short_term_memory_backend = "local"
+        logger.info(f"Short term memory: backend={short_term_memory_backend}")
+
+        long_term_memory_backend = os.getenv("LONG_TERM_MEMORY_BACKEND")
+        long_term_memory = None
+
+        if long_term_memory_backend:
+            from veadk.memory.long_term_memory import LongTermMemory
+
+            logger.info(f"Long term memory: backend={long_term_memory_backend}")
+            long_term_memory = LongTermMemory(backend=long_term_memory_backend)  # type: ignore
+        else:
+            logger.info("No long term memory backend settings detected.")
+
+        self.session_service = ShortTermMemory(
+            backend=short_term_memory_backend  # type: ignore
+        ).session_service
+
+        self.memory_service = long_term_memory
+
+    import google.adk.cli.adk_web_server
+
+    google.adk.cli.adk_web_server.AdkWebServer.__init__ = init_for_veadk
+
+    import google.adk.cli.cli_tools_click as cli_tools_click
+
+    agents_dir = os.getcwd()
+    logger.info(f"Load agents from {agents_dir}")
+
+    cli_tools_click.cli_web.main(args=[agents_dir, "--host", host])