import org.junit.Test;
import org.sonar.wsclient.Sonar;
import org.sonar.wsclient.services.Favourite;
-import org.sonar.wsclient.services.FavouriteDeleteQuery;
import org.sonar.wsclient.services.FavouriteQuery;
import org.sonarqube.ws.client.WsClient;
assertThat(favourites.stream().map(Favourite::getKey)).containsOnly("sample", "sample:src/main/xoo/sample/Sample.xoo");
// DELETE (a favorite)
- oldWsClient.delete(new FavouriteDeleteQuery("sample"));
+ adminClient.favorites().remove("sample");
favourites = oldWsClient.findAll(new FavouriteQuery());
assertThat(favourites.stream().map(Favourite::getKey)).containsOnly("sample:src/main/xoo/sample/Sample.xoo");
}
import org.sonar.core.platform.Module;
import org.sonar.server.favorite.ws.AddAction;
import org.sonar.server.favorite.ws.FavoritesWs;
+import org.sonar.server.favorite.ws.RemoveAction;
public class FavoriteModule extends Module {
add(
FavoriteUpdater.class,
FavoritesWs.class,
- AddAction.class);
+ AddAction.class,
+ RemoveAction.class);
}
}
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
+import org.sonar.db.component.ComponentDto;
import org.sonar.db.property.PropertyDto;
+import org.sonar.server.exceptions.BadRequestException;
import org.sonar.server.user.UserSession;
+import static org.sonar.server.ws.WsUtils.checkRequest;
+
public class FavoriteUpdater {
private static final String PROP_FAVORITE_KEY = "favourite";
/**
* Set favorite to the logged in user. If no user is logged, no action is done
*/
- public void add(DbSession dbSession, long componentDbId) {
+ public void add(DbSession dbSession, long componentDtoId) {
if (!userSession.isLoggedIn()) {
return;
}
dbClient.propertiesDao().saveProperty(dbSession, new PropertyDto()
.setKey(PROP_FAVORITE_KEY)
- .setResourceId(componentDbId)
+ .setResourceId(componentDtoId)
+ .setUserId(Long.valueOf(userSession.getUserId())));
+ }
+
+ /**
+ * Remove a favorite to the logged in user.
+ * @throws BadRequestException if the component is not a favorite
+ */
+ public void remove(DbSession dbSession, ComponentDto component) {
+ if (!userSession.isLoggedIn()) {
+ return;
+ }
+
+ int result = dbClient.propertiesDao().delete(dbSession, new PropertyDto()
+ .setKey(PROP_FAVORITE_KEY)
+ .setResourceId(component.getId())
.setUserId(Long.valueOf(userSession.getUserId())));
+ checkRequest(result == 1, "Component '%s' is not a favorite", component.key());
}
}
--- /dev/null
+/*
+ * 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.favorite.ws;
+
+import java.util.function.Consumer;
+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.db.component.ComponentDto;
+import org.sonar.server.component.ComponentFinder;
+import org.sonar.server.favorite.FavoriteUpdater;
+import org.sonar.server.user.UserSession;
+import org.sonar.server.ws.KeyExamples;
+
+import static org.sonarqube.ws.client.favorite.FavoritesWsParameters.PARAM_COMPONENT;
+
+public class RemoveAction implements FavoritesWsAction {
+ private final UserSession userSession;
+ private final DbClient dbClient;
+ private final FavoriteUpdater favoriteUpdater;
+ private final ComponentFinder componentFinder;
+
+ public RemoveAction(UserSession userSession, DbClient dbClient, FavoriteUpdater favoriteUpdater, ComponentFinder componentFinder) {
+ this.userSession = userSession;
+ this.dbClient = dbClient;
+ this.favoriteUpdater = favoriteUpdater;
+ this.componentFinder = componentFinder;
+ }
+
+ @Override
+ public void define(WebService.NewController context) {
+ WebService.NewAction action = context.createAction("remove")
+ .setDescription("Remove a component (project, directory, file etc.) as favorite for the authenticated user.<br>" +
+ "Requires authentication.")
+ .setSince("6.3")
+ .setPost(true)
+ .setHandler(this);
+
+ action.createParam("component")
+ .setDescription("Component key")
+ .setRequired(true)
+ .setExampleValue(KeyExamples.KEY_PROJECT_EXAMPLE_001);
+ }
+
+ @Override
+ public void handle(Request request, Response response) throws Exception {
+ removeFavorite().accept(request);
+ response.noContent();
+ }
+
+ private Consumer<Request> removeFavorite() {
+ return request -> {
+ try (DbSession dbSession = dbClient.openSession(false)) {
+ ComponentDto component = componentFinder.getByKey(dbSession, request.mandatoryParam(PARAM_COMPONENT));
+ userSession
+ .checkLoggedIn();
+ favoriteUpdater.remove(dbSession, component);
+ dbSession.commit();
+ }
+ };
+ }
+}
public void verify_count_of_added_components() {
ComponentContainer container = new ComponentContainer();
new FavoriteModule().configure(container);
- assertThat(container.size()).isEqualTo(3 + 2);
+ assertThat(container.size()).isEqualTo(4 + 2);
}
}
--- /dev/null
+/*
+ * 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.favorite.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.db.DbClient;
+import org.sonar.db.DbTester;
+import org.sonar.db.component.ComponentDto;
+import org.sonar.server.component.ComponentFinder;
+import org.sonar.server.exceptions.BadRequestException;
+import org.sonar.server.exceptions.NotFoundException;
+import org.sonar.server.exceptions.UnauthorizedException;
+import org.sonar.server.favorite.FavoriteUpdater;
+import org.sonar.server.tester.UserSessionRule;
+import org.sonar.server.ws.TestRequest;
+import org.sonar.server.ws.TestResponse;
+import org.sonar.server.ws.WsActionTester;
+
+import static java.net.HttpURLConnection.HTTP_NO_CONTENT;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.sonar.core.util.Protobuf.setNullable;
+import static org.sonar.db.component.ComponentTesting.newFileDto;
+import static org.sonar.db.component.ComponentTesting.newProjectDto;
+import static org.sonarqube.ws.client.favorite.FavoritesWsParameters.PARAM_COMPONENT;
+
+public class RemoveActionTest {
+ private static final String PROJECT_KEY = "project-key";
+ private static final String PROJECT_UUID = "project-uuid";
+ private static final int USER_ID = 123;
+
+ @Rule
+ public ExpectedException expectedException = ExpectedException.none();
+ @Rule
+ public UserSessionRule userSession = UserSessionRule.standalone();
+ @Rule
+ public DbTester db = DbTester.create();
+ private DbClient dbClient = db.getDbClient();
+
+ private FavoriteUpdater favoriteUpdater = new FavoriteUpdater(dbClient, userSession);
+ private WsActionTester ws = new WsActionTester(new RemoveAction(userSession, dbClient, favoriteUpdater, new ComponentFinder(dbClient)));
+
+ @Test
+ public void remove_a_favorite_project() {
+ ComponentDto project = insertProjectAndPermissions();
+ ComponentDto file = db.components().insertComponent(newFileDto(project));
+ db.favorites().add(project, USER_ID);
+ db.favorites().add(file, USER_ID);
+
+ TestResponse result = call(PROJECT_KEY);
+
+ assertThat(result.getStatus()).isEqualTo(HTTP_NO_CONTENT);
+ assertThat(db.favorites().hasFavorite(project, USER_ID)).isFalse();
+ assertThat(db.favorites().hasFavorite(file, USER_ID)).isTrue();
+ }
+
+ @Test
+ public void fail_if_not_already_a_favorite() {
+ insertProjectAndPermissions();
+
+ expectedException.expect(BadRequestException.class);
+ expectedException.expectMessage("Component '" + PROJECT_KEY + "' is not a favorite");
+
+ call(PROJECT_KEY);
+ }
+
+ @Test
+ public void fail_when_component_is_not_found() {
+ userSession.login();
+
+ expectedException.expect(NotFoundException.class);
+
+ call("P42");
+ }
+
+ @Test
+ public void fail_when_user_is_not_authenticated() {
+ insertProject();
+
+ expectedException.expect(UnauthorizedException.class);
+
+ call(PROJECT_KEY);
+ }
+
+ @Test
+ public void definition() {
+ WebService.Action definition = ws.getDef();
+
+ assertThat(definition.key()).isEqualTo("remove");
+ assertThat(definition.isPost()).isTrue();
+ assertThat(definition.param("component").isRequired()).isTrue();
+ }
+
+ private ComponentDto insertProject() {
+ return db.components().insertComponent(newProjectDto(PROJECT_UUID).setKey(PROJECT_KEY));
+ }
+
+ private ComponentDto insertProjectAndPermissions() {
+ userSession.login().setUserId(USER_ID);
+
+ return insertProject();
+ }
+
+ private TestResponse call(@Nullable String componentKey) {
+ TestRequest request = ws.newRequest();
+ setNullable(componentKey, c -> request.setParam(PARAM_COMPONENT, c));
+
+ return request.execute();
+ }
+}
import org.sonar.core.util.SequenceUuidFactory;
import org.sonar.db.component.ComponentDbTester;
import org.sonar.db.event.EventDbTester;
+import org.sonar.db.favorite.FavoriteDbTester;
import org.sonar.db.issue.IssueDbTester;
import org.sonar.db.organization.OrganizationDbTester;
import org.sonar.db.organization.OrganizationDto;
private final UserDbTester userTester;
private final ComponentDbTester componentTester;
+ private final FavoriteDbTester favoriteTester;
private final EventDbTester eventTester;
private final OrganizationDbTester organizationTester;
private final PermissionTemplateDbTester permissionTemplateTester;
initDbClient();
this.userTester = new UserDbTester(this);
this.componentTester = new ComponentDbTester(this);
+ this.favoriteTester = new FavoriteDbTester(this);
this.eventTester = new EventDbTester(this);
this.organizationTester = new OrganizationDbTester(this);
this.permissionTemplateTester = new PermissionTemplateDbTester(this);
return componentTester;
}
+ public FavoriteDbTester favorites() {
+ return favoriteTester;
+ }
+
public EventDbTester events() {
return eventTester;
}
*/
public void assertIndexDoesNotExist(String tableName, String indexName) {
try (Connection connection = getConnection();
- ResultSet rs = connection.getMetaData().getIndexInfo(null, null, tableName.toUpperCase(Locale.ENGLISH), false, false)) {
+ ResultSet rs = connection.getMetaData().getIndexInfo(null, null, tableName.toUpperCase(Locale.ENGLISH), false, false)) {
List<String> indices = new ArrayList<>();
while (rs.next()) {
indices.add(rs.getString("INDEX_NAME").toLowerCase(Locale.ENGLISH));
--- /dev/null
+/*
+ * 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.db.favorite;
+
+import java.util.List;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
+import org.sonar.db.DbTester;
+import org.sonar.db.component.ComponentDto;
+import org.sonar.db.property.PropertyDto;
+import org.sonar.db.property.PropertyQuery;
+
+public class FavoriteDbTester {
+ private static final String PROP_FAVORITE_KEY = "favourite";
+
+ private final DbTester db;
+ private final DbClient dbClient;
+ private final DbSession dbSession;
+
+ public FavoriteDbTester(DbTester db) {
+ this.db = db;
+ this.dbClient = db.getDbClient();
+ this.dbSession = db.getSession();
+ }
+
+ public void add(ComponentDto componentDto, long userId) {
+ dbClient.propertiesDao().saveProperty(dbSession, new PropertyDto()
+ .setKey(PROP_FAVORITE_KEY)
+ .setUserId(userId)
+ .setResourceId(componentDto.getId()));
+ dbSession.commit();
+ }
+
+ public boolean hasFavorite(ComponentDto componentDto, long userId) {
+ List<PropertyDto> result = dbClient.propertiesDao().selectByQuery(PropertyQuery.builder()
+ .setKey(PROP_FAVORITE_KEY)
+ .setComponentId(componentDto.getId())
+ .setUserId((int) userId)
+ .build(), dbSession);
+
+ return !result.isEmpty();
+ }
+}
import org.sonarqube.ws.client.WsConnector;
import static org.sonarqube.ws.client.favorite.FavoritesWsParameters.ACTION_ADD;
+import static org.sonarqube.ws.client.favorite.FavoritesWsParameters.ACTION_REMOVE;
import static org.sonarqube.ws.client.favorite.FavoritesWsParameters.CONTROLLER_FAVORITES;
import static org.sonarqube.ws.client.favorite.FavoritesWsParameters.PARAM_COMPONENT;
-public class FavoritesService extends BaseService{
+public class FavoritesService extends BaseService {
public FavoritesService(WsConnector wsConnector) {
super(wsConnector, CONTROLLER_FAVORITES);
}
call(post);
}
+
+ public void remove(String component) {
+ PostRequest post = new PostRequest(path(ACTION_REMOVE)).setParam(PARAM_COMPONENT, component);
+
+ call(post);
+ }
}
public static final String CONTROLLER_FAVORITES = "api/favorites";
public static final String ACTION_ADD = "add";
+ public static final String ACTION_REMOVE = "remove";
public static final String PARAM_COMPONENT = "component";
.hasParam(PARAM_COMPONENT, "my_project")
.andNoOtherParam();
}
+
+ @Test
+ public void remove() {
+ underTest.remove("my_project");
+
+ serviceTester.assertThat(serviceTester.getPostRequest())
+ .hasPath("remove")
+ .hasParam(PARAM_COMPONENT, "my_project")
+ .andNoOtherParam();
+ }
}
projects / sonarqube.git / commitdiff