oncall-engine/engine/apps/grafana_plugin/tests/test_sync.py
Joey Orlando 9e598385f4
Add RBAC Support (#777)
* Modify plugin.json to support RBAC role registration

* defines 26 new custom roles in plugin.json. The main roles are:

- Admin: read/write access to everything in OnCall
- Reader: read access to everything in OnCall
- OnCaller : read access to everything in OnCall + edit access to Alert Groups and Schedules
- <object-type> Editor: read/write access to everything related to <object-type>
- <object-type> Reader: read access for <object-type>
- User Settings Admin: read/write access to all user's settings, not just own settings. This is in comparison to User Settings Editor which can only read/write own settings

* update changelog and documentation (#686)

* implement RBAC for OnCall backend

This commit refactors backend authorization. It trys to use RBAC authorization if the org's grafana instance supports it, otherwise it falls back to basic role authorization.

* update RBAC backend tests

* add tests for RBAC changes
- run backend tests as matrix where RBAC is enabled/disabled. When RBAC is enabled, the permissions granted are read from the role grants in the frontend's plugin.json file (instead of relying what we specify in RBACPermission.Permissions)
- remove --reuse-db --nomigrations flags from engine/tox.ini
- minor autoformatting changes to docker-compose-developer.yml

* remove --ds=settings.ci-test from pytest CI command

DJANGO_SETTINGS_MODULE is already specified as an env var so this is just unecessary duplication

* update gitignore

* update github action job name for "test"

* RBAC frontend changes

* refactors the use of basic roles (ex. Viewer, Editor, Admin) use RBAC permissions (when supported), or falling back to basic roles when RBAC is not supported.

- updates the UserAction enum in grafana-plugin/src/state/userAction.ts. Previously this was hardcoded to a list of strings that were being returned by the OnCall API. Now the values here correspond to the permissions in plugin.json (plus a fallback role)

* changes per Gabriel's comments:
- get rid of group attribute in rbac roles
- remove displayName role attribute
- remove hidden role attribute
- add back role to includes section

* don't try to update user timezone if they don't have permission
2022-11-29 09:41:56 +01:00

102 lines
3.3 KiB
Python

from unittest.mock import patch
import pytest
from django.conf import settings
from django.test.utils import override_settings
from django.utils import timezone
from apps.grafana_plugin.tasks.sync import run_organization_sync
class SyncOrganization(object):
called = False
org = None
def do_sync_organization(self, org):
self.called = True
self.org = org
def reset(self):
self.called = False
self.org = None
class TestGcomAPIClient:
called = False
info = None
status = None
STACK_STATUS_ACTIVE = "active"
def reset(self):
self.called = False
self.info = None
self.status = None
def set_info(self, info):
self.info = info
def set_status(self, status):
self.status = status
def get_instance_info(self, stack_id: str):
self.called = True
return self.info
@pytest.mark.django_db
def test_sync_organization_skip(
make_organization,
make_token_for_organization,
):
organization = make_organization()
syncer = SyncOrganization()
with patch("apps.grafana_plugin.tasks.sync.sync_organization", new=lambda org: syncer.do_sync_organization(org)):
run_organization_sync(organization.id, True) # Call for existing org (forced)
assert syncer.called and syncer.org == organization
syncer.reset()
run_organization_sync(123321, True) # Not called for non-existing org
assert not syncer.called and not syncer.org
syncer.reset()
run_organization_sync(organization.id, False) # Call for new org
assert syncer.called and syncer.org == organization
syncer.reset()
organization.last_time_synced = timezone.now()
organization.save(update_fields=["last_time_synced"])
run_organization_sync(organization.id, False) # Not called for recently synced org
assert not syncer.called and not syncer.org
syncer.reset()
@override_settings(GRAFANA_COM_API_TOKEN="TestGrafanaComToken")
@override_settings(LICENSE=settings.CLOUD_LICENSE_NAME)
@pytest.mark.django_db
def test_sync_organization_skip_cloud(
make_organization,
make_token_for_organization,
):
organization = make_organization()
syncer = SyncOrganization()
test_client = TestGcomAPIClient()
with patch("apps.grafana_plugin.tasks.sync.sync_organization", new=lambda org: syncer.do_sync_organization(org)):
with patch("apps.grafana_plugin.tasks.sync.GcomAPIClient", new=lambda api_token: test_client):
test_client.info = {"status": "active"}
run_organization_sync(organization.id, False) # Called since instance info is active in cloud
assert test_client.called and syncer.called and syncer.org == organization
syncer.reset()
test_client.reset()
test_client.info = {"status": "paused"}
run_organization_sync(organization.id, False) # Not called since status != active in cloud
assert test_client.called and not syncer.called and not syncer.org
syncer.reset()
test_client.reset()
run_organization_sync(organization.id, False) # Not called since status was none in cloud
assert test_client.called and not syncer.called and not syncer.org
syncer.reset()
test_client.reset()