Text Matrix: Python, Redis Stack, and hiredis (#73)

Building off of Chayims Pr in #62, This PR extends the test suite
capability to more variations supported by Redis.

---------

Co-authored-by: Chayim I. Kirshen <c@kirshen.com>
Co-authored-by: Chayim <chayim@users.noreply.github.com>
Co-authored-by: Tyler Hutcherson <tyler.hutcherson@redis.com>

Author: 3 people

.github/workflows/run_tests.yml

@@ -2,59 +2,82 @@ name: Test Suite
 
 on:
   pull_request:
+
   push:
     branches:
       - main
 
 jobs:
   test:
-    name: Test on ${{ matrix.python-version }} - ${{ matrix.os }}
+    name: Python ${{ matrix.python-version }} - ${{ matrix.connection }} [redis-stack ${{matrix.redis-stack-version}}]
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
         python-version: [3.8, 3.9, '3.10', 3.11]
+        connection: ['hiredis', 'plain']
+        redis-stack-version: ['6.2.6-v9', 'latest']
 
     services:
       redis:
-        image: redis/redis-stack-server:latest
+        image: redis/redis-stack-server:${{matrix.redis-stack-version}}
         ports:
           - 6379:6379
 
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install .[dev,all]
+
+    - name: Install hiredis if needed
+      if: matrix.connection == 'hiredis'
+      run: |
+        pip install hiredis
+
     - name: Start Redis
       run: |
         REDIS_URL=redis://localhost:6379
         echo REDIS_URL=$REDIS_URL >> $GITHUB_ENV
+
     - name: Authenticate to Google Cloud
       uses: google-github-actions/auth@v1
       with:
         credentials_json: ${{ secrets.GOOGLE_CREDENTIALS }}
+
     - name: Run tests
+      if: matrix.connection == 'plain' && matrix.redis-stack-version == 'latest'
       env:
         OPENAI_API_KEY: ${{ secrets.OPENAI_KEY }}
         GCP_LOCATION: ${{ secrets.GCP_LOCATION }}
         GCP_PROJECT_ID: ${{ secrets.GCP_PROJECT_ID }}
       run: |
         make test-cov
+
+    - name: Run tests
+      if: matrix.connection != 'plain' || matrix.redis-stack-version != 'latest'
+      run: |
+        SKIP_VECTORIZERS=True make test-cov
+
     - name: Run notebooks
+      if: matrix.connection == 'plain' && matrix.redis-stack-version == 'latest'
       env:
         OPENAI_API_KEY: ${{ secrets.OPENAI_KEY }}
         GCP_LOCATION: ${{ secrets.GCP_LOCATION }}
         GCP_PROJECT_ID: ${{ secrets.GCP_PROJECT_ID }}
       run: |
         cd docs/ && treon -v --exclude="./examples/openai_qna.ipynb"
+
     - name: Publish coverage results
       uses: codecov/codecov-action@v2
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
-        fail_ci_if_error: true
+        fail_ci_if_error: true

README.md

@@ -61,6 +61,12 @@ Install `redisvl` using `pip`:
 pip install redisvl
 ```
 
+This library supports the use of hiredis, so you can also install by running:
+
+```bash
+pip install redisvl[hiredis]
+```
+
 Then make sure to have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):
 
 ```bash
@@ -195,5 +201,3 @@ cache.check("What is the capital of France?")
 cache.check("What really is the capital of France?")
 ["Paris"]
 ```
-
-

tests/integration/test_vectorizers.py

@@ -9,8 +9,18 @@
 )
 
 
+@pytest.fixture
+def skip_vectorizer() -> bool:
+    # os.getenv returns a string
+    return os.getenv("SKIP_VECTORIZERS", 'False').lower() == 'true'
+
+skip_vectorizer_test = lambda: pytest.config.getfixturevalue("skip_vectorizer")
+
+
 @pytest.fixture(params=[HFTextVectorizer, OpenAITextVectorizer, VertexAITextVectorizer])
 def vectorizer(request, openai_key, gcp_location, gcp_project_id):
+    # if skip_vectorizer:
+    #     pytest.skip("Skipping vectorizer tests")
     # Here we use actual models for integration test
     if request.param == HFTextVectorizer:
         return request.param(model="sentence-transformers/all-mpnet-base-v2")
@@ -29,6 +39,7 @@ def vectorizer(request, openai_key, gcp_location, gcp_project_id):
         )
 
 
+@pytest.mark.skipif(skip_vectorizer_test, reason="Skipping vectorizer tests")
 def test_vectorizer_embed(vectorizer):
     text = "This is a test sentence."
     embedding = vectorizer.embed(text)
@@ -37,6 +48,7 @@ def test_vectorizer_embed(vectorizer):
     assert len(embedding) == vectorizer.dims
 
 
+@pytest.mark.skipif(skip_vectorizer_test, reason="Skipping vectorizer tests")
 def test_vectorizer_embed_many(vectorizer):
     texts = ["This is the first test sentence.", "This is the second test sentence."]
     embeddings = vectorizer.embed_many(texts)
@@ -48,6 +60,7 @@ def test_vectorizer_embed_many(vectorizer):
     )
 
 
+@pytest.mark.skipif(skip_vectorizer_test, reason="Skipping vectorizer tests")
 def test_vectorizer_bad_input(vectorizer):
     with pytest.raises(TypeError):
         vectorizer.embed(1)
@@ -68,6 +81,7 @@ def avectorizer(request, openai_key):
         )
 
 
+@pytest.mark.skipif(skip_vectorizer_test, reason="Skipping vectorizer tests")
 @pytest.mark.asyncio
 async def test_vectorizer_aembed(avectorizer):
     text = "This is a test sentence."
@@ -77,6 +91,7 @@ async def test_vectorizer_aembed(avectorizer):
     assert len(embedding) == avectorizer.dims
 
 
+@pytest.mark.skipif(skip_vectorizer_test, reason="Skipping vectorizer tests")
 @pytest.mark.asyncio
 async def test_vectorizer_aembed_many(avectorizer):
     texts = ["This is the first test sentence.", "This is the second test sentence."]
@@ -89,6 +104,7 @@ async def test_vectorizer_aembed_many(avectorizer):
     )
 
 
+@pytest.mark.skipif(skip_vectorizer_test, reason="Skipping vectorizer tests")
 @pytest.mark.asyncio
 async def test_avectorizer_bad_input(avectorizer):
     with pytest.raises(TypeError):