Skip to content

Commit

Permalink
Merge pull request #3730 from inception-project/bugfix/3729-Project-p…
Browse files Browse the repository at this point in the history 
…ermissions-for-project-bound-users-of-foreign-project-might-be-created

#3729 - Project permissions for project-bound users of foreign project might be created
  • Loading branch information
@reckart
reckart authored Jan 18, 2023
2 parents 4655f2d + a6f84ea commit 11b7870
Show file tree
Hide file tree
Showing 4 changed files with 326 additions and 62 deletions.
46 changes: 46 additions & 0 deletions ...-api/src/main/java/de/tudarmstadt/ukp/clarin/webanno/api/export/ProjectImportRequest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ public class ProjectImportRequest
private final boolean importPermissions;
private final User manager;

private ProjectImportRequest(Builder builder)
{
this.createMissingUsers = builder.createMissingUsers;
this.importPermissions = builder.importPermissions;
this.manager = builder.manager;
}

/**
* Request the import of a project, optionally creating any users referenced in the project but
* missing in the current instance.
Expand Down Expand Up @@ -96,4 +103,43 @@ public Optional<User> getManager()
{
return Optional.ofNullable(manager);
}

public static Builder builder()
{
return new Builder();
}

public static final class Builder
{
private boolean createMissingUsers;
private boolean importPermissions;
private User manager;

private Builder()
{
}

public Builder withCreateMissingUsers(boolean aCreateMissingUsers)
{
this.createMissingUsers = aCreateMissingUsers;
return this;
}

public Builder withImportPermissions(boolean aImportPermissions)
{
this.importPermissions = aImportPermissions;
return this;
}

public Builder withManager(User aManager)
{
this.manager = aManager;
return this;
}

public ProjectImportRequest build()
{
return new ProjectImportRequest(this);
}
}
}
154 changes: 128 additions & 26 deletions ...st/java/de/tudarmstadt/ukp/inception/export/exporters/ProjectPermissionsExporterTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,14 @@

import static de.tudarmstadt.ukp.clarin.webanno.model.PermissionLevel.ANNOTATOR;
import static de.tudarmstadt.ukp.clarin.webanno.model.PermissionLevel.MANAGER;
import static de.tudarmstadt.ukp.clarin.webanno.security.UserDao.REALM_GLOBAL;
import static de.tudarmstadt.ukp.clarin.webanno.security.UserDao.REALM_PROJECT_PREFIX;
import static de.tudarmstadt.ukp.clarin.webanno.security.model.Role.ROLE_USER;
import static java.util.Arrays.asList;
import static org.apache.commons.collections4.CollectionUtils.union;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.lenient;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

Expand Down Expand Up @@ -66,71 +67,172 @@ public class ProjectPermissionsExporterTest
private @Mock UserDao userService;

private Project project;
private ExportedProject exportedProject;

private User manager;
private List<ProjectPermission> managerPermissions;
private User annotator;
private List<ProjectPermission> annotatorPermissions;

private ProjectPermissionsExporter sut;

private ArgumentCaptor<User> userCaptor;
private ArgumentCaptor<ProjectPermission> permissionCaptor;

@BeforeEach
public void setUp() throws Exception
{
new ApplicationContextProvider().setApplicationContext(appContext);
when(appContext.getBean("passwordEncoder", PasswordEncoder.class))
lenient().when(appContext.getBean("passwordEncoder", PasswordEncoder.class))
.thenReturn(new BCryptPasswordEncoder());

project = new Project();
project.setId(1l);
project.setName("Test Project");
project = Project.builder().withId(1l).withName("Test Project").build();
exportedProject = new ExportedProject();

manager = new User("manager", ROLE_USER);
manager = User.builder().withUsername("manager").withRoles(ROLE_USER).build();
managerPermissions = asList(new ProjectPermission(project, manager.getUsername(), MANAGER));

annotator = new User("projectAnnotator", ROLE_USER);
annotator.setRealm(REALM_PROJECT_PREFIX + project.getId());
annotatorPermissions = asList(
new ProjectPermission(project, annotator.getUsername(), ANNOTATOR));

sut = new ProjectPermissionsExporter(projectService, userService);

when(projectService.listProjectUsersWithPermissions(any()))
.thenReturn(asList(manager, annotator));
when(projectService.listProjectPermissionLevel(manager, project))
.thenReturn(managerPermissions);
when(projectService.listProjectPermissionLevel(annotator, project))
.thenReturn(annotatorPermissions);

sut = new ProjectPermissionsExporter(projectService, userService);
userCaptor = captureCreatedUsers();
permissionCaptor = captureCreatedPermissions();
}

@Test
public void thatExportingWorks() throws Exception
public void thatUserPermissionsAreExportedAndImported() throws Exception
{
// Export the project
FullProjectExportRequest exportRequest = new FullProjectExportRequest(project, null, false);
ProjectExportTaskMonitor monitor = new ProjectExportTaskMonitor(project, null, "test");
ExportedProject exportedProject = new ExportedProject();
annotator.setRealm(REALM_GLOBAL);

sut.exportData(exportRequest, monitor, exportedProject, workFolder);

// Import the project again
ArgumentCaptor<User> userCaptor = ArgumentCaptor.forClass(User.class);
when(userService.create(userCaptor.capture())).thenAnswer(_call -> _call.getArgument(0));
exportProject();

ArgumentCaptor<ProjectPermission> permissionCaptor = ArgumentCaptor
.forClass(ProjectPermission.class);
doNothing().when(projectService).createProjectPermission(permissionCaptor.capture());
var importRequest = ProjectImportRequest.builder() //
.withCreateMissingUsers(true) //
.withImportPermissions(true) //
.build();
sut.importData(importRequest, project, exportedProject, mock(ZipFile.class));

ProjectImportRequest importRequest = new ProjectImportRequest(true);
ZipFile zipFile = mock(ZipFile.class);
sut.importData(importRequest, project, exportedProject, zipFile);

// Check that after re-importing the exported projects, they are identical to the original
assertThat(userCaptor.getAllValues()) //
.as("Missing users have been created") //
.containsExactlyInAnyOrderElementsOf(asList(manager, annotator));

assertThat(permissionCaptor.getAllValues()) //
.as("Permissions have been imported") //
.usingRecursiveFieldByFieldElementComparatorIgnoringFields("id") //
.containsExactlyInAnyOrderElementsOf(
union(managerPermissions, annotatorPermissions));
}

@Test
public void thatUserPermissionsAreNotImported() throws Exception
{
annotator.setRealm(REALM_GLOBAL);

exportProject();

var importRequest = ProjectImportRequest.builder() //
.withCreateMissingUsers(false) //
.withImportPermissions(false) //
.withManager(manager) //
.build();
sut.importData(importRequest, project, exportedProject, mock(ZipFile.class));

assertThat(userCaptor.getAllValues()) //
.as("No missing users have been created") //
.isEmpty();

assertThat(permissionCaptor.getAllValues()) //
.as("Permissions have been imported") //
.usingRecursiveFieldByFieldElementComparatorIgnoringFields("id") //
.containsExactlyInAnyOrderElementsOf(managerPermissions);
}

@Test
public void thatProjectSpecificPermissionsAreCreatedIfUserDidNotYetExist() throws Exception
{
annotator.setRealm(REALM_PROJECT_PREFIX + project.getId());

exportProject();

// Trying to import project into another instance from which the project was exported, so
// the project-bound user should not yet exist. Thus, we can create this user and set up the
// permissions
when(userService.exists(annotator.getUsername())).thenReturn(false);

var importRequest = ProjectImportRequest.builder() //
.withCreateMissingUsers(false) // project-bound users are always created ...
.withImportPermissions(false) // ... and always get their permissions
.build();
sut.importData(importRequest, project, exportedProject, mock(ZipFile.class));

assertThat(userCaptor.getAllValues()) //
.as("Missing users have been created") //
.containsExactlyInAnyOrderElementsOf(asList(annotator));

assertThat(permissionCaptor.getAllValues()) //
.as("Permissions have been imported") //
.usingRecursiveFieldByFieldElementComparatorIgnoringFields("id") //
.containsExactlyInAnyOrderElementsOf(annotatorPermissions);
}

@Test
public void thatProjectSpecificPermissionsAreNotCreatedIfUserAlreadyExisted() throws Exception
{
annotator.setRealm(REALM_PROJECT_PREFIX + project.getId());

exportProject();

// Trying to import project into the same instance from which the project was exported, so
// the project-bound user already exists. We must not bind this used to another project in
// the same instance.
when(userService.exists(annotator.getUsername())).thenReturn(true);

var importRequest = ProjectImportRequest.builder() //
.withCreateMissingUsers(false) // project-bound users are always created ...
.withImportPermissions(true) // ... and always get their permissions unless they
// existed!
.build();
sut.importData(importRequest, project, exportedProject, mock(ZipFile.class));

assertThat(userCaptor.getAllValues()) //
.as("No missing users have been created") //
.isEmpty();

assertThat(permissionCaptor.getAllValues()) //
.as("Permissions have been imported") //
.usingRecursiveFieldByFieldElementComparatorIgnoringFields("id") //
.containsExactlyInAnyOrderElementsOf(managerPermissions);
}

private void exportProject() throws Exception
{
FullProjectExportRequest exportRequest = new FullProjectExportRequest(project, null, false);
ProjectExportTaskMonitor monitor = new ProjectExportTaskMonitor(project, null, "test");
sut.exportData(exportRequest, monitor, exportedProject, workFolder);
}

private ArgumentCaptor<ProjectPermission> captureCreatedPermissions()
{
ArgumentCaptor<ProjectPermission> captor = ArgumentCaptor.forClass(ProjectPermission.class);
lenient().doNothing().when(projectService).createProjectPermission(captor.capture());
return captor;
}

private ArgumentCaptor<User> captureCreatedUsers()
{
ArgumentCaptor<User> captor = ArgumentCaptor.forClass(User.class);
lenient().when(userService.create(captor.capture()))
.thenAnswer(_call -> _call.getArgument(0));
return captor;
}
}
Loading

0 comments on commit 11b7870

Please sign in to comment.