SONAR-4694 Refactor GlobalPermission definitions by replacing object by string and add ComponentPermissions containing component permissions

4 files changed, 94 insertions, 74 deletions

diff --git a/sonar-core/src/main/java/org/sonar/core/permission/ComponentPermissions.java b/sonar-core/src/main/java/org/sonar/core/permission/ComponentPermissions.java
new file mode 100644
index 00000000000..9cffdcb1eaa
--- /dev/null
+++ b/sonar-core/src/main/java/org/sonar/core/permission/ComponentPermissions.java
@@ -0,0 +1,40 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2013 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+package org.sonar.core.permission;
+
+import com.google.common.collect.ImmutableList;
+import org.sonar.api.web.UserRole;
+
+import java.util.List;
+
+/**
+ * Holds the constants representing the various component permissions that can be assigned to users & groups
+ *
+ */
+public final class ComponentPermissions {
+
+  /**
+   * All the component permissions values, ordered from {@link UserRole#USER} to {@link UserRole#CODEVIEWER}.
+   */
+  public static final List<String> ALL = ImmutableList.of(UserRole.USER, UserRole.ADMIN, UserRole.CODEVIEWER);
+
+
+}
diff --git a/sonar-core/src/main/java/org/sonar/core/permission/GlobalPermission.java b/sonar-core/src/main/java/org/sonar/core/permission/GlobalPermission.java
deleted file mode 100644
index 9696ed4e4c9..00000000000
--- a/sonar-core/src/main/java/org/sonar/core/permission/GlobalPermission.java
+++ /dev/null
@@ -1,64 +0,0 @@
-/*
- * SonarQube, open source software quality management tool.
- * Copyright (C) 2008-2013 SonarSource
- * mailto:contact AT sonarsource DOT com
- *
- * SonarQube is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * SonarQube is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
- */
-
-package org.sonar.core.permission;
-
-import java.util.LinkedHashMap;
-import java.util.Map;
-
-/**
- * Holds the constants representing the various global permissions that can be assigned to users & groups
- *
- * @since 3.7
- */
-public class GlobalPermission {
-
-  public static final GlobalPermission SYSTEM_ADMIN = new GlobalPermission("admin");
-  public static final GlobalPermission QUALITY_PROFILE_ADMIN = new GlobalPermission("profileadmin");
-  public static final GlobalPermission DASHBOARD_SHARING = new GlobalPermission("shareDashboard");
-  public static final GlobalPermission SCAN_EXECUTION = new GlobalPermission("scan");
-  public static final GlobalPermission DRY_RUN_EXECUTION = new GlobalPermission("dryRunScan");
-
-  private final String key;
-
-  // Use linked hash map to preserve order
-  private static Map<String, GlobalPermission> allGlobal = new LinkedHashMap<String, GlobalPermission>();
-
-  static {
-    allGlobal.put(SYSTEM_ADMIN.key, SYSTEM_ADMIN);
-    allGlobal.put(QUALITY_PROFILE_ADMIN.key, QUALITY_PROFILE_ADMIN);
-    allGlobal.put(DASHBOARD_SHARING.key, DASHBOARD_SHARING);
-    allGlobal.put(SCAN_EXECUTION.key, SCAN_EXECUTION);
-    allGlobal.put(DRY_RUN_EXECUTION.key, DRY_RUN_EXECUTION);
-  }
-
-  private GlobalPermission(String key) {
-    this.key = key;
-  }
-
-  public String key() {
-    return key;
-  }
-
-  public static Map<String, GlobalPermission> allGlobal() {
-    return allGlobal;
-  }
-
-}
diff --git a/sonar-core/src/main/java/org/sonar/core/permission/GlobalPermissions.java b/sonar-core/src/main/java/org/sonar/core/permission/GlobalPermissions.java
new file mode 100644
index 00000000000..1757220c330
--- /dev/null
+++ b/sonar-core/src/main/java/org/sonar/core/permission/GlobalPermissions.java
@@ -0,0 +1,44 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2013 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+package org.sonar.core.permission;
+
+import com.google.common.collect.ImmutableList;
+
+import java.util.List;
+
+/**
+ * Holds the constants representing the various global permissions that can be assigned to users & groups
+ *
+ */
+public final class GlobalPermissions {
+
+  public static final String SYSTEM_ADMIN = "admin";
+  public static final String QUALITY_PROFILE_ADMIN = "profileadmin";
+  public static final String DASHBOARD_SHARING = "shareDashboard";
+  public static final String SCAN_EXECUTION = "scan";
+  public static final String DRY_RUN_EXECUTION = "dryRunScan";
+
+  /**
+   * All the global permissions values, ordered from {@link #SYSTEM_ADMIN} to {@link #DRY_RUN_EXECUTION}.
+   */
+  public static final List<String> ALL = ImmutableList.of(SYSTEM_ADMIN, QUALITY_PROFILE_ADMIN, DASHBOARD_SHARING, SCAN_EXECUTION, DRY_RUN_EXECUTION);
+
+}
diff --git a/sonar-core/src/test/java/org/sonar/core/user/RoleDaoTest.java b/sonar-core/src/test/java/org/sonar/core/user/RoleDaoTest.java
index b3d94a203cb..7f28109eb42 100644
--- a/sonar-core/src/test/java/org/sonar/core/user/RoleDaoTest.java
+++ b/sonar-core/src/test/java/org/sonar/core/user/RoleDaoTest.java
@@ -22,7 +22,7 @@ package org.sonar.core.user;
 
 import org.junit.Test;
 import org.sonar.api.security.DefaultGroups;
-import org.sonar.core.permission.GlobalPermission;
+import org.sonar.core.permission.GlobalPermissions;
 import org.sonar.core.persistence.AbstractDaoTestCase;
 
 import static org.fest.assertions.Assertions.assertThat;
@@ -35,8 +35,8 @@ public class RoleDaoTest extends AbstractDaoTestCase {
 
     RoleDao dao = new RoleDao(getMyBatis());
 
-    assertThat(dao.selectUserPermissions("admin_user")).containsOnly(GlobalPermission.SYSTEM_ADMIN.key(), GlobalPermission.QUALITY_PROFILE_ADMIN.key());
-    assertThat(dao.selectUserPermissions("profile_admin_user")).containsOnly(GlobalPermission.QUALITY_PROFILE_ADMIN.key());
+    assertThat(dao.selectUserPermissions("admin_user")).containsOnly(GlobalPermissions.SYSTEM_ADMIN, GlobalPermissions.QUALITY_PROFILE_ADMIN);
+    assertThat(dao.selectUserPermissions("profile_admin_user")).containsOnly(GlobalPermissions.QUALITY_PROFILE_ADMIN);
   }
 
   @Test
@@ -45,18 +45,18 @@ public class RoleDaoTest extends AbstractDaoTestCase {
 
     RoleDao dao = new RoleDao(getMyBatis());
 
-    assertThat(dao.selectGroupPermissions("sonar-administrators")).containsOnly(GlobalPermission.SYSTEM_ADMIN.key(), GlobalPermission.QUALITY_PROFILE_ADMIN.key(),
-        GlobalPermission.DASHBOARD_SHARING.key(), GlobalPermission.DRY_RUN_EXECUTION.key(), GlobalPermission.SCAN_EXECUTION.key());
-    assertThat(dao.selectGroupPermissions("sonar-users")).containsOnly(GlobalPermission.DASHBOARD_SHARING.key(), GlobalPermission.DRY_RUN_EXECUTION.key(),
-        GlobalPermission.SCAN_EXECUTION.key());
-    assertThat(dao.selectGroupPermissions(DefaultGroups.ANYONE)).containsOnly(GlobalPermission.DRY_RUN_EXECUTION.key(), GlobalPermission.SCAN_EXECUTION.key());
+    assertThat(dao.selectGroupPermissions("sonar-administrators")).containsOnly(GlobalPermissions.SYSTEM_ADMIN, GlobalPermissions.QUALITY_PROFILE_ADMIN,
+        GlobalPermissions.DASHBOARD_SHARING, GlobalPermissions.DRY_RUN_EXECUTION, GlobalPermissions.SCAN_EXECUTION);
+    assertThat(dao.selectGroupPermissions("sonar-users")).containsOnly(GlobalPermissions.DASHBOARD_SHARING, GlobalPermissions.DRY_RUN_EXECUTION,
+        GlobalPermissions.SCAN_EXECUTION);
+    assertThat(dao.selectGroupPermissions(DefaultGroups.ANYONE)).containsOnly(GlobalPermissions.DRY_RUN_EXECUTION, GlobalPermissions.SCAN_EXECUTION);
   }
 
   @Test
   public void should_delete_user_global_permission() throws Exception {
     setupData("userPermissions");
 
-    UserRoleDto userRoleToDelete = new UserRoleDto().setUserId(200L).setRole(GlobalPermission.QUALITY_PROFILE_ADMIN.key());
+    UserRoleDto userRoleToDelete = new UserRoleDto().setUserId(200L).setRole(GlobalPermissions.QUALITY_PROFILE_ADMIN);
 
     RoleDao dao = new RoleDao(getMyBatis());
     dao.deleteUserRole(userRoleToDelete);
@@ -68,7 +68,7 @@ public class RoleDaoTest extends AbstractDaoTestCase {
   public void should_delete_group_global_permission() throws Exception {
     setupData("groupPermissions");
 
-    GroupRoleDto groupRoleToDelete = new GroupRoleDto().setGroupId(100L).setRole(GlobalPermission.QUALITY_PROFILE_ADMIN.key());
+    GroupRoleDto groupRoleToDelete = new GroupRoleDto().setGroupId(100L).setRole(GlobalPermissions.QUALITY_PROFILE_ADMIN);
 
     RoleDao dao = new RoleDao(getMyBatis());
     dao.deleteGroupRole(groupRoleToDelete);