Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CSS-7044 Added mock authenticator #1160

Merged
merged 5 commits into from
Feb 20, 2024
Merged

Conversation

kian99
Copy link
Contributor

@kian99 kian99 commented Feb 19, 2024

Description

Adds an empty mock authenticator to the JIMM suite used for tests. Note that the mock is mostly empty except for VerifySessionToken, this is intentional. Reason being, in most tests we don't need to test the full login flow so only the VerifySessionToken functions needs to be implemented. The test login function can generate a JWT with pre-defined key that is the same as the MockAuthenticator. The removal of Candid will require the Juju login changes to land in Juju, so that we can bump our Juju version and start to use the new login flows.

Fixes CSS-7044

Engineering checklist

Check only items that apply

  • Documentation updated
  • Covered by unit tests
  • Covered by integration tests

Copy link
Collaborator

@alesstimec alesstimec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a few suggestions..

internal/auth/oauth2.go Show resolved Hide resolved
internal/jimmtest/auth.go Outdated Show resolved Hide resolved
// for user object creation
//
// This method is exported for use by the mock authenticator.
func VerifySessionToken(token string, secretKey string) (jwt.Token, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure i understand why is this a separate function and not directly inside func (as *AuthenticationService) VerifySessionToken

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in other words, why do we need a wrapper and a function, and not only the function

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. As a method it's basically a class method, as a function it's like a static method namespaced to the auth package. It probably shouldn't have been added as a method on the struct, but I can't remove it without also changing the interface (this method implements the OAuth interface). So I'll keep it like this until Alex is back and we can discuss changing the interface.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aha, good point

internal/auth/oauth2.go Show resolved Hide resolved
internal/jimmtest/suite.go Show resolved Hide resolved
// for user object creation
//
// This method is exported for use by the mock authenticator.
func VerifySessionToken(token string, secretKey string) (jwt.Token, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aha, good point

@kian99 kian99 merged commit 9ebe220 into canonical:feature-oidc Feb 20, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants