test(examples): Add runnable examples for testing #2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR introduces several example applications to demonstrate different identity providers and updates the token model accordingly. Key changes include:
- Reordering the rawToken field in the Token struct constructor.
- Adding example implementations for managed, default Azure, custom, and confidential identity providers.
- Including a mock identity provider implementation to simulate token generation and parsing.
Reviewed Changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| token/token.go | Reordered rawToken field to align with constructor parameters. |
| examples/managed_identity/main.go | Added example for system and user-assigned managed identity. |
| examples/default_azure_identity/main.go | Added example for default Azure identity credentials provider. |
| examples/custom_idp/main.go | Added custom identity provider example with a fake provider. |
| examples/confidential_identity/main.go | Added example for confidential identity with client secret auth. |
Files not reviewed (2)
- examples/custom_idp/go.mod: Language not supported
- go.mod: Language not supported
Comments suppressed due to low confidence (1)
examples/custom_idp/main.go:32
- The variable 'redis' shadows the imported package name 'redis'. Consider renaming it to 'redisClient' to improve code clarity.
redis := redis.NewClient(&redis.Options{
There was a problem hiding this comment.
Pull Request Overview
This PR adds a variety of example implementations for different authentication methods (managed identity, default credentials, client secret, client certificate, and a custom identity provider) to demonstrate the wiring for a custom identity provider using the library. Key changes include:
- New example programs and go.mod files for different authentication scenarios under the examples/ folder.
- Updates to the README to reflect the new import paths and configuration details.
- Minor adjustments to test files and internal package imports.
Reviewed Changes
Copilot reviewed 48 out of 48 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/entraid//.go and go.mod | Addition of example authentication methods and updated dependency refs |
| examples/entraid/config/* | New configuration loader and endpoints JSON for examples |
| examples/custom_idp/* | New custom identity provider example with fake provider implementation |
| entraid*, credentials_provider* | Updated imports to use the correct package naming |
| README.md | Updated documentation and code snippets to match new import conventions |
Comments suppressed due to low confidence (1)
README.md:430
- [nitpick] Ensure that the environment variable name for user-assigned identities ('AZURE_USER_ASSIGNED_MANAGED_ID') is consistently used across the code and documentation. This consistency will help avoid confusion when setting up configuration.
UserAssignedClientID: os.Getenv("AZURE_USER_ASSIGNED_MANAGED_ID"),
Co-authored-by: Copilot <[email protected]>
ndyakov
changed the title
There was a problem hiding this comment.
Pull Request Overview
Adds standalone example applications demonstrating various Azure identity authentication methods and a custom identity provider for the go-redis-entraid library, along with a shared configuration loader and sample endpoints.
- Introduces multiple example modules (
managedidentity_user,managedidentity_system,defaultcredentials,clientsecret,clientcert,default_azure_identity,custom_idp) showing different credential providers in action. - Adds a
configpackage withLoadConfigandGetRedisScopesfor loading JSON and environment-based settings. - Updates import paths and test files to use the new repository location (
github.com/redis/go-redis-entraid).
Reviewed Changes
Copilot reviewed 48 out of 48 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| examples/entraid/managedidentity_user/go.mod | Adds module and dependencies for user-assigned managed identity example |
| examples/entraid/managedidentity_system/main.go | Example for system-assigned identity provider with Redis client |
| examples/entraid/managedidentity_system/go.mod | Module setup for system-assigned identity example |
| examples/entraid/defaultcredentials/main.go | Default Azure credentials example using built-in identity chain |
| examples/entraid/defaultcredentials/go.mod | Module setup for default credentials example |
| examples/entraid/clientsecret/main.go | Example for client-secret authentication provider |
| examples/entraid/clientsecret/go.mod | Module setup for client-secret example |
| examples/entraid/clientcert/main.go | Example for client-certificate authentication provider |
| examples/entraid/clientcert/go.mod | Module setup for client-certificate example |
| examples/entraid/config/config.go | Shared config loader for JSON and environment variables |
| examples/entraid/config/go.mod | Module setup for shared config package |
| examples/entraid/endpoints.json | Sample Redis endpoints configuration |
| examples/default_azure_identity/main.go | Minimal default Azure identity example |
| examples/custom_idp/main.go | Custom identity provider example with a fake provider |
| examples/custom_idp/go.mod | Module setup for custom identity provider example |
| entraid.go | Updated import path for shared package |
| credentials_provider.go | Updated import paths for manager and token packages |
| entraid_test.go, credentials_provider_test.go | Test imports updated to new module path |
| README.md | Updated examples and import references to the new repository path |
Comments suppressed due to low confidence (6)
examples/custom_idp/go.mod:1
- [nitpick] The module name
custom_exampledoes not match its directory namecustom_idp, which can be confusing. Consider renaming the module tocustom_idpor updating the directory name.
module custom_example
examples/entraid/config/config.go:49
- The code uses fmt.Errorf but the fmt package is not imported, which will cause a compile error. Add
import "fmt"to the import block.
return nil, fmt.Errorf("failed to open configuration file: %v", err)
examples/custom_idp/main.go:23
- The error returned by NewTokenManager is not checked. Add an
if err != nil { ... }block immediately after to handle initialization failures.
tm, err := manager.NewTokenManager(idp, manager.TokenManagerOptions{
examples/entraid/managedidentity_system/main.go:30
- [nitpick] Hard-coded string literal for
ManagedIdentityType. Consider using the provided constantidentity.SystemAssignedIdentityto avoid typos and improve readability.
ManagedIdentityType: "SystemAssigned",
examples/entraid/managedidentity_system/main.go:50
- Only
Addrsis passed to ClusterOptions, dropping authentication and TLS settings parsed byredis.ParseURL. PropagateclusterOptsfields (e.g., Username, Password, TLSConfig) to ensure the client connects correctly.
clusterClient := redis.NewClusterClient(&redis.ClusterOptions{
examples/entraid/defaultcredentials/go.mod:7
- [nitpick] The placeholder version
v0.0.0-00010101000000-000000000000is not a valid published tag and may confuse users. Consider using a real version or relying solely on a local replace directive.
github.com/redis/go-redis-entraid v0.0.0-00010101000000-000000000000
4bbeadc to
b01271c
Compare
ndyakov
force-pushed
the
ndyakov/examples
branch
2 times, most recently
from
237660c to
ce9c51b
Compare
trigger ci.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces runnable examples and test configurations for various authentication flows using Redis with Azure identity providers, aimed at helping developers validate and understand the package usage.
- Added new examples for system-assigned managed identity, client secret, client certificate, default and custom identity providers.
- Updated module definitions, configuration files, tests, and README to reflect the new usage patterns.
Reviewed Changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/entraid/managedidentity_systemassigned/go.mod | Module file for system-assigned managed identity example. |
| examples/entraid/endpoints.json | New JSON config with various endpoint setups. |
| examples/entraid/defaultcredentials/main.go | Example using default Azure credentials with token refresh testing. |
| examples/entraid/clientsecret/main.go | Example using client secret authentication. |
| examples/entraid/clientcert/main.go | Example using client certificate authentication and custom certificate parsing. |
| examples/default_azure_identity/main.go | Example using default Azure identity provider. |
| examples/custom_idp/main.go | Example demonstrating a custom identity provider. |
| README.md | Updated documentation and example usage with revised import paths and naming. |
| .testcoverage.yml | Updated to exclude examples from test coverage. |
| Other test and source files | Updated import paths and references to the new module names. |
Merging this branch will increase overall coverage
Coverage by fileChanged files (no unit tests)
Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code. Changed unit test files
|
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a set of runnable examples demonstrating various authentication methods and configurations for testing the package with different identity providers. Key changes include:
- New examples for system-assigned managed identity, default credentials, client secret, client certificate, and a custom identity provider.
- Updates to go.mod files across examples and imports to reflect the new module naming convention.
- README.md revisions and test coverage configuration adjustments to support the examples.
Reviewed Changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/entraid/managedidentity_systemassigned/go.mod | New module file for system-assigned managed identity example. |
| examples/entraid/endpoints.json | Added endpoints configuration for various Redis setups. |
| examples/entraid/defaultcredentials/* | Example demonstrating use of default Azure credentials for both standalone and cluster. |
| examples/entraid/config/* | Configuration files and tests for loading and parsing endpoint and Azure settings. |
| examples/entraid/clientsecret/* | Example using client secret authentication. |
| examples/entraid/clientcert/* | Example using client certificate authentication with base64 decoding. |
| examples/default_azure_identity/main.go | Example using the default Azure identity chain for authentication. |
| examples/custom_idp/* | Example with a custom identity provider and associated fake response parser. |
| entraid*, credentials_provider*, README.md | Package-level changes updating import paths and documentation to align with renaming. |
| .testcoverage.yml | Updated to exclude examples from test coverage reporting. |
Comments suppressed due to low confidence (2)
README.md:181
- Ensure the label 'UserAssignedObjectID' clearly replaces the previous 'UserAssignedIdentity' terminology to avoid confusion in the examples and documentation.
C -->|No| F[UserAssignedObjectID]
.testcoverage.yml:41
- Review whether excluding the examples folder from test coverage is intentional, as adding automated tests for example code can help ensure their continued functionality.
- ^examples
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The examples placed in
examples/entraidcan be executed with the proper env setup.The rest of the examples in the
examplesfolder are there to show developers how the package can be used with custom identity providers or with the default azure credentials provider.