gitiles.Log: implement paging.

common/api/gitiles/gitiles_test.go

+// Copyright 2017 The LUCI Authors.
+//
+// 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 gitiles
+
+import (
+        "fmt"
+        "net/http"
+        "net/http/httptest"
+        "testing"
+
+        "golang.org/x/net/context"
+
+        . "github.com/smartystreets/goconvey/convey"
+)
+
+func TestRepoURL(t *testing.T) {
+        t.Parallel()
+        Convey("Malformed", t, func() {
+                f := func(arg string) {
+                        So(ValidateRepoURL(arg), ShouldNotBeNil)
+                        _, err := NormalizeRepoURL(arg)
+                        So(err, ShouldNotBeNil)
+                }
+
+                f("wtf/\\is\this")
+                f("https://example.com/repo.git")
+                f("http://bad-protocol.googlesource.com/repo.git")
+                f("https://a.googlesource.com")
+                f("https://a.googlesource.com/")
+                f("a.googlesource.com/no-protocol.git")
+                f("https://a.googlesource.com/no-protocol#fragment")
+        })
+
+        Convey("OK", t, func() {
+                f := func(arg, exp string) {
+                        So(ValidateRepoURL(arg), ShouldBeNil)
+                        act, err := NormalizeRepoURL(arg)
+                        So(err, ShouldBeNil)
+                        So(act, ShouldEqual, exp)
+                }
+
+                f("https://chromium.googlesource.com/repo.git",
+                        "https://chromium.googlesource.com/a/repo")
+                f("https://chromium.googlesource.com/repo/",
+                        "https://chromium.googlesource.com/a/repo")
+                f("https://chromium.googlesource.com/a/repo",
+                        "https://chromium.googlesource.com/a/repo")
+                f("https://chromium.googlesource.com/parent/repo.git/",
+                        "https://chromium.googlesource.com/a/parent/repo")
+        })
+}
+
+func TestNew(t *testing.T) {
+        Convey("New with bad url", t, func() {
+                _, err := New(nil, "bad://repo.url")
+                So(err, ShouldNotBeNil)
+        })
+        Convey("New with good url", t, func() {
+                c, err := New(nil, "https://chromium.googlesource.com/repo.git")
+                So(err, ShouldBeNil)
+                So(c.RepoURL, ShouldEqual, "https://chromium.googlesource.com/a/repo")
+        })
+}
+
+func TestLog(t *testing.T) {
+        t.Parallel()
+        ctx := context.Background()
+
+        Convey("Log w/o pages", t, func() {
+                srv, c := newMockClient(func(w http.ResponseWriter, r *http.Request) {
+                        w.WriteHeader(200)
+                        w.Header().Set("Content-Type", "application/json")
+                        fmt.Fprintf(w, ")]}'\n{\"log\": [%s, %s]}\n", fake_commit1_str, fake_commit2_str)
+                })
+                defer srv.Close()
+
+                Convey("Return All", func() {
+                        commits, err := c.Log(ctx, "master..8de6836858c99e48f3c58164ab717bda728e95dd", 10)
+                        So(err, ShouldBeNil)
+                        So(len(commits), ShouldEqual, 2)
+                        So(commits[0].Author.Name, ShouldEqual, "Author 1")
+                        So(commits[1].Commit, ShouldEqual, "dc1dbf1aa56e4dd4cbfaab61c4d30a35adce5f40")
+                })
+
+                Convey("DO not exceed limit", func() {
+                        commits, err := c.Log(ctx, "master..8de6836858c99e48f3c58164ab717bda728e95dd", 1)
+                        So(err, ShouldBeNil)
+                        So(len(commits), ShouldEqual, 1)
+                        So(commits[0].Author.Name, ShouldEqual, "Author 1")
+                })
+        })
+
+        Convey("Log Paging", t, func() {
+                cursor_sent := ""
+                srv, c := newMockClient(func(w http.ResponseWriter, r *http.Request) {
+                        w.WriteHeader(200)
+                        w.Header().Set("Content-Type", "application/json")
+                        if next := r.URL.Query().Get("s"); next == "" {
+                                fmt.Fprintf(w, ")]}'\n{\"log\": [%s], \"next\": \"next_cursor_value\"}\n", fake_commit1_str)
+                        } else {
+                                cursor_sent = next
+                                fmt.Fprintf(w, ")]}'\n{\"log\": [%s]}\n", fake_commit2_str)
+                        }
+                })
+                defer srv.Close()
+
+                Convey("Page till no cursor", func() {
+                        commits, err := c.Log(ctx, "master..8de6836858c99e48f3c58164ab717bda728e95dd", 10)
+                        So(err, ShouldBeNil)
+                        So(cursor_sent, ShouldEqual, "next_cursor_value")
+                        So(len(commits), ShouldEqual, 2)
+                        So(commits[0].Author.Name, ShouldEqual, "Author 1")
+                        So(commits[1].Commit, ShouldEqual, "dc1dbf1aa56e4dd4cbfaab61c4d30a35adce5f40")
+                })
+
+                Convey("Page till limit", func() {
+                        commits, err := c.Log(ctx, "master", 1)
+                        So(err, ShouldBeNil)
+                        So(cursor_sent, ShouldEqual, "")
+                        So(len(commits), ShouldEqual, 1)
+                        So(commits[0].Author.Name, ShouldEqual, "Author 1")
+                })
+        })
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+var (
+        fake_commit1_str = `{
+                "commit": "0b2c5409e58a71c691b05454b55cc5580cc822d1",
+                "tree": "3c6f95bc757698cd6aca3c49f88f640fd145ea69",
+                "parents": [ "dc1dbf1aa56e4dd4cbfaab61c4d30a35adce5f40" ],
+                "author": {
+                        "name": "Author 1",
+                        "email": "author1@example.com",
+                        "time": "Mon Jul 17 15:02:43 2017"
+                },
+                "committer": {
+                        "name": "Commit Bot",
+                        "email": "commit-bot@chromium.org",
+                        "time": "Mon Jul 17 15:02:43 2017"
+                },
+                "message": "Import wpt@d96d68ed964f9bfc2bb248c2d2fab7a8870dc685\\n\\nCr-Commit-Position: refs/heads/master@{#487078}"
+        }`
+        fake_commit2_str = `{
+                "commit": "dc1dbf1aa56e4dd4cbfaab61c4d30a35adce5f40",
+                "tree": "1ba2335c07915c31597b97a8d824aecc85a996f6",
+                "parents": ["8de6836858c99e48f3c58164ab717bda728e95dd"],
+                "author": {
+                        "name": "Author 2",
+                        "email": "author-2@example.com",
+                        "time": "Mon Jul 17 15:01:13 2017"
+                },
+                "committer": {
+                        "name": "Commit Bot",
+                        "email": "commit-bot@chromium.org",
+                        "time": "Mon Jul 17 15:01:13 2017"
+                },
+                "message": "[Web Payments] User weak ptr in Payment Request\u0027s error callback\\n\\nBug: 742329\\nReviewed-on: https://chromium-review.googlesource.com/570982\\nCr-Commit-Position: refs/heads/master@{#487077}"
+  }`
+)
+
+////////////////////////////////////////////////////////////////////////////////
+
+func newMockClient(handler func(w http.ResponseWriter, r *http.Request)) (*httptest.Server, *Client) {
+        srv := httptest.NewServer(http.HandlerFunc(handler))
+        return srv, &Client{Client: http.DefaultClient, RepoURL: srv.URL}
+}