-
Notifications
You must be signed in to change notification settings - Fork 3
Document new dtable-web endpoints
#85
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
Draft
simonhammes
wants to merge
2
commits into
v7.0
Choose a base branch
from
document-new-dtable-web-endpoints
base: v7.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
20 changes: 20 additions & 0 deletions
20
tests/__snapshots__/test_team_apps/test_listManagedApps.json
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| { | ||
| "count": 1, | ||
| "managed_apps": [ | ||
| { | ||
| "app_config": "{\"app_type\": \"universal-app\", \"app_name\": \"Test App\", \"settings\": {\"pages\": [], \"navigation\": []}}", | ||
| "app_id": "int", | ||
| "app_name": "Test App", | ||
| "app_user_id": "int", | ||
| "app_uuid": "str", | ||
| "dtable_name": "ManagedAppsTest", | ||
| "dtable_uuid": "str", | ||
| "edit_link": "str", | ||
| "joined_at": "str", | ||
| "link": "str", | ||
| "permission": "rw", | ||
| "role_name": "admin", | ||
| "workspace_id": "int" | ||
| } | ||
| ] | ||
| } |
20 changes: 20 additions & 0 deletions
20
tests/__snapshots__/test_team_apps/test_listUsableApps.json
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| { | ||
| "can_use_apps": [ | ||
| { | ||
| "app_config": "{\"app_type\": \"universal-app\", \"app_name\": \"Test App\", \"settings\": {\"pages\": [], \"navigation\": []}}", | ||
| "app_id": "int", | ||
| "app_name": "Test App", | ||
| "app_user_id": "int", | ||
| "app_uuid": "str", | ||
| "dtable_name": "UsableAppsTest", | ||
| "dtable_uuid": "str", | ||
| "edit_link": "str", | ||
| "joined_at": "str", | ||
| "link": "str", | ||
| "permission": "rw", | ||
| "role_name": "default", | ||
| "workspace_id": "int" | ||
| } | ||
| ], | ||
| "count": 1 | ||
| } |
25 changes: 25 additions & 0 deletions
25
tests/__snapshots__/test_team_bases/test_listBasesSharedToUser.json
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| { | ||
| "count": 1, | ||
| "dtable_list": [ | ||
| { | ||
| "backend": "js", | ||
| "color": null, | ||
| "created_at": "str", | ||
| "creator": "str", | ||
| "file_size": "int", | ||
| "from_user": "str", | ||
| "from_user_name": "str", | ||
| "icon": null, | ||
| "id": "int", | ||
| "in_storage": true, | ||
| "is_encrypted": false, | ||
| "modifier": "str", | ||
| "name": "SharedBasesTest", | ||
| "rows_count": 0, | ||
| "text_color": null, | ||
| "updated_at": "str", | ||
| "uuid": "str", | ||
| "workspace_id": "int" | ||
| } | ||
| ] | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| import json | ||
| import pytest | ||
| import requests | ||
| from conftest import ( | ||
| BASE_URL, Secret, TeamAdmin, system_admin_account_operations, team_admin_account_operations, | ||
| user_account_operations, | ||
| ) | ||
| from schemathesis import Case | ||
| from syrupy.assertion import SnapshotAssertion | ||
| from syrupy.matchers import path_type | ||
|
|
||
| pytestmark = pytest.mark.needs_large_license | ||
|
|
||
|
|
||
| def test_listManagedApps(team: TeamAdmin, system_admin_account_token: Secret, snapshot_json: SnapshotAssertion): | ||
| """Create a universal app, make the team admin its admin and verify it appears in listManagedApps.""" | ||
| headers = {'Authorization': f'Bearer {team.account_token}'} | ||
| path_parameters = {'org_id': team.team_id} | ||
|
|
||
| # Custom app roles require the "advanced customization" permission, which the default team role lacks | ||
| case: Case = system_admin_account_operations.find_operation_by_id('updateTeam') \ | ||
| .Case(path_parameters=path_parameters, body={'role': 'org_enterprise'}) | ||
| response = case.call(headers={'Authorization': f'Bearer {system_admin_account_token.value}'}) | ||
| assert response.status_code == 200 | ||
|
|
||
| # The team admin will be the app's admin, so get their own user ID | ||
| case: Case = user_account_operations.find_operation_by_id('getAccountInfo').Case() | ||
| response = case.call(headers=headers) | ||
| assert response.status_code == 200 | ||
| user_id = response.json()['email'] | ||
|
|
||
| # Create a base in the team admin's personal workspace | ||
| case: Case = user_account_operations.find_operation_by_id('listWorkspaces').Case() | ||
| response = case.call(headers=headers) | ||
| assert response.status_code == 200 | ||
| ws_id = next(w for w in response.json()['workspace_list'] if w.get('type') == 'personal')['id'] | ||
|
|
||
| body = {'workspace_id': ws_id, 'name': 'ManagedAppsTest'} | ||
| case: Case = user_account_operations.find_operation_by_id('createBase').Case(body=body) | ||
| response = case.call(headers=headers) | ||
| assert response.status_code == 201 | ||
| base_uuid = response.json()['table']['uuid'] | ||
|
|
||
| # Create a universal app, an "admin" role and add the team admin with that role (endpoints not in the spec) | ||
| app_config = json.dumps({'app_type': 'universal-app', 'app_name': 'Test App', 'settings': {'pages': [], 'navigation': []}}) | ||
| response = requests.post( | ||
| f'{BASE_URL}/api/v2.1/workspace/{ws_id}/dtable/ManagedAppsTest/external-apps/', | ||
| headers=headers, data={'app_type': 'universal-app', 'app_config': app_config}, | ||
| ) | ||
| assert response.status_code == 201 | ||
| app_uuid = response.json()['external_app']['app_uuid'] | ||
|
|
||
| response = requests.post( | ||
| f'{BASE_URL}/api/v2.1/universal-apps/{app_uuid}/app-roles/', | ||
| headers=headers, data={'role_name': 'admin', 'permission': 'rw'}, | ||
| ) | ||
| assert response.status_code == 200 | ||
| role_id = response.json()['app_role']['id'] | ||
|
|
||
| response = requests.post( | ||
| f'{BASE_URL}/api/v2.1/universal-apps/{app_uuid}/app-users/', | ||
| headers=headers, data={'app_user': user_id, 'app_role_id': role_id}, | ||
| ) | ||
| assert response.status_code == 200 | ||
|
|
||
| # List the user's managed apps | ||
| case: Case = team_admin_account_operations.find_operation_by_id('listManagedApps') \ | ||
| .Case(path_parameters={'org_id': team.team_id, 'user_id': user_id}) | ||
| response = case.call(headers=headers) | ||
|
|
||
| assert response.status_code == 200 | ||
|
|
||
| data = response.json() | ||
| assert data['count'] == 1 | ||
| assert len(data['managed_apps']) == 1 | ||
|
|
||
| managed_app = data['managed_apps'][0] | ||
| assert managed_app['app_uuid'] == app_uuid | ||
| assert managed_app['dtable_uuid'] == base_uuid.replace('-', '') | ||
|
|
||
| matcher = path_type({ | ||
| r"managed_apps\.\d+\.app_user_id": (int,), | ||
| r"managed_apps\.\d+\.app_id": (int,), | ||
| r"managed_apps\.\d+\.app_uuid": (str,), | ||
| r"managed_apps\.\d+\.dtable_uuid": (str,), | ||
| r"managed_apps\.\d+\.workspace_id": (int,), | ||
| r"managed_apps\.\d+\.link": (str,), | ||
| r"managed_apps\.\d+\.edit_link": (str,), | ||
| r"managed_apps\.\d+\.joined_at": (str,), | ||
| }, regex=True) | ||
|
|
||
| assert snapshot_json(matcher=matcher) == data | ||
|
|
||
|
|
||
| def test_listUsableApps(team: TeamAdmin, snapshot_json: SnapshotAssertion): | ||
| """Create a universal app, add the team admin with the default role and verify it appears in listUsableApps.""" | ||
| headers = {'Authorization': f'Bearer {team.account_token}'} | ||
|
|
||
| case: Case = user_account_operations.find_operation_by_id('getAccountInfo').Case() | ||
| response = case.call(headers=headers) | ||
| assert response.status_code == 200 | ||
| user_id = response.json()['email'] | ||
|
|
||
| # Create a base in the team admin's personal workspace | ||
| case: Case = user_account_operations.find_operation_by_id('listWorkspaces').Case() | ||
| response = case.call(headers=headers) | ||
| assert response.status_code == 200 | ||
| ws_id = next(w for w in response.json()['workspace_list'] if w.get('type') == 'personal')['id'] | ||
|
|
||
| body = {'workspace_id': ws_id, 'name': 'UsableAppsTest'} | ||
| case: Case = user_account_operations.find_operation_by_id('createBase').Case(body=body) | ||
| response = case.call(headers=headers) | ||
| assert response.status_code == 201 | ||
| base_uuid = response.json()['table']['uuid'] | ||
|
|
||
| # Create a universal app and add the team admin with its auto-created "default" role (endpoints not in the spec) | ||
| app_config = json.dumps({'app_type': 'universal-app', 'app_name': 'Test App', 'settings': {'pages': [], 'navigation': []}}) | ||
| response = requests.post( | ||
| f'{BASE_URL}/api/v2.1/workspace/{ws_id}/dtable/UsableAppsTest/external-apps/', | ||
| headers=headers, data={'app_type': 'universal-app', 'app_config': app_config}, | ||
| ) | ||
| assert response.status_code == 201 | ||
| app_uuid = response.json()['external_app']['app_uuid'] | ||
|
|
||
| response = requests.get(f'{BASE_URL}/api/v2.1/universal-apps/{app_uuid}/app-roles/', headers=headers) | ||
| assert response.status_code == 200 | ||
| role_id = next(r['id'] for r in response.json()['app_roles'] if r['role_name'] == 'default') | ||
|
|
||
| response = requests.post( | ||
| f'{BASE_URL}/api/v2.1/universal-apps/{app_uuid}/app-users/', | ||
| headers=headers, data={'app_user': user_id, 'app_role_id': role_id}, | ||
| ) | ||
| assert response.status_code == 200 | ||
|
|
||
| # List the apps the user can use | ||
| case: Case = team_admin_account_operations.find_operation_by_id('listUsableApps') \ | ||
| .Case(path_parameters={'org_id': team.team_id, 'user_id': user_id}) | ||
| response = case.call(headers=headers) | ||
|
|
||
| assert response.status_code == 200 | ||
|
|
||
| data = response.json() | ||
| assert data['count'] == 1 | ||
| assert len(data['can_use_apps']) == 1 | ||
|
|
||
| usable_app = data['can_use_apps'][0] | ||
| assert usable_app['app_uuid'] == app_uuid | ||
| assert usable_app['dtable_uuid'] == base_uuid.replace('-', '') | ||
|
|
||
| matcher = path_type({ | ||
| r"can_use_apps\.\d+\.app_user_id": (int,), | ||
| r"can_use_apps\.\d+\.app_id": (int,), | ||
| r"can_use_apps\.\d+\.app_uuid": (str,), | ||
| r"can_use_apps\.\d+\.dtable_uuid": (str,), | ||
| r"can_use_apps\.\d+\.workspace_id": (int,), | ||
| r"can_use_apps\.\d+\.link": (str,), | ||
| r"can_use_apps\.\d+\.edit_link": (str,), | ||
| r"can_use_apps\.\d+\.joined_at": (str,), | ||
| }, regex=True) | ||
|
|
||
| assert snapshot_json(matcher=matcher) == data |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Naming?