Merge pull request #1 from redis-developer/intro

Add Entra ID Authentication Support for Redis ( `go-redis` )

Author: ndyakov

.githooks/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+goimports -l -w . # includes go fmt
+golangci-lint run # includes golint, go vet

.github/workflows/bench.yml

@@ -0,0 +1,49 @@
+name: Benchmark Performance
+on:
+    pull_request:
+        branches:
+            - master
+            - main
+    push:
+        branches:
+            - master
+            - main
+permissions:
+    # deployments permission to deploy GitHub pages website
+    deployments: write
+    # contents permission to update benchmark contents in gh-pages branch
+    contents: write
+
+jobs:
+  benchmark:
+    name: Performance regression check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          go-version: "stable"
+      - name: Install dependencies
+        run: go mod tidy
+      - name: Run benchmark
+        run: go test ./... -bench=. -benchmem -count 2 -timeout 1m | tee benchmarks.txt
+      # Download previous benchmark result from cache (if exists)
+      - name: Download previous benchmark data
+        uses: actions/cache@v4
+        with:
+          path: ./cache
+          key: ${{ runner.os }}-benchmark
+      # Run `github-action-benchmark` action
+      - name: Store benchmark result
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Go Benchmark
+          tool: 'go'
+          output-file-path: benchmarks.txt
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+          # Show alert with commit comment on detecting possible performance regression
+          alert-threshold: '200%'
+          comment-on-alert: true
+          fail-on-alert: true
+          alert-comment-cc-users: '@ndyakov'

.github/workflows/build.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Install dependencies
       run: go mod tidy
     - name: Run tests with coverage
-      run: go test ./... -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
+      run: go test ./... -coverprofile=./cover.out -covermode=atomic -race -count 2 -timeout 5m
     - name: Upload coverage
       uses: actions/upload-artifact@v4
       with:

.gitignore

@@ -3,5 +3,8 @@
 *.tar.gz
 *.dic
 coverage.txt
+cover.out
 **/coverage.txt
+**/cover.out
 .vscode
+tmp/

.golangci.yml

@@ -0,0 +1,7 @@
+version: "2"
+run:
+  tests: false
+linters:
+  disable:
+    - depguard
+

.testcoverage.yml

@@ -11,15 +11,15 @@ profile: cover.out
 threshold:
   # (optional; default 0)
   # Minimum coverage percentage required for individual files.
-  file: 70
+  file: 85
 
   # (optional; default 0)
   # Minimum coverage percentage required for each package.
-  package: 80
+  package: 85
 
   # (optional; default 0)
   # Minimum overall project coverage percentage required.
-  total: 95
+  total: 90
 
 # Holds regexp rules which will override thresholds for matched files or packages
 # using their paths.
@@ -28,9 +28,9 @@ threshold:
 # new threshold to it. If project has multiple rules that match same path,
 # override rules should be listed in order from specific to more general rules.
 override:
-  # Increase coverage threshold to 100% for `foo` package
-  # (default is 80, as configured above in this example).
-  - path: ^pkg/lib/foo$
+  - path: ^internal$
+    threshold: 95
+  - path: ^token$
     threshold: 100
 
 # Holds regexp rules which will exclude matched files or packages

CONTRIBUTING.md

@@ -0,0 +1,103 @@
+# Contributing to go-redis-entraid
+
+We welcome contributions from the community! If you'd like to contribute to this project, please follow these guidelines:
+
+## Getting Started
+
+1. Fork the repository
+2. Create a new branch for your feature or bugfix
+3. Make your changes
+4. Run the tests and ensure they pass
+5. Submit a pull request
+
+## Development Setup
+
+```bash
+# Clone your fork
+git clone https://github.com/your-username/go-redis-entraid.git
+cd go-redis-entraid
+
+# Install dependencies
+go mod download
+
+# Run tests
+go test ./...
+```
+
+## Code Style and Standards
+
+- Follow the Go standard formatting (`go fmt`)
+- Write clear and concise commit messages
+- Include tests for new features
+- Update documentation as needed
+- Follow the existing code style and patterns
+
+## Testing
+
+We maintain high test coverage for the project. When contributing:
+
+- Add tests for new features
+- Ensure existing tests pass
+- Run the test coverage tool:
+  ```bash
+  go test -coverprofile=cover.out ./...
+  go tool cover -html=cover.out
+  ```
+
+## Pull Request Process
+
+1. Ensure your code passes all tests
+2. Update the README.md if necessary
+3. Submit your pull request with a clear description of the changes
+
+## Reporting Issues
+
+If you find a bug or have a feature request:
+
+1. Check the existing issues to avoid duplicates
+2. Create a new issue with:
+   - A clear title and description
+   - Steps to reproduce (for bugs)
+   - Expected and actual behavior
+   - Environment details (Go version, OS, etc.)
+
+## Development Workflow
+
+1. Create a new branch for your feature/fix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make your changes and commit them:
+   ```bash
+   git add .
+   git commit -m "Description of your changes"
+   ```
+
+3. Push your changes to your fork:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+4. Create a pull request from your fork to the main repository
+
+## Review Process
+
+- All pull requests will be reviewed by maintainers
+- Be prepared to make changes based on feedback
+- Ensure your code meets the project's standards
+- Address any CI/CD failures
+
+## Documentation
+
+- Update relevant documentation when making changes
+- Include examples for new features
+- Update the README if necessary
+- Add comments to complex code sections
+
+## Questions?
+
+If you have any questions about contributing, please:
+1. Check the existing documentation
+2. Look through existing issues
+3. Create a new issue if your question hasn't been answered