Log blob updates in sharedref_log
Not every ref update is a commit, some refs in gerrit are actually
pointers to blob objects instead. This is the case for
refs/sequences/changes for example.
Before this change, updates of blob objects were not recorded in the
sharedref_log file: now they are recorded as UPDATE_REF.
Note that, because these are not commits, the committer and commit
message will not be present in the log. For example:
{
"ref_name":"refs/sequences/changes",
"old_id":"56a6051ca2b02b04ef92d5150c9ef600403cb1de",
"new_id":"b5045cc4046dbc1d7cafa4c603fd3cdf35dc5dde",
"project_name":"All-Projects",
"type":"UPDATE_REF"
}
Bug: Issue 11243
Change-Id: I1661489934a46a5160378bddae30a8929bbeb788
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/Log4jSharedRefLogger.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/Log4jSharedRefLogger.java
index 90380e3..36ed2a7 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/Log4jSharedRefLogger.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/Log4jSharedRefLogger.java
@@ -14,7 +14,12 @@
package com.googlesource.gerrit.plugins.multisite;
+import static org.eclipse.jgit.lib.Constants.OBJ_BLOB;
+import static org.eclipse.jgit.lib.Constants.OBJ_COMMIT;
+
+import com.google.common.annotations.VisibleForTesting;
import com.google.common.flogger.FluentLogger;
+import com.google.gerrit.extensions.common.GitPerson;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.CommonConverters;
import com.google.gerrit.server.OutputFormat;
@@ -25,6 +30,8 @@
import com.google.inject.Singleton;
import java.io.IOException;
import org.apache.log4j.PatternLayout;
+import org.eclipse.jgit.errors.IncorrectObjectTypeException;
+import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.lib.Repository;
@@ -36,7 +43,7 @@
@Singleton
public class Log4jSharedRefLogger extends LibModuleLogFile implements SharedRefLogger {
private static final String LOG_NAME = "sharedref_log";
- private final Logger sharedRefDBLog;
+ private Logger sharedRefDBLog;
private final GitRepositoryManager gitRepositoryManager;
private static final Gson gson = OutputFormat.JSON_COMPACT.newGson();
@@ -55,8 +62,20 @@
try (Repository repository =
gitRepositoryManager.openRepository(new Project.NameKey(project));
RevWalk walk = new RevWalk(repository)) {
- RevCommit commit = walk.parseCommit(newRefValue);
-
+ GitPerson committer = null;
+ String commitMessage = null;
+ int objectType = walk.parseAny(newRefValue).getType();
+ switch (objectType) {
+ case OBJ_COMMIT:
+ RevCommit commit = walk.parseCommit(newRefValue);
+ committer = CommonConverters.toGitPerson(commit.getCommitterIdent());
+ commitMessage = commit.getShortMessage();
+ break;
+ case OBJ_BLOB:
+ break;
+ default:
+ throw new IncorrectObjectTypeException(newRefValue, Constants.typeString(objectType));
+ }
sharedRefDBLog.info(
gson.toJson(
new SharedRefLogEntry.UpdateRef(
@@ -64,14 +83,13 @@
currRef.getName(),
currRef.getObjectId().getName(),
newRefValue.getName(),
- CommonConverters.toGitPerson(commit.getCommitterIdent()),
- commit.getShortMessage())));
+ committer,
+ commitMessage)));
} catch (IOException e) {
logger.atSevere().withCause(e).log(
"Cannot log sharedRefDB interaction for ref %s on project %s",
currRef.getName(), project);
}
-
} else {
sharedRefDBLog.info(
gson.toJson(
@@ -84,4 +102,9 @@
public void logProjectDelete(String project) {
sharedRefDBLog.info(gson.toJson(new SharedRefLogEntry.DeleteProject(project)));
}
+
+ @VisibleForTesting
+ public void setLogger(Logger logger) {
+ this.sharedRefDBLog = logger;
+ }
}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/multisite/SharedRefLogEntry.java b/src/main/java/com/googlesource/gerrit/plugins/multisite/SharedRefLogEntry.java
index 50c7949..88d38bb 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/multisite/SharedRefLogEntry.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/multisite/SharedRefLogEntry.java
@@ -14,6 +14,7 @@
package com.googlesource.gerrit.plugins.multisite;
+import com.google.gerrit.common.Nullable;
import com.google.gerrit.extensions.common.GitPerson;
public class SharedRefLogEntry {
@@ -40,8 +41,8 @@
String refName,
String oldId,
String newId,
- GitPerson committer,
- String comment) {
+ @Nullable GitPerson committer,
+ @Nullable String comment) {
this.type = Type.UPDATE_REF;
this.projectName = projectName;
this.refName = refName;
diff --git a/src/test/java/com/googlesource/gerrit/plugins/multisite/validation/Log4jSharedRefLoggerTest.java b/src/test/java/com/googlesource/gerrit/plugins/multisite/validation/Log4jSharedRefLoggerTest.java
new file mode 100644
index 0000000..8b305c7
--- /dev/null
+++ b/src/test/java/com/googlesource/gerrit/plugins/multisite/validation/Log4jSharedRefLoggerTest.java
@@ -0,0 +1,141 @@
+// Copyright (C) 2019 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.googlesource.gerrit.plugins.multisite.validation;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.gerrit.acceptance.AbstractDaemonTest;
+import com.google.gerrit.acceptance.PushOneCommit;
+import com.google.gerrit.reviewdb.client.RefNames;
+import com.google.gerrit.server.OutputFormat;
+import com.google.gerrit.server.Sequences;
+import com.google.gerrit.server.config.SitePaths;
+import com.google.gerrit.server.util.SystemLog;
+import com.google.gson.Gson;
+import com.googlesource.gerrit.plugins.multisite.Log4jSharedRefLogger;
+import com.googlesource.gerrit.plugins.multisite.SharedRefLogEntry;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import org.apache.log4j.LogManager;
+import org.apache.log4j.PatternLayout;
+import org.apache.log4j.WriterAppender;
+import org.eclipse.jgit.lib.ObjectId;
+import org.eclipse.jgit.lib.Ref;
+import org.eclipse.jgit.lib.Repository;
+import org.junit.Before;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class Log4jSharedRefLoggerTest extends AbstractDaemonTest {
+
+ private static final Gson gson = OutputFormat.JSON_COMPACT.newGson();
+ private StringWriter logWriter;
+ private Log4jSharedRefLogger log4jSharedRefLogger;
+
+ @Before
+ public void setUp() throws IOException {
+ this.logWriter = new StringWriter();
+ this.log4jSharedRefLogger = newLog4jSharedRefLogger();
+ }
+
+ @Test
+ public void shouldLogProjectDeletion() {
+ log4jSharedRefLogger.logProjectDelete(project.get());
+
+ SharedRefLogEntry.DeleteProject gotLogEntry =
+ gson.fromJson(logWriter.toString(), SharedRefLogEntry.DeleteProject.class);
+
+ assertThat(gotLogEntry.type).isEqualTo(SharedRefLogEntry.Type.DELETE_PROJECT);
+ assertThat(gotLogEntry.projectName).isEqualTo(project.get());
+ }
+
+ @Test
+ public void shouldLogUpdateRef() throws Exception {
+ final String refName = "refs/remotes/origin/master";
+ Ref currRef = repo().exactRef(refName);
+ PushOneCommit.Result result = pushTo(refName);
+ ObjectId newRefValue = result.getCommit().toObjectId();
+
+ log4jSharedRefLogger.logRefUpdate(project.get(), currRef, newRefValue);
+
+ SharedRefLogEntry.UpdateRef gotLogEntry =
+ gson.fromJson(logWriter.toString(), SharedRefLogEntry.UpdateRef.class);
+
+ assertThat(gotLogEntry.type).isEqualTo(SharedRefLogEntry.Type.UPDATE_REF);
+ assertThat(gotLogEntry.projectName).isEqualTo(project.get());
+ assertThat(gotLogEntry.refName).isEqualTo(refName);
+ assertThat(gotLogEntry.oldId).isEqualTo(currRef.getObjectId().getName());
+ assertThat(gotLogEntry.newId).isEqualTo(newRefValue.getName());
+ assertThat(gotLogEntry.comment).isNotNull();
+ assertThat(gotLogEntry.committer).isNotNull();
+ }
+
+ @Test
+ public void shouldLogDeleteRef() throws Exception {
+ final String refName = "refs/remotes/origin/master";
+ Ref currRef = repo().exactRef(refName);
+
+ log4jSharedRefLogger.logRefUpdate(project.get(), currRef, ObjectId.zeroId());
+
+ SharedRefLogEntry.DeleteRef gotLogEntry =
+ gson.fromJson(logWriter.toString(), SharedRefLogEntry.DeleteRef.class);
+
+ assertThat(gotLogEntry.type).isEqualTo(SharedRefLogEntry.Type.DELETE_REF);
+ assertThat(gotLogEntry.projectName).isEqualTo(project.get());
+ assertThat(gotLogEntry.refName).isEqualTo(refName);
+ assertThat(gotLogEntry.oldId).isEqualTo(currRef.getObjectId().getName());
+ }
+
+ @Test
+ public void shouldLogBlobRefs() throws Exception {
+ Repository allUsersRepo = repoManager.openRepository(allUsers);
+ String blobRefName = RefNames.REFS_SEQUENCES + Sequences.NAME_ACCOUNTS;
+ Ref currRef = allUsersRepo.exactRef(blobRefName);
+ log4jSharedRefLogger.logRefUpdate(allUsers.get(), currRef, currRef.getObjectId());
+
+ SharedRefLogEntry.UpdateRef gotLogEntry =
+ gson.fromJson(logWriter.toString(), SharedRefLogEntry.UpdateRef.class);
+
+ assertThat(gotLogEntry.type).isEqualTo(SharedRefLogEntry.Type.UPDATE_REF);
+ assertThat(gotLogEntry.projectName).isEqualTo(allUsers.get());
+ assertThat(gotLogEntry.refName).isEqualTo(blobRefName);
+ assertThat(gotLogEntry.oldId).isEqualTo(currRef.getObjectId().getName());
+ assertThat(gotLogEntry.newId).isEqualTo(currRef.getObjectId().getName());
+ assertThat(gotLogEntry.comment).isNull();
+ assertThat(gotLogEntry.committer).isNull();
+ }
+
+ private Log4jSharedRefLogger newLog4jSharedRefLogger() throws IOException {
+ final Log4jSharedRefLogger log4jSharedRefLogger =
+ new Log4jSharedRefLogger(new SystemLog(new SitePaths(newPath()), baseConfig), repoManager);
+ log4jSharedRefLogger.setLogger(logWriterLogger());
+ return log4jSharedRefLogger;
+ }
+
+ private Logger logWriterLogger() {
+ org.apache.log4j.Logger logger = LogManager.getLogger("logWriterLogger");
+ logger.addAppender(new WriterAppender(new PatternLayout("%m"), logWriter));
+ return LoggerFactory.getLogger("logWriterLogger");
+ }
+
+ private static Path newPath() throws IOException {
+ Path tmp = Files.createTempFile("gerrit_test_", "_site");
+ Files.deleteIfExists(tmp);
+ return tmp;
+ }
+}
