From f1eda9d89e4d6a09acd3ff6b382e1fe21b39e068 Mon Sep 17 00:00:00 2001
From: Julien Lancelot <julien.lancelot@sonarsource.com>
Date: Thu, 20 Apr 2017 18:53:31 +0200
Subject: [PATCH] SONAR-9150 Return paging in api/organizations/search

---
 .../db/organization/OrganizationDao.java      |   5 +
 .../db/organization/OrganizationMapper.java   |   4 +-
 .../db/organization/OrganizationMapper.xml    |   5 +
 .../db/organization/OrganizationDaoTest.java  |  13 +++
 .../server/organization/ws/SearchAction.java  |  25 +++--
 .../organization/ws/search-example.json       |   5 +
 .../organization/ws/SearchActionTest.java     | 101 +++++++++++-------
 .../src/main/protobuf/ws-organizations.proto  |   1 +
 8 files changed, 109 insertions(+), 50 deletions(-)

diff --git a/server/sonar-db-dao/src/main/java/org/sonar/db/organization/OrganizationDao.java b/server/sonar-db-dao/src/main/java/org/sonar/db/organization/OrganizationDao.java
index 7db35478b53..7626e23a991 100644
--- a/server/sonar-db-dao/src/main/java/org/sonar/db/organization/OrganizationDao.java
+++ b/server/sonar-db-dao/src/main/java/org/sonar/db/organization/OrganizationDao.java
@@ -48,6 +48,11 @@ public class OrganizationDao implements Dao {
     getMapper(dbSession).insert(organization);
   }
 
+  public int countByQuery(DbSession dbSession, OrganizationQuery organizationQuery) {
+    requireNonNull(organizationQuery, "organizationQuery can't be null");
+    return getMapper(dbSession).countByQuery(organizationQuery);
+  }
+
   public List<OrganizationDto> selectByQuery(DbSession dbSession, OrganizationQuery organizationQuery, Pagination pagination) {
     requireNonNull(organizationQuery, "organizationQuery can't be null");
     return getMapper(dbSession).selectByQuery(organizationQuery, pagination);
diff --git a/server/sonar-db-dao/src/main/java/org/sonar/db/organization/OrganizationMapper.java b/server/sonar-db-dao/src/main/java/org/sonar/db/organization/OrganizationMapper.java
index 8e511f5a75d..d1350aa9a7c 100644
--- a/server/sonar-db-dao/src/main/java/org/sonar/db/organization/OrganizationMapper.java
+++ b/server/sonar-db-dao/src/main/java/org/sonar/db/organization/OrganizationMapper.java
@@ -27,6 +27,8 @@ import org.sonar.db.Pagination;
 public interface OrganizationMapper {
   void insert(@Param("organization") OrganizationDto organization);
 
+  int countByQuery(@Param("query") OrganizationQuery organizationQuery);
+
   List<OrganizationDto> selectByQuery(@Param("query") OrganizationQuery organizationQuery,
     @Param("pagination") Pagination pagination);
 
@@ -64,7 +66,7 @@ public interface OrganizationMapper {
     @Param("defaultTemplates") DefaultTemplates defaultTemplates, @Param("now") long now);
 
   void updateDefaultGroupId(@Param("organizationUuid") String organizationUuid,
-                              @Param("defaultGroupId") int defaultGroupId, @Param("now") long now);
+    @Param("defaultGroupId") int defaultGroupId, @Param("now") long now);
 
   int deleteByUuid(@Param("uuid") String uuid);
 }
diff --git a/server/sonar-db-dao/src/main/resources/org/sonar/db/organization/OrganizationMapper.xml b/server/sonar-db-dao/src/main/resources/org/sonar/db/organization/OrganizationMapper.xml
index b8ce8643386..d3bc8b02e00 100644
--- a/server/sonar-db-dao/src/main/resources/org/sonar/db/organization/OrganizationMapper.xml
+++ b/server/sonar-db-dao/src/main/resources/org/sonar/db/organization/OrganizationMapper.xml
@@ -56,6 +56,11 @@
         </foreach>
   </select>
 
+  <select id="countByQuery" resultType="int">
+    select count(org.uuid)
+    <include refid="sqlSelectByQuery" />
+  </select>
+
   <select id="selectByQuery" parameterType="map" resultType="Organization">
     select
       <include refid="selectColumns"/>
diff --git a/server/sonar-db-dao/src/test/java/org/sonar/db/organization/OrganizationDaoTest.java b/server/sonar-db-dao/src/test/java/org/sonar/db/organization/OrganizationDaoTest.java
index b1389be3f62..ed122c52226 100644
--- a/server/sonar-db-dao/src/test/java/org/sonar/db/organization/OrganizationDaoTest.java
+++ b/server/sonar-db-dao/src/test/java/org/sonar/db/organization/OrganizationDaoTest.java
@@ -303,6 +303,19 @@ public class OrganizationDaoTest {
         .isEmpty();
   }
 
+  @Test
+  public void countByQuery() {
+    insertOrganization(copyOf(ORGANIZATION_DTO_1).setUuid("uuid3").setKey("key-3"));
+    insertOrganization(copyOf(ORGANIZATION_DTO_1).setUuid("uuid1").setKey("key-1"));
+    insertOrganization(copyOf(ORGANIZATION_DTO_1).setUuid("uuid2").setKey("key-2"));
+    insertOrganization(copyOf(ORGANIZATION_DTO_1).setUuid("uuid5").setKey("key-5"));
+    insertOrganization(copyOf(ORGANIZATION_DTO_1).setUuid("uuid4").setKey("key-4"));
+
+    assertThat(underTest.countByQuery(dbSession, returnAll())).isEqualTo(5);
+    assertThat(underTest.countByQuery(dbSession, newQueryWithKeys("key-1", "key-2"))).isEqualTo(2);
+    assertThat(underTest.countByQuery(dbSession, newQueryWithKeys("unknown"))).isZero();
+  }
+
   @Test
   public void selectByQuery_returns_empty_when_table_is_empty() {
     assertThat(underTest.selectByQuery(dbSession, returnAll(), forPage(2).andSize(1))).isEmpty();
diff --git a/server/sonar-server/src/main/java/org/sonar/server/organization/ws/SearchAction.java b/server/sonar-server/src/main/java/org/sonar/server/organization/ws/SearchAction.java
index 902ed5a5dfa..3430c51ea82 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/organization/ws/SearchAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/organization/ws/SearchAction.java
@@ -20,11 +20,11 @@
 package org.sonar.server.organization.ws;
 
 import java.util.List;
+import org.sonar.api.server.ws.Change;
 import org.sonar.api.server.ws.Request;
 import org.sonar.api.server.ws.Response;
 import org.sonar.api.server.ws.WebService;
 import org.sonar.api.server.ws.WebService.Param;
-import org.sonar.api.utils.Paging;
 import org.sonar.db.DbClient;
 import org.sonar.db.DbSession;
 import org.sonar.db.organization.OrganizationDto;
@@ -35,6 +35,7 @@ import org.sonarqube.ws.Organizations.Organization;
 import static org.sonar.db.Pagination.forPage;
 import static org.sonar.db.organization.OrganizationQuery.newOrganizationQueryBuilder;
 import static org.sonar.server.ws.WsUtils.writeProtobuf;
+import static org.sonarqube.ws.Common.Paging;
 
 public class SearchAction implements OrganizationsWsAction {
   private static final String PARAM_ORGANIZATIONS = "organizations";
@@ -56,6 +57,7 @@ public class SearchAction implements OrganizationsWsAction {
       .setResponseExample(getClass().getResource("search-example.json"))
       .setInternal(true)
       .setSince("6.2")
+      .setChangelog(new Change("6.4", "Paging fields have been added to the response"))
       .setHandler(this);
 
     action.createParam(PARAM_ORGANIZATIONS)
@@ -70,27 +72,34 @@ public class SearchAction implements OrganizationsWsAction {
   @Override
   public void handle(Request request, Response response) throws Exception {
     try (DbSession dbSession = dbClient.openSession(false)) {
-      Paging paging = Paging.forPageIndex(request.mandatoryParamAsInt(Param.PAGE))
-        .withPageSize(request.mandatoryParamAsInt(Param.PAGE_SIZE))
-        .andTotal(0);
       OrganizationQuery organizationQuery = newOrganizationQueryBuilder()
         .setKeys(request.paramAsStrings(PARAM_ORGANIZATIONS))
         .build();
 
+      int total = dbClient.organizationDao().countByQuery(dbSession, organizationQuery);
+      Paging paging = buildWsPaging(request, total);
       List<OrganizationDto> dtos = dbClient.organizationDao().selectByQuery(
         dbSession,
         organizationQuery,
-        forPage(paging.pageIndex()).andSize(paging.pageSize()));
-
-      writeResponse(request, response, dtos);
+        forPage(paging.getPageIndex()).andSize(paging.getPageSize()));
+      writeResponse(request, response, dtos, paging);
     }
   }
 
-  private void writeResponse(Request request, Response response, List<OrganizationDto> dtos) {
+  private void writeResponse(Request request, Response response, List<OrganizationDto> dtos, Paging paging) {
     Organizations.SearchWsResponse.Builder responseBuilder = Organizations.SearchWsResponse.newBuilder();
+    responseBuilder.setPaging(paging);
     Organization.Builder organizationBuilder = Organization.newBuilder();
     dtos.forEach(dto -> responseBuilder.addOrganizations(wsSupport.toOrganization(organizationBuilder, dto)));
     writeProtobuf(responseBuilder.build(), request, response);
   }
 
+  private static Paging buildWsPaging(Request request, int total) {
+    return Paging.newBuilder()
+      .setPageIndex(request.mandatoryParamAsInt(Param.PAGE))
+      .setPageSize(request.mandatoryParamAsInt(Param.PAGE_SIZE))
+      .setTotal(total)
+      .build();
+  }
+
 }
diff --git a/server/sonar-server/src/main/resources/org/sonar/server/organization/ws/search-example.json b/server/sonar-server/src/main/resources/org/sonar/server/organization/ws/search-example.json
index 81566290cf1..84a79a7e84a 100644
--- a/server/sonar-server/src/main/resources/org/sonar/server/organization/ws/search-example.json
+++ b/server/sonar-server/src/main/resources/org/sonar/server/organization/ws/search-example.json
@@ -1,4 +1,9 @@
 {
+  "paging": {
+    "pageIndex": 1,
+    "pageSize": 25,
+    "total": 2
+  },
   "organizations": [
     {
       "key": "foo-company",
diff --git a/server/sonar-server/src/test/java/org/sonar/server/organization/ws/SearchActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/organization/ws/SearchActionTest.java
index e7f238b583b..242156f515f 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/organization/ws/SearchActionTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/organization/ws/SearchActionTest.java
@@ -38,9 +38,10 @@ import org.sonar.db.organization.OrganizationDto;
 import org.sonar.server.organization.OrganizationValidationImpl;
 import org.sonar.server.ws.TestRequest;
 import org.sonar.server.ws.WsActionTester;
+import org.sonarqube.ws.Common.Paging;
 import org.sonarqube.ws.MediaTypes;
-import org.sonarqube.ws.Organizations;
 import org.sonarqube.ws.Organizations.Organization;
+import org.sonarqube.ws.Organizations.SearchWsResponse;
 
 import static java.lang.String.valueOf;
 import static org.assertj.core.api.Assertions.assertThat;
@@ -122,12 +123,12 @@ public class SearchActionTest {
 
   @Test
   public void request_on_empty_db_returns_an_empty_organization_list() {
-    assertThat(executeRequest(null, null)).isEmpty();
-    assertThat(executeRequest(null, 1)).isEmpty();
-    assertThat(executeRequest(1, null)).isEmpty();
-    assertThat(executeRequest(1, 10)).isEmpty();
-    assertThat(executeRequest(2, null)).isEmpty();
-    assertThat(executeRequest(2, 1)).isEmpty();
+    assertThat(executeRequestAndReturnList(null, null)).isEmpty();
+    assertThat(executeRequestAndReturnList(null, 1)).isEmpty();
+    assertThat(executeRequestAndReturnList(1, null)).isEmpty();
+    assertThat(executeRequestAndReturnList(1, 10)).isEmpty();
+    assertThat(executeRequestAndReturnList(2, null)).isEmpty();
+    assertThat(executeRequestAndReturnList(2, 1)).isEmpty();
   }
 
   @Test
@@ -135,11 +136,11 @@ public class SearchActionTest {
     when(system2.now()).thenReturn(SOME_DATE);
     insertOrganization(ORGANIZATION_DTO);
 
-    assertThat(executeRequest(2, null)).isEmpty();
-    assertThat(executeRequest(2, 1)).isEmpty();
+    assertThat(executeRequestAndReturnList(2, null)).isEmpty();
+    assertThat(executeRequestAndReturnList(2, 1)).isEmpty();
     int somePage = Math.abs(new Random().nextInt(10)) + 2;
-    assertThat(executeRequest(somePage, null)).isEmpty();
-    assertThat(executeRequest(somePage, 1)).isEmpty();
+    assertThat(executeRequestAndReturnList(somePage, null)).isEmpty();
+    assertThat(executeRequestAndReturnList(somePage, 1)).isEmpty();
   }
 
   @Test
@@ -151,33 +152,33 @@ public class SearchActionTest {
     insertOrganization(ORGANIZATION_DTO.setUuid("uuid5").setKey("key-5"));
     insertOrganization(ORGANIZATION_DTO.setUuid("uuid4").setKey("key-4"));
 
-    assertThat(executeRequest(1, 1))
+    assertThat(executeRequestAndReturnList(1, 1))
       .extracting(Organization::getKey)
       .containsExactly("key-4");
-    assertThat(executeRequest(2, 1))
+    assertThat(executeRequestAndReturnList(2, 1))
       .extracting(Organization::getKey)
       .containsExactly("key-5");
-    assertThat(executeRequest(3, 1))
+    assertThat(executeRequestAndReturnList(3, 1))
       .extracting(Organization::getKey)
       .containsExactly("key-2");
-    assertThat(executeRequest(4, 1))
+    assertThat(executeRequestAndReturnList(4, 1))
       .extracting(Organization::getKey)
       .containsExactly("key-1");
-    assertThat(executeRequest(5, 1))
+    assertThat(executeRequestAndReturnList(5, 1))
       .extracting(Organization::getKey)
       .containsExactly("key-3");
-    assertThat(executeRequest(6, 1))
+    assertThat(executeRequestAndReturnList(6, 1))
       .isEmpty();
 
-    assertThat(executeRequest(1, 5))
+    assertThat(executeRequestAndReturnList(1, 5))
       .extracting(Organization::getKey)
       .containsExactly("key-4", "key-5", "key-2", "key-1", "key-3");
-    assertThat(executeRequest(2, 5))
+    assertThat(executeRequestAndReturnList(2, 5))
       .isEmpty();
-    assertThat(executeRequest(1, 3))
+    assertThat(executeRequestAndReturnList(1, 3))
       .extracting(Organization::getKey)
       .containsExactly("key-4", "key-5", "key-2");
-    assertThat(executeRequest(2, 3))
+    assertThat(executeRequestAndReturnList(2, 3))
       .extracting(Organization::getKey)
       .containsExactly("key-1", "key-3");
   }
@@ -191,24 +192,39 @@ public class SearchActionTest {
     insertOrganization(ORGANIZATION_DTO.setUuid("uuid5").setKey("key-5"));
     insertOrganization(ORGANIZATION_DTO.setUuid("uuid4").setKey("key-4"));
 
-    assertThat(executeRequest(1, 10, "key-3", "key-1", "key-5"))
+    assertThat(executeRequestAndReturnList(1, 10, "key-3", "key-1", "key-5"))
       .extracting(Organization::getKey)
       .containsExactly("key-5", "key-1", "key-3");
     // ensure order of arguments doesn't change order of result
-    assertThat(executeRequest(1, 10, "key-1", "key-3", "key-5"))
+    assertThat(executeRequestAndReturnList(1, 10, "key-1", "key-3", "key-5"))
       .extracting(Organization::getKey)
       .containsExactly("key-5", "key-1", "key-3");
+  }
 
-    // verify paging
-    assertThat(executeRequest(1, 1, "key-1", "key-3", "key-5"))
-      .extracting(Organization::getKey)
-      .containsExactly("key-5");
-    assertThat(executeRequest(1, 2, "key-1", "key-3", "key-5"))
-      .extracting(Organization::getKey)
-      .containsExactly("key-5", "key-1");
-    assertThat(executeRequest(2, 2, "key-1", "key-3", "key-5"))
-      .extracting(Organization::getKey)
-      .containsExactly("key-3");
+  @Test
+  public void result_is_paginated() {
+    when(system2.now()).thenReturn(SOME_DATE, SOME_DATE + 1_000, SOME_DATE + 2_000, SOME_DATE + 3_000, SOME_DATE + 5_000);
+    insertOrganization(ORGANIZATION_DTO.setUuid("uuid3").setKey("key-3"));
+    insertOrganization(ORGANIZATION_DTO.setUuid("uuid1").setKey("key-1"));
+    insertOrganization(ORGANIZATION_DTO.setUuid("uuid2").setKey("key-2"));
+    insertOrganization(ORGANIZATION_DTO.setUuid("uuid5").setKey("key-5"));
+    insertOrganization(ORGANIZATION_DTO.setUuid("uuid4").setKey("key-4"));
+
+    SearchWsResponse response = executeRequest(1, 1, "key-1", "key-3", "key-5");
+    assertThat(response.getOrganizationsList()).extracting(Organization::getKey).containsOnly("key-5");
+    assertThat(response.getPaging()).extracting(Paging::getPageIndex, Paging::getPageSize, Paging::getTotal).containsOnly(1, 1, 3);
+
+    response = executeRequest(1, 2, "key-1", "key-3", "key-5");
+    assertThat(response.getOrganizationsList()).extracting(Organization::getKey).containsOnly("key-5", "key-1");
+    assertThat(response.getPaging()).extracting(Paging::getPageIndex, Paging::getPageSize, Paging::getTotal).containsOnly(1, 2, 3);
+
+    response = executeRequest(2, 2, "key-1", "key-3", "key-5");
+    assertThat(response.getOrganizationsList()).extracting(Organization::getKey).containsOnly("key-3");
+    assertThat(response.getPaging()).extracting(Paging::getPageIndex, Paging::getPageSize, Paging::getTotal).containsOnly(2, 2, 3);
+
+    response = executeRequest(null, null);
+    assertThat(response.getOrganizationsList()).extracting(Organization::getKey).hasSize(5);
+    assertThat(response.getPaging()).extracting(Paging::getPageIndex, Paging::getPageSize, Paging::getTotal).containsOnly(1, 25, 5);
   }
 
   @Test
@@ -216,22 +232,25 @@ public class SearchActionTest {
     when(system2.now()).thenReturn(SOME_DATE);
     insertOrganization(ORGANIZATION_DTO);
 
-    assertThat(executeRequest(1, 10, ORGANIZATION_DTO.getKey()))
+    assertThat(executeRequestAndReturnList(1, 10, ORGANIZATION_DTO.getKey()))
       .extracting(Organization::getKey)
       .containsExactly(ORGANIZATION_DTO.getKey());
   }
 
-  private void insertOrganization(OrganizationDto dto) {
-    DbSession dbSession = dbTester.getSession();
-    dbTester.getDbClient().organizationDao().insert(dbSession, dto);
-    dbSession.commit();
+  private List<Organization> executeRequestAndReturnList(@Nullable Integer page, @Nullable Integer pageSize, String... keys) {
+    return executeRequest(page, pageSize, keys).getOrganizationsList();
   }
 
-  private List<Organization> executeRequest(@Nullable Integer page, @Nullable Integer pageSize, String... keys) {
+  private SearchWsResponse executeRequest(@Nullable Integer page, @Nullable Integer pageSize, String... keys) {
     TestRequest request = wsTester.newRequest();
     populateRequest(request, page, pageSize, keys);
-    return request.executeProtobuf(Organizations.SearchWsResponse.class)
-      .getOrganizationsList();
+    return request.executeProtobuf(SearchWsResponse.class);
+  }
+
+  private void insertOrganization(OrganizationDto dto) {
+    DbSession dbSession = dbTester.getSession();
+    dbTester.getDbClient().organizationDao().insert(dbSession, dto);
+    dbSession.commit();
   }
 
   private String executeJsonRequest(@Nullable Integer page, @Nullable Integer pageSize, String... keys) {
diff --git a/sonar-ws/src/main/protobuf/ws-organizations.proto b/sonar-ws/src/main/protobuf/ws-organizations.proto
index c878f537d1e..f6f2733c772 100644
--- a/sonar-ws/src/main/protobuf/ws-organizations.proto
+++ b/sonar-ws/src/main/protobuf/ws-organizations.proto
@@ -39,6 +39,7 @@ message UpdateWsResponse {
 // WS api/organizations/search
 message SearchWsResponse {
   repeated Organization organizations = 1;
+  optional sonarqube.ws.commons.Paging paging = 2;
 }
 
 // WS api/organizations/search_members
-- 
2.39.5