source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2018 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.permission.ws.template;
  21
  22 import java.util.List;
  23 import javax.annotation.Nullable;
  24 import org.junit.Before;
  25 import org.junit.Rule;
  26 import org.junit.Test;
  27 import org.sonar.api.resources.Qualifiers;
  28 import org.sonar.api.resources.ResourceTypes;
  29 import org.sonar.api.web.UserRole;
  30 import org.sonar.db.component.ComponentDto;
  31 import org.sonar.db.component.ResourceTypesRule;
  32 import org.sonar.db.permission.PermissionQuery;
  33 import org.sonar.db.permission.template.PermissionTemplateDto;
  34 import org.sonar.db.user.GroupDto;
  35 import org.sonar.db.user.UserDto;
  36 import org.sonar.server.es.TestProjectIndexers;
  37 import org.sonar.server.exceptions.BadRequestException;
  38 import org.sonar.server.exceptions.ForbiddenException;
  39 import org.sonar.server.exceptions.NotFoundException;
  40 import org.sonar.server.permission.PermissionService;
  41 import org.sonar.server.permission.PermissionServiceImpl;
  42 import org.sonar.server.permission.PermissionTemplateService;
  43 import org.sonar.server.permission.ws.BasePermissionWsTest;
  44 import org.sonar.server.ws.TestRequest;
  45 import org.sonar.server.ws.TestResponse;
  46
  47 import static org.assertj.core.api.Assertions.assertThat;
  48 import static org.sonar.db.permission.OrganizationPermission.ADMINISTER;
  49 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_PROJECT_ID;
  50 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_PROJECT_KEY;
  51 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_TEMPLATE_ID;
  52 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_TEMPLATE_NAME;
  53
  54 public class ApplyTemplateActionTest extends BasePermissionWsTest<ApplyTemplateAction> {
  55
  56   @Rule
  57   public DefaultTemplatesResolverRule defaultTemplatesResolver = DefaultTemplatesResolverRule.withoutGovernance();
  58   private UserDto user1;
  59   private UserDto user2;
  60   private GroupDto group1;
  61   private GroupDto group2;
  62   private ComponentDto project;
  63   private PermissionTemplateDto template1;
  64   private PermissionTemplateDto template2;
  65
  66   private ResourceTypes resourceTypes = new ResourceTypesRule().setRootQualifiers(Qualifiers.PROJECT);
  67   private PermissionService permissionService = new PermissionServiceImpl(resourceTypes);
  68
  69   private PermissionTemplateService permissionTemplateService = new PermissionTemplateService(db.getDbClient(),
  70      new TestProjectIndexers(), userSession, defaultTemplatesResolver, permissionService);
  71
  72   @Override
  73   protected ApplyTemplateAction buildWsAction() {
  74     return new ApplyTemplateAction(db.getDbClient(), userSession, permissionTemplateService, newPermissionWsSupport());
  75   }
  76
  77   @Before
  78   public void setUp() {
  79     user1 = db.users().insertUser();
  80     db.organizations().addMember(db.getDefaultOrganization(), user1);
  81     user2 = db.users().insertUser();
  82     db.organizations().addMember(db.getDefaultOrganization(), user2);
  83     group1 = db.users().insertGroup();
  84     group2 = db.users().insertGroup();
  85
  86     // template 1
  87     template1 = db.permissionTemplates().insertTemplate(db.getDefaultOrganization());
  88     addUserToTemplate(user1, template1, UserRole.CODEVIEWER);
  89     addUserToTemplate(user2, template1, UserRole.ISSUE_ADMIN);
  90     addGroupToTemplate(group1, template1, UserRole.ADMIN);
  91     addGroupToTemplate(group2, template1, UserRole.USER);
  92     // template 2
  93     template2 = db.permissionTemplates().insertTemplate(db.getDefaultOrganization());
  94     addUserToTemplate(user1, template2, UserRole.USER);
  95     addUserToTemplate(user2, template2, UserRole.USER);
  96     addGroupToTemplate(group1, template2, UserRole.USER);
  97     addGroupToTemplate(group2, template2, UserRole.USER);
  98
  99     project = db.components().insertPrivateProject();
 100     db.users().insertProjectPermissionOnUser(user1, UserRole.ADMIN, project);
 101     db.users().insertProjectPermissionOnUser(user2, UserRole.ADMIN, project);
 102     db.users().insertProjectPermissionOnGroup(group1, UserRole.ADMIN, project);
 103     db.users().insertProjectPermissionOnGroup(group2, UserRole.ADMIN, project);
 104   }
 105
 106   @Test
 107   public void apply_template_with_project_uuid() throws Exception {
 108     loginAsAdmin(db.getDefaultOrganization());
 109
 110     newRequest(template1.getUuid(), project.uuid(), null);
 111
 112     assertTemplate1AppliedToProject();
 113   }
 114
 115   @Test
 116   public void apply_template_with_project_uuid_by_template_name() {
 117     loginAsAdmin(db.getDefaultOrganization());
 118
 119     newRequest()
 120       .setParam(PARAM_TEMPLATE_NAME, template1.getName().toUpperCase())
 121       .setParam(PARAM_PROJECT_ID, project.uuid())
 122       .execute();
 123
 124     assertTemplate1AppliedToProject();
 125   }
 126
 127   @Test
 128   public void apply_template_with_project_key() throws Exception {
 129     loginAsAdmin(db.getDefaultOrganization());
 130
 131     newRequest(template1.getUuid(), null, project.getDbKey());
 132
 133     assertTemplate1AppliedToProject();
 134   }
 135
 136   @Test
 137   public void fail_when_unknown_template() throws Exception {
 138     loginAsAdmin(db.getDefaultOrganization());
 139
 140     expectedException.expect(NotFoundException.class);
 141     expectedException.expectMessage("Permission template with id 'unknown-template-uuid' is not found");
 142
 143     newRequest("unknown-template-uuid", project.uuid(), null);
 144   }
 145
 146   @Test
 147   public void fail_when_unknown_project_uuid() throws Exception {
 148     loginAsAdmin(db.getDefaultOrganization());
 149
 150     expectedException.expect(NotFoundException.class);
 151     expectedException.expectMessage("Project id 'unknown-project-uuid' not found");
 152
 153     newRequest(template1.getUuid(), "unknown-project-uuid", null);
 154   }
 155
 156   @Test
 157   public void fail_when_unknown_project_key() throws Exception {
 158     loginAsAdmin(db.getDefaultOrganization());
 159
 160     expectedException.expect(NotFoundException.class);
 161     expectedException.expectMessage("Project key 'unknown-project-key' not found");
 162
 163     newRequest(template1.getUuid(), null, "unknown-project-key");
 164   }
 165
 166   @Test
 167   public void fail_when_template_is_not_provided() throws Exception {
 168     loginAsAdmin(db.getDefaultOrganization());
 169
 170     expectedException.expect(BadRequestException.class);
 171
 172     newRequest(null, project.uuid(), null);
 173   }
 174
 175   @Test
 176   public void fail_when_project_uuid_and_key_not_provided() throws Exception {
 177     loginAsAdmin(db.getDefaultOrganization());
 178
 179     expectedException.expect(BadRequestException.class);
 180     expectedException.expectMessage("Project id or project key can be provided, not both.");
 181
 182     newRequest(template1.getUuid(), null, null);
 183   }
 184
 185   @Test
 186   public void fail_when_not_admin_of_organization() throws Exception {
 187     userSession.logIn().addPermission(ADMINISTER, "otherOrg");
 188
 189     expectedException.expect(ForbiddenException.class);
 190
 191     newRequest(template1.getUuid(), project.uuid(), null);
 192   }
 193
 194   private void assertTemplate1AppliedToProject() {
 195     assertThat(selectProjectPermissionGroups(project, UserRole.ADMIN)).containsExactly(group1.getName());
 196     assertThat(selectProjectPermissionGroups(project, UserRole.USER)).containsExactly(group2.getName());
 197     assertThat(selectProjectPermissionUsers(project, UserRole.ADMIN)).isEmpty();
 198     assertThat(selectProjectPermissionUsers(project, UserRole.CODEVIEWER)).containsExactly(user1.getId());
 199     assertThat(selectProjectPermissionUsers(project, UserRole.ISSUE_ADMIN)).containsExactly(user2.getId());
 200   }
 201
 202   private TestResponse newRequest(@Nullable String templateUuid, @Nullable String projectUuid, @Nullable String projectKey) {
 203     TestRequest request = newRequest();
 204     if (templateUuid != null) {
 205       request.setParam(PARAM_TEMPLATE_ID, templateUuid);
 206     }
 207     if (projectUuid != null) {
 208       request.setParam(PARAM_PROJECT_ID, projectUuid);
 209     }
 210     if (projectKey != null) {
 211       request.setParam(PARAM_PROJECT_KEY, projectKey);
 212     }
 213
 214     return request.execute();
 215   }
 216
 217   private void addUserToTemplate(UserDto user, PermissionTemplateDto permissionTemplate, String permission) {
 218     db.getDbClient().permissionTemplateDao().insertUserPermission(db.getSession(), permissionTemplate.getId(), user.getId(), permission);
 219     db.commit();
 220   }
 221
 222   private void addGroupToTemplate(GroupDto group, PermissionTemplateDto permissionTemplate, String permission) {
 223     db.getDbClient().permissionTemplateDao().insertGroupPermission(db.getSession(), permissionTemplate.getId(), group.getId(), permission);
 224     db.commit();
 225   }
 226
 227   private List<String> selectProjectPermissionGroups(ComponentDto project, String permission) {
 228     PermissionQuery query = PermissionQuery.builder().setOrganizationUuid(project.getOrganizationUuid()).setPermission(permission).setComponentUuid(project.uuid()).build();
 229     return db.getDbClient().groupPermissionDao().selectGroupNamesByQuery(db.getSession(), query);
 230   }
 231
 232   private List<Integer> selectProjectPermissionUsers(ComponentDto project, String permission) {
 233     PermissionQuery query = PermissionQuery.builder().setOrganizationUuid(project.getOrganizationUuid()).setPermission(permission).setComponentUuid(project.uuid()).build();
 234     return db.getDbClient().userPermissionDao().selectUserIdsByQuery(db.getSession(), query);
 235   }
 236 }