Skip to content

Commit

Permalink
SONAR-10134 Allow creating quality gates in organization (wip)
Browse files Browse the repository at this point in the history
  • Loading branch information
ehartmann authored and julienlancelot committed Dec 14, 2017
1 parent 9aa4ba8 commit 5dc6808
Show file tree
Hide file tree
Showing 14 changed files with 286 additions and 48 deletions.
@@ -0,0 +1,75 @@
/*
* SonarQube
* Copyright (C) 2009-2017 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.db.qualitygate;

import java.util.Date;

/**
* This Dto is a join between QualityGates and Organizations.
*
* Tables : QUALITY_GATES joined with ORG_QUALITY_GATES
*/
public class QGateWithOrgDto extends QualityGateDto {
private String organizationUuid;

public String getOrganizationUuid() {
return organizationUuid;
}

public void setOrganizationUuid(String organizationUuid) {
this.organizationUuid = organizationUuid;
}

@Override
public QGateWithOrgDto setUuid(String uuid) {
super.setUuid(uuid);
return this;
}

@Override
public QGateWithOrgDto setId(Long id) {
super.setId(id);
return this;
}

@Override
public QGateWithOrgDto setName(String name) {
super.setName(name);
return this;
}

@Override
public QGateWithOrgDto setBuiltIn(boolean builtIn) {
super.setBuiltIn(builtIn);
return this;
}

@Override
public QGateWithOrgDto setCreatedAt(Date createdAt) {
super.setCreatedAt(createdAt);
return this;
}

@Override
public QGateWithOrgDto setUpdatedAt(Date updatedAt) {
super.setUpdatedAt(updatedAt);
return this;
}
}
Expand Up @@ -24,15 +24,20 @@
import javax.annotation.CheckForNull;
import org.sonar.db.Dao;
import org.sonar.db.DbSession;
import org.sonar.db.organization.OrganizationDto;

public class QualityGateDao implements Dao {

public QualityGateDto insert(DbSession session, QualityGateDto newQualityGate) {
mapper(session).insert(newQualityGate.setCreatedAt(new Date()));
mapper(session).insertQualityGate(newQualityGate.setCreatedAt(new Date()));

return newQualityGate;
}

public void associate(DbSession dbSession, String uuid, OrganizationDto organization, QualityGateDto qualityGate) {
mapper(dbSession).insertOrgQualityGate(uuid, organization.getUuid(), qualityGate.getUuid());
}

public Collection<QualityGateDto> selectAll(DbSession session) {
return mapper(session).selectAll();
}
Expand All @@ -47,6 +52,10 @@ public QualityGateDto selectById(DbSession session, long id) {
return mapper(session).selectById(id);
}

public QGateWithOrgDto selectByOrganizationAndUuid(DbSession dbSession, OrganizationDto organization, String qualityGateUuid) {
return mapper(dbSession).selectByUuidAndOrganization(qualityGateUuid, organization.getUuid());
}

public void delete(QualityGateDto qGate, DbSession session) {
mapper(session).delete(qGate.getId());
}
Expand Down
Expand Up @@ -20,17 +20,22 @@
package org.sonar.db.qualitygate;

import java.util.List;
import org.apache.ibatis.annotations.Param;

public interface QualityGateMapper {

void insert(QualityGateDto qualityGate);
void insertQualityGate(QualityGateDto qualityGate);

void insertOrgQualityGate(@Param("uuid") String uuid, @Param("organizationUuid") String organizationUuid, @Param("qualityGateUuid") String qualityGateUuuid);

List<QualityGateDto> selectAll();

QualityGateDto selectByName(String name);

QualityGateDto selectById(long id);

QGateWithOrgDto selectByUuidAndOrganization(@Param("qualityGateUuid") String qualityGateUuid, @Param("organizationUuid") String organizationUuid);

QualityGateDto selectBuiltIn();

void delete(long id);
Expand Down
Expand Up @@ -3,9 +3,14 @@

<mapper namespace="org.sonar.db.qualitygate.QualityGateMapper">

<insert id="insert" parameterType="QualityGate" keyColumn="id" useGeneratedKeys="true" keyProperty="id">
insert into quality_gates (name, uuid, is_built_in, created_at, updated_at)
values (#{name}, #{uuid}, #{isBuiltIn}, #{createdAt}, #{updatedAt})
<insert id="insertQualityGate" parameterType="QualityGate" keyColumn="id" useGeneratedKeys="true" keyProperty="id">
insert into quality_gates (uuid, name, is_built_in, created_at, updated_at)
values (#{uuid}, #{name}, #{isBuiltIn}, #{createdAt}, #{updatedAt})
</insert>

<insert id="insertOrgQualityGate" parameterType="Map">
INSERT INTO org_quality_gates (uuid, organization_uuid, quality_gate_uuid)
VALUES (#{uuid}, #{organizationUuid}, #{qualityGateUuid})
</insert>

<sql id="gateColumns">
Expand All @@ -26,6 +31,25 @@
where name=#{name}
</select>

<select id="selectByUuidAndOrganization" parameterType="Map" resultType="org.sonar.db.qualitygate.QGateWithOrgDto">
SELECT
qg.id as id,
qg.uuid as uuid,
qg.name as name,
qg.is_built_in as isBuiltIn,
oqg.organization_uuid as organizationUuid,
qg.created_at as createdAt,
qg.updated_at as updatedAd
FROM
quality_gates qg
INNER JOIN
org_quality_gates oqg ON oqg.quality_gate_uuid = qg.uuid
WHERE
qg.uuid = #{qualityGateUuid} AND
oqg.organization_uuid = #{organizationUuid}
</select>


<select id="selectById" parameterType="long" resultType="QualityGate">
select
<include refid="gateColumns"/>
Expand Down
Expand Up @@ -25,6 +25,7 @@
import org.sonar.core.util.Uuids;
import org.sonar.db.DbSession;
import org.sonar.db.DbTester;
import org.sonar.db.organization.OrganizationDto;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.groups.Tuple.tuple;
Expand Down Expand Up @@ -52,6 +53,19 @@ public void testInsert() {
assertThat(newQgate.getId()).isNotNull();
}

@Test
public void associate() {
QualityGateDto qgate = db.qualityGates().insertQualityGate();
OrganizationDto org = db.organizations().insert();

underTest.associate(dbSession, Uuids.createFast(), org, qgate);

assertThat(underTest.selectByOrganizationAndUuid(dbSession, org, qgate.getUuid())).isNotNull();
assertThat(underTest.selectByOrganizationAndUuid(dbSession, org, qgate.getUuid()))
.extracting(QGateWithOrgDto::getId, QGateWithOrgDto::getUuid, QGateWithOrgDto::getOrganizationUuid, QGateWithOrgDto::getName)
.containsExactly(qgate.getId(), qgate.getUuid(), org.getUuid(), qgate.getName());
}

@Test
public void insert_built_in() {
underTest.insert(db.getSession(), new QualityGateDto().setName("test").setBuiltIn(true).setUuid(Uuids.createFast()));
Expand Down
Expand Up @@ -45,7 +45,6 @@ public void execute(Context context) throws SQLException {
massUpdate.rowPluralName("quality gates");
massUpdate.update("update quality_gates set uuid=?, updated_at=? where id=?");
massUpdate.execute((row, update) -> {
String name = row.getString(2);
update.setString(1, uuidFactory.create());
update.setDate(2, new Date(system2.now()));
update.setLong(3, row.getLong(1));
Expand Down
Expand Up @@ -25,6 +25,7 @@
import org.sonar.core.util.UuidFactory;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.organization.OrganizationDto;
import org.sonar.db.property.PropertyDto;
import org.sonar.db.qualitygate.QualityGateDto;
import org.sonar.server.exceptions.NotFoundException;
Expand All @@ -46,13 +47,14 @@ public QualityGateUpdater(DbClient dbClient, UuidFactory uuidFactory) {
this.uuidFactory = uuidFactory;
}

public QualityGateDto create(DbSession dbSession, String name) {
validateQualityGate(dbSession, null, name);
public QualityGateDto create(DbSession dbSession, OrganizationDto organizationDto, String name) {
validateQualityGate(dbSession, organizationDto, name);
QualityGateDto newQualityGate = new QualityGateDto()
.setName(name)
.setBuiltIn(false)
.setUuid(uuidFactory.create());
dbClient.qualityGateDao().insert(dbSession, newQualityGate);
dbClient.qualityGateDao().associate(dbSession, uuidFactory.create(), organizationDto, newQualityGate);
return newQualityGate;
}

Expand All @@ -73,20 +75,19 @@ private void checkQualityGateExistence(DbSession dbSession, @Nullable Long quali
}
}

private void validateQualityGate(DbSession dbSession, @Nullable Long qGateId, @Nullable String name) {
private void validateQualityGate(DbSession dbSession, OrganizationDto organizationDto, @Nullable String name) {
List<String> errors = new ArrayList<>();
if (isNullOrEmpty(name)) {
errors.add(format(Validation.CANT_BE_EMPTY_MESSAGE, "Name"));
} else {
checkQualityGateDoesNotAlreadyExist(dbSession, qGateId, name, errors);
checkQualityGateDoesNotAlreadyExist(dbSession, organizationDto, name, errors);
}
checkRequest(errors.isEmpty(), errors);
}

private void checkQualityGateDoesNotAlreadyExist(DbSession dbSession, @Nullable Long qGateId, String name, List<String> errors) {
QualityGateDto existingQgate = dbClient.qualityGateDao().selectByName(dbSession, name);
boolean isModifyingCurrentQgate = qGateId != null && existingQgate != null && existingQgate.getId().equals(qGateId);
if (!isModifyingCurrentQgate && existingQgate != null) {
private void checkQualityGateDoesNotAlreadyExist(DbSession dbSession, OrganizationDto organizationDto, String name, List<String> errors) {
QualityGateDto existingQgate = dbClient.qualityGateDao().selectByOrganizationAndName(dbSession, organizationDto, name);
if (existingQgate != null) {
errors.add(format(Validation.IS_ALREADY_USED_MESSAGE, "Name"));
}
}
Expand Down
Expand Up @@ -24,16 +24,16 @@
import org.sonar.api.server.ws.WebService;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.organization.OrganizationDto;
import org.sonar.db.permission.OrganizationPermission;
import org.sonar.db.qualitygate.QualityGateDto;
import org.sonar.server.organization.DefaultOrganizationProvider;
import org.sonar.server.qualitygate.QualityGateUpdater;
import org.sonar.server.user.UserSession;
import org.sonarqube.ws.Qualitygates.CreateResponse;

import static org.sonar.server.ws.WsUtils.writeProtobuf;
import static org.sonar.server.qualitygate.ws.QualityGatesWsParameters.ACTION_CREATE;
import static org.sonar.server.qualitygate.ws.QualityGatesWsParameters.PARAM_NAME;
import static org.sonar.server.ws.WsUtils.writeProtobuf;

public class CreateAction implements QualityGatesWsAction {

Expand All @@ -42,14 +42,14 @@ public class CreateAction implements QualityGatesWsAction {
private final DbClient dbClient;
private final UserSession userSession;
private final QualityGateUpdater qualityGateUpdater;
private final DefaultOrganizationProvider defaultOrganizationProvider;
private final QualityGatesWsSupport wsSupport;

public CreateAction(DbClient dbClient, UserSession userSession, QualityGateUpdater qualityGateUpdater,
DefaultOrganizationProvider defaultOrganizationProvider) {
QualityGatesWsSupport wsSupport) {
this.dbClient = dbClient;
this.userSession = userSession;
this.qualityGateUpdater = qualityGateUpdater;
this.defaultOrganizationProvider = defaultOrganizationProvider;
this.wsSupport = wsSupport;
}

@Override
Expand All @@ -67,20 +67,23 @@ public void define(WebService.NewController controller) {
.setMaximumLength(NAME_MAXIMUM_LENGTH)
.setDescription("The name of the quality gate to create")
.setExampleValue("My Quality Gate");

wsSupport.createOrganizationParam(action);
}

@Override
public void handle(Request request, Response response) {
userSession.checkPermission(OrganizationPermission.ADMINISTER_QUALITY_GATES, defaultOrganizationProvider.get().getUuid());

try (DbSession dbSession = dbClient.openSession(false)) {
QualityGateDto newQualityGate = qualityGateUpdater.create(dbSession, request.mandatoryParam(PARAM_NAME));
OrganizationDto organizationDto = wsSupport.getOrganization(dbSession, request);

userSession.checkPermission(OrganizationPermission.ADMINISTER_QUALITY_GATES, organizationDto.getUuid());

QualityGateDto newQualityGate = qualityGateUpdater.create(dbSession, organizationDto, request.mandatoryParam(PARAM_NAME));
CreateResponse.Builder createResponse = CreateResponse.newBuilder()
.setId(newQualityGate.getId())
.setName(newQualityGate.getName());
dbSession.commit();
writeProtobuf(createResponse.build(), request, response);
}
}

}
Expand Up @@ -30,6 +30,7 @@ public class QualityGatesWsParameters {
public static final String ACTION_CREATE_CONDITION = "create_condition";
public static final String ACTION_UPDATE_CONDITION = "update_condition";

static final String PARAM_ORGANIZATION = "organization";
public static final String PARAM_ANALYSIS_ID = "analysisId";
public static final String PARAM_PROJECT_ID = "projectId";
public static final String PARAM_PROJECT_KEY = "projectKey";
Expand Down
Expand Up @@ -20,9 +20,14 @@

package org.sonar.server.qualitygate.ws;

import java.util.Optional;
import javax.annotation.Nullable;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.server.ws.WebService.NewAction;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.organization.OrganizationDto;
import org.sonar.db.qualitygate.QualityGateConditionDto;
import org.sonar.db.qualitygate.QualityGateDto;
import org.sonar.server.organization.DefaultOrganizationProvider;
Expand All @@ -31,7 +36,9 @@

import static com.google.common.base.Preconditions.checkArgument;
import static org.sonar.db.permission.OrganizationPermission.ADMINISTER_QUALITY_GATES;
import static org.sonar.server.qualitygate.ws.QualityGatesWsParameters.PARAM_ORGANIZATION;
import static org.sonar.server.ws.WsUtils.checkFound;
import static org.sonar.server.ws.WsUtils.checkFoundWithOptional;

public class QualityGatesWsSupport {

Expand All @@ -53,6 +60,15 @@ boolean isQualityGateAdmin() {
return userSession.hasPermission(ADMINISTER_QUALITY_GATES, defaultOrganizationProvider.get().getUuid());
}

WebService.NewParam createOrganizationParam(NewAction action) {
return action
.createParam(PARAM_ORGANIZATION)
.setDescription("Organization key. If no organization is provided, the default organization is used.")
.setRequired(false)
.setInternal(false)
.setExampleValue("my-org");
}

Qualitygates.Actions getActions(QualityGateDto qualityGate, @Nullable QualityGateDto defaultQualityGate) {
Long defaultId = defaultQualityGate == null ? null : defaultQualityGate.getId();
boolean isDefault = qualityGate.getId().equals(defaultId);
Expand All @@ -68,6 +84,13 @@ Qualitygates.Actions getActions(QualityGateDto qualityGate, @Nullable QualityGat
.build();
}

OrganizationDto getOrganization(DbSession dbSession, Request request) {
String organizationUuid = Optional.ofNullable(request.param(PARAM_ORGANIZATION))
.orElseGet(() -> defaultOrganizationProvider.get().getUuid());
Optional<OrganizationDto> organizationDto = dbClient.organizationDao().selectByUuid(dbSession, organizationUuid);
return checkFoundWithOptional(organizationDto, "No organization with key '%s'", organizationUuid);
}

void checkCanEdit(QualityGateDto qualityGate) {
checkNotBuiltInt(qualityGate);
userSession.checkPermission(ADMINISTER_QUALITY_GATES, defaultOrganizationProvider.get().getUuid());
Expand Down

0 comments on commit 5dc6808

Please sign in to comment.