Extract a StandaloneSiteTest for testing offline programs
Analogous to GerritServerTest, but just initializes the site, and
provides helper methods for starting the server and running other
programs.
ReindexIT is now a one-liner.
Change-Id: Idb8e5b66bb1ae7f6e7b8e039c44396dc4898c0f3
diff --git a/gerrit-acceptance-framework/src/test/java/com/google/gerrit/acceptance/StandaloneSiteTest.java b/gerrit-acceptance-framework/src/test/java/com/google/gerrit/acceptance/StandaloneSiteTest.java
new file mode 100644
index 0000000..be34ba6
--- /dev/null
+++ b/gerrit-acceptance-framework/src/test/java/com/google/gerrit/acceptance/StandaloneSiteTest.java
@@ -0,0 +1,142 @@
+// Copyright (C) 2017 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.acceptance;
+
+import static com.google.common.truth.Truth.assertThat;
+import static java.util.stream.Collectors.joining;
+import static org.junit.Assert.fail;
+
+import com.google.common.collect.Streams;
+import com.google.gerrit.launcher.GerritLauncher;
+import com.google.gerrit.reviewdb.client.Account;
+import com.google.gerrit.reviewdb.server.ReviewDb;
+import com.google.gerrit.server.CurrentUser;
+import com.google.gerrit.server.config.SitePaths;
+import com.google.gerrit.server.util.ManualRequestContext;
+import com.google.gerrit.server.util.OneOffRequestContext;
+import com.google.gerrit.server.util.RequestContext;
+import com.google.gerrit.testutil.ConfigSuite;
+import com.google.inject.Injector;
+import com.google.inject.Provider;
+import java.util.Arrays;
+import org.eclipse.jgit.lib.Config;
+import org.junit.Rule;
+import org.junit.rules.RuleChain;
+import org.junit.rules.TemporaryFolder;
+import org.junit.rules.TestRule;
+import org.junit.runner.Description;
+import org.junit.runner.RunWith;
+import org.junit.runners.model.Statement;
+
+@RunWith(ConfigSuite.class)
+@UseLocalDisk
+public abstract class StandaloneSiteTest {
+ protected class ServerContext implements RequestContext, AutoCloseable {
+ private final GerritServer server;
+ private final ManualRequestContext ctx;
+
+ private ServerContext(GerritServer server) throws Exception {
+ this.server = server;
+ Injector i = server.getTestInjector();
+ if (adminId == null) {
+ adminId = i.getInstance(AccountCreator.class).admin().getId();
+ }
+ ctx = i.getInstance(OneOffRequestContext.class).openAs(adminId);
+ }
+
+ @Override
+ public CurrentUser getUser() {
+ return ctx.getUser();
+ }
+
+ @Override
+ public Provider<ReviewDb> getReviewDbProvider() {
+ return ctx.getReviewDbProvider();
+ }
+
+ public Injector getInjector() {
+ return server.getTestInjector();
+ }
+
+ @Override
+ public void close() throws Exception {
+ try {
+ ctx.close();
+ } finally {
+ server.close();
+ }
+ }
+ }
+
+ @ConfigSuite.Parameter public Config baseConfig;
+ @ConfigSuite.Name private String configName;
+
+ private final TemporaryFolder tempSiteDir = new TemporaryFolder();
+
+ private final TestRule testRunner =
+ new TestRule() {
+ @Override
+ public Statement apply(Statement base, Description description) {
+ return new Statement() {
+ @Override
+ public void evaluate() throws Throwable {
+ beforeTest(description);
+ base.evaluate();
+ }
+ };
+ }
+ };
+
+ @Rule public RuleChain ruleChain = RuleChain.outerRule(tempSiteDir).around(testRunner);
+
+ protected SitePaths sitePaths;
+
+ private GerritServer.Description serverDesc;
+ private Account.Id adminId;
+
+ private void beforeTest(Description description) throws Exception {
+ serverDesc = GerritServer.Description.forTestMethod(description, configName);
+ sitePaths = new SitePaths(tempSiteDir.getRoot().toPath());
+ GerritServer.init(serverDesc, baseConfig, sitePaths.site_path);
+ }
+
+ protected ServerContext startServer() throws Exception {
+ return new ServerContext(startImpl());
+ }
+
+ protected void assertServerStartupFails() throws Exception {
+ try (GerritServer server = startImpl()) {
+ fail("expected server startup to fail");
+ } catch (GerritServer.StartupException e) {
+ // Expected.
+ }
+ }
+
+ private GerritServer startImpl() throws Exception {
+ return GerritServer.start(serverDesc, baseConfig, sitePaths.site_path);
+ }
+
+ protected static void runGerrit(String... args) throws Exception {
+ assertThat(GerritLauncher.mainImpl(args))
+ .named("gerrit.war " + Arrays.stream(args).collect(joining(" ")))
+ .isEqualTo(0);
+ }
+
+ @SafeVarargs
+ protected static void runGerrit(Iterable<String>... multiArgs) throws Exception {
+ runGerrit(
+ Arrays.stream(multiArgs).flatMap(args -> Streams.stream(args)).toArray(String[]::new));
+ }
+}
diff --git a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/pgm/OfflineNoteDbMigrationIT.java b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/pgm/OfflineNoteDbMigrationIT.java
index 51f3fa5..9b36b03 100644
--- a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/pgm/OfflineNoteDbMigrationIT.java
+++ b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/pgm/OfflineNoteDbMigrationIT.java
@@ -16,23 +16,17 @@
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth8.assertThat;
-import static org.junit.Assert.fail;
+import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
-import com.google.gerrit.acceptance.AccountCreator;
-import com.google.gerrit.acceptance.GerritServer;
import com.google.gerrit.acceptance.NoHttpd;
-import com.google.gerrit.acceptance.TestAccount;
-import com.google.gerrit.acceptance.UseLocalDisk;
+import com.google.gerrit.acceptance.StandaloneSiteTest;
import com.google.gerrit.extensions.api.GerritApi;
import com.google.gerrit.extensions.common.ChangeInput;
-import com.google.gerrit.launcher.GerritLauncher;
-import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.client.Change;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.reviewdb.client.RefNames;
import com.google.gerrit.reviewdb.server.ReviewDb;
-import com.google.gerrit.server.config.SitePaths;
import com.google.gerrit.server.git.GitRepositoryManager;
import com.google.gerrit.server.index.GerritIndexStatus;
import com.google.gerrit.server.index.change.ChangeSchemaDefinitions;
@@ -42,29 +36,17 @@
import com.google.gerrit.server.notedb.NoteDbChangeState.RefState;
import com.google.gerrit.server.notedb.NotesMigrationState;
import com.google.gerrit.server.schema.ReviewDbFactory;
-import com.google.gerrit.server.util.ManualRequestContext;
-import com.google.gerrit.server.util.OneOffRequestContext;
-import com.google.gerrit.testutil.ConfigSuite;
-import com.google.gerrit.testutil.TempFileUtil;
import com.google.gwtorm.server.SchemaFactory;
-import com.google.inject.Injector;
import com.google.inject.Key;
import com.google.inject.TypeLiteral;
-import java.nio.file.Path;
-import java.util.stream.Stream;
-import org.eclipse.jgit.lib.Config;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.StoredConfig;
import org.eclipse.jgit.storage.file.FileBasedConfig;
import org.eclipse.jgit.util.FS;
-import org.junit.After;
import org.junit.Before;
-import org.junit.Rule;
import org.junit.Test;
-import org.junit.rules.TestWatcher;
-import org.junit.runner.Description;
/**
* Tests for offline {@code migrate-to-note-db} program.
@@ -73,37 +55,16 @@
* adding tests to {@link com.google.gerrit.acceptance.server.notedb.OnlineNoteDbMigrationIT} if
* possible.
*/
-@UseLocalDisk
@NoHttpd
-public class OfflineNoteDbMigrationIT {
- @Rule
- public TestWatcher testWatcher =
- new TestWatcher() {
- @Override
- protected void starting(Description description) {
- serverDesc = GerritServer.Description.forTestMethod(description, ConfigSuite.DEFAULT);
- }
- };
-
- private GerritServer.Description serverDesc;
-
- private Path site;
+public class OfflineNoteDbMigrationIT extends StandaloneSiteTest {
private StoredConfig gerritConfig;
- private Account.Id accountId;
private Project.NameKey project;
private Change.Id changeId;
@Before
public void setUp() throws Exception {
- site = TempFileUtil.createTempDirectory().toPath();
- GerritServer.init(serverDesc, new Config(), site);
- gerritConfig = new FileBasedConfig(new SitePaths(site).gerrit_config.toFile(), FS.detect());
- }
-
- @After
- public void tearDown() throws Exception {
- TempFileUtil.cleanup();
+ gerritConfig = new FileBasedConfig(sitePaths.gerrit_config.toFile(), FS.detect());
}
@Test
@@ -114,10 +75,8 @@
migrate();
assertNotesMigrationState(NotesMigrationState.READ_WRITE_NO_SEQUENCE);
- try (GerritServer server = startServer();
- ManualRequestContext ctx = openContext(server, accountId)) {
- GitRepositoryManager repoManager =
- server.getTestInjector().getInstance(GitRepositoryManager.class);
+ try (ServerContext ctx = startServer()) {
+ GitRepositoryManager repoManager = ctx.getInjector().getInstance(GitRepositoryManager.class);
ObjectId metaId;
try (Repository repo = repoManager.openRepository(project)) {
Ref ref = repo.exactRef(RefNames.changeMetaRef(changeId));
@@ -125,7 +84,7 @@
metaId = ref.getObjectId();
}
- try (ReviewDb db = openUnderlyingReviewDb(server)) {
+ try (ReviewDb db = openUnderlyingReviewDb(ctx)) {
Change c = db.changes().get(changeId);
assertThat(c).isNotNull();
NoteDbChangeState state = NoteDbChangeState.parse(c);
@@ -144,15 +103,13 @@
migrate("--trial", "false");
assertNotesMigrationState(NotesMigrationState.NOTE_DB_UNFUSED);
- try (GerritServer server = startServer();
- ManualRequestContext ctx = openContext(server, accountId)) {
- GitRepositoryManager repoManager =
- server.getTestInjector().getInstance(GitRepositoryManager.class);
+ try (ServerContext ctx = startServer()) {
+ GitRepositoryManager repoManager = ctx.getInjector().getInstance(GitRepositoryManager.class);
try (Repository repo = repoManager.openRepository(project)) {
assertThat(repo.exactRef(RefNames.changeMetaRef(changeId))).isNotNull();
}
- try (ReviewDb db = openUnderlyingReviewDb(server)) {
+ try (ReviewDb db = openUnderlyingReviewDb(ctx)) {
Change c = db.changes().get(changeId);
assertThat(c).isNotNull();
NoteDbChangeState state = NoteDbChangeState.parse(c);
@@ -162,7 +119,7 @@
ChangeInput in = new ChangeInput(project.get(), "master", "NoteDb-only change");
in.newBranch = true;
- GerritApi gApi = server.getTestInjector().getInstance(GerritApi.class);
+ GerritApi gApi = ctx.getInjector().getInstance(GerritApi.class);
Change.Id id2 = new Change.Id(gApi.changes().create(in).info()._number);
assertThat(db.changes().get(id2)).isNull();
}
@@ -175,7 +132,7 @@
setUpOneChange();
int version = ChangeSchemaDefinitions.INSTANCE.getLatest().getVersion();
- GerritIndexStatus status = new GerritIndexStatus(new SitePaths(site));
+ GerritIndexStatus status = new GerritIndexStatus(sitePaths);
assertThat(status.getReady(ChangeSchemaDefinitions.NAME, version)).isTrue();
status.setReady(ChangeSchemaDefinitions.NAME, version, false);
status.save();
@@ -183,23 +140,17 @@
migrate("--trial", "false");
assertNotesMigrationState(NotesMigrationState.NOTE_DB_UNFUSED);
- status = new GerritIndexStatus(new SitePaths(site));
+ status = new GerritIndexStatus(sitePaths);
assertThat(status.getReady(ChangeSchemaDefinitions.NAME, version)).isFalse();
// TODO(dborowitz): Remove when offline migration includes reindex.
- try (GerritServer server = startServer()) {
- fail("expected server startup to fail");
- } catch (GerritServer.StartupException e) {
- // Expected.
- }
+ assertServerStartupFails();
}
private void setUpOneChange() throws Exception {
project = new Project.NameKey("project");
- try (GerritServer server = startServer();
- ManualRequestContext ctx = openContext(server)) {
- accountId = ctx.getUser().getAccountId();
- GerritApi gApi = server.getTestInjector().getInstance(GerritApi.class);
+ try (ServerContext ctx = startServer()) {
+ GerritApi gApi = ctx.getInjector().getInstance(GerritApi.class);
gApi.projects().create("project");
ChangeInput in = new ChangeInput(project.get(), "master", "Test change");
@@ -208,28 +159,11 @@
}
}
- private GerritServer startServer() throws Exception {
- return GerritServer.start(serverDesc, new Config(), site);
- }
-
- private ManualRequestContext openContext(GerritServer server) throws Exception {
- Injector i = server.getTestInjector();
- TestAccount a = i.getInstance(AccountCreator.class).admin();
- return openContext(server, a.getId());
- }
-
- private ManualRequestContext openContext(GerritServer server, Account.Id accountId)
- throws Exception {
- return server.getTestInjector().getInstance(OneOffRequestContext.class).openAs(accountId);
- }
-
private void migrate(String... additionalArgs) throws Exception {
- String[] args =
- Stream.concat(
- Stream.of("migrate-to-note-db", "-d", site.toString(), "--show-stack-trace"),
- Stream.of(additionalArgs))
- .toArray(String[]::new);
- assertThat(GerritLauncher.mainImpl(args)).isEqualTo(0);
+ runGerrit(
+ ImmutableList.of(
+ "migrate-to-note-db", "-d", sitePaths.site_path.toString(), "--show-stack-trace"),
+ ImmutableList.copyOf(additionalArgs));
}
private void assertNotesMigrationState(NotesMigrationState expected) throws Exception {
@@ -238,9 +172,8 @@
.hasValue(expected);
}
- private ReviewDb openUnderlyingReviewDb(GerritServer server) throws Exception {
- return server
- .getTestInjector()
+ private ReviewDb openUnderlyingReviewDb(ServerContext ctx) throws Exception {
+ return ctx.getInjector()
.getInstance(Key.get(new TypeLiteral<SchemaFactory<ReviewDb>>() {}, ReviewDbFactory.class))
.open();
}
diff --git a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/pgm/ReindexIT.java b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/pgm/ReindexIT.java
index 79bbba2..10c51df 100644
--- a/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/pgm/ReindexIT.java
+++ b/gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/pgm/ReindexIT.java
@@ -14,48 +14,14 @@
package com.google.gerrit.acceptance.pgm;
-import static com.google.common.truth.Truth.assertThat;
-
-import com.google.gerrit.launcher.GerritLauncher;
-import com.google.gerrit.testutil.TempFileUtil;
-import java.io.File;
-import org.junit.After;
-import org.junit.Before;
+import com.google.gerrit.acceptance.NoHttpd;
+import com.google.gerrit.acceptance.StandaloneSiteTest;
import org.junit.Test;
-public class ReindexIT {
- private File sitePath;
-
- @Before
- public void createTempDirectory() throws Exception {
- sitePath = TempFileUtil.createTempDirectory();
- }
-
- @After
- public void destroySite() throws Exception {
- if (sitePath != null) {
- TempFileUtil.cleanup();
- }
- }
-
+@NoHttpd
+public class ReindexIT extends StandaloneSiteTest {
@Test
public void reindexEmptySite() throws Exception {
- initSite();
- runGerrit("reindex", "-d", sitePath.toString(), "--show-stack-trace");
- }
-
- private void initSite() throws Exception {
- runGerrit(
- "init",
- "-d",
- sitePath.getPath(),
- "--batch",
- "--no-auto-start",
- "--skip-plugins",
- "--show-stack-trace");
- }
-
- private static void runGerrit(String... args) throws Exception {
- assertThat(GerritLauncher.mainImpl(args)).isEqualTo(0);
+ runGerrit("reindex", "-d", sitePaths.site_path.toString(), "--show-stack-trace");
}
}
