123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134 |
- /*
- * SonarQube
- * Copyright (C) 2009-2023 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.issue.ws;
-
- import com.google.common.io.Resources;
- import java.util.Date;
- import org.sonar.api.issue.DefaultTransitions;
- 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.utils.System2;
- import org.sonar.core.issue.DefaultIssue;
- import org.sonar.core.issue.IssueChangeContext;
- import org.sonar.core.util.Uuids;
- import org.sonar.db.DbClient;
- import org.sonar.db.DbSession;
- import org.sonar.db.component.BranchDto;
- import org.sonar.db.issue.IssueDto;
- import org.sonar.server.issue.IssueFinder;
- import org.sonar.server.issue.TransitionService;
- import org.sonar.server.pushapi.issues.IssueChangeEventService;
- import org.sonar.server.user.UserSession;
-
- import static java.lang.String.format;
- import static org.sonar.api.issue.DefaultTransitions.OPEN_AS_VULNERABILITY;
- import static org.sonar.api.issue.DefaultTransitions.RESET_AS_TO_REVIEW;
- import static org.sonar.api.issue.DefaultTransitions.RESOLVE_AS_REVIEWED;
- import static org.sonar.api.issue.DefaultTransitions.SET_AS_IN_REVIEW;
- import static org.sonar.core.issue.IssueChangeContext.issueChangeContextByUserBuilder;
- import static org.sonar.db.component.BranchType.BRANCH;
- import static org.sonarqube.ws.client.issue.IssuesWsParameters.ACTION_DO_TRANSITION;
- import static org.sonarqube.ws.client.issue.IssuesWsParameters.PARAM_ISSUE;
- import static org.sonarqube.ws.client.issue.IssuesWsParameters.PARAM_TRANSITION;
-
- public class DoTransitionAction implements IssuesWsAction {
-
- private final DbClient dbClient;
- private final UserSession userSession;
- private final IssueChangeEventService issueChangeEventService;
- private final IssueFinder issueFinder;
- private final IssueUpdater issueUpdater;
- private final TransitionService transitionService;
- private final OperationResponseWriter responseWriter;
- private final System2 system2;
-
- public DoTransitionAction(DbClient dbClient, UserSession userSession, IssueChangeEventService issueChangeEventService,
- IssueFinder issueFinder, IssueUpdater issueUpdater, TransitionService transitionService,
- OperationResponseWriter responseWriter, System2 system2) {
- this.dbClient = dbClient;
- this.userSession = userSession;
- this.issueChangeEventService = issueChangeEventService;
- this.issueFinder = issueFinder;
- this.issueUpdater = issueUpdater;
- this.transitionService = transitionService;
- this.responseWriter = responseWriter;
- this.system2 = system2;
- }
-
- @Override
- public void define(WebService.NewController controller) {
- WebService.NewAction action = controller.createAction(ACTION_DO_TRANSITION)
- .setDescription("Do workflow transition on an issue. Requires authentication and Browse permission on project.<br/>" +
- "The transitions '" + DefaultTransitions.WONT_FIX + "' and '" + DefaultTransitions.FALSE_POSITIVE + "' require the permission 'Administer Issues'.<br/>" +
- "The transitions involving security hotspots require the permission 'Administer Security Hotspot'.")
- .setSince("3.6")
- .setChangelog(
- new Change("10.2", "Add 'impacts', 'cleanCodeAttribute', 'cleanCodeAttributeCategory' fields to the response"),
- new Change("9.6", "Response field 'ruleDescriptionContextKey' added"),
- new Change("8.8", "The response field components.uuid is removed"),
- new Change("8.1", format("transitions '%s' and '%s' are no more supported", SET_AS_IN_REVIEW, OPEN_AS_VULNERABILITY)),
- new Change("7.8", format("added '%s', %s, %s and %s transitions for security hotspots ", SET_AS_IN_REVIEW, RESOLVE_AS_REVIEWED, OPEN_AS_VULNERABILITY, RESET_AS_TO_REVIEW)),
- new Change("7.3", "added transitions for security hotspots"),
- new Change("6.5", "the database ids of the components are removed from the response"),
- new Change("6.5", "the response field components.uuid is deprecated. Use components.key instead."))
- .setHandler(this)
- .setResponseExample(Resources.getResource(this.getClass(), "do_transition-example.json"))
- .setPost(true);
-
- action.createParam(PARAM_ISSUE)
- .setDescription("Issue key")
- .setRequired(true)
- .setExampleValue(Uuids.UUID_EXAMPLE_01);
- action.createParam(PARAM_TRANSITION)
- .setDescription("Transition")
- .setRequired(true)
- .setPossibleValues(DefaultTransitions.ALL);
- }
-
- @Override
- public void handle(Request request, Response response) {
- userSession.checkLoggedIn();
- String issue = request.mandatoryParam(PARAM_ISSUE);
- try (DbSession dbSession = dbClient.openSession(false)) {
- IssueDto issueDto = issueFinder.getByKey(dbSession, issue);
- SearchResponseData preloadedSearchResponseData = doTransition(dbSession, issueDto, request.mandatoryParam(PARAM_TRANSITION));
- responseWriter.write(issue, preloadedSearchResponseData, request, response);
- }
- }
-
- private SearchResponseData doTransition(DbSession session, IssueDto issueDto, String transitionKey) {
- DefaultIssue defaultIssue = issueDto.toDefaultIssue();
- IssueChangeContext context = issueChangeContextByUserBuilder(new Date(system2.now()), userSession.getUuid()).withRefreshMeasures().build();
- transitionService.checkTransitionPermission(transitionKey, defaultIssue);
- if (transitionService.doTransition(defaultIssue, context, transitionKey)) {
- BranchDto branch = issueUpdater.getBranch(session, defaultIssue);
- SearchResponseData response = issueUpdater.saveIssueAndPreloadSearchResponseData(session, defaultIssue, context, branch);
-
- if (branch.getBranchType().equals(BRANCH) && response.getComponentByUuid(defaultIssue.projectUuid()) != null) {
- issueChangeEventService.distributeIssueChangeEvent(defaultIssue, null, null, transitionKey, branch,
- response.getComponentByUuid(defaultIssue.projectUuid()).getKey());
- }
- return response;
- }
- return new SearchResponseData(issueDto);
- }
- }
|