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.

Sign up for GitHub

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

task/WP-682: Fix Community Project Folders on Core portals #1041

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
+58 −48
Open

task/WP-682: Fix Community Project Folders on Core portals #1041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
12990a3
To update ACLs on shared systems outside of the root project's direct…
fnets Dec 12, 2024
75a5924
In the case where a user is added to a project but doesn’t have file …
fnets Jan 15, 2025
4fa22cd
Resolving issues with root directory hardcoding and refactoring funct…
fnets Jan 15, 2025
269aa35
minor refactoring
fnets Jan 15, 2025
f6e1cf5
Changed ACL job to submit with the user's client, so that we know the…
fnets Jan 22, 2025
83a7871
Merge branch 'main' into task/WP-682
fnets Jan 22, 2025
00c9f7b
Adding path back into logger statement.
fnets Jan 22, 2025
b226779
Fixed unit tests to work with code changes.
fnets Jan 31, 2025
2cd6a69
Merge branch 'task/WP-682' of https://github.com/TACC/Core-Portal int…
fnets Jan 31, 2025
69ba64a
Fixed linting errors
fnets Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions server/portal/apps/projects/unit_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,8 +251,8 @@ def create_shared_workspace_2_user(
new_username = "new_user"
mock_add_user_to_workspace(client, workspace_id, new_username, "writer")
mock_service_account().files.setFacl.assert_called_with(
systemId="projects.system.name",
path="test.project-2",
systemId="test.project.test.project-2",
path="/",
operation="ADD",
recursionMethod="PHYSICAL",
aclString=f"d:u:{new_username}:rwX,u:{new_username}:rwX",
Expand Down Expand Up @@ -519,7 +519,7 @@ def test_add_member(mock_tapis_client, mock_owner, authenticated_user):
"title": mock_system_result.notes.title,
"description": getattr(mock_system_result.notes, "description", None),
"created": mock_system_result.updated,
"projectId": "test.project-2",
"projectId": "test.project.test.project-2",
"members": [
{"user": ws_o.get_project_user("username"), "access": "owner"},
],
Expand Down Expand Up @@ -548,8 +548,8 @@ def test_add_member(mock_tapis_client, mock_owner, authenticated_user):
mock_service_account.assert_called()

mock_service_account().files.setFacl.assert_called_with(
systemId="projects.system.name",
path="test.project-2",
systemId="test.project.test.project-2",
path="/",
operation="ADD",
recursionMethod="PHYSICAL",
aclString=f"d:u:{new_username}:rwX,u:{new_username}:rwX",
Expand Down Expand Up @@ -768,8 +768,8 @@ def test_get_workspace_role(mock_tapis_client, mock_owner, authenticated_user):
new_username = "new_user"
mock_add_user_to_workspace(client, workspace_id, new_username, "writer")
mock_service_account().files.setFacl.assert_called_with(
systemId="projects.system.name",
path="test.project-2",
systemId="test.project.test.project-2",
path="/",
operation="ADD",
recursionMethod="PHYSICAL",
aclString=f"d:u:{new_username}:rwX,u:{new_username}:rwX",
Expand Down Expand Up @@ -801,8 +801,8 @@ def test_get_workspace_role(mock_tapis_client, mock_owner, authenticated_user):
# Add user action
mock_add_user_to_workspace(client, workspace_id, "GuestAccount", "reader")
mock_service_account().files.setFacl.assert_called_with(
systemId="projects.system.name",
path="test.project-2",
systemId="test.project.test.project-2",
path="/",
operation="ADD",
recursionMethod="PHYSICAL",
aclString="d:u:GuestAccount:rX,u:GuestAccount:rX",
Expand Down
52 changes: 28 additions & 24 deletions server/portal/apps/projects/views_unit_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,7 @@ def test_projects_search(


def test_projects_search_result_not_in_tapis(
authenticated_user,
client,
mock_tapis_client,
mock_project_index,
mock_project_search_indexer,
project_list,
Expand Down Expand Up @@ -219,6 +217,9 @@ def test_projects_post(
def test_projects_post_setfacl_job(
authenticated_user, client, mock_service_account, mock_tapis_client
):

mock_rootDir = mock_service_account().systems.getSystem().rootDir

response = client.post(
"/api/projects/",
{
Expand All @@ -227,7 +228,6 @@ def test_projects_post_setfacl_job(
},
content_type="application/json",
)

assert response.status_code == 200
assert response.json() == {
"status": 200,
Expand All @@ -241,7 +241,7 @@ def test_projects_post_setfacl_job(
)
mock_service_account().files.setFacl.assert_not_called()
mock_service_account().jobs.submitJob.assert_called_with(
name='setfacl-project-test.project-2-username-add-writer',
name='setfacl-project-projects.system.name-username-add-writer',
appId='setfacl-corral-wmaprtl',
appVersion='0.0.1',
description='Add/Remove ACLs on a directory',
Expand All @@ -251,7 +251,7 @@ def test_projects_post_setfacl_job(
'schedulerOptions': [],
'envVariables': [
{'key': 'usernames', 'value': 'username'},
{'key': 'directory', 'value': '/path/to/root/test.project-2'},
{'key': 'directory', 'value': str(mock_rootDir)},
{'key': 'action', 'value': 'add'},
{'key': 'role', 'value': 'writer'},
],
Expand Down Expand Up @@ -373,7 +373,7 @@ def test_project_instance_patch(
}


def test_project_change_role(authenticated_user, client, mock_project_mgr):
def test_project_change_role(client, mock_project_mgr):
mock_project_mgr.change_project_role.return_value = MagicMock(
metadata={"projectId": "PRJ-123"}
)
Expand All @@ -395,7 +395,7 @@ def test_project_change_role(authenticated_user, client, mock_project_mgr):


def test_project_change_system_role(
authenticated_user, client, mock_service_account, mock_tapis_client
client, mock_service_account, mock_tapis_client
):
# USER translates to writer role
patch_body = {
Expand All @@ -409,8 +409,8 @@ def test_project_change_system_role(
assert response.json() == {"status": 200, "response": "OK"}
# System Id used in setFacl is project root system name
mock_service_account().files.setFacl.assert_called_with(
systemId="projects.system.name",
path="PRJ-123",
systemId="test.project.PRJ-123",
path="/",
operation="ADD",
recursionMethod="PHYSICAL",
aclString="d:u:test_user:rwX,u:test_user:rwX",
Expand All @@ -431,8 +431,10 @@ def test_project_change_system_role(

@override_settings(PORTAL_PROJECTS_USE_SET_FACL_JOB=True)
def test_project_change_system_role_setfacl_job(
authenticated_user, client, mock_service_account, mock_tapis_client
client, mock_service_account, mock_tapis_client
):
mock_rootDir = mock_service_account().systems.getSystem().rootDir

# USER translates to writer role
patch_body = {
"action": "change_system_role",
Expand All @@ -446,7 +448,7 @@ def test_project_change_system_role_setfacl_job(
# System Id used in setFacl is project root system name
mock_service_account().files.setFacl.assert_not_called()
mock_service_account().jobs.submitJob.assert_called_with(
name='setfacl-project-PRJ-123-test_user-add-writer',
name='setfacl-project-test.project.PRJ-123-test_user-add-writer',
appId='setfacl-corral-wmaprtl',
appVersion='0.0.1',
description='Add/Remove ACLs on a directory',
Expand All @@ -456,7 +458,7 @@ def test_project_change_system_role_setfacl_job(
'schedulerOptions': [],
'envVariables': [
{'key': 'usernames', 'value': 'test_user'},
{'key': 'directory', 'value': '/path/to/root/PRJ-123'},
{'key': 'directory', 'value': str(mock_rootDir)},
{'key': 'action', 'value': 'add'},
{'key': 'role', 'value': 'writer'},
],
Expand All @@ -478,7 +480,7 @@ def test_project_change_system_role_setfacl_job(


def test_members_view_add(
authenticated_user, client, mock_service_account, mock_tapis_client, project_list
authenticated_user, client, mock_tapis_client, project_list
):
mock_tapis_client.systems.getSystem.return_value = project_list["tapis_response"][0]
mock_tapis_client.systems.getShareInfo.return_value = TapisResult(
Expand Down Expand Up @@ -525,9 +527,10 @@ def test_members_view_add(
"title": project_list["api_response"][0]["title"],
},
}
mock_service_account().files.setFacl.assert_called_with(
systemId="projects.system.name",
path="PRJ-123",

mock_tapis_client.files.setFacl.assert_called_with(
systemId="test.project.PRJ-123",
path="/",
operation="ADD",
recursionMethod="PHYSICAL",
aclString="d:u:test_user:rwX,u:test_user:rwX",
Expand Down Expand Up @@ -599,7 +602,7 @@ def test_members_view_add_setfacl_job(
}
mock_service_account().files.setFacl.assert_not_called()
mock_service_account().jobs.submitJob.assert_called_with(
name='setfacl-project-PRJ-123-test_user-add-writer',
name='setfacl-project-test.project.PRJ-123-test_user-add-writer',
appId='setfacl-corral-wmaprtl',
appVersion='0.0.1',
description='Add/Remove ACLs on a directory',
Expand All @@ -609,7 +612,7 @@ def test_members_view_add_setfacl_job(
'schedulerOptions': [],
'envVariables': [
{'key': 'usernames', 'value': 'test_user'},
{'key': 'directory', 'value': '/path/to/root/PRJ-123'},
{'key': 'directory', 'value': '/corral-repl/tacc/aci/CEP/projects/CEP-1018'},
{'key': 'action', 'value': 'add'},
{'key': 'role', 'value': 'writer'},
],
Expand All @@ -633,7 +636,7 @@ def test_members_view_add_setfacl_job(


def test_members_view_remove(
authenticated_user, client, mock_service_account, mock_tapis_client, project_list
client, mock_service_account, mock_tapis_client, project_list
):
mock_tapis_client.systems.getSystem.return_value = project_list["tapis_response"][0]
patch_body = {"action": "remove_member", "username": "test_user"}
Expand Down Expand Up @@ -661,8 +664,8 @@ def test_members_view_remove(
},
}
mock_service_account().files.setFacl.assert_called_with(
systemId="projects.system.name",
path="PRJ-123",
systemId="test.project.PRJ-123",
path="/",
operation="REMOVE",
recursionMethod="PHYSICAL",
aclString="d:u:test_user,u:test_user",
Expand All @@ -685,9 +688,10 @@ def test_members_view_remove(

@override_settings(PORTAL_PROJECTS_USE_SET_FACL_JOB=True)
def test_members_view_remove_setfacl_job(
authenticated_user, client, mock_service_account, mock_tapis_client, project_list
client, mock_service_account, mock_tapis_client, project_list
):
mock_tapis_client.systems.getSystem.return_value = project_list["tapis_response"][0]
mock_rootDir = mock_service_account().systems.getSystem().rootDir
patch_body = {"action": "remove_member", "username": "test_user"}

response = client.patch("/api/projects/PRJ-123/members/", json.dumps(patch_body))
Expand All @@ -714,7 +718,7 @@ def test_members_view_remove_setfacl_job(
}
mock_service_account().files.setFacl.assert_not_called()
mock_service_account().jobs.submitJob.assert_called_with(
name='setfacl-project-PRJ-123-test_user-remove-none',
name='setfacl-project-test.project.PRJ-123-test_user-remove-none',
appId='setfacl-corral-wmaprtl',
appVersion='0.0.1',
description='Add/Remove ACLs on a directory',
Expand All @@ -724,7 +728,7 @@ def test_members_view_remove_setfacl_job(
'schedulerOptions': [],
'envVariables': [
{'key': 'usernames', 'value': 'test_user'},
{'key': 'directory', 'value': '/path/to/root/PRJ-123'},
{'key': 'directory', 'value': str(mock_rootDir)},
{'key': 'action', 'value': 'remove'},
{'key': 'role', 'value': 'none'},
],
Expand Down
36 changes: 21 additions & 15 deletions server/portal/apps/projects/workspace_operations/shared_workspace_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ def set_workspace_acls(client, system_id, path, username, operation, role):
}

if settings.PORTAL_PROJECTS_USE_SET_FACL_JOB:
logger.info(f"Using setfacl job to submit ACL change for project: {path}, username: {username}, operation: {operation}, role: {role}")
job_res = submit_workspace_acls_job(username, path, role, operation)
logger.info(f"""Using setfacl job to submit ACL change for project: {system_id},
path: {path}, username: {username}, operation: {operation}, role: {role}""")
job_res = submit_workspace_acls_job(client, username, system_id, role, operation)
logger.info(f"Submitted workspace ACL job {job_res.name} with UUID {job_res.uuid}")
return

Expand All @@ -73,7 +74,7 @@ def set_workspace_acls(client, system_id, path, username, operation, role):


def submit_workspace_acls_job(
username, project_name, role, action=Literal["add", "remove"]
user_client, username, system_id, role, action=Literal["add", "remove"]
):
"""
Submit a job to set ACLs on a project for a specific user. This should be used if
Expand All @@ -83,8 +84,10 @@ def submit_workspace_acls_job(
client = service_account()
portal_name = settings.PORTAL_NAMESPACE

prj = user_client.systems.getSystem(systemId=system_id)
rstijerina marked this conversation as resolved.
Show resolved Hide resolved

job_body = {
"name": f"setfacl-project-{project_name}-{username}-{action}-{role}",
"name": f"setfacl-project-{system_id}-{username}-{action}-{role}"[:64],
"appId": "setfacl-corral-wmaprtl",
"appVersion": "0.0.1",
"description": "Add/Remove ACLs on a directory",
Expand All @@ -96,7 +99,7 @@ def submit_workspace_acls_job(
{"key": "usernames", "value": username},
{
"key": "directory",
"value": f"{settings.PORTAL_PROJECTS_ROOT_DIR}/{project_name}",
"value": f"{prj.rootDir}",
},
{"key": "action", "value": action},
{"key": "role", "value": role},
Expand Down Expand Up @@ -199,11 +202,10 @@ def add_user_to_workspace(client: Tapis,
"""
Give a user POSIX and Tapis permissions on a workspace system.
"""
service_client = service_account()
system_id = f"{settings.PORTAL_PROJECTS_SYSTEM_PREFIX}.{workspace_id}"
set_workspace_acls(service_client,
settings.PORTAL_PROJECTS_ROOT_SYSTEM_NAME,
workspace_id,
set_workspace_acls(client,
system_id,
"/",
username,
"add",
role)
Expand Down Expand Up @@ -231,8 +233,8 @@ def change_user_role(client, workspace_id: str, username: str, new_role):
service_client = service_account()
system_id = f"{settings.PORTAL_PROJECTS_SYSTEM_PREFIX}.{workspace_id}"
set_workspace_acls(service_client,
settings.PORTAL_PROJECTS_ROOT_SYSTEM_NAME,
workspace_id,
system_id,
"/",
username,
"add",
new_role)
Expand All @@ -247,8 +249,8 @@ def remove_user(client, workspace_id: str, username: str):
service_client = service_account()
system_id = f"{settings.PORTAL_PROJECTS_SYSTEM_PREFIX}.{workspace_id}"
set_workspace_acls(service_client,
settings.PORTAL_PROJECTS_ROOT_SYSTEM_NAME,
workspace_id,
system_id,
"/",
username,
"remove",
"none")
Expand All @@ -271,8 +273,8 @@ def transfer_ownership(client, workspace_id: str, new_owner: str, old_owner: str
service_client = service_account()
system_id = f"{settings.PORTAL_PROJECTS_SYSTEM_PREFIX}.{workspace_id}"
set_workspace_acls(service_client,
settings.PORTAL_PROJECTS_ROOT_SYSTEM_NAME,
workspace_id,
system_id,
"/",
new_owner,
"add",
"writer")
Expand Down Expand Up @@ -352,6 +354,10 @@ def get_project(client, workspace_id):
access = 'edit'
elif perms.permission == 'READ':
access = 'read'
else:
logger.info(f"System shared to user without proper Tapis file permissions: {system_id}, username: {username}")
rstijerina marked this conversation as resolved.
Show resolved Hide resolved
access = 'none'

users.append({"user": get_project_user(username), "access": access})

return {
Expand Down
Loading