aboutsummaryrefslogtreecommitdiff
path: root/internal/api/api_test.go
diff options
context:
space:
mode:
authorJonathan Amsterdam <jba@google.com>2026-03-20 10:21:23 -0400
committerJonathan Amsterdam <jba@google.com>2026-03-24 09:32:17 -0700
commitf2497254fdac6fde9ff38a604f6891753b583a20 (patch)
tree3522fb17432e82bb336e83e643713e2955e637f2 /internal/api/api_test.go
parent1b091e590bab0f0e98b815d7dd42b1e29041b473 (diff)
downloadgo-x-pkgsite-f2497254fdac6fde9ff38a604f6891753b583a20.tar.xz
internal/api: initial logic for doc
Obtain the go/doc.Package from the retrieved unit and validate the doc query param. Rendering is more complicated; it is deferred to another CL. Change-Id: I1d16fe98dbf06457182f5925ce0986448882d40e Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/757360 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> kokoro-CI: kokoro <noreply+kokoro@google.com> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Ethan Lee <ethanalee@google.com>
Diffstat (limited to 'internal/api/api_test.go')
-rw-r--r--internal/api/api_test.go25
1 files changed, 18 insertions, 7 deletions
diff --git a/internal/api/api_test.go b/internal/api/api_test.go
index 9112c576..87d6b8d0 100644
--- a/internal/api/api_test.go
+++ b/internal/api/api_test.go
@@ -14,6 +14,7 @@ import (
"github.com/google/go-cmp/cmp"
"golang.org/x/pkgsite/internal"
"golang.org/x/pkgsite/internal/testing/fakedatasource"
+ "golang.org/x/pkgsite/internal/testing/sample"
)
func TestServePackage(t *testing.T) {
@@ -35,11 +36,7 @@ func TestServePackage(t *testing.T) {
ModuleInfo: internal.ModuleInfo{ModulePath: "example.com", Version: version},
Name: "pkg",
},
- Documentation: []*internal.Documentation{{
- GOOS: "linux",
- GOARCH: "amd64",
- Synopsis: "Basic synopsis",
- }},
+ Documentation: []*internal.Documentation{sample.Documentation("linux", "amd64", sample.DocContents)},
}},
})
@@ -84,7 +81,7 @@ func TestServePackage(t *testing.T) {
Path: "example.com/pkg",
ModulePath: "example.com",
ModuleVersion: version,
- Synopsis: "Basic synopsis",
+ Synopsis: "This is a package synopsis for GOOS=linux, GOARCH=amd64",
GOOS: "linux",
GOARCH: "amd64",
},
@@ -123,11 +120,25 @@ func TestServePackage(t *testing.T) {
Path: "example.com/pkg",
ModulePath: "example.com",
ModuleVersion: version,
- Synopsis: "Basic synopsis",
+ Synopsis: "This is a package synopsis for GOOS=linux, GOARCH=amd64",
GOOS: "linux",
GOARCH: "amd64",
},
},
+ {
+ name: "doc",
+ url: "/v1/package/example.com/pkg?version=v1.2.3&doc=text",
+ wantStatus: http.StatusOK,
+ want: &Package{
+ Path: "example.com/pkg",
+ ModulePath: "example.com",
+ ModuleVersion: version,
+ Synopsis: "This is a package synopsis for GOOS=linux, GOARCH=amd64",
+ GOOS: "linux",
+ GOARCH: "amd64",
+ Docs: "TODO\n",
+ },
+ },
} {
t.Run(test.name, func(t *testing.T) {
r := httptest.NewRequest("GET", test.url, nil)