import org.sonar.db.component.ComponentDto;
import org.sonar.server.es.ProjectIndexer;
import org.sonar.server.es.ProjectIndexers;
+import org.sonar.server.project.Project;
+import org.sonar.server.project.ProjectLifeCycleListeners;
+import org.sonar.server.project.RekeyedProject;
import org.sonar.server.user.UserSession;
import static java.util.Collections.singletonList;
private final DbClient dbClient;
private final UserSession userSession;
private final ProjectIndexers projectIndexers;
+ private final ProjectLifeCycleListeners projectLifeCycleListeners;
- public ComponentService(DbClient dbClient, UserSession userSession, ProjectIndexers projectIndexers) {
+ public ComponentService(DbClient dbClient, UserSession userSession, ProjectIndexers projectIndexers, ProjectLifeCycleListeners projectLifeCycleListeners) {
this.dbClient = dbClient;
this.userSession = userSession;
this.projectIndexers = projectIndexers;
+ this.projectLifeCycleListeners = projectLifeCycleListeners;
}
- // TODO should be moved to UpdateKeyAction
public void updateKey(DbSession dbSession, ComponentDto projectOrModule, String newKey) {
userSession.checkComponentPermission(UserRole.ADMIN, projectOrModule);
checkIsProjectOrModule(projectOrModule);
checkProjectOrModuleKeyFormat(newKey);
dbClient.componentKeyUpdaterDao().updateKey(dbSession, projectOrModule.uuid(), newKey);
projectIndexers.commitAndIndex(dbSession, singletonList(projectOrModule), ProjectIndexer.Cause.PROJECT_KEY_UPDATE);
+ if (projectOrModule.isRootProject() && projectOrModule.getMainBranchProjectUuid() == null) {
+ Project newProject = new Project(projectOrModule.uuid(), newKey, projectOrModule.name(), projectOrModule.description());
+ projectLifeCycleListeners.onProjectRekeyed(new RekeyedProject(newProject, projectOrModule.getDbKey()));
+ }
}
- // TODO should be moved to BulkUpdateKeyAction
public void bulkUpdateKey(DbSession dbSession, ComponentDto projectOrModule, String stringToReplace, String replacementString) {
dbClient.componentKeyUpdaterDao().bulkUpdateKey(dbSession, projectOrModule.uuid(), stringToReplace, replacementString);
projectIndexers.commitAndIndex(dbSession, singletonList(projectOrModule), ProjectIndexer.Cause.PROJECT_KEY_UPDATE);
* This method is called after the specified projects have been deleted.
*/
void onProjectsDeleted(Set<Project> projects);
+
+ /**
+ * This method is called after the specified project's key has been modified.
+ */
+ void onProjectRekeyed(RekeyedProject rekeyedProject);
}
* them fail with an exception.
*/
void onProjectsDeleted(Set<Project> projects);
+
+ /**
+ * This method is called after the specified project's key has been changed and will call method
+ * {@link ProjectLifeCycleListener#onProjectRekeyed(RekeyedProject) onProjectRekeyed(RekeyedProject)} of all known
+ * {@link ProjectLifeCycleListener} implementations.
+ * <p>
+ * This method ensures all {@link ProjectLifeCycleListener} implementations are called, even if one or more of
+ * them fail with an exception.
+ */
+ void onProjectRekeyed(RekeyedProject rekeyedProject);
+
}
*/
package org.sonar.server.project;
-import com.google.common.base.Preconditions;
import java.util.Arrays;
import java.util.Set;
import java.util.function.Consumer;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
+import static com.google.common.base.Preconditions.checkNotNull;
+
public class ProjectLifeCycleListenersImpl implements ProjectLifeCycleListeners {
private static final Logger LOG = Loggers.get(ProjectLifeCycleListenersImpl.class);
@Override
public void onProjectsDeleted(Set<Project> projects) {
- Preconditions.checkNotNull(projects, "projects can't be null");
+ checkNotNull(projects, "projects can't be null");
if (projects.isEmpty()) {
return;
}
.forEach(safelyCallListener(listener -> listener.onProjectsDeleted(projects)));
}
+ @Override
+ public void onProjectRekeyed(RekeyedProject rekeyedProject) {
+ checkNotNull(rekeyedProject, "rekeyedProject can't be null");
+
+ Arrays.stream(listeners)
+ .forEach(safelyCallListener(listener -> listener.onProjectRekeyed(rekeyedProject)));
+ }
+
private static Consumer<ProjectLifeCycleListener> safelyCallListener(Consumer<ProjectLifeCycleListener> task) {
return listener -> {
try {
task.accept(listener);
} catch (Error | Exception e) {
- LOG.error("Call to ProjectLifeCycleListener \"{}\" failed", listener.getClass(), e);
+ LOG.error("Call on ProjectLifeCycleListener \"{}\" failed", listener.getClass(), e);
}
};
}
--- /dev/null
+/*
+ * 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.project;
+
+import java.util.Objects;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+public final class RekeyedProject {
+ private final Project project;
+ private final String previousKey;
+
+ public RekeyedProject(Project project, String previousKey) {
+ this.project = checkNotNull(project, "project can't be null");
+ this.previousKey = checkNotNull(previousKey, "previousKey can't be null");
+ }
+
+ public Project getProject() {
+ return project;
+ }
+
+ public String getPreviousKey() {
+ return previousKey;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ RekeyedProject that = (RekeyedProject) o;
+ return Objects.equals(project, that.project) &&
+ Objects.equals(previousKey, that.previousKey);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(project, previousKey);
+ }
+
+ @Override
+ public String toString() {
+ return "RekeyedProject{" +
+ "project=" + project +
+ ", previousKey='" + previousKey + '\'' +
+ '}';
+ }
+}
import org.sonar.db.component.ComponentDto;
import org.sonar.db.component.ComponentTesting;
import org.sonar.server.es.TestProjectIndexers;
+import org.sonar.server.project.ProjectLifeCycleListeners;
import org.sonar.server.tester.UserSessionRule;
import static org.assertj.guava.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
import static org.sonar.db.component.ComponentTesting.newFileDto;
import static org.sonar.db.component.ComponentTesting.newModuleDto;
private DbClient dbClient = dbTester.getDbClient();
private DbSession dbSession = dbTester.getSession();
private TestProjectIndexers projectIndexers = new TestProjectIndexers();
+ private ProjectLifeCycleListeners projectLifeCycleListeners = mock(ProjectLifeCycleListeners.class);
- private ComponentService underTest = new ComponentService(dbClient, userSession, projectIndexers);
+ private ComponentService underTest = new ComponentService(dbClient, userSession, projectIndexers, projectLifeCycleListeners);
@Test
public void bulk_update() {
import org.sonar.server.es.TestProjectIndexers;
import org.sonar.server.exceptions.BadRequestException;
import org.sonar.server.exceptions.ForbiddenException;
+import org.sonar.server.project.ProjectLifeCycleListeners;
import org.sonar.server.tester.UserSessionRule;
import static org.assertj.guava.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
import static org.sonar.db.component.ComponentTesting.newFileDto;
import static org.sonar.db.component.ComponentTesting.newModuleDto;
private DbClient dbClient = db.getDbClient();
private DbSession dbSession = db.getSession();
private TestProjectIndexers projectIndexers = new TestProjectIndexers();
- private ComponentService underTest = new ComponentService(dbClient, userSession, projectIndexers);
+ private ProjectLifeCycleListeners projectLifeCycleListeners = mock(ProjectLifeCycleListeners.class);
+ private ComponentService underTest = new ComponentService(dbClient, userSession, projectIndexers, projectLifeCycleListeners);
@Test
public void update_project_key() {
--- /dev/null
+/*
+ * 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.project;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+import static org.apache.commons.lang.RandomStringUtils.randomAlphanumeric;
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class RekeyedProjectTest {
+ @Rule
+ public ExpectedException expectedException = ExpectedException.none();
+
+ @Test
+ public void constructor_throws_NPE_if_project_is_null() {
+ expectedException.expect(NullPointerException.class);
+ expectedException.expectMessage("project can't be null");
+
+ new RekeyedProject(null, randomAlphanumeric(3));
+ }
+
+ @Test
+ public void constructor_throws_NPE_if_previousKey_is_null() {
+ expectedException.expect(NullPointerException.class);
+ expectedException.expectMessage("previousKey can't be null");
+
+ new RekeyedProject(newRandomProject(), null);
+ }
+
+ @Test
+ public void verify_getters() {
+ Project project = newRandomProject();
+ String previousKey = randomAlphanumeric(6);
+ RekeyedProject underTest = new RekeyedProject(project, previousKey);
+
+ assertThat(underTest.getProject()).isSameAs(project);
+ assertThat(underTest.getPreviousKey()).isEqualTo(previousKey);
+ }
+
+ @Test
+ public void equals_is_based_on_project_and_previousKey() {
+ Project project = newRandomProject();
+ String previousKey = randomAlphanumeric(6);
+ RekeyedProject underTest = new RekeyedProject(project, previousKey);
+
+ assertThat(underTest).isEqualTo(underTest);
+ assertThat(underTest).isEqualTo(new RekeyedProject(project, previousKey));
+ assertThat(underTest).isNotEqualTo(new RekeyedProject(project, randomAlphanumeric(11)));
+ assertThat(underTest).isNotEqualTo(new RekeyedProject(newRandomProject(), previousKey));
+ assertThat(underTest).isNotEqualTo(new Object());
+ assertThat(underTest).isNotEqualTo(null);
+ }
+
+ @Test
+ public void hashCode_is_based_on_project_and_previousKey() {
+ Project project = newRandomProject();
+ String previousKey = randomAlphanumeric(6);
+ RekeyedProject underTest = new RekeyedProject(project, previousKey);
+
+ assertThat(underTest.hashCode()).isEqualTo(underTest.hashCode());
+ assertThat(underTest.hashCode()).isEqualTo(new RekeyedProject(project, previousKey).hashCode());
+ assertThat(underTest.hashCode()).isNotEqualTo(new RekeyedProject(project, randomAlphanumeric(11)).hashCode());
+ assertThat(underTest.hashCode()).isNotEqualTo(new RekeyedProject(newRandomProject(), previousKey).hashCode());
+ assertThat(underTest.hashCode()).isNotEqualTo(new Object().hashCode());
+ assertThat(underTest.hashCode()).isNotEqualTo(null);
+ }
+
+ @Test
+ public void verify_toString() {
+ Project project = new Project("A", "B", "C", "D");
+ String previousKey = "E";
+ RekeyedProject underTest = new RekeyedProject(project, previousKey);
+
+ assertThat(underTest.toString()).isEqualTo("RekeyedProject{project=Project{uuid='A', key='B', name='C', description='D'}, previousKey='E'}");
+ }
+
+ private static Project newRandomProject() {
+ return new Project(randomAlphanumeric(3), randomAlphanumeric(4), randomAlphanumeric(5));
+ }
+}
projects / sonarqube.git / commitdiff