feat(sandbox): add sandbox module

.env.example

@@ -0,0 +1,35 @@
+# Copy this file to .env in the project root before running sandbox examples
+# or sandbox integration tests.
+
+# Sandbox API key auth.
+QINIU_SANDBOX_API_KEY=
+
+# Optional custom endpoint.
+# QINIU_SANDBOX_ENDPOINT is the preferred name; QINIU_SANDBOX_API_URL and
+# E2B_API_URL are also accepted by the SDK for compatibility.
+QINIU_SANDBOX_ENDPOINT=
+
+# Optional template alias or ID. Defaults to base.
+QINIU_SANDBOX_TEMPLATE=base
+
+# Required only for injection-rule and Kodo resource examples/tests.
+QINIU_SANDBOX_ACCESS_KEY=
+QINIU_SANDBOX_SECRET_KEY=
+
+# Optional Git remote examples.
+GIT_REPO_URL=
+GIT_USERNAME=
+GIT_PASSWORD=
+
+# Optional Git repository resource example.
+GITHUB_TOKEN=
+QINIU_SANDBOX_GIT_MOUNT_PATH=/workspace/repo
+
+# Optional Kodo resource example.
+QINIU_SANDBOX_KODO_BUCKET=
+QINIU_SANDBOX_KODO_MOUNT_PATH=/workspace/kodo
+QINIU_SANDBOX_KODO_PREFIX=
+
+# Optional request injection examples.
+QINIU_SANDBOX_HTTP_INJECTION_TOKEN=real_token
+QINIU_SANDBOX_OPENAI_API_KEY=

.github/workflows/ci-test.yml

@@ -1,5 +1,11 @@
-on: [push]
 name: Run Test Cases
+on:
+  - push
+  - pull_request
+
+permissions:
+  contents: read
+
 jobs:
   test:
     strategy:
@@ -29,6 +35,9 @@ jobs:
         run: |
           MAJOR=$(echo "$PYTHON_VERSION" | cut -d'.' -f1)
           MINOR=$(echo "$PYTHON_VERSION" | cut -d'.' -f2)
+          if ! python -m pip --version >/dev/null 2>&1; then
+            conda install -y pip
+          fi
           # reinstall pip by some python(<3.7) not compatible
           if ! [[ $MAJOR -ge 3 && $MINOR -ge 7 ]]; then
             cd /tmp
@@ -49,7 +58,31 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install -I -e ".[dev]"
+      - name: Run public cases
+        if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository }}
+        shell: bash -el {0}
+        env:
+          MOCK_SERVER_ADDRESS: "http://127.0.0.1:9000"
+        run: |
+          flake8 --show-source --max-line-length=160 ./qiniu
+          python -m pytest \
+            tests/cases/test_auth.py \
+            tests/cases/test_http/test_endpoint.py \
+            tests/cases/test_http/test_endpoints_retry_policy.py \
+            tests/cases/test_http/test_middleware.py \
+            tests/cases/test_http/test_qiniu_conf.py \
+            tests/cases/test_http/test_region.py \
+            tests/cases/test_http/test_regions_retry_policy.py \
+            tests/cases/test_http/test_resp.py \
+            tests/cases/test_http/test_single_flight.py \
+            tests/cases/test_retry \
+            tests/cases/test_utils.py \
+            tests/cases/test_services/test_sandbox/test_client.py \
+            tests/cases/test_services/test_sandbox/test_config.py \
+            tests/cases/test_services/test_sandbox/test_envd.py \
+            tests/cases/test_services/test_sandbox/test_example_config.py
       - name: Run cases
+        if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}
         shell: bash -el {0}
         env:
           QINIU_ACCESS_KEY: ${{ secrets.QINIU_ACCESS_KEY }}
@@ -75,6 +108,7 @@ jobs:
         run: |
           cat py-mock-server.log
       - name: Upload results to Codecov
+        if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
@@ -106,6 +140,10 @@ jobs:
           PYTHON_VERSION: ${{ matrix.python_version }}
           PIP_BOOTSTRAP_SCRIPT_PREFIX: https://bootstrap.pypa.io/pip
         run: |
+          $null = python -m pip --version
+          if ($LASTEXITCODE -ne 0) {
+            conda install -y pip
+          }
           # reinstall pip by some python(<3.7) not compatible
           $pyversion = [Version]"$ENV:PYTHON_VERSION"
           if ($pyversion -lt [Version]"3.7") {
@@ -117,7 +155,47 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install -I -e ".[dev]"
+      - name: Run public cases
+        if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository }}
+        env:
+          MOCK_SERVER_ADDRESS: "http://127.0.0.1:9000"
+          PYTHONPATH: "$PYTHONPATH:."
+        run: |
+          Write-Host "======== Setup Mock Server ========="
+          conda create -y -n mock-server python=3.10
+          conda activate mock-server
+          python --version
+          $processOptions = @{
+            FilePath="python"
+            ArgumentList="tests\mock_server\main.py", "--port", "9000"
+            PassThru=$true
+            RedirectStandardOutput="py-mock-server.log"
+          }
+          $mocksrvp = Start-Process @processOptions
+          $mocksrvp.Id | Out-File -FilePath "mock-server.pid"
+          conda deactivate
+          Sleep 3
+          Write-Host "======== Running Public Test ========="
+          python --version
+          flake8 --show-source --max-line-length=160 ./qiniu
+          python -m pytest `
+            tests/cases/test_auth.py `
+            tests/cases/test_http/test_endpoint.py `
+            tests/cases/test_http/test_endpoints_retry_policy.py `
+            tests/cases/test_http/test_middleware.py `
+            tests/cases/test_http/test_qiniu_conf.py `
+            tests/cases/test_http/test_region.py `
+            tests/cases/test_http/test_regions_retry_policy.py `
+            tests/cases/test_http/test_resp.py `
+            tests/cases/test_http/test_single_flight.py `
+            tests/cases/test_retry `
+            tests/cases/test_utils.py `
+            tests/cases/test_services/test_sandbox/test_client.py `
+            tests/cases/test_services/test_sandbox/test_config.py `
+            tests/cases/test_services/test_sandbox/test_envd.py `
+            tests/cases/test_services/test_sandbox/test_example_config.py
       - name: Run cases
+        if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}
         env:
           QINIU_ACCESS_KEY: ${{ secrets.QINIU_ACCESS_KEY }}
           QINIU_SECRET_KEY: ${{ secrets.QINIU_SECRET_KEY }}
@@ -148,6 +226,7 @@ jobs:
           python -m pytest ./test_qiniu.py tests --cov qiniu --cov-report=xml
       - name: Post Setup mock server
         if: ${{ always() }}
+        continue-on-error: true
         run: |
           Try {
             $mocksrvpid = Get-Content -Path "mock-server.pid"
@@ -158,9 +237,11 @@ jobs:
           }
       - name: Print mock server log
         if: ${{ failure() }}
+        continue-on-error: true
         run: |
           Get-Content -Path "py-mock-server.log" | Write-Host
       - name: Upload results to Codecov
+        if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 *.swp
 *.pyc
+.env
 
 *.py[cod]
 

examples/sandbox_commands.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+from qiniu.services.sandbox import SandboxError
+
+from sandbox_common import cleanup_sandbox, create_sandbox, run_example
+
+
+def main():
+    sandbox = create_sandbox(metadata={'example': 'sandbox_commands'})
+    try:
+        stdout = []
+        result = sandbox.commands.run(
+            'printf command-callback',
+            on_stdout=stdout.append,
+        )
+        print('run:', result.stdout)
+        print('callback:', ''.join(stdout))
+
+        handle = sandbox.commands.start(
+            'read line; echo "stdin:$line"',
+            stdin=True,
+            tag='qiniu-python-sdk-commands',
+            timeout=30,
+        )
+        print('started pid:', handle.pid)
+        print('processes:', [
+            item.pid for item in sandbox.commands.list()
+            if item.pid == handle.pid or item.tag == 'qiniu-python-sdk-commands'
+        ])
+        try:
+            sandbox.commands.send_stdin(handle.pid, 'hello\n')
+            sandbox.commands.close_stdin(handle.pid)
+            print('stdin result:', handle.wait().stdout.strip())
+        except SandboxError as err:
+            print('stdin skipped:', err)
+            try:
+                sandbox.commands.kill(handle.pid)
+            except SandboxError:
+                pass
+
+        sleeper = sandbox.commands.run(
+            'sleep 30',
+            background=True,
+            tag='qiniu-python-sdk-kill',
+        )
+        print('background pid:', sleeper.pid)
+        try:
+            connected = sandbox.commands.connect(sleeper.pid)
+            print('connect running pid:', connected.pid)
+        except SandboxError as err:
+            print('connect running process skipped:', err)
+        try:
+            print('kill background:', sandbox.commands.kill(sleeper.pid))
+        except SandboxError as err:
+            print('kill background skipped:', err)
+    finally:
+        cleanup_sandbox(sandbox)
+
+
+if __name__ == '__main__':
+    run_example(main)

examples/sandbox_common.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+import os
+
+from qiniu.services.sandbox import Sandbox
+from qiniu.services.sandbox.config import (
+    env,
+    load_dotenv_if_present,
+    required_env,
+    sandbox_client,
+    sandbox_template,
+)
+
+
+__all__ = [
+    'cleanup_sandbox',
+    'create_sandbox',
+    'env',
+    'load_example_env',
+    'required_env',
+    'run_example',
+    'sandbox_client',
+    'sandbox_template',
+]
+
+
+def load_example_env():
+    root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+    load_dotenv_if_present(
+        os.path.join(root, '.env'),
+        os.path.join(os.getcwd(), '.env'),
+    )
+
+
+def create_sandbox(**options):
+    client = options.pop('client', None) or sandbox_client()
+    template = options.pop('template', sandbox_template())
+    options.setdefault('timeout', 300)
+    sandbox = Sandbox.create(template, client=client, **options)
+    print('Sandbox created:', sandbox.sandbox_id)
+    return sandbox
+
+
+def cleanup_sandbox(sandbox):
+    if sandbox is None:
+        return
+    try:
+        sandbox.kill()
+        print('Sandbox killed:', sandbox.sandbox_id)
+    except Exception as err:
+        print('Failed to kill sandbox:', sandbox.sandbox_id, err)
+
+
+def run_example(fn):
+    load_example_env()
+    try:
+        fn()
+    except Exception as err:
+        print(err)
+        raise

examples/sandbox_connect.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+from qiniu.services.sandbox import Sandbox
+from sandbox_common import (
+    cleanup_sandbox,
+    create_sandbox,
+    run_example,
+    sandbox_client,
+)
+
+
+def main():
+    client = sandbox_client()
+    sandbox = create_sandbox(
+        client=client,
+        timeout=300,
+        metadata={'example': 'sandbox_connect'},
+    )
+    try:
+        items = Sandbox.list(client=client, limit=10).next_items()
+        print('list:', [item.sandbox_id for item in items])
+
+        connected = Sandbox.connect(
+            sandbox.sandbox_id,
+            client=client,
+            timeout=300,
+        )
+        print('connected:', connected.sandbox_id)
+        print('envd:', connected.envd_url())
+        print('uptime:', connected.commands.run('uptime').stdout)
+    finally:
+        cleanup_sandbox(sandbox)
+
+
+if __name__ == '__main__':
+    run_example(main)

examples/sandbox_create.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+from sandbox_common import cleanup_sandbox, create_sandbox, run_example
+
+
+def main():
+    sandbox = create_sandbox(
+        metadata={'example': 'sandbox_create'},
+        envs={'HELLO': 'qiniu'},
+    )
+    try:
+        print('sandbox:', sandbox.sandbox_id)
+        result = sandbox.commands.run('printf "$HELLO"')
+        print('stdout:', result.stdout)
+
+        sandbox.files.write('/tmp/qiniu.txt', 'hello from qiniu sandbox')
+        print('file:', sandbox.files.read_text('/tmp/qiniu.txt'))
+    finally:
+        cleanup_sandbox(sandbox)
+
+
+if __name__ == '__main__':
+    run_example(main)