Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* SonarQube
* Copyright (C) 2009-2018 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.measure.ws;
import com.google.common.collect.Sets;
import java.util.Date;
import java.util.List;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Stream;
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.web.UserRole;
import org.sonar.core.util.stream.MoreCollectors;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.component.ComponentDto;
import org.sonar.db.component.SnapshotDto;
import org.sonar.db.component.SnapshotQuery;
import org.sonar.db.component.SnapshotQuery.SORT_FIELD;
import org.sonar.db.component.SnapshotQuery.SORT_ORDER;
import org.sonar.db.measure.MeasureDto;
import org.sonar.db.measure.PastMeasureQuery;
import org.sonar.db.metric.MetricDto;
import org.sonar.server.component.ComponentFinder;
import org.sonar.server.user.UserSession;
import org.sonar.server.ws.KeyExamples;
import org.sonarqube.ws.Measures.SearchHistoryResponse;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import static java.lang.String.format;
import static org.sonar.api.utils.DateUtils.parseEndingDateOrDateTime;
import static org.sonar.api.utils.DateUtils.parseStartingDateOrDateTime;
import static org.sonar.core.util.Protobuf.setNullable;
import static org.sonar.db.component.SnapshotDto.STATUS_PROCESSED;
import static org.sonar.server.ws.KeyExamples.KEY_BRANCH_EXAMPLE_001;
import static org.sonar.server.ws.WsUtils.writeProtobuf;
import static org.sonar.server.component.ws.MeasuresWsParameters.ACTION_SEARCH_HISTORY;
import static org.sonar.server.component.ws.MeasuresWsParameters.PARAM_BRANCH;
import static org.sonar.server.component.ws.MeasuresWsParameters.PARAM_COMPONENT;
import static org.sonar.server.component.ws.MeasuresWsParameters.PARAM_FROM;
import static org.sonar.server.component.ws.MeasuresWsParameters.PARAM_METRICS;
import static org.sonar.server.component.ws.MeasuresWsParameters.PARAM_TO;
public class SearchHistoryAction implements MeasuresWsAction {
private static final int MAX_PAGE_SIZE = 1_000;
private static final int DEFAULT_PAGE_SIZE = 100;
private final DbClient dbClient;
private final ComponentFinder componentFinder;
private final UserSession userSession;
public SearchHistoryAction(DbClient dbClient, ComponentFinder componentFinder, UserSession userSession) {
this.dbClient = dbClient;
this.componentFinder = componentFinder;
this.userSession = userSession;
}
private static SearchHistoryRequest toWsRequest(Request request) {
return SearchHistoryRequest.builder()
.setComponent(request.mandatoryParam(PARAM_COMPONENT))
.setBranch(request.param(PARAM_BRANCH))
.setMetrics(request.mandatoryParamAsStrings(PARAM_METRICS))
.setFrom(request.param(PARAM_FROM))
.setTo(request.param(PARAM_TO))
.setPage(request.mandatoryParamAsInt(Param.PAGE))
.setPageSize(request.mandatoryParamAsInt(Param.PAGE_SIZE))
.build();
}
@Override
public void define(WebService.NewController context) {
WebService.NewAction action = context.createAction(ACTION_SEARCH_HISTORY)
.setDescription("Search measures history of a component. " +
"Measures are ordered chronologically. " +
"Pagination applies to the number of measures for each metric. " +
"Requires the following permission: 'Browse' on the specified component")
.setResponseExample(getClass().getResource("search_history-example.json"))
.setSince("6.3")
.setHandler(this);
action.createParam(PARAM_COMPONENT)
.setDescription("Component key")
.setRequired(true)
.setExampleValue(KeyExamples.KEY_PROJECT_EXAMPLE_001);
action.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setSince("6.6")
.setInternal(true)
.setExampleValue(KEY_BRANCH_EXAMPLE_001);
action.createParam(PARAM_METRICS)
.setDescription("Comma-separated list of metric keys")
.setRequired(true)
.setExampleValue("ncloc,coverage,new_violations");
action.createParam(PARAM_FROM)
.setDescription("Filter measures created after the given date (inclusive). " +
"Either a date (server timezone) or datetime can be provided")
.setExampleValue("2017-10-19 or 2017-10-19T13:00:00+0200");
action.createParam(PARAM_TO)
.setDescription("Filter measures created before the given date (inclusive). " +
"Either a date (server timezone) or datetime can be provided")
.setExampleValue("2017-10-19 or 2017-10-19T13:00:00+0200");
action.addPagingParams(DEFAULT_PAGE_SIZE, MAX_PAGE_SIZE);
}
@Override
public void handle(Request request, Response response) throws Exception {
SearchHistoryResponse searchHistoryResponse = Stream.of(request)
.map(SearchHistoryAction::toWsRequest)
.map(search())
.map(result -> new SearchHistoryResponseFactory(result).apply())
.collect(MoreCollectors.toOneElement());
writeProtobuf(searchHistoryResponse, request, response);
}
private Function search() {
return request -> {
try (DbSession dbSession = dbClient.openSession(false)) {
ComponentDto component = searchComponent(request, dbSession);
SearchHistoryResult result = new SearchHistoryResult(request.page, request.pageSize)
.setComponent(component)
.setAnalyses(searchAnalyses(dbSession, request, component))
.setMetrics(searchMetrics(dbSession, request));
return result.setMeasures(searchMeasures(dbSession, request, result));
}
};
}
private ComponentDto searchComponent(SearchHistoryRequest request, DbSession dbSession) {
ComponentDto component = loadComponent(dbSession, request);
userSession.checkComponentPermission(UserRole.USER, component);
return component;
}
private List searchMeasures(DbSession dbSession, SearchHistoryRequest request, SearchHistoryResult result) {
Date from = parseStartingDateOrDateTime(request.getFrom());
Date to = parseEndingDateOrDateTime(request.getTo());
PastMeasureQuery dbQuery = new PastMeasureQuery(
result.getComponent().uuid(),
result.getMetrics().stream().map(MetricDto::getId).collect(MoreCollectors.toList()),
from == null ? null : from.getTime(),
to == null ? null : (to.getTime() + 1_000L));
return dbClient.measureDao().selectPastMeasures(dbSession, dbQuery);
}
private List searchAnalyses(DbSession dbSession, SearchHistoryRequest request, ComponentDto component) {
SnapshotQuery dbQuery = new SnapshotQuery()
.setComponentUuid(component.projectUuid())
.setStatus(STATUS_PROCESSED)
.setSort(SORT_FIELD.BY_DATE, SORT_ORDER.ASC);
setNullable(request.getFrom(), from -> dbQuery.setCreatedAfter(parseStartingDateOrDateTime(from).getTime()));
setNullable(request.getTo(), to -> dbQuery.setCreatedBefore(parseEndingDateOrDateTime(to).getTime() + 1_000L));
return dbClient.snapshotDao().selectAnalysesByQuery(dbSession, dbQuery);
}
private List searchMetrics(DbSession dbSession, SearchHistoryRequest request) {
List metrics = dbClient.metricDao().selectByKeys(dbSession, request.getMetrics());
if (request.getMetrics().size() > metrics.size()) {
Set requestedMetrics = request.getMetrics().stream().collect(MoreCollectors.toSet());
Set foundMetrics = metrics.stream().map(MetricDto::getKey).collect(MoreCollectors.toSet());
Set unfoundMetrics = Sets.difference(requestedMetrics, foundMetrics).immutableCopy();
throw new IllegalArgumentException(format("Metrics %s are not found", String.join(", ", unfoundMetrics)));
}
return metrics;
}
private ComponentDto loadComponent(DbSession dbSession, SearchHistoryRequest request) {
String componentKey = request.getComponent();
String branch = request.getBranch();
if (branch != null) {
return componentFinder.getByKeyAndBranch(dbSession, componentKey, branch);
}
return componentFinder.getByKey(dbSession, componentKey);
}
static class SearchHistoryRequest {
private final String component;
private final String branch;
private final List metrics;
private final String from;
private final String to;
private final int page;
private final int pageSize;
public SearchHistoryRequest(Builder builder) {
this.component = builder.component;
this.branch = builder.branch;
this.metrics = builder.metrics;
this.from = builder.from;
this.to = builder.to;
this.page = builder.page;
this.pageSize = builder.pageSize;
}
public String getComponent() {
return component;
}
@CheckForNull
public String getBranch() {
return branch;
}
public List getMetrics() {
return metrics;
}
@CheckForNull
public String getFrom() {
return from;
}
@CheckForNull
public String getTo() {
return to;
}
public int getPage() {
return page;
}
public int getPageSize() {
return pageSize;
}
public static Builder builder() {
return new Builder();
}
}
static class Builder {
private String component;
private String branch;
private List metrics;
private String from;
private String to;
private int page = 1;
private int pageSize = DEFAULT_PAGE_SIZE;
private Builder() {
// enforce build factory method
}
public Builder setComponent(String component) {
this.component = component;
return this;
}
public Builder setBranch(@Nullable String branch) {
this.branch = branch;
return this;
}
public Builder setMetrics(List metrics) {
this.metrics = metrics;
return this;
}
public Builder setFrom(@Nullable String from) {
this.from = from;
return this;
}
public Builder setTo(@Nullable String to) {
this.to = to;
return this;
}
public Builder setPage(int page) {
this.page = page;
return this;
}
public Builder setPageSize(int pageSize) {
this.pageSize = pageSize;
return this;
}
public SearchHistoryRequest build() {
checkArgument(component != null && !component.isEmpty(), "Component key is required");
checkArgument(metrics != null && !metrics.isEmpty(), "Metric keys are required");
checkArgument(pageSize <= MAX_PAGE_SIZE, "Page size (%d) must be lower than or equal to %d", pageSize, MAX_PAGE_SIZE);
return new SearchHistoryRequest(this);
}
private static void checkArgument(boolean condition, String message, Object... args) {
if (!condition) {
throw new IllegalArgumentException(format(message, args));
}
}
}
}
