Add tests for PathServlet HTML rendering
Service the request including Soy rendering to make sure our Soy
templates are lined up correctly, then check the various data fields
to see how they were populated.
Change-Id: I9e2d003d00244ab0e255977dd70cf1ac6bbcb109
diff --git a/gitiles-servlet/src/main/java/com/google/gitiles/BaseServlet.java b/gitiles-servlet/src/main/java/com/google/gitiles/BaseServlet.java
index 972f913..cf45af7 100644
--- a/gitiles-servlet/src/main/java/com/google/gitiles/BaseServlet.java
+++ b/gitiles-servlet/src/main/java/com/google/gitiles/BaseServlet.java
@@ -188,29 +188,25 @@
*/
protected void renderHtml(HttpServletRequest req, HttpServletResponse res, String templateName,
Map<String, ?> soyData) throws IOException {
- try {
- res.setContentType(FormatType.HTML.getMimeType());
- res.setCharacterEncoding(Charsets.UTF_8.name());
- setCacheHeaders(res);
+ res.setContentType(FormatType.HTML.getMimeType());
+ res.setCharacterEncoding(Charsets.UTF_8.name());
+ setCacheHeaders(res);
- Map<String, Object> allData = getData(req);
+ Map<String, Object> allData = getData(req);
- GitilesConfig.putVariant(
- getAccess(req).getConfig(), "customHeader", "headerVariant", allData);
- allData.putAll(soyData);
- GitilesView view = ViewFilter.getView(req);
- if (!allData.containsKey("repositoryName") && view.getRepositoryName() != null) {
- allData.put("repositoryName", view.getRepositoryName());
- }
- if (!allData.containsKey("breadcrumbs")) {
- allData.put("breadcrumbs", view.getBreadcrumbs());
- }
-
- res.setStatus(HttpServletResponse.SC_OK);
- renderer.render(res, templateName, allData);
- } finally {
- req.removeAttribute(DATA_ATTRIBUTE);
+ GitilesConfig.putVariant(
+ getAccess(req).getConfig(), "customHeader", "headerVariant", allData);
+ allData.putAll(soyData);
+ GitilesView view = ViewFilter.getView(req);
+ if (!allData.containsKey("repositoryName") && view.getRepositoryName() != null) {
+ allData.put("repositoryName", view.getRepositoryName());
}
+ if (!allData.containsKey("breadcrumbs")) {
+ allData.put("breadcrumbs", view.getBreadcrumbs());
+ }
+
+ res.setStatus(HttpServletResponse.SC_OK);
+ renderer.render(res, templateName, allData);
}
/**
diff --git a/gitiles-servlet/src/test/java/com/google/gitiles/PathServletTest.java b/gitiles-servlet/src/test/java/com/google/gitiles/PathServletTest.java
new file mode 100644
index 0000000..6fc0bc4
--- /dev/null
+++ b/gitiles-servlet/src/test/java/com/google/gitiles/PathServletTest.java
@@ -0,0 +1,177 @@
+// Copyright (C) 2014 Google Inc. All Rights Reserved.
+//
+// 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.gitiles;
+
+import static org.junit.Assert.assertEquals;
+
+import com.google.common.collect.ImmutableList;
+import com.google.template.soy.data.SoyListData;
+import com.google.template.soy.data.restricted.StringData;
+
+import org.eclipse.jgit.dircache.DirCacheEditor.PathEdit;
+import org.eclipse.jgit.dircache.DirCacheEntry;
+import org.eclipse.jgit.internal.storage.dfs.DfsRepository;
+import org.eclipse.jgit.internal.storage.dfs.DfsRepositoryDescription;
+import org.eclipse.jgit.internal.storage.dfs.InMemoryRepository;
+import org.eclipse.jgit.junit.TestRepository;
+import org.eclipse.jgit.lib.FileMode;
+import org.eclipse.jgit.lib.ObjectId;
+import org.eclipse.jgit.revwalk.RevBlob;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.net.URL;
+import java.util.List;
+import java.util.Map;
+
+/** Tests for {@PathServlet}. */
+@SuppressWarnings("unchecked")
+public class PathServletTest {
+ private static final Renderer RENDERER =
+ new DefaultRenderer("/+static", ImmutableList.<URL> of(), "Test");
+
+ private TestRepository<DfsRepository> repo;
+ private PathServlet servlet;
+
+ @Before
+ public void setUp() throws Exception {
+ DfsRepository r = new InMemoryRepository(new DfsRepositoryDescription("repo"));
+ repo = new TestRepository<DfsRepository>(r);
+ servlet = new PathServlet(
+ new TestGitilesAccess(repo.getRepository()), RENDERER, TestGitilesUrls.URLS);
+ }
+
+ @Test
+ public void rootTreeHtml() throws Exception {
+ repo.branch("master").commit().add("foo", "contents").create();
+
+ Map<String, ?> data = buildData("/repo/+/master/");
+ assertEquals("TREE", data.get("type"));
+ List<Map<String, ?>> entries = getTreeEntries(data);
+ assertEquals(1, entries.size());
+ assertEquals("foo", entries.get(0).get("name"));
+ }
+
+ @Test
+ public void subTreeHtml() throws Exception {
+ repo.branch("master").commit()
+ .add("foo/bar", "bar contents")
+ .add("baz", "baz contents")
+ .create();
+
+ Map<String, ?> data = buildData("/repo/+/master/");
+ assertEquals("TREE", data.get("type"));
+ List<Map<String, ?>> entries = getTreeEntries(data);
+ assertEquals(2, entries.size());
+ assertEquals("baz", entries.get(0).get("name"));
+ assertEquals("foo/", entries.get(1).get("name"));
+
+ data = buildData("/repo/+/master/foo");
+ assertEquals("TREE", data.get("type"));
+ entries = getTreeEntries(data);
+ assertEquals(1, entries.size());
+ assertEquals("bar", entries.get(0).get("name"));
+
+ data = buildData("/repo/+/master/foo/");
+ assertEquals("TREE", data.get("type"));
+ entries = getTreeEntries(data);
+ assertEquals(1, entries.size());
+ assertEquals("bar", entries.get(0).get("name"));
+ }
+
+ @Test
+ public void fileHtml() throws Exception {
+ repo.branch("master").commit().add("foo", "foo\ncontents\n").create();
+
+ Map<String, ?> data = buildData("/repo/+/master/foo");
+ assertEquals("REGULAR_FILE", data.get("type"));
+
+ SoyListData lines = (SoyListData) getBlobData(data).get("lines");
+ assertEquals(2, lines.length());
+
+ SoyListData spans = lines.getListData(0);
+ assertEquals(1, spans.length());
+ assertEquals(StringData.forValue("pln"), spans.getMapData(0).get("classes"));
+ assertEquals(StringData.forValue("foo"), spans.getMapData(0).get("text"));
+
+ spans = lines.getListData(1);
+ assertEquals(1, spans.length());
+ assertEquals(StringData.forValue("pln"), spans.getMapData(0).get("classes"));
+ assertEquals(StringData.forValue("contents"), spans.getMapData(0).get("text"));
+ }
+
+ @Test
+ public void symlinkHtml() throws Exception {
+ final RevBlob link = repo.blob("foo");
+ repo.branch("master").commit().add("foo", "contents")
+ .edit(new PathEdit("bar") {
+ @Override
+ public void apply(DirCacheEntry ent) {
+ ent.setFileMode(FileMode.SYMLINK);
+ ent.setObjectId(link);
+ }
+ }).create();
+
+ Map<String, ?> data = buildData("/repo/+/master/bar");
+ assertEquals("SYMLINK", data.get("type"));
+ assertEquals("foo", getBlobData(data).get("target"));
+ }
+
+ @Test
+ public void gitlinkHtml() throws Exception {
+ String gitmodules = "[submodule \"gitiles\"]\n"
+ + " path = gitiles\n"
+ + " url = https://gerrit.googlesource.com/gitiles\n";
+ final String gitilesSha = "2b2f34bba3c2be7e2506ce6b1f040949da350cf9";
+ repo.branch("master").commit().add(".gitmodules", gitmodules)
+ .edit(new PathEdit("gitiles") {
+ @Override
+ public void apply(DirCacheEntry ent) {
+ ent.setFileMode(FileMode.GITLINK);
+ ent.setObjectId(ObjectId.fromString(gitilesSha));
+ }
+ }).create();
+
+ Map<String, ?> data = buildData("/repo/+/master/gitiles");
+ assertEquals("GITLINK", data.get("type"));
+
+ Map<String, ?> linkData = getBlobData(data);
+ assertEquals(gitilesSha, linkData.get("sha"));
+ assertEquals("https://gerrit.googlesource.com/gitiles", linkData.get("remoteUrl"));
+ assertEquals("https://gerrit.googlesource.com/gitiles", linkData.get("httpUrl"));
+ }
+
+ private Map<String, ?> getBlobData(Map<String, ?> data) {
+ return ((Map<String, Map<String, ?>>) data).get("data");
+ }
+
+ private List<Map<String, ?>> getTreeEntries(Map<String, ?> data) {
+ return ((Map<String, List<Map<String, ?>>>) data.get("data")).get("entries");
+ }
+
+ private TestViewFilter.Result service(String pathAndQuery) throws Exception {
+ TestViewFilter.Result res = TestViewFilter.service(repo, pathAndQuery);
+ assertEquals(200, res.getResponse().getStatus());
+ assertEquals(GitilesView.Type.PATH, res.getView().getType());
+ servlet.service(res.getRequest(), res.getResponse());
+ return res;
+ }
+
+ private Map<String, ?> buildData(String pathAndQuery) throws Exception {
+ // Render the page through Soy to ensure templates are valid, then return
+ // the Soy data for introspection.
+ return BaseServlet.getData(service(pathAndQuery).getRequest());
+ }
+}
diff --git a/gitiles-servlet/src/test/java/com/google/gitiles/TestViewFilter.java b/gitiles-servlet/src/test/java/com/google/gitiles/TestViewFilter.java
index 4f1e5ba..369eb9e 100644
--- a/gitiles-servlet/src/test/java/com/google/gitiles/TestViewFilter.java
+++ b/gitiles-servlet/src/test/java/com/google/gitiles/TestViewFilter.java
@@ -22,6 +22,7 @@
import com.google.common.collect.ImmutableList;
+import org.eclipse.jgit.http.server.ServletUtils;
import org.eclipse.jgit.http.server.glue.MetaFilter;
import org.eclipse.jgit.http.server.glue.MetaServlet;
import org.eclipse.jgit.internal.storage.dfs.DfsRepository;
@@ -39,10 +40,12 @@
class TestViewFilter {
static class Result {
private final GitilesView view;
+ private final FakeHttpServletRequest req;
private final FakeHttpServletResponse res;
- private Result(GitilesView view, FakeHttpServletResponse res) {
+ private Result(GitilesView view, FakeHttpServletRequest req, FakeHttpServletResponse res) {
this.view = view;
+ this.req = req;
this.res = res;
}
@@ -50,6 +53,10 @@
return view;
}
+ FakeHttpServletRequest getRequest() {
+ return req;
+ }
+
FakeHttpServletResponse getResponse() {
return res;
}
@@ -69,13 +76,19 @@
.through(vf)
.with(servlet);
}
+
+ FakeHttpServletRequest req = newRequest(repo, pathAndQuery);
+ req.setAttribute(ServletUtils.ATTRIBUTE_REPOSITORY, repo.getRepository());
FakeHttpServletResponse res = new FakeHttpServletResponse();
- dummyServlet(mf).service(newRequest(repo, pathAndQuery), res);
- if (servlet.view != null && servlet.view.getRepositoryName() != null) {
- assertEquals(repo.getRepository().getDescription().getRepositoryName(),
- servlet.view.getRepositoryName());
+ dummyServlet(mf).service(req, res);
+ if (servlet.view != null) {
+ ViewFilter.setView(req, servlet.view);
+ if (servlet.view.getRepositoryName() != null) {
+ assertEquals(repo.getRepository().getDescription().getRepositoryName(),
+ servlet.view.getRepositoryName());
+ }
}
- return new Result(servlet.view, res);
+ return new Result(servlet.view, req, res);
}
private static class TestServlet extends HttpServlet {
