weaviate-cli 3.1.4__tar.gz → 3.2.0__tar.gz

weaviate_cli-3.2.0/.github/workflows/main.yaml

@@ -0,0 +1,132 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint-and-format:
+    name: Run Linter and Formatter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install -r requirements-dev.txt
+      - name: "Black"
+        run: black --check cli.py weaviate_cli test
+      - name: "Check release for pypi"
+        run: |
+          python -m build
+          python -m twine check dist/*
+
+  unit-tests:
+    name: Run Unit Tests
+    needs: [lint-and-format]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.version }}
+    - run: pip install -e .
+    - name: Run unit tests with pytest
+      run: |
+        pip install pytest-html
+        pytest test/unittests --html=test-report-${{ matrix.version }}.html --self-contained-html
+    - name: Upload test results
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-results-${{ matrix.version }}
+        path: test-report-${{ matrix.version }}.html
+
+  get-latest-weaviate-version:
+    runs-on: ubuntu-latest
+    needs: [unit-tests]
+    name: Get latest Weaviate version
+    outputs:
+      LATEST_WEAVIATE_VERSION: ${{ steps.latest-version.outputs.latest_weaviate_version }}
+    steps:
+      - name: Retrieve latest Weaviate version
+        id: latest-version
+        uses: weaviate/github-common-actions/.github/actions/get-latest-weaviate-version@main
+
+  integration-tests:
+    needs: [unit-tests, get-latest-weaviate-version]
+    env:
+      WEAVIATE_VERSION: ${{ needs.get-latest-weaviate-version.outputs.LATEST_WEAVIATE_VERSION }}
+      MODULES: "text2vec-transformers,text2vec-contextionary"
+    name: Run Integration Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.version }}
+    - run: pip install -e .
+    - name: Start up Weaviate cluster
+      uses: weaviate/weaviate-local-k8s@v2
+      with:
+        workers: 1
+        replicas: 1
+        weaviate-version: ${{ env.WEAVIATE_VERSION }}
+        modules: ${{ env.MODULES }}
+        enable-backup: true
+        dynamic-users: true
+    - name: Run integration tests with pytest
+      run: |
+        pip install pytest-html
+        pytest test/integration/test_integration.py --html=test-report-${{ matrix.version }}.html --self-contained-html
+  integration-auth-tests:
+    needs: [unit-tests, get-latest-weaviate-version]
+    env:
+      WEAVIATE_VERSION: ${{ needs.get-latest-weaviate-version.outputs.LATEST_WEAVIATE_VERSION }}
+      MODULES: "text2vec-transformers,text2vec-contextionary"
+    name: Run Integration Tests Auth
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.version }}
+    - run: pip install -e .
+    - name: Start up Weaviate cluster
+      uses: weaviate/weaviate-local-k8s@v2
+      with:
+        workers: 1
+        replicas: 1
+        weaviate-version: ${{ env.WEAVIATE_VERSION }}
+        modules: ${{ env.MODULES }}
+        enable-backup: true
+        rbac: true
+        dynamic-users: true
+    - name: Create config directory
+      run: mkdir -p ~/.config/weaviate
+    - name: Create config file
+      run: |
+        echo '{
+          "host": "localhost",
+          "http_port": "8080",
+          "grpc_port": "50051",
+          "auth": {
+              "type": "api_key",
+              "api_key": "admin-key"
+          }
+        }' > ~/.config/weaviate/config.json
+    - name: Run integration auth tests with pytest
+      run: |
+        pip install pytest-html
+        pytest test/integration/test_auth_integration.py --html=test-auth-report-${{ matrix.version }}.html --self-contained-html

{weaviate_cli-3.1.4 → weaviate_cli-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: weaviate-cli
-Version: 3.1.4
+Version: 3.2.0
 Summary: Command line interface to interact with weaviate
 Home-page: https://github.com/weaviate/weaviate-cli
 Download-URL: https://github.com/weaviate/weaviate-cli
@@ -28,13 +28,15 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: weaviate-client>=4.11.0
+Requires-Dist: weaviate-client>=4.12.0
 Requires-Dist: click==8.1.7
 Requires-Dist: semver>=3.0.2
 Requires-Dist: numpy>=1.24.0
 Requires-Dist: importlib-resources>=5.0.0
 Requires-Dist: prettytable>=3.1.0
+Requires-Dist: faker>=20.0.0
 Dynamic: download-url
+Dynamic: license-file
 
 # Weaviate CLI
 
@@ -118,6 +120,7 @@ The configuration file should be a JSON file with the following structure:
     "host": "your-weaviate-host",
     "http_port": "your-http-port",
     "grpc_port": "your-grpc-port",
+    "grpc_host": "your-grpc-host",
     "auth": {
         "type": "api_key",
         "api_key": "your-api-key"

{weaviate_cli-3.1.4 → weaviate_cli-3.2.0}/README.md

@@ -80,6 +80,7 @@ The configuration file should be a JSON file with the following structure:
     "host": "your-weaviate-host",
     "http_port": "your-http-port",
     "grpc_port": "your-grpc-port",
+    "grpc_host": "your-grpc-host",
     "auth": {
         "type": "api_key",
         "api_key": "your-api-key"

{weaviate_cli-3.1.4 → weaviate_cli-3.2.0}/requirements-dev.txt

@@ -1,4 +1,4 @@
-weaviate-client>=4.11.0
+weaviate-client>=4.12.0
 click==8.1.7
 twine
 pytest
@@ -12,3 +12,4 @@ setuptools_scm
 black==24.3.0
 pre-commit==3.6.2
 prettytable>=3.1.0
+faker>=20.0.0

{weaviate_cli-3.1.4 → weaviate_cli-3.2.0}/setup.cfg

@@ -36,12 +36,13 @@ classifiers =
 include_package_data = True
 python_requires = >=3.9
 install_requires = 
-	weaviate-client>=4.11.0
+	weaviate-client>=4.12.0
 	click==8.1.7
 	semver>=3.0.2
 	numpy>=1.24.0
 	importlib-resources>=5.0.0
 	prettytable>=3.1.0
+	faker>=20.0.0
 setup_requires = 
 	pip
 	setuptools

weaviate_cli-3.2.0/test/integration/test_auth_integration.py

@@ -0,0 +1,56 @@
+import pytest
+import weaviate
+import click
+from click.testing import CliRunner
+from weaviate_cli.managers.collection_manager import CollectionManager
+from weaviate_cli.managers.config_manager import ConfigManager
+from weaviate_cli.managers.user_manager import UserManager
+import weaviate.classes.config as wvc
+
+
+@pytest.fixture
+def client() -> weaviate.Client:
+    config = ConfigManager()
+    return config.get_client()
+
+
+@pytest.fixture
+def collection_manager(client: weaviate.Client) -> CollectionManager:
+    return CollectionManager(client)
+
+
+@pytest.fixture
+def user_manager(client: weaviate.Client) -> UserManager:
+    return UserManager(client)
+
+
+def test_user_lifecycle(user_manager: UserManager):
+    try:
+        user_name = "test_user"
+        # Create user
+        api_key = user_manager.create_user(user_name=user_name)
+        assert user_name in [user.user_id for user in user_manager.get_all_users()]
+        assert api_key is not None
+
+        # Update user
+        new_api_key = user_manager.update_user(user_name=user_name, rotate_api_key=True)
+        assert new_api_key is not None
+        assert new_api_key != api_key
+
+        # Deactivate user
+        user_manager.update_user(user_name=user_name, deactivate=True)
+        user = user_manager.get_user(user_name=user_name)
+        assert not user.active
+
+        # Activate user
+        user_manager.update_user(user_name=user_name, activate=True)
+        user = user_manager.get_user(user_name=user_name)
+        assert user.active
+
+        # Print user
+        user_manager.print_user(user=user_name)
+
+    finally:
+        # Delete user
+        user_manager.delete_user(user_name=user_name)
+        assert user_name not in [user.user_id for user in user_manager.get_all_users()]

{weaviate_cli-3.1.4 → weaviate_cli-3.2.0}/test/integration/test_integration.py

@@ -1,6 +1,5 @@
 import pytest
 import weaviate
-import click
 from click.testing import CliRunner
 from weaviate_cli.managers.collection_manager import CollectionManager
 from weaviate_cli.managers.config_manager import ConfigManager
@@ -12,11 +11,7 @@ import weaviate.classes.config as wvc
 @pytest.fixture
 def client() -> weaviate.Client:
     config = ConfigManager()
-    return weaviate.connect_to_local(
-        host=config.config["host"],
-        port=int(config.config["http_port"]),
-        grpc_port=int(config.config["grpc_port"]),
-    )
+    return config.get_client()
 
 
 @pytest.fixture

{weaviate_cli-3.1.4 → weaviate_cli-3.2.0}/test/unittests/test_defaults.py

@@ -92,7 +92,7 @@ def test_create_tenants_defaults(runner):
     mock_collection.tenants.get.return_value = empty_tenants
 
     mock_tenants = {
-        f"{CreateTenantsDefaults.tenant_suffix}{i}": MagicMock(
+        f"{CreateTenantsDefaults.tenant_suffix}-{i}": MagicMock(
             activity_status=TenantActivityStatus.ACTIVE
         )
         for i in range(CreateTenantsDefaults.number_tenants)
@@ -134,7 +134,19 @@ def test_create_data_defaults(runner):
     # Create mock context with config
     ctx = click.Context(create_data_cli)
     ctx.obj = {"config": MagicMock()}
-    ctx.obj["config"].get_client = MagicMock()
+    mock_client = MagicMock()
+    mock_client.collections.exists.return_value = True
+
+    # Mock collection object
+    mock_collection = MagicMock()
+    mock_client.collections.get.return_value = mock_collection
+
+    # Mock multi-tenancy config
+    mock_config = MagicMock()
+    mock_config.multi_tenancy_config.enabled = False
+    mock_collection.config.get.return_value = mock_config
+
+    ctx.obj["config"].get_client.return_value = mock_client
 
     result = runner.invoke(create_data_cli, obj=ctx.obj)
     assert result.exit_code == 0, result.output
@@ -179,7 +191,7 @@ def test_delete_tenants_defaults(runner):
 
     # Mock tenants with side effect to return different values on subsequent calls
     mock_tenants = {
-        f"{DeleteTenantsDefaults.tenant_suffix}{i}": MagicMock()
+        f"{DeleteTenantsDefaults.tenant_suffix}-{i}": MagicMock()
         for i in range(1, DeleteTenantsDefaults.number_tenants + 1)
     }
     empty_tenants = {}
@@ -365,7 +377,7 @@ def test_update_tenants_defaults(runner):
 
     # Mock tenants with side effect to return different values on subsequent calls
     mock_tenants = {
-        f"{UpdateTenantsDefaults.tenant_suffix}{i}": MagicMock(
+        f"{UpdateTenantsDefaults.tenant_suffix}-{i}": MagicMock(
             activity_status=TenantActivityStatus.ACTIVE
         )
         for i in range(UpdateTenantsDefaults.number_tenants)
@@ -373,7 +385,7 @@ def test_update_tenants_defaults(runner):
     mock_collection.tenants.get.return_value = mock_tenants
 
     updated_tenants = {
-        f"{UpdateTenantsDefaults.tenant_suffix}{i}": MagicMock(
+        f"{UpdateTenantsDefaults.tenant_suffix}-{i}": MagicMock(
             activity_status=TenantActivityStatus.ACTIVE
         )
         for i in range(UpdateTenantsDefaults.number_tenants)

{weaviate_cli-3.1.4 → weaviate_cli-3.2.0}/test/unittests/test_managers/test_data_manager.py

@@ -22,6 +22,7 @@ def test_ingest_data(mock_client):
         collection="TestCollection",
         limit=100,
         randomize=True,
+        auto_tenants=10,
     )
 
     mock_client.collections.get.assert_called_once_with("TestCollection")

weaviate_cli-3.2.0/test/unittests/test_managers/test_user_manager.py

@@ -0,0 +1,325 @@
+import pytest
+from unittest.mock import Mock, patch
+from weaviate_cli.managers.user_manager import UserManager
+from weaviate.exceptions import WeaviateConnectionError
+
+
+@pytest.fixture
+def mock_client():
+    client = Mock()
+    return client
+
+
+@pytest.fixture
+def user_manager(mock_client):
+    return UserManager(mock_client)
+
+
+def test_get_user_from_role_success(user_manager):
+    # Arrange
+    role_name = "test_role"
+    expected_users = ["user1", "user2"]
+    user_manager.client.roles.get_assigned_user_ids.return_value = expected_users
+
+    # Act
+    result = user_manager.get_user_from_role(role_name)
+
+    # Assert
+    assert result == expected_users
+    user_manager.client.roles.get_assigned_user_ids.assert_called_once_with(
+        role_name=role_name
+    )
+
+
+def test_get_user_from_role_error(user_manager):
+    # Arrange
+    role_name = "test_role"
+    user_manager.client.roles.get_assigned_user_ids.side_effect = Exception(
+        "Test error"
+    )
+
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.get_user_from_role(role_name)
+    assert (
+        str(exc_info.value) == f"Error getting users for role '{role_name}': Test error"
+    )
+
+
+def test_create_user_success(user_manager):
+    # Arrange
+    user_name = "test_user"
+    expected_api_key = "test_api_key"
+    user_manager.client.users.db.create.return_value = expected_api_key
+
+    # Act
+    result = user_manager.create_user(user_name)
+
+    # Assert
+    assert result == expected_api_key
+    user_manager.client.users.db.create.assert_called_once_with(user_id=user_name)
+
+
+def test_create_user_no_name(user_manager):
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.create_user(None)
+    assert str(exc_info.value) == "User name is required."
+
+
+def test_create_user_error(user_manager):
+    # Arrange
+    user_name = "test_user"
+    user_manager.client.users.db.create.side_effect = Exception("Test error")
+
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.create_user(user_name)
+    assert str(exc_info.value) == f"Error creating user '{user_name}': Test error"
+
+
+def test_update_user_rotate_key_success(user_manager):
+    # Arrange
+    user_name = "test_user"
+    expected_api_key = "new_api_key"
+    user_manager.client.users.db.rotate_key.return_value = expected_api_key
+
+    # Act
+    result = user_manager.update_user(user_name=user_name, rotate_api_key=True)
+
+    # Assert
+    assert result == expected_api_key
+    user_manager.client.users.db.rotate_key.assert_called_once_with(user_id=user_name)
+
+
+def test_update_user_activate_success(user_manager):
+    # Arrange
+    user_name = "test_user"
+    user_manager.client.users.db.activate.return_value = None
+
+    # Act
+    result = user_manager.update_user(user_name=user_name, activate=True)
+
+    # Assert
+    assert result is None
+    user_manager.client.users.db.activate.assert_called_once_with(user_id=user_name)
+
+
+def test_update_user_deactivate_success(user_manager):
+    # Arrange
+    user_name = "test_user"
+    user_manager.client.users.db.deactivate.return_value = None
+
+    # Act
+    result = user_manager.update_user(user_name=user_name, deactivate=True)
+
+    # Assert
+    assert result is None
+    user_manager.client.users.db.deactivate.assert_called_once_with(user_id=user_name)
+
+
+def test_update_user_invalid_combination(user_manager):
+    # Arrange
+    user_name = "test_user"
+
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.update_user(
+            user_name=user_name, rotate_api_key=True, activate=True
+        )
+    assert (
+        str(exc_info.value)
+        == "Cannot rotate api key and activate or deactivate user at the same time."
+    )
+
+
+def test_update_user_activate_deactivate(user_manager):
+    # Arrange
+    user_name = "test_user"
+
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.update_user(user_name=user_name, activate=True, deactivate=True)
+    assert (
+        str(exc_info.value) == "Cannot activate and deactivate user at the same time."
+    )
+
+
+def test_update_user_no_name(user_manager):
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.update_user(None)
+    assert str(exc_info.value) == "User name is required."
+
+
+def test_update_user_error(user_manager):
+    # Arrange
+    user_name = "test_user"
+    user_manager.client.users.db.rotate_key.side_effect = Exception("Test error")
+
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.update_user(user_name=user_name, rotate_api_key=True)
+    assert str(exc_info.value) == f"Error updating user '{user_name}': Test error"
+
+
+def test_delete_user_success(user_manager):
+    # Arrange
+    user_name = "test_user"
+
+    # Act
+    user_manager.delete_user(user_name)
+
+    # Assert
+    user_manager.client.users.db.delete.assert_called_once_with(user_id=user_name)
+
+
+def test_delete_user_no_name(user_manager):
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.delete_user(None)
+    assert str(exc_info.value) == "User name is required."
+
+
+def test_delete_user_error(user_manager):
+    # Arrange
+    user_name = "test_user"
+    user_manager.client.users.db.delete.side_effect = Exception("Test error")
+
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.delete_user(user_name)
+    assert str(exc_info.value) == f"Error deleting user '{user_name}': Test error"
+
+
+def test_add_role_db_success(user_manager):
+    # Arrange
+    role_name = ("test_role",)
+    user_name = "test_user"
+    user_manager.client.get_meta.return_value = {"version": "1.30.0"}
+
+    # Act
+    user_manager.add_role(role_name, user_name, "db")
+
+    # Assert
+    user_manager.client.users.db.assign_roles.assert_called_once_with(
+        user_id=user_name, role_names=list(role_name)
+    )
+
+
+def test_add_role_db_success_pre_130(user_manager):
+    # Arrange
+    role_name = ("test_role",)
+    user_name = "test_user"
+    user_manager.client.get_meta.return_value = {"version": "1.29.0"}
+
+    # Act
+    user_manager.add_role(role_name, user_name, "db")
+
+    # Assert
+    user_manager.client.users.assign_roles.assert_called_once_with(
+        user_id=user_name, role_names=list(role_name)
+    )
+
+
+def test_add_role_oidc_success(user_manager):
+    # Arrange
+    role_name = ("test_role",)
+    user_name = "test_user"
+    user_manager.client.get_meta.return_value = {"version": "1.30.0"}
+
+    # Act
+    user_manager.add_role(role_name, user_name, "oidc")
+
+    # Assert
+    user_manager.client.users.oidc.assign_roles.assert_called_once_with(
+        user_id=user_name, role_names=list(role_name)
+    )
+
+
+def test_add_role_error(user_manager):
+    # Arrange
+    role_name = ("test_role",)
+    user_name = "test_user"
+    user_manager.client.get_meta.return_value = {"version": "1.30.0"}
+    user_manager.client.users.db.assign_roles.side_effect = Exception("Test error")
+
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.add_role(role_name, user_name, "db")
+    assert (
+        str(exc_info.value)
+        == f"Error assigning db role '{role_name}' to user '{user_name}': Test error"
+    )
+
+
+def test_revoke_role_db_success(user_manager):
+    # Arrange
+    role_name = ("test_role",)
+    user_name = "test_user"
+    user_manager.client.get_meta.return_value = {"version": "1.30.0"}
+
+    # Act
+    user_manager.revoke_role(role_name, user_name, "db")
+
+    # Assert
+    user_manager.client.users.db.revoke_roles.assert_called_once_with(
+        user_id=user_name, role_names=list(role_name)
+    )
+
+
+def test_revoke_role_db_success_pre_130(user_manager):
+    # Arrange
+    role_name = ("test_role",)
+    user_name = "test_user"
+    user_manager.client.get_meta.return_value = {"version": "1.29.0"}
+
+    # Act
+    user_manager.revoke_role(role_name, user_name, "db")
+
+    # Assert
+    user_manager.client.users.revoke_roles.assert_called_once_with(
+        user_id=user_name, role_names=list(role_name)
+    )
+
+
+def test_revoke_role_oidc_success(user_manager):
+    # Arrange
+    role_name = ("test_role",)
+    user_name = "test_user"
+    user_manager.client.get_meta.return_value = {"version": "1.30.0"}
+    # Act
+    user_manager.revoke_role(role_name, user_name, "oidc")
+
+    # Assert
+    user_manager.client.users.oidc.revoke_roles.assert_called_once_with(
+        user_id=user_name, role_names=list(role_name)
+    )
+
+
+def test_revoke_role_error(user_manager):
+    # Arrange
+    role_name = ("test_role",)
+    user_name = "test_user"
+    user_manager.client.users.db.revoke_roles.side_effect = Exception("Test error")
+    user_manager.client.get_meta.return_value = {"version": "1.30.0"}
+
+    # Act & Assert
+    with pytest.raises(Exception) as exc_info:
+        user_manager.revoke_role(role_name, user_name, "db")
+    assert (
+        str(exc_info.value)
+        == f"Error revoking db role '{role_name}' from user '{user_name}': Test error"
+    )
+
+
+def test_print_user(user_manager, capsys):
+    # Arrange
+    user = "test_user"
+
+    # Act
+    user_manager.print_user(user)
+
+    # Assert
+    captured = capsys.readouterr()
+    assert captured.out == f"User: {user}\n"

{weaviate_cli-3.1.4 → weaviate_cli-3.2.0}/test/unittests/test_utils.py

@@ -222,10 +222,26 @@ def test_parse_permission_roles():
 
 
 def test_parse_permission_users():
+    assert parse_permission("create_users:admin") == Permissions.users(
+        user="admin", create=True
+    )
+
+    assert parse_permission("crud_users:admin") == Permissions.users(
+        user="admin", create=True, read=True, update=True, delete=True
+    )
+
     assert parse_permission("assign_and_revoke_users:admin") == Permissions.users(
         user="admin", assign_and_revoke=True
     )
 
+    assert parse_permission("cr_users:admin1,admin2,viewer1") == Permissions.users(
+        user=["admin1", "admin2", "viewer1"],
+        create=True,
+        read=True,
+        update=False,
+        delete=False,
+    )
+
     assert parse_permission(
         "assign_and_revoke_users:admin,admin1,admin2"
     ) == Permissions.users(user=["admin", "admin1", "admin2"], assign_and_revoke=True)