weaviate-cli 3.0.2__tar.gz → 3.1.0__tar.gz

weaviate_cli-3.1.0/.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Keep GitHub Actions up to date with GitHub's Dependabot...
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    groups:
+      github-actions:
+        patterns:
+          - "*"  # Group all Actions updates into a single larger pull request
+    schedule:
+      interval: weekly

{weaviate_cli-3.0.2 → weaviate_cli-3.1.0}/.github/workflows/main.yaml

@@ -29,10 +29,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: [ "3.9", "3.10", "3.11", "3.12" ]
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.version }}
     - run: pip install -e .
@@ -42,7 +42,7 @@ jobs:
         pytest test/unittests --html=test-report-${{ matrix.version }}.html --self-contained-html
     - name: Upload test results
       if: always()
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: test-results-${{ matrix.version }}
         path: test-report-${{ matrix.version }}.html
@@ -56,10 +56,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: [ "3.9", "3.10", "3.11", "3.12" ]
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.version }}
     - run: pip install -e .

{weaviate_cli-3.0.2 → weaviate_cli-3.1.0}/.github/workflows/release.yaml

@@ -15,7 +15,7 @@ jobs:
           with:
             fetch-depth: 0
         - name: Set up Python 3.11
-          uses: actions/setup-python@v4
+          uses: actions/setup-python@v5
           with:
             python-version: "3.11"
         - name: Install dependencies

{weaviate_cli-3.0.2 → weaviate_cli-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weaviate-cli
-Version: 3.0.2
+Version: 3.1.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,7 +28,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: weaviate-client>=4.5.0
+Requires-Dist: weaviate-client>=4.10.0
 Requires-Dist: click==8.1.7
 Requires-Dist: semver>=3.0.2
 Requires-Dist: numpy>=1.24.0
@@ -50,6 +50,7 @@ A powerful command-line interface for managing and interacting with Weaviate vec
 - **Backup & Restore**: Create and restore backups with support for S3, GCS and filesystem
 - **Sharding**: Monitor and manage collection shards
 - **Flexible Configuration**: Configure vector indexes, replication, consistency levels and more
+- **Role Management**: Assign and revoke roles and permissions to users
 
 ## Quick Start
 Install using pip:
@@ -58,6 +59,11 @@ Install using pip:
 pip install weaviate-cli
 ```
 
+On Mac, install using Homebrew:
+```bash
+brew install weaviate-cli
+```
+
 ## Basic Usage
 
 ```bash
@@ -82,7 +88,8 @@ weaviate-cli query data --collection movies --search-type hybrid --query "action
 - **get**: Retrieve collection info, tenant details or shard status
 - **query**: Search data using various methods
 - **restore**: Restore backups from supported backends
-
+- **assign**: Assign roles and permissions to users
+- **revoke**: Revoke roles and permissions from users
 ## Configuration
 
 Weaviate CLI allows you to configure your cluster endpoints and parameters through a configuration file. By default, the CLI looks for a
@@ -134,9 +141,30 @@ Here you can see an example on how the configuration file should look like if yo
  }
 ```
 
+If you want to allow using different users for different actions in your cluster, you can specify the different users in the configuration file and use the `--user` option to specify which user to use for a specific action.
+An example of how the configuration file should look like is the following:
+
+```json
+{
+    "host": "your-weaviate-host",
+    "auth": {
+        "type": "user",
+        "user1": "your-api-key-for-user1",
+        "user2": "your-api-key-for-user2"
+    }
+}
+```
+It's important to note that the "type" key must be set to "user" and the users must be specified in the auth section.
+When using the `weaviate-cli` command, you can specify the user to use for an action by using the `--user` option. For example:
+
+```bash
+weaviate-cli --user user1 create collection --collection movies --vectorizer transformers
+weaviate-cli --user user2 get collection --collection movies
+```
+
 ## Requirements
 
-- Python 3.9+
+- Python 3.10+
 - Weaviate instance (local or remote)
 
 ## Documentation
@@ -145,6 +173,7 @@ Detailed documentation will be added soon.
 
 ## Supported Model Provider
 
+- Weaviate Embeddings Service (WCD clusters only)
 - Contextionary
 - Transformers
 - OpenAI

{weaviate_cli-3.0.2 → weaviate_cli-3.1.0}/README.md

@@ -14,6 +14,7 @@ A powerful command-line interface for managing and interacting with Weaviate vec
 - **Backup & Restore**: Create and restore backups with support for S3, GCS and filesystem
 - **Sharding**: Monitor and manage collection shards
 - **Flexible Configuration**: Configure vector indexes, replication, consistency levels and more
+- **Role Management**: Assign and revoke roles and permissions to users
 
 ## Quick Start
 Install using pip:
@@ -22,6 +23,11 @@ Install using pip:
 pip install weaviate-cli
 ```
 
+On Mac, install using Homebrew:
+```bash
+brew install weaviate-cli
+```
+
 ## Basic Usage
 
 ```bash
@@ -46,7 +52,8 @@ weaviate-cli query data --collection movies --search-type hybrid --query "action
 - **get**: Retrieve collection info, tenant details or shard status
 - **query**: Search data using various methods
 - **restore**: Restore backups from supported backends
-
+- **assign**: Assign roles and permissions to users
+- **revoke**: Revoke roles and permissions from users
 ## Configuration
 
 Weaviate CLI allows you to configure your cluster endpoints and parameters through a configuration file. By default, the CLI looks for a
@@ -98,9 +105,30 @@ Here you can see an example on how the configuration file should look like if yo
  }
 ```
 
+If you want to allow using different users for different actions in your cluster, you can specify the different users in the configuration file and use the `--user` option to specify which user to use for a specific action.
+An example of how the configuration file should look like is the following:
+
+```json
+{
+    "host": "your-weaviate-host",
+    "auth": {
+        "type": "user",
+        "user1": "your-api-key-for-user1",
+        "user2": "your-api-key-for-user2"
+    }
+}
+```
+It's important to note that the "type" key must be set to "user" and the users must be specified in the auth section.
+When using the `weaviate-cli` command, you can specify the user to use for an action by using the `--user` option. For example:
+
+```bash
+weaviate-cli --user user1 create collection --collection movies --vectorizer transformers
+weaviate-cli --user user2 get collection --collection movies
+```
+
 ## Requirements
 
-- Python 3.9+
+- Python 3.10+
 - Weaviate instance (local or remote)
 
 ## Documentation
@@ -109,6 +137,7 @@ Detailed documentation will be added soon.
 
 ## Supported Model Provider
 
+- Weaviate Embeddings Service (WCD clusters only)
 - Contextionary
 - Transformers
 - OpenAI

{weaviate_cli-3.0.2 → weaviate_cli-3.1.0}/cli.py

@@ -1,3 +1,4 @@
+from typing import Optional
 import click
 import sys
 from weaviate_cli.managers.config_manager import ConfigManager
@@ -8,6 +9,8 @@ from weaviate_cli.commands.update import update
 from weaviate_cli.commands.query import query
 from weaviate_cli.commands.restore import restore
 from weaviate_cli.commands.cancel import cancel
+from weaviate_cli.commands.assign import assign
+from weaviate_cli.commands.revoke import revoke
 from weaviate_cli import __version__
 
 
@@ -26,6 +29,12 @@ def print_version(ctx, param, value):
     is_flag=False,
     help="If specified cli uses the config specified with this path.",
 )
+@click.option(
+    "--user",
+    required=False,
+    type=str,
+    help="If specified cli uses the user specified in the config file.",
+)
 @click.option(
     "--version",
     is_flag=True,
@@ -35,10 +44,10 @@ def print_version(ctx, param, value):
     help="Prints the version of the CLI.",
 )
 @click.pass_context
-def main(ctx: click.Context, config_file):
+def main(ctx: click.Context, config_file: Optional[str], user: Optional[str]):
     """Weaviate CLI tool"""
     try:
-        ctx.obj = {"config": ConfigManager(config_file)}
+        ctx.obj = {"config": ConfigManager(config_file, user)}
     except Exception as e:
         click.echo(f"Fatal Error: {e}")
         sys.exit(1)
@@ -51,6 +60,8 @@ main.add_command(update)
 main.add_command(restore)
 main.add_command(query)
 main.add_command(cancel)
+main.add_command(assign)
+main.add_command(revoke)
 
 if __name__ == "__main__":
     main()

{weaviate_cli-3.0.2 → weaviate_cli-3.1.0}/requirements-dev.txt

@@ -1,4 +1,4 @@
-weaviate-client>=4.0.0
+weaviate-client>=4.10.0
 click==8.1.7
 twine
 pytest

{weaviate_cli-3.0.2 → weaviate_cli-3.1.0}/setup.cfg

@@ -36,7 +36,7 @@ classifiers =
 include_package_data = True
 python_requires = >=3.9
 install_requires = 
-	weaviate-client>=4.5.0
+	weaviate-client>=4.10.0
 	click==8.1.7
 	semver>=3.0.2
 	numpy>=1.24.0

weaviate_cli-3.1.0/test/unittests/test_managers/test_config_manager.py

@@ -0,0 +1,141 @@
+import socket
+import pytest
+import weaviate
+from unittest.mock import MagicMock, mock_open, patch
+from weaviate_cli.managers.config_manager import ConfigManager
+import json
+
+
+def test_init_with_config_file():
+    config_data = {"host": "localhost", "http_port": "8080", "grpc_port": "50051"}
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            config = ConfigManager(config_file="test_config.json")
+            assert config.config == config_data
+
+
+def test_create_default_config():
+    with patch("pathlib.Path.exists") as mock_exists:
+        mock_exists.return_value = False
+        config = ConfigManager()
+        assert config.config["host"] == "localhost"
+        assert config.config["http_port"] == "8080"
+        assert config.config["grpc_port"] == "50051"
+
+
+@patch("socket.create_connection")
+def test_check_host_docker_internal(mock_socket):
+    config = ConfigManager()
+
+    # Test successful connection
+    mock_socket.return_value = MagicMock()
+    assert config._ConfigManager__check_host_docker_internal() == True
+
+
+@patch("socket.create_connection")
+def test_check_host_docker_internal_failed(mock_socket):
+    config = ConfigManager()
+
+    # Test failed connection
+    mock_socket.side_effect = socket.error()
+    assert config._ConfigManager__check_host_docker_internal() == False
+
+
+def test_init_with_user():
+    config_data = {
+        "host": "localhost",
+        "http_port": "8080",
+        "grpc_port": "50051",
+        "auth": {"type": "user", "admin": "admin-key", "jose": "jose-key"},
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            config = ConfigManager(config_file="test_config.json", user="jose")
+            assert config.user == "jose"
+            assert config.config == config_data
+
+
+def test_get_client_with_user_auth():
+    config_data = {
+        "host": "localhost",
+        "http_port": "8080",
+        "grpc_port": "50051",
+        "auth": {"type": "user", "admin": "admin-key", "jose": "jose-key"},
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            with patch("weaviate.connect_to_local") as mock_connect:
+                config = ConfigManager(config_file="test_config.json", user="jose")
+                config.get_client()
+
+                mock_connect.assert_called_once()
+                call_kwargs = mock_connect.call_args.kwargs
+                assert isinstance(
+                    call_kwargs["auth_credentials"], weaviate.auth.AuthApiKey
+                )
+                assert call_kwargs["auth_credentials"].api_key == "jose-key"
+
+
+def test_get_client_with_invalid_user():
+    config_data = {
+        "host": "localhost",
+        "http_port": "8080",
+        "grpc_port": "50051",
+        "auth": {"type": "user", "admin": "admin-key"},
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            config = ConfigManager(config_file="test_config.json", user="jose")
+            with pytest.raises(Exception) as exc_info:
+                config.get_client()
+            assert str(exc_info.value) == "User 'jose' not found in config file"
+
+
+def test_get_client_missing_user():
+    config_data = {
+        "host": "localhost",
+        "http_port": "8080",
+        "grpc_port": "50051",
+        "auth": {"type": "user", "admin": "admin-key"},
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            config = ConfigManager(config_file="test_config.json")
+            with pytest.raises(Exception) as exc_info:
+                config.get_client()
+            assert (
+                str(exc_info.value) == "User must be specified when auth type is 'user'"
+            )
+
+
+def test_get_client_with_api_key_auth():
+    config_data = {
+        "host": "localhost",
+        "http_port": "8080",
+        "grpc_port": "50051",
+        "auth": {"type": "api_key", "api_key": "test-key"},
+    }
+
+    with patch("builtins.open", mock_open(read_data=json.dumps(config_data))):
+        with patch("os.path.isfile") as mock_isfile:
+            mock_isfile.return_value = True
+            with patch("weaviate.connect_to_local") as mock_connect:
+                config = ConfigManager(config_file="test_config.json")
+                config.get_client()
+
+                mock_connect.assert_called_once()
+                call_kwargs = mock_connect.call_args.kwargs
+                assert isinstance(
+                    call_kwargs["auth_credentials"], weaviate.auth.AuthApiKey
+                )
+                assert call_kwargs["auth_credentials"].api_key == "test-key"

weaviate_cli-3.1.0/test/unittests/test_utils.py

@@ -0,0 +1,218 @@
+import pytest
+from unittest.mock import MagicMock
+from weaviate_cli.utils import (
+    get_client_from_context,
+    get_random_string,
+    pp_objects,
+    parse_permission,
+)
+from weaviate.collections import Collection
+from io import StringIO
+import sys
+from weaviate.rbac.models import Permissions
+
+
+def test_get_client_from_context(mock_click_context, mock_client):
+    mock_click_context.obj["config"].get_client.return_value = mock_client
+    client = get_client_from_context(mock_click_context)
+    assert client == mock_client
+    mock_click_context.obj["config"].get_client.assert_called_once()
+
+
+def test_get_random_string():
+    # Test different lengths
+    assert len(get_random_string(5)) == 5
+    assert len(get_random_string(10)) == 10
+
+    # Test randomness
+    str1 = get_random_string(8)
+    str2 = get_random_string(8)
+    assert str1 != str2
+
+    # Test only lowercase letters
+    random_str = get_random_string(20)
+    assert all(c.islower() for c in random_str)
+
+
+def test_pp_objects_empty():
+    # Test empty response
+    response = MagicMock()
+    response.objects = []
+
+    # Capture stdout
+    captured_output = StringIO()
+    sys.stdout = captured_output
+
+    pp_objects(response, ["name", "description"])
+
+    sys.stdout = sys.__stdout__
+    assert "No objects found" in captured_output.getvalue()
+
+
+def test_pp_objects_with_data():
+    # Mock response object
+    response = MagicMock()
+    mock_obj = MagicMock()
+    mock_obj.uuid = "test-uuid-1234"
+    mock_obj.properties = {"name": "test_name", "description": "test_description"}
+    mock_obj.metadata.distance = 0.5
+    mock_obj.metadata.certainty = 0.8
+    mock_obj.metadata.score = 0.9
+    response.objects = [mock_obj]
+
+    # Capture stdout
+    captured_output = StringIO()
+    sys.stdout = captured_output
+
+    pp_objects(response, ["name", "description"])
+
+    sys.stdout = sys.__stdout__
+    output = captured_output.getvalue()
+
+    # Verify output contains expected data
+    assert "test-uuid-1234" in output
+    assert "test_name" in output
+    assert "test_description" in output
+    assert "0.5" in output
+    assert "0.8" in output
+    assert "0.9" in output
+    assert "Total: 1 objects" in output
+
+
+def test_pp_objects_missing_properties():
+    # Test handling of missing properties
+    response = MagicMock()
+    mock_obj = MagicMock()
+    mock_obj.uuid = "test-uuid-5678"
+    mock_obj.properties = {"name": "test_name"}  # Missing description
+    mock_obj.metadata.distance = None
+    mock_obj.metadata.certainty = None
+    mock_obj.metadata.score = None
+    response.objects = [mock_obj]
+
+    captured_output = StringIO()
+    sys.stdout = captured_output
+
+    pp_objects(response, ["name", "description"])
+
+    sys.stdout = sys.__stdout__
+    output = captured_output.getvalue()
+
+    assert "test-uuid-5678" in output
+    assert "test_name" in output
+    assert "None" in output
+
+
+def test_parse_permission_collections():
+    # Test basic collection permissions
+    assert parse_permission("read_collections:Movies") == Permissions.collections(
+        collection="Movies", read_config=True
+    )
+
+    # Test multiple collections
+    assert parse_permission(
+        "create_collections:Movies,Books,Films"
+    ) == Permissions.collections(
+        collection=["Movies", "Books", "Films"], create_collection=True
+    )
+
+    # Test crud collections
+    assert parse_permission("crud_collections:Movies") == Permissions.collections(
+        collection="Movies",
+        create_collection=True,
+        read_config=True,
+        update_config=True,
+        delete_collection=True,
+    )
+
+
+def test_parse_permission_data():
+    # Test basic data permissions
+    assert parse_permission("read_data:Movies") == Permissions.data(
+        collection="Movies", read=True
+    )
+
+    # Test multiple collections
+    assert parse_permission("create_data:Movies,Books,Films") == Permissions.data(
+        collection=["Movies", "Books", "Films"], create=True
+    )
+
+    # Test crud data
+    assert parse_permission("crud_data:Movies") == Permissions.data(
+        collection="Movies", create=True, read=True, update=True, delete=True
+    )
+
+
+def test_parse_permission_roles():
+    # Test basic role permissions
+    assert parse_permission("read_roles:custom") == Permissions.roles(
+        role="custom", read=True
+    )
+
+    # Test multiple roles
+    assert parse_permission("read_roles:custom,editor,viewer") == Permissions.roles(
+        role=["custom", "editor", "viewer"], read=True
+    )
+
+    # Test manage roles
+    assert parse_permission("manage_roles:custom") == Permissions.roles(
+        role="custom", manage=True
+    )
+
+
+def test_parse_permission_backups():
+    # Test basic backup permissions
+    assert parse_permission("manage_backups:Movies") == Permissions.backup(
+        collection="Movies", manage=True
+    )
+
+    # Test multiple collections
+    assert parse_permission("manage_backups:Movies,Books,Films") == Permissions.backup(
+        collection=["Movies", "Books", "Films"], manage=True
+    )
+
+
+def test_parse_permission_nodes():
+    # Test basic node permissions
+    assert parse_permission("read_nodes:minimal:Movies") == Permissions.nodes(
+        collection="Movies", verbosity="minimal", read=True
+    )
+
+    # Test verbose node permissions
+    assert parse_permission("read_nodes:verbose:Movies") == Permissions.nodes(
+        collection="Movies", verbosity="verbose", read=True
+    )
+
+    # Test multiple collections
+    assert parse_permission(
+        "read_nodes:verbose:Movies,Books,Films"
+    ) == Permissions.nodes(
+        collection=["Movies", "Books", "Films"], verbosity="verbose", read=True
+    )
+
+
+def test_parse_permission_cluster():
+    # Test cluster read permission
+    assert parse_permission("read_cluster") == Permissions.cluster(read=True)
+
+
+def test_parse_permission_invalid():
+    # Test invalid action
+    with pytest.raises(ValueError, match="Invalid resource type: action"):
+        parse_permission("invalid_action:Movies")
+
+    # Test invalid crud combination
+    with pytest.raises(ValueError, match="Invalid crud combination: xyz"):
+        parse_permission("xyz_collections:Movies")
+
+    # Test invalid node verbosity
+    with pytest.raises(ValueError, match="Input should be 'minimal' or 'verbose'"):
+        parse_permission("read_nodes:invalid:Movies")
+
+    # Test missing node verbosity
+    with pytest.raises(ValueError, match="Input should be 'minimal' or 'verbose'"):
+        parse_permission("read_nodes:Movies")
+
+    # Test passing too many parts
+    with pytest.raises(ValueError, match="Invalid permission format"):
+        parse_permission("read_nodes:minimal:Movies:custom")