set up initial test for sync operation

Author: AlePouroullis

poetry.lock

@@ -1,5 +1,8 @@
 [project]
 name = "humanloop"
+description = "The Humanloop Python Library"
+authors = []
+keywords = ["ai", "machine-learning", "llm", "sdk", "humanloop"]
 
 [tool.poetry]
 name = "humanloop"
@@ -54,7 +57,7 @@ pydantic = ">= 1.9.2"
 pydantic-core = "^2.18.2"
 typing_extensions = ">= 4.0.0"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 mypy = "1.0.1"
 pytest = "^7.4.0"
 pytest-asyncio = "^0.23.5"

pyproject.toml

@@ -347,6 +347,9 @@ def agent():
             path=path,
             attributes=attributes,
         )
+    
+    def sync(self):
+        return "Hello world"
 
 
 class AsyncHumanloop(AsyncBaseHumanloop):

src/humanloop/client.py

@@ -192,7 +192,10 @@ def api_keys() -> APIKeys:
 
 @pytest.fixture(scope="session")
 def humanloop_client(api_keys: APIKeys) -> Humanloop:
-    return Humanloop(api_key=api_keys.humanloop)
+    return Humanloop(
+        api_key=api_keys.humanloop,
+        base_url="http://localhost:80/v5",
+    )
 
 
 @pytest.fixture(scope="session", autouse=True)

src/humanloop/sync/__init__.py

@@ -0,0 +1,95 @@
+import pytest
+from humanloop import Humanloop, FileType
+from pathlib import Path
+from typing import List, NamedTuple
+
+
+class SyncableFile(NamedTuple):
+    path: str
+    type: FileType
+    model: str
+    id: str = ""
+
+
+@pytest.fixture
+def test_file_structure(humanloop_client: Humanloop, get_test_path) -> List[SyncableFile]:
+    """Creates a predefined structure of files in Humanloop for testing sync"""
+    files: List[SyncableFile] = [
+        SyncableFile(
+            path="prompts/gpt-4",
+            type="prompt",
+            model="gpt-4",
+        ),
+        SyncableFile(
+            path="prompts/gpt-4o",
+            type="prompt",
+            model="gpt-4o",
+        ),
+        SyncableFile(
+            path="prompts/nested/complex/gpt-4o",
+            type="prompt",
+            model="gpt-4o",
+        ),
+        SyncableFile(
+            path="agents/gpt-4",
+            type="agent",
+            model="gpt-4",
+        ),
+        SyncableFile(
+            path="agents/gpt-4o",
+            type="agent",
+            model="gpt-4o",
+        ),
+    ]
+
+    # Create the files in Humanloop
+    created_files = []
+    for file in files:
+        full_path = get_test_path(file.path)
+        if file.type == "prompt":
+            response = humanloop_client.prompts.upsert(
+                path=full_path,
+                model=file.model,
+            )
+        elif file.type == "agent":
+            response = humanloop_client.agents.upsert(
+                path=full_path,
+                model=file.model,
+            )
+        created_files.append(SyncableFile(path=full_path, type=file.type, model=file.model, id=response.id))
+
+    return created_files
+
+
+@pytest.fixture
+def cleanup_local_files():
+    """Cleanup any locally synced files after tests"""
+    yield
+    # Clean up the local humanloop directory after tests
+    local_dir = Path("humanloop")
+    if local_dir.exists():
+        import shutil
+
+        shutil.rmtree(local_dir)
+
+
+def test_sync_basic(humanloop_client: Humanloop, test_file_structure: List[SyncableFile], cleanup_local_files):
+    """Test that humanloop.sync() correctly syncs remote files to local filesystem"""
+    # Run the sync
+    successful_files = humanloop_client.sync()
+
+    # Verify each file was synced correctly
+    for file in test_file_structure:
+        # Get the extension based on file type: .prompt, .agent
+        extension = f".{file.type}"
+
+        # The local path should mirror the remote path structure
+        local_path = Path("humanloop") / f"{file.path}{extension}"
+
+        # Basic assertions
+        assert local_path.exists(), f"Expected synced file at {local_path}"
+        assert local_path.parent.exists(), f"Expected directory at {local_path.parent}"
+
+        # Verify it's not empty
+        content = local_path.read_text()
+        assert content, f"File at {local_path} should not be empty"