SONAR-8191 add WS api/root/unset_root

diff --git a/server/sonar-server/src/main/java/org/sonar/server/root/ws/RootWsModule.java b/server/sonar-server/src/main/java/org/sonar/server/root/ws/RootWsModule.java
index 4cd92de2ad4b7b77196f6ae756f3e77b0cca5a3f..2b5edc86b7a28710505c0c615e9c34fa26c852d1 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/root/ws/RootWsModule.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/root/ws/RootWsModule.java
@@ -25,6 +25,7 @@ public class RootWsModule extends Module {
   @Override
   protected void configureModule() {
     add(RootWs.class,
-      SetRootWsAction.class);
+      SetRootWsAction.class,
+      UnsetRootWsAction.class);
   }
 }

diff --git a/server/sonar-server/src/main/java/org/sonar/server/root/ws/UnsetRootWsAction.java b/server/sonar-server/src/main/java/org/sonar/server/root/ws/UnsetRootWsAction.java
new file mode 100644 (file)
index 0000000..1dcf2b7
--- /dev/null
+++ b/server/sonar-server/src/main/java/org/sonar/server/root/ws/UnsetRootWsAction.java
@@ -0,0 +1,68 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2016 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * This program 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.
+ *
+ * This program 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.server.root.ws;
+
+import org.sonar.api.server.ws.Request;
+import org.sonar.api.server.ws.Response;
+import org.sonar.api.server.ws.WebService;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
+import org.sonar.server.user.UserSession;
+
+public class UnsetRootWsAction implements RootWsAction {
+  private static final String PARAM_LOGIN = "login";
+
+  private final UserSession userSession;
+  private final DbClient dbClient;
+
+  public UnsetRootWsAction(UserSession userSession, DbClient dbClient) {
+    this.userSession = userSession;
+    this.dbClient = dbClient;
+  }
+
+  @Override
+  public void define(WebService.NewController controller) {
+    WebService.NewAction action = controller.createAction("unset_root")
+      .setInternal(true)
+      .setPost(true)
+      .setDescription("Make the specified user not root.<br/>" +
+        "Requires to be root.")
+      .setSince("6.2")
+      .setHandler(this);
+
+    action.createParam(PARAM_LOGIN)
+      .setDescription("A user login")
+      .setExampleValue("admin")
+      .setRequired(true)
+      .setSince("6.2");
+  }
+
+  @Override
+  public void handle(Request request, Response response) throws Exception {
+    userSession.checkIsRoot();
+
+    String login = request.mandatoryParam(PARAM_LOGIN);
+    try (DbSession dbSession = dbClient.openSession(false)) {
+      dbClient.userDao().setRoot(dbSession, login, false);
+      dbSession.commit();
+    }
+    response.noContent();
+  }
+}

diff --git a/server/sonar-server/src/test/java/org/sonar/server/root/ws/UnsetRootWsActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/root/ws/UnsetRootWsActionTest.java
new file mode 100644 (file)
index 0000000..140460f
--- /dev/null
+++ b/server/sonar-server/src/test/java/org/sonar/server/root/ws/UnsetRootWsActionTest.java
@@ -0,0 +1,152 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2016 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * This program 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.
+ *
+ * This program 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.server.root.ws;
+
+import javax.annotation.Nullable;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.sonar.api.server.ws.WebService;
+import org.sonar.api.utils.System2;
+import org.sonar.db.DbSession;
+import org.sonar.db.DbTester;
+import org.sonar.db.user.UserDao;
+import org.sonar.db.user.UserDto;
+import org.sonar.db.user.UserTesting;
+import org.sonar.server.exceptions.ForbiddenException;
+import org.sonar.server.tester.UserSessionRule;
+import org.sonar.server.ws.TestRequest;
+import org.sonar.server.ws.WsActionTester;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class UnsetRootWsActionTest {
+  private static final String SOME_LOGIN = "johndoe";
+
+  @Rule
+  public DbTester dbTester = DbTester.create(System2.INSTANCE);
+  @Rule
+  public UserSessionRule userSessionRule = UserSessionRule.standalone();
+  @Rule
+  public ExpectedException expectedException = ExpectedException.none();
+
+  private UserDao userDao = dbTester.getDbClient().userDao();
+  private DbSession dbSession = dbTester.getSession();
+  private UnsetRootWsAction underTest = new UnsetRootWsAction(userSessionRule, dbTester.getDbClient());
+  private WsActionTester wsTester = new WsActionTester(underTest);
+
+  @Test
+  public void verify_definition() {
+    WebService.Action action = wsTester.getDef();
+    assertThat(action.key()).isEqualTo("unset_root");
+    assertThat(action.isInternal()).isTrue();
+    assertThat(action.isPost()).isTrue();
+    assertThat(action.since()).isEqualTo("6.2");
+    assertThat(action.description()).isEqualTo("Make the specified user not root.<br/>" +
+        "Requires to be root.");
+    assertThat(action.responseExample()).isNull();
+    assertThat(action.deprecatedKey()).isNull();
+    assertThat(action.deprecatedSince()).isNull();
+    assertThat(action.handler()).isSameAs(underTest);
+    assertThat(action.params()).hasSize(1);
+
+    WebService.Param param = action.param("login");
+    assertThat(param.isRequired()).isTrue();
+    assertThat(param.description()).isEqualTo("A user login");
+    assertThat(param.defaultValue()).isNull();
+    assertThat(param.deprecatedSince()).isNull();
+    assertThat(param.deprecatedKey()).isNull();
+    assertThat(param.exampleValue()).isEqualTo("admin");
+  }
+
+  @Test
+  public void execute_fails_with_ForbiddenException_when_user_is_not_logged_in() {
+    expectInsufficientPrivilegesForbiddenException();
+
+    executeRequest(SOME_LOGIN);
+  }
+
+  @Test
+  public void execute_fails_with_ForbiddenException_when_user_is_not_root() {
+    userSessionRule.login();
+
+    expectInsufficientPrivilegesForbiddenException();
+
+    executeRequest(SOME_LOGIN);
+  }
+
+  @Test
+  public void execute_fails_with_IAE_when_login_param_is_not_provided() {
+    userSessionRule.login().setRoot();
+
+    expectedException.expect(IllegalArgumentException.class);
+    expectedException.expectMessage("The 'login' parameter is missing");
+
+    executeRequest(null);
+  }
+
+  @Test
+  public void execute_makes_user_with_specified_login_not_root_when_it_is() {
+    UserDto otherUser = UserTesting.newUserDto();
+    userDao.insert(dbSession, otherUser);
+    userDao.setRoot(dbSession, otherUser.getLogin(), true);
+    userDao.insert(dbSession, UserTesting.newUserDto(SOME_LOGIN, "name", "email"));
+    userDao.setRoot(dbSession, SOME_LOGIN, true);
+    dbSession.commit();
+    userSessionRule.login().setRoot();
+
+    executeRequest(SOME_LOGIN);
+
+    assertThat(userDao.selectByLogin(dbSession, SOME_LOGIN).isRoot()).isFalse();
+    assertThat(userDao.selectByLogin(dbSession, otherUser.getLogin()).isRoot()).isTrue();
+  }
+
+  @Test
+  public void execute_has_no_effect_when_user_is_already_not_root() {
+    UserDto otherUser = UserTesting.newUserDto();
+    userDao.insert(dbSession, otherUser);
+    userDao.setRoot(dbSession, otherUser.getLogin(), true);
+    userDao.insert(dbSession, UserTesting.newUserDto(SOME_LOGIN, "name", "email"));
+    userDao.setRoot(dbSession, SOME_LOGIN, true);
+    dbSession.commit();
+    userSessionRule.login().setRoot();
+
+    executeRequest(SOME_LOGIN);
+
+    assertThat(userDao.selectByLogin(dbSession, SOME_LOGIN).isRoot()).isFalse();
+    assertThat(userDao.selectByLogin(dbSession, otherUser.getLogin()).isRoot()).isTrue();
+  }
+
+  private void expectInsufficientPrivilegesForbiddenException() {
+    expectedException.expect(ForbiddenException.class);
+    expectedException.expectMessage("Insufficient privileges");
+  }
+
+  private int executeRequest(@Nullable String login) {
+    TestRequest request = wsTester.newRequest();
+    if (login != null) {
+      request.setParam("login", login);
+    }
+    return request
+        .execute()
+        .getStatus();
+  }
+
+}