Merge branch 'master' into auth_pwd_user

Author: gkorland

.github/workflows/benchmark.yml

@@ -13,17 +13,17 @@ jobs:
         redis-version: [5]
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2.3.4
         with:
           fetch-depth: 1
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2.1.5
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Setup Redis
-        uses: shogo82148/actions-setup-redis@v1.0.1
+        uses: shogo82148/actions-setup-redis@v1.9.7
         with:
           redis-version: ${{ matrix.redis-version }}
           auto-start: "true"
@@ -32,7 +32,7 @@ jobs:
       - name: Run Benchmark
         run: npm run benchmark > benchmark-output.txt && cat benchmark-output.txt
       - name: Upload Benchmark Result
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v2.2.2
         with:
           name: benchmark-output.txt
           path: benchmark-output.txt

.github/workflows/linting.yml

@@ -7,10 +7,10 @@ jobs:
     name: ESLint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2.3.4
         with:
           fetch-depth: 1
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2.1.5
         with:
           node-version: 12
       - run: npm i --no-audit --prefer-offline
@@ -20,12 +20,12 @@ jobs:
         run: npm run lint:report
         continue-on-error: true
       - name: Annotate Code Linting Results
-        uses: ataylorme/eslint-annotate-action@1.0.4
+        uses: ataylorme/eslint-annotate-action@1.1.2
         with:
           repo-token: "${{ secrets.GITHUB_TOKEN }}"
           report-json: "eslint-report.json"
       - name: Upload ESLint report
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v2.2.2
         with:
           name: eslint-report.json
           path: eslint-report.json

.github/workflows/tests.yml

@@ -13,17 +13,17 @@ jobs:
         redis-version: [4.x, 5.x]
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2.3.4
         with:
           fetch-depth: 1
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2.1.5
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Setup Redis
-        uses: shogo82148/actions-setup-redis@v1.0.1
+        uses: shogo82148/actions-setup-redis@v1.9.7
         with:
           redis-version: ${{ matrix.redis-version }}
           auto-start: "false"
@@ -46,7 +46,7 @@ jobs:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
 
       - name: Upload Coverage Report
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v2.2.2
         with:
           name: coverage
           path: coverage

.github/workflows/tests_windows.yml

@@ -11,14 +11,14 @@ jobs:
       matrix:
         node-version: [6.x, 8.x, 10.x, 12.x]
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2.3.4
         with:
           fetch-depth: 1
 
       - name: Install Redis
-        uses: crazy-max/ghaction-chocolatey@v1
+        uses: crazy-max/ghaction-chocolatey@v1.4.0
         with:
-          args: install redis-64 --no-progress
+          args: install redis-64 --version=3.0.503 --no-progress
 
       - name: Start Redis
         run: |
@@ -27,7 +27,7 @@ jobs:
           redis-cli config set stop-writes-on-bgsave-error no
 
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2.1.5
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -43,7 +43,7 @@ jobs:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
 
       - name: Upload Coverage Report
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v2.2.2
         with:
           name: coverage
           path: coverage

CONTRIBUTING.md

@@ -82,9 +82,13 @@ Working on your first Pull Request? You can learn how from this _free_ series,
 
 Node Redis has a full test suite with coverage setup.
 
-To run the tests use the `npm test` command. To check detailed coverage locally run the `npm run coverage` command after
+To run the tests, run `npm install` to install all dependencies, and then run `npm test`. To check detailed coverage locally run the `npm run coverage` command after
 testing and open the generated `./coverage/index.html` in your browser.
 
+Note that the test suite assumes that a few tools are installed in your environment, such as:
+- redis (make sure redis-server is not running when starting the tests, it's part of the test-suite to start it and you'll end up with a "port already in use" error)
+- stunnel (for TLS tests)
+
 ### Submitting code for review
 
 The bigger the pull request, the longer it will take to review and merge. Where possible try to break down large pull