# What this PR does The following is deployed under a feature flag. **How it works** 1. The user clicks on the "Connect using your Google account" button in the user profile settings modal 2. The UI makes a call to `GET /api/internal/v1/login/google-oauth2`. The backend has now been configured to add `apps.social_auth.backends.GoogleOAuth2` as a "`social_auth` backend". 3. The backend will respond w/ a URL which points to the Google OAuth2 consent screen. The frontend then proceeds by sending the user to this page. This URL includes the following query parameters (amongst others): - `redirect_uri` - this will send the user back to `/api/internal/v1/complete/google-oauth2` (ie. make another API call to the OnCall backend to finalize the Google OAuth2 flow) - `state` - this represents an `apps.auth_token.models.GoogleOAuth2Token` token. This allows us to identify the OnCall user once they've linked their Google account. 4. Once redirected back to `/api/internal/v1/complete/google-oauth2`, this will complete the OAuth2 flow. At this point, the backend has access to several pieces of information about the Google user, including their `access_token` and `refresh_token`. We persist these (encrypted) for future use to fetch the user's out-of-office calendar events 5. The response from the API call in 4 above ☝️ is HTTP 302 (redirect) to `/a/grafana-oncall-app/users/me` (ie. open the user profile settings modal). At this point the user will see that their account has been connected and they can further configure the settings  ## Which issue(s) this PR closes Closes https://github.com/grafana/oncall-private/issues/2584 ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - will be done in https://github.com/grafana/oncall-private/issues/2591 - [x] Added the relevant release notes label (see labels prefixed w/ `release:`). These labels dictate how your PR will show up in the autogenerated release notes. - will be done in https://github.com/grafana/oncall-private/issues/2591 --------- Co-authored-by: Dominik <dominik.broj@grafana.com> Co-authored-by: Maxim Mordasov <maxim.mordasov@grafana.com>
124 lines
4.2 KiB
Python
124 lines
4.2 KiB
Python
from unittest.mock import patch
|
|
|
|
import pytest
|
|
from django.contrib.auth import REDIRECT_FIELD_NAME
|
|
from django.http import HttpResponse
|
|
from django.test.utils import override_settings
|
|
from django.urls import reverse
|
|
from rest_framework import status
|
|
from rest_framework.test import APIClient
|
|
|
|
from apps.auth_token.constants import SLACK_AUTH_TOKEN_NAME
|
|
|
|
|
|
@pytest.mark.django_db
|
|
@pytest.mark.parametrize(
|
|
"backend_name,expected_url",
|
|
(
|
|
("slack-login", "/a/grafana-oncall-app/users/me"),
|
|
("slack-install-free", "/a/grafana-oncall-app/chat-ops"),
|
|
),
|
|
)
|
|
def test_complete_slack_auth_redirect_ok(
|
|
make_organization,
|
|
make_user_for_organization,
|
|
make_slack_token_for_user,
|
|
backend_name,
|
|
expected_url,
|
|
):
|
|
organization = make_organization()
|
|
admin = make_user_for_organization(organization)
|
|
_, slack_token = make_slack_token_for_user(admin)
|
|
|
|
client = APIClient()
|
|
url = (
|
|
reverse("api-internal:complete-social-auth", kwargs={"backend": backend_name})
|
|
+ f"?{SLACK_AUTH_TOKEN_NAME}={slack_token}"
|
|
)
|
|
|
|
with patch("apps.api.views.auth.do_complete") as mock_do_complete:
|
|
mock_do_complete.return_value = None
|
|
response = client.get(url)
|
|
|
|
assert response.status_code == status.HTTP_302_FOUND
|
|
assert response.url == expected_url
|
|
|
|
|
|
@pytest.mark.django_db
|
|
def test_complete_slack_auth_redirect_error(
|
|
make_organization,
|
|
make_user_for_organization,
|
|
make_slack_token_for_user,
|
|
):
|
|
organization = make_organization()
|
|
admin = make_user_for_organization(organization)
|
|
_, slack_token = make_slack_token_for_user(admin)
|
|
|
|
client = APIClient()
|
|
url = (
|
|
reverse("api-internal:complete-social-auth", kwargs={"backend": "slack-login"})
|
|
+ f"?{SLACK_AUTH_TOKEN_NAME}={slack_token}"
|
|
)
|
|
|
|
def _custom_do_complete(backend, *args, **kwargs):
|
|
backend.strategy.session[REDIRECT_FIELD_NAME] = "some-url"
|
|
return HttpResponse(status=status.HTTP_400_BAD_REQUEST)
|
|
|
|
with patch("apps.api.views.auth.do_complete", side_effect=_custom_do_complete):
|
|
response = client.get(url)
|
|
|
|
assert response.status_code == status.HTTP_302_FOUND
|
|
assert response.url == "some-url"
|
|
|
|
|
|
@pytest.mark.django_db
|
|
@patch("apps.social_auth.backends.GoogleOAuth2.get_redirect_uri")
|
|
@patch("apps.social_auth.backends.GoogleOAuth2Token.create_auth_token", return_value=("something", "token_string"))
|
|
@override_settings(SOCIAL_AUTH_GOOGLE_OAUTH2_SCOPE=["https://www.googleapis.com/auth/calendar.events.readonly"])
|
|
@override_settings(SOCIAL_AUTH_GOOGLE_OAUTH2_KEY="ouath2_key")
|
|
def test_google_start_auth_redirect_ok(
|
|
_mock_create_google_oauth2_auth_token,
|
|
mock_google_oauth2_backend_get_redirect_uri,
|
|
make_organization_and_user_with_plugin_token,
|
|
make_user_auth_headers,
|
|
):
|
|
redirect_uri = "http://testserver"
|
|
mock_google_oauth2_backend_get_redirect_uri.return_value = redirect_uri
|
|
|
|
_, user, token = make_organization_and_user_with_plugin_token()
|
|
|
|
client = APIClient()
|
|
url = reverse("api-internal:social-auth", kwargs={"backend": "google-oauth2"})
|
|
response = client.get(url, **make_user_auth_headers(user, token))
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
assert response.json() == (
|
|
"https://accounts.google.com/o/oauth2/auth?client_id=ouath2_key"
|
|
f"&redirect_uri={redirect_uri}&response_type=code"
|
|
"&state=token_string&scope=https://www.googleapis.com/auth/calendar.events.readonly+openid+email+profile"
|
|
"&access_type=offline&approval_prompt=auto"
|
|
)
|
|
|
|
|
|
@pytest.mark.django_db
|
|
@patch("apps.api.views.auth.do_complete", return_value=None)
|
|
def test_google_complete_auth_redirect_ok(
|
|
_mock_do_complete,
|
|
make_organization,
|
|
make_user_for_organization,
|
|
make_google_oauth2_token_for_user,
|
|
):
|
|
organization = make_organization()
|
|
admin = make_user_for_organization(organization)
|
|
_, google_oauth2_token = make_google_oauth2_token_for_user(admin)
|
|
|
|
client = APIClient()
|
|
url = (
|
|
reverse("api-internal:complete-social-auth", kwargs={"backend": "google-oauth2"})
|
|
+ f"?state={google_oauth2_token}"
|
|
)
|
|
|
|
response = client.get(url)
|
|
|
|
assert response.status_code == status.HTTP_302_FOUND
|
|
assert response.url == "/a/grafana-oncall-app/users/me"
|