Add SSH command to run Git garbage collection
Add a new SSH command that allows to run the Git garbage collection for specific or all Gerrit projects. The default parameters for the Git garbage collection can be defined in the user global Git configuration file of the system user that runs the Gerrit server. It is possible to specify repository specific parameters for the garbage collection in the Git configuration files on repository level. All GC runs are logged in a newly added GC log file. This log file also contains statistics of the repositories that were garbage collected. Change-Id: Ie8730e3db785d5e05d5b739cfb1ef87ba515e870 Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:

committed by
Shawn Pearce

parent
910e954ac8
commit
619169b4eb
@@ -47,6 +47,7 @@ public class DefaultCommandModule extends CommandModule {
|
||||
command(gerrit, ShowQueue.class);
|
||||
command(gerrit, StreamEvents.class);
|
||||
command(gerrit, VersionCommand.class);
|
||||
command(gerrit, GarbageCollectionCommand.class);
|
||||
|
||||
command(gerrit, "plugin").toProvider(new DispatchCommandProvider(plugin));
|
||||
|
||||
|
@@ -0,0 +1,122 @@
|
||||
// Copyright (C) 2012 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.google.gerrit.sshd.commands;
|
||||
|
||||
import com.google.common.collect.Lists;
|
||||
import com.google.gerrit.common.data.GarbageCollectionResult;
|
||||
import com.google.gerrit.common.data.GlobalCapability;
|
||||
import com.google.gerrit.extensions.annotations.RequiresCapability;
|
||||
import com.google.gerrit.reviewdb.client.Project;
|
||||
import com.google.gerrit.server.git.GarbageCollection;
|
||||
import com.google.gerrit.server.project.ProjectCache;
|
||||
import com.google.gerrit.server.project.ProjectControl;
|
||||
import com.google.gerrit.sshd.BaseCommand;
|
||||
import com.google.gerrit.sshd.CommandMetaData;
|
||||
import com.google.inject.Inject;
|
||||
|
||||
import org.apache.sshd.server.Environment;
|
||||
import org.kohsuke.args4j.Argument;
|
||||
import org.kohsuke.args4j.Option;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.PrintWriter;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
/** Runs the Git garbage collection. */
|
||||
@RequiresCapability(GlobalCapability.RUN_GC)
|
||||
@CommandMetaData(name = "gc", descr = "Run Git garbage collection")
|
||||
public class GarbageCollectionCommand extends BaseCommand {
|
||||
|
||||
@Option(name = "--all", usage = "runs the Git garbage collection for all projects")
|
||||
private boolean all;
|
||||
|
||||
@Argument(index = 0, required = false, multiValued = true, metaVar = "NAME",
|
||||
usage = "projects for which the Git garbage collection should be run")
|
||||
private List<ProjectControl> projects = new ArrayList<ProjectControl>();
|
||||
|
||||
@Inject
|
||||
private ProjectCache projectCache;
|
||||
|
||||
@Inject
|
||||
private GarbageCollection.Factory garbageCollectionFactory;
|
||||
|
||||
private PrintWriter stdout;
|
||||
|
||||
@Override
|
||||
public void start(Environment env) throws IOException {
|
||||
startThread(new CommandRunnable() {
|
||||
@Override
|
||||
public void run() throws Exception {
|
||||
stdout = toPrintWriter(out);
|
||||
try {
|
||||
parseCommandLine();
|
||||
verifyCommandLine();
|
||||
runGC();
|
||||
} finally {
|
||||
stdout.flush();
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
private void verifyCommandLine() throws UnloggedFailure {
|
||||
if (!all && projects.isEmpty()) {
|
||||
throw new UnloggedFailure(1,
|
||||
"needs projects as command arguments or --all option");
|
||||
}
|
||||
if (all && !projects.isEmpty()) {
|
||||
throw new UnloggedFailure(1,
|
||||
"either specify projects as command arguments or use --all option");
|
||||
}
|
||||
}
|
||||
|
||||
private void runGC() {
|
||||
List<Project.NameKey> projectNames;
|
||||
if (all) {
|
||||
projectNames = Lists.newArrayList(projectCache.all());
|
||||
} else {
|
||||
projectNames = Lists.newArrayListWithCapacity(projects.size());
|
||||
for (ProjectControl pc : projects) {
|
||||
projectNames.add(pc.getProject().getNameKey());
|
||||
}
|
||||
}
|
||||
|
||||
GarbageCollectionResult result =
|
||||
garbageCollectionFactory.create().run(projectNames, stdout);
|
||||
if (result.hasErrors()) {
|
||||
for (GarbageCollectionResult.Error e : result.getErrors()) {
|
||||
String msg;
|
||||
switch (e.getType()) {
|
||||
case REPOSITORY_NOT_FOUND:
|
||||
msg = "error: project \"" + e.getProjectName() + "\" not found";
|
||||
break;
|
||||
case GC_ALREADY_SCHEDULED:
|
||||
msg = "error: garbage collection for project \""
|
||||
+ e.getProjectName() + "\" was already scheduled";
|
||||
break;
|
||||
case GC_FAILED:
|
||||
msg = "error: garbage collection for project \"" + e.getProjectName()
|
||||
+ "\" failed";
|
||||
break;
|
||||
default:
|
||||
msg = "error: garbage collection for project \"" + e.getProjectName()
|
||||
+ "\" failed: " + e.getType();
|
||||
}
|
||||
stdout.print(msg + "\n");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user