WS api/favorites/search use a SearchRequest

it/it-tests/src/test/java/it/analysis/FavoriteTest.java

@@ -32,6 +32,7 @@
 import org.sonarqube.ws.Favorites.Favorite;
 import org.sonarqube.ws.WsPermissions;
 import org.sonarqube.ws.client.WsClient;
+import org.sonarqube.ws.client.favorite.SearchRequest;
 import org.sonarqube.ws.client.permission.AddProjectCreatorToTemplateWsRequest;
 import org.sonarqube.ws.client.permission.RemoveProjectCreatorFromTemplateWsRequest;
 import org.sonarqube.ws.client.permission.SearchTemplatesWsRequest;
@@ -71,7 +72,7 @@ public void project_as_favorite_when_authenticated_and_first_analysis_and_a_proj
 
     orchestrator.executeBuild(sampleProject);
 
-    Favorites.SearchResponse response = adminWsClient.favorites().search(null, null);
+    Favorites.SearchResponse response = adminWsClient.favorites().search(new SearchRequest());
     assertThat(response.getFavoritesList()).extracting(Favorite::getKey).contains(PROJECT_KEY);
   }
 
@@ -81,7 +82,7 @@ public void no_project_as_favorite_when_no_project_creator_permission() {
 
     orchestrator.executeBuild(sampleProject);
 
-    Favorites.SearchResponse response = adminWsClient.favorites().search(null, null);
+    Favorites.SearchResponse response = adminWsClient.favorites().search(new SearchRequest());
     assertThat(response.getFavoritesList()).extracting(Favorite::getKey).doesNotContain(PROJECT_KEY);
   }
 
@@ -94,7 +95,7 @@ public void no_project_as_favorite_when_second_analysis() {
 
     orchestrator.executeBuild(sampleProject);
 
-    Favorites.SearchResponse response = adminWsClient.favorites().search(null, null);
+    Favorites.SearchResponse response = adminWsClient.favorites().search(new SearchRequest());
     assertThat(response.getFavoritesList()).extracting(Favorite::getKey).doesNotContain(PROJECT_KEY);
   }
 

it/it-tests/src/test/java/it/user/FavoritesWsTest.java

@@ -28,6 +28,7 @@
 import org.junit.Test;
 import org.sonarqube.ws.Favorites.Favorite;
 import org.sonarqube.ws.client.WsClient;
+import org.sonarqube.ws.client.favorite.SearchRequest;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static util.ItUtils.newAdminWsClient;
@@ -52,20 +53,20 @@ public void inspectProject() {
   @Test
   public void favorites_web_service() {
     // GET (nothing)
-    List<Favorite> favorites = adminClient.favorites().search(null, null).getFavoritesList();
+    List<Favorite> favorites = adminClient.favorites().search(new SearchRequest()).getFavoritesList();
     assertThat(favorites).isEmpty();
 
     // POST (create favorites)
     adminClient.favorites().add("sample");
     adminClient.favorites().add("sample:src/main/xoo/sample/Sample.xoo");
 
     // GET (created favorites)
-    favorites = adminClient.favorites().search(null, null).getFavoritesList();
+    favorites = adminClient.favorites().search(new SearchRequest()).getFavoritesList();
     assertThat(favorites.stream().map(Favorite::getKey)).containsOnly("sample", "sample:src/main/xoo/sample/Sample.xoo");
 
     // DELETE (a favorite)
     adminClient.favorites().remove("sample");
-    favorites = adminClient.favorites().search(null, null).getFavoritesList();
+    favorites = adminClient.favorites().search(new SearchRequest()).getFavoritesList();
     assertThat(favorites.stream().map(Favorite::getKey)).containsOnly("sample:src/main/xoo/sample/Sample.xoo");
   }
 

server/sonar-server/src/main/java/org/sonar/server/favorite/ws/SearchAction.java

@@ -42,11 +42,13 @@
 import org.sonarqube.ws.Common;
 import org.sonarqube.ws.Favorites.Favorite;
 import org.sonarqube.ws.Favorites.SearchResponse;
+import org.sonarqube.ws.client.favorite.SearchRequest;
 
 import static org.sonar.core.util.Protobuf.setNullable;
 import static org.sonar.core.util.stream.Collectors.toOneElement;
 import static org.sonar.server.ws.WsUtils.writeProtobuf;
 import static org.sonarqube.ws.client.favorite.FavoritesWsParameters.ACTION_SEARCH;
+import static org.sonarqube.ws.client.favorite.SearchRequest.MAX_PAGE_SIZE;
 
 public class SearchAction implements FavoritesWsAction {
   private final FavoriteFinder favoriteFinder;
@@ -68,19 +70,26 @@ public void define(WebService.NewController context) {
       .setResponseExample(getClass().getResource("search-example.json"))
       .setHandler(this);
 
-    action.addPagingParams(100, 500);
+    action.addPagingParams(100, MAX_PAGE_SIZE);
   }
 
   @Override
   public void handle(Request request, Response response) throws Exception {
     SearchResponse wsResponse = Stream.of(request)
+      .map(toWsRequest())
       .map(search())
       .map(new ResponseBuilder())
       .collect(Collectors.toOneElement());
     writeProtobuf(wsResponse, request, response);
   }
 
-  private Function<Request, SearchResults> search() {
+  private static Function<Request, SearchRequest> toWsRequest() {
+    return request -> new SearchRequest()
+      .setPage(request.mandatoryParamAsInt(Param.PAGE))
+      .setPageSize(request.mandatoryParamAsInt(Param.PAGE_SIZE));
+  }
+
+  private Function<SearchRequest, SearchResults> search() {
     return request -> {
       try (DbSession dbSession = dbClient.openSession(false)) {
         return Stream.of(request)
@@ -103,7 +112,7 @@ private Consumer<SearchResults.Builder> addAuthorizedProjectUuids() {
       .copyOf(dbClient.authorizationDao().selectAuthorizedRootProjectsUuids(results.dbSession, userSession.getUserId(), UserRole.USER));
   }
 
-  private static Consumer<Request> checkAuthentication(UserSession userSession) {
+  private static Consumer<SearchRequest> checkAuthentication(UserSession userSession) {
     return r -> userSession.checkLoggedIn();
   }
 
@@ -122,7 +131,7 @@ private SearchResults(Builder builder) {
         .collect(Collectors.toList());
     }
 
-    static Function<Request, Builder> builder(DbSession dbSession) {
+    static Function<SearchRequest, Builder> builder(DbSession dbSession) {
       return request -> new Builder(dbSession, request);
     }
 
@@ -133,10 +142,10 @@ private static class Builder {
       private Set<String> authorizedProjectUuids;
       private List<ComponentDto> allFavorites;
 
-      private Builder(DbSession dbSession, Request request) {
+      private Builder(DbSession dbSession, SearchRequest request) {
         this.dbSession = dbSession;
-        this.page = request.mandatoryParamAsInt(Param.PAGE);
-        this.pageSize = request.mandatoryParamAsInt(Param.PAGE_SIZE);
+        this.page = request.getPage();
+        this.pageSize = request.getPageSize();
       }
 
       public SearchResults build() {

sonar-ws/src/main/java/org/sonarqube/ws/client/favorite/FavoritesService.java

@@ -20,7 +20,6 @@
 
 package org.sonarqube.ws.client.favorite;
 
-import javax.annotation.Nullable;
 import org.sonar.api.server.ws.WebService.Param;
 import org.sonarqube.ws.Favorites.SearchResponse;
 import org.sonarqube.ws.client.BaseService;
@@ -51,13 +50,13 @@ public void remove(String component) {
     call(post);
   }
 
-  public SearchResponse search(@Nullable Integer page, @Nullable Integer pageSize) {
+  public SearchResponse search(SearchRequest request) {
     GetRequest get = new GetRequest(path(ACTION_SEARCH));
-    if (page != null) {
-      get.setParam(Param.PAGE, page);
+    if (request.getPage() != null) {
+      get.setParam(Param.PAGE, request.getPage());
     }
-    if (pageSize != null) {
-      get.setParam(Param.PAGE_SIZE, pageSize);
+    if (request.getPageSize() != null) {
+      get.setParam(Param.PAGE_SIZE, request.getPageSize());
     }
 
     return call(get, SearchResponse.parser());

sonar-ws/src/main/java/org/sonarqube/ws/client/favorite/SearchRequest.java

@@ -0,0 +1,54 @@
+/*
+ * 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.sonarqube.ws.client.favorite;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nullable;
+
+public class SearchRequest {
+  public static final int MAX_PAGE_SIZE = 500;
+
+  private Integer page;
+  private Integer pageSize;
+
+  @CheckForNull
+  public Integer getPage() {
+    return page;
+  }
+
+  public SearchRequest setPage(@Nullable Integer page) {
+    this.page = page;
+    return this;
+  }
+
+  @CheckForNull
+  public Integer getPageSize() {
+    return pageSize;
+  }
+
+  public SearchRequest setPageSize(@Nullable Integer pageSize) {
+    if (pageSize != null && pageSize > MAX_PAGE_SIZE) {
+      throw new IllegalArgumentException("Page size must be lower than or equals to " + MAX_PAGE_SIZE);
+    }
+    this.pageSize = pageSize;
+    return this;
+  }
+}

sonar-ws/src/test/java/org/sonarqube/ws/client/favorite/FavoritesServiceTest.java

@@ -22,6 +22,7 @@
 
 import org.junit.Rule;
 import org.junit.Test;
+import org.sonar.api.server.ws.WebService.Param;
 import org.sonarqube.ws.client.ServiceTester;
 import org.sonarqube.ws.client.WsConnector;
 
@@ -53,4 +54,15 @@ public void remove() {
       .hasParam(PARAM_COMPONENT, "my_project")
       .andNoOtherParam();
   }
+
+  @Test
+  public void search() {
+    underTest.search(new SearchRequest().setPage(42).setPageSize(255));
+
+    serviceTester.assertThat(serviceTester.getGetRequest())
+      .hasPath("search")
+      .hasParam(Param.PAGE, 42)
+      .hasParam(Param.PAGE_SIZE, 255)
+      .andNoOtherParam();
+  }
 }

sonar-ws/src/test/java/org/sonarqube/ws/client/favorite/SearchRequestTest.java

@@ -0,0 +1,40 @@
+/*
+ * 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.sonarqube.ws.client.favorite;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+public class SearchRequestTest {
+  @Rule
+  public ExpectedException expectedException = ExpectedException.none();
+
+  private SearchRequest underTest = new SearchRequest();
+
+  @Test
+  public void fail_if_page_size_greater_than_500() {
+    expectedException.expect(IllegalArgumentException.class);
+    expectedException.expectMessage("Page size must be lower than or equals to 500");
+
+    underTest.setPageSize(501);
+  }
+}