merging master

Author: chayim

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,6 +6,7 @@ _Please make sure to review and check all of these items:_
 - [ ] Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
 - [ ] Is the new or changed code fully tested?
 - [ ] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
+- [ ] Is there an example added to the examples folder (if applicable)?
 
 _NOTE: these things are not required to open a PR and can be done
 afterwards / while the PR is open._

.github/workflows/install_and_test.sh

@@ -38,4 +38,8 @@ cd ${TESTDIR}
 
 # install, run tests
 pip install ${PKG}
-pytest
+# Redis tests
+pytest -m 'not onlycluster'
+# RedisCluster tests
+CLUSTER_URL="redis://localhost:16379/0"
+pytest -m 'not onlynoncluster and not redismod and not ssl' --redis-url=${CLUSTER_URL}

.github/workflows/integration.yaml

@@ -34,9 +34,11 @@ jobs:
        max-parallel: 6
        matrix:
          python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', 'pypy-3.7']
+         test-type: ['standalone', 'cluster']
+         connection-type: ['hiredis', 'plain']
      env:
        ACTIONS_ALLOW_UNSECURE_COMMANDS: true
-     name: Python ${{ matrix.python-version }} tests
+     name: Python ${{ matrix.python-version }} ${{matrix.test-type}}-${{matrix.connection-type}} tests
      steps:
        - uses: actions/checkout@v2
        - name: install python
@@ -46,7 +48,8 @@ jobs:
        - name: run tests
          run: |
            pip install -r dev_requirements.txt
-           invoke tests
+           bash docker/stunnel/create_certs.sh
+           tox -e ${{matrix.test-type}}-${{matrix.connection-type}}
        - name: Upload codecov coverage
          uses: codecov/codecov-action@v2
          with:
@@ -68,3 +71,19 @@ jobs:
       - name: Run installed unit tests
         run: |
           bash .github/workflows/install_and_test.sh ${{ matrix.extension }}
+
+   install_package_from_commit:
+    name: Install package from commit hash
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', 'pypy-3.7']
+    steps:
+      - uses: actions/checkout@v2
+      - name: install python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: install from pip
+        run: |
+          pip install --quiet git+${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git@${GITHUB_SHA}

.github/workflows/pypi-publish.yaml

@@ -13,7 +13,7 @@ jobs:
       - name: install python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.0
+          python-version: 3.9
       - name: Install dev tools
         run: |
           pip install -r dev_requirements.txt
@@ -22,7 +22,7 @@ jobs:
       - name: Build package
         run: |
           python setup.py build
-          python setup.py dist bdist_wheel
+          python setup.py sdist bdist_wheel
 
       - name: Publish to Pypi
         uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -15,3 +15,6 @@ env
 venv
 coverage.xml
 .venv
+*.xml
+.coverage*
+docker/stunnel/keys

CONTRIBUTING.md

@@ -58,6 +58,7 @@ can execute docker and its various commands.
 -   A Redis replica node
 -   Three sentinel Redis nodes
 -   A multi-python docker, with your source code mounted in /data
+-   An stunnel docker, fronting the master Redis node
 
 The replica node, is a replica of the master node, using the
 [leader-follower replication](https://redis.io/topics/replication)
@@ -68,6 +69,14 @@ configuration](https://redis.io/topics/sentinel).
 
 ## Testing
 
+Call `invoke tests` to run all tests, or `invoke all-tests` to run linters 
+tests as well. With the 'tests' and 'all-tests' targets, all Redis and 
+RedisCluster tests will be run. 
+
+It is possible to run only Redis client tests (with cluster mode disabled) by 
+using `invoke standalone-tests`; similarly, RedisCluster tests can be run by using 
+`invoke cluster-tests`.
+
 Each run of tox starts and stops the various dockers required. Sometimes
 things get stuck, an `invoke clean` can help.