123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148 |
- /*
- * SonarQube
- * Copyright (C) 2009-2019 SonarSource SA
- * mailto:info 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.ce.ws;
-
- import com.google.common.base.Optional;
- import org.sonar.api.server.ws.Change;
- import org.sonar.api.server.ws.Response;
- import org.sonar.api.server.ws.WebService;
- import org.sonar.api.web.UserRole;
- import org.sonar.core.util.Uuids;
- import org.sonar.db.DbClient;
- import org.sonar.db.DbSession;
- import org.sonar.db.ce.CeActivityDto;
- import org.sonar.db.ce.CeQueueDto;
- import org.sonar.db.component.ComponentDto;
- import org.sonar.server.component.ComponentFinder;
- import org.sonar.server.user.UserSession;
- import org.sonar.server.ws.KeyExamples;
- import org.sonarqube.ws.Ce.ActivityStatusWsResponse;
-
- import static org.sonar.server.ce.ws.CeWsParameters.DEPRECATED_PARAM_COMPONENT_KEY;
- import static org.sonar.server.ce.ws.CeWsParameters.PARAM_COMPONENT_ID;
- import static org.sonar.server.component.ComponentFinder.ParamNames.COMPONENT_ID_AND_KEY;
- import static org.sonar.server.ws.WsUtils.writeProtobuf;
-
- public class ActivityStatusAction implements CeWsAction {
- private final UserSession userSession;
- private final DbClient dbClient;
- private final ComponentFinder componentFinder;
-
- public ActivityStatusAction(UserSession userSession, DbClient dbClient, ComponentFinder componentFinder) {
- this.userSession = userSession;
- this.dbClient = dbClient;
- this.componentFinder = componentFinder;
- }
-
- @Override
- public void define(WebService.NewController controller) {
- WebService.NewAction action = controller
- .createAction("activity_status")
- .setDescription("Return CE activity related metrics.<br>" +
- "Requires 'Administer System' permission or 'Administer' rights on the specified project.")
- .setSince("5.5")
- .setResponseExample(getClass().getResource("activity_status-example.json"))
- .setInternal(true)
- .setHandler(this);
-
- action.createParam(PARAM_COMPONENT_ID)
- .setDescription("Id of the component (project) to filter on")
- .setExampleValue(Uuids.UUID_EXAMPLE_03);
- action.createParam(DEPRECATED_PARAM_COMPONENT_KEY)
- .setDeprecatedSince("6.6")
- .setDescription("Key of the component (project) to filter on")
- .setExampleValue(KeyExamples.KEY_PROJECT_EXAMPLE_001);
-
- action.setChangelog(new Change("6.6", "New field 'inProgress' in response"));
- }
-
- @Override
- public void handle(org.sonar.api.server.ws.Request request, Response response) throws Exception {
- ActivityStatusWsResponse activityStatusResponse = doHandle(toWsRequest(request));
- writeProtobuf(activityStatusResponse, request, response);
- }
-
- private ActivityStatusWsResponse doHandle(Request request) {
- try (DbSession dbSession = dbClient.openSession(false)) {
- Optional<ComponentDto> component = searchComponent(dbSession, request);
- String componentUuid = component.isPresent() ? component.get().uuid() : null;
- checkPermissions(component);
- int pendingCount = dbClient.ceQueueDao().countByStatusAndMainComponentUuid(dbSession, CeQueueDto.Status.PENDING, componentUuid);
- int inProgressCount = dbClient.ceQueueDao().countByStatusAndMainComponentUuid(dbSession, CeQueueDto.Status.IN_PROGRESS, componentUuid);
- int failingCount = dbClient.ceActivityDao().countLastByStatusAndMainComponentUuid(dbSession, CeActivityDto.Status.FAILED, componentUuid);
-
- return ActivityStatusWsResponse.newBuilder()
- .setPending(pendingCount)
- .setInProgress(inProgressCount)
- .setFailing(failingCount)
- .build();
- }
- }
-
- private Optional<ComponentDto> searchComponent(DbSession dbSession, Request request) {
- ComponentDto component = null;
- if (hasComponentInRequest(request)) {
- component = componentFinder.getByUuidOrKey(dbSession, request.getComponentId(), request.getComponentKey(), COMPONENT_ID_AND_KEY);
- }
- return Optional.fromNullable(component);
- }
-
- private void checkPermissions(Optional<ComponentDto> component) {
- if (component.isPresent()) {
- userSession.checkComponentPermission(UserRole.ADMIN, component.get());
- } else {
- userSession.checkIsSystemAdministrator();
- }
- }
-
- private static boolean hasComponentInRequest(Request request) {
- return request.getComponentId() != null || request.getComponentKey() != null;
- }
-
- private static Request toWsRequest(org.sonar.api.server.ws.Request request) {
- return new Request()
- .setComponentId(request.param(PARAM_COMPONENT_ID))
- .setComponentKey(request.param(DEPRECATED_PARAM_COMPONENT_KEY));
- }
-
- private static class Request {
-
- private String componentId;
- private String componentKey;
-
- public Request setComponentId(String componentId) {
- this.componentId = componentId;
- return this;
- }
-
- public String getComponentId() {
- return componentId;
- }
-
- public Request setComponentKey(String componentKey) {
- this.componentKey = componentKey;
- return this;
- }
-
- public String getComponentKey() {
- return componentKey;
- }
- }
- }
|