blob: 89857f507f273ce835f23f8933db064f2d0ac808 [file] [log] [blame]
// Copyright 2019 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package frontend
import (
"context"
"html/template"
"testing"
"github.com/google/go-cmp/cmp"
"golang.org/x/pkgsite/internal"
"golang.org/x/pkgsite/internal/postgres"
"golang.org/x/pkgsite/internal/source"
"golang.org/x/pkgsite/internal/stdlib"
"golang.org/x/pkgsite/internal/testing/sample"
"golang.org/x/pkgsite/internal/version"
)
func TestFetchOverviewDetails(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testTimeout)
defer cancel()
tc := struct {
name string
module *internal.Module
wantDetails *OverviewDetails
}{
name: "want expected overview details",
module: sample.DefaultModule(),
wantDetails: &OverviewDetails{
ModulePath: sample.ModulePath,
RepositoryURL: sample.RepositoryURL,
ReadMe: template.HTML("<p>readme</p>\n"),
ReadMeSource: "github.com/valid_module_name@v1.0.0/README.md",
ModuleURL: "/mod/github.com/valid_module_name@v1.0.0",
Redistributable: true,
},
}
defer postgres.ResetTestDB(testDB, t)
if err := testDB.InsertModule(ctx, tc.module); err != nil {
t.Fatal(err)
}
readme := &internal.Readme{Filepath: tc.module.LegacyReadmeFilePath, Contents: tc.module.LegacyReadmeContents}
got := constructOverviewDetails(ctx, &tc.module.ModuleInfo, readme, true, true)
if diff := cmp.Diff(tc.wantDetails, got); diff != "" {
t.Errorf("constructOverviewDetails(%q, %q) mismatch (-want +got):\n%s", tc.module.LegacyPackages[0].Path, tc.module.Version, diff)
}
}
func TestConstructPackageOverviewDetailsNew(t *testing.T) {
for _, test := range []struct {
name string
vdir *internal.VersionedDirectory
versionedLinks bool
want *OverviewDetails
}{
{
name: "redistributable",
vdir: &internal.VersionedDirectory{
DirectoryNew: internal.DirectoryNew{
Path: "github.com/u/m/p",
IsRedistributable: true,
Readme: &internal.Readme{
Filepath: "README.md",
Contents: "readme",
},
},
ModuleInfo: *sample.ModuleInfo("github.com/u/m", "v1.2.3"),
},
versionedLinks: true,
want: &OverviewDetails{
ModulePath: "github.com/u/m",
ModuleURL: "/mod/github.com/u/m@v1.2.3",
RepositoryURL: "https://github.com/u/m",
PackageSourceURL: "https://github.com/u/m/tree/v1.2.3/p",
ReadMe: template.HTML("<p>readme</p>\n"),
ReadMeSource: "github.com/u/m@v1.2.3/README.md",
Redistributable: true,
},
},
{
name: "unversioned",
vdir: &internal.VersionedDirectory{
DirectoryNew: internal.DirectoryNew{
Path: "github.com/u/m/p",
IsRedistributable: true,
Readme: &internal.Readme{
Filepath: "README.md",
Contents: "readme",
},
},
ModuleInfo: *sample.ModuleInfo("github.com/u/m", "v1.2.3"),
},
versionedLinks: false,
want: &OverviewDetails{
ModulePath: "github.com/u/m",
ModuleURL: "/mod/github.com/u/m",
RepositoryURL: "https://github.com/u/m",
PackageSourceURL: "https://github.com/u/m/tree/v1.2.3/p",
ReadMe: template.HTML("<p>readme</p>\n"),
ReadMeSource: "github.com/u/m@v1.2.3/README.md",
Redistributable: true,
},
},
{
name: "non-redistributable",
vdir: &internal.VersionedDirectory{
DirectoryNew: internal.DirectoryNew{
Path: "github.com/u/m/p",
IsRedistributable: false,
},
ModuleInfo: *sample.ModuleInfo("github.com/u/m", "v1.2.3"),
},
versionedLinks: true,
want: &OverviewDetails{
ModulePath: "github.com/u/m",
ModuleURL: "/mod/github.com/u/m@v1.2.3",
RepositoryURL: "https://github.com/u/m",
PackageSourceURL: "https://github.com/u/m/tree/v1.2.3/p",
ReadMe: "",
ReadMeSource: "",
Redistributable: false,
},
},
} {
t.Run(test.name, func(t *testing.T) {
got := fetchPackageOverviewDetailsNew(context.Background(), test.vdir, test.versionedLinks)
if diff := cmp.Diff(test.want, got); diff != "" {
t.Errorf("mismatch (-want +got):\n%s", diff)
}
})
}
}
func TestReadmeHTML(t *testing.T) {
ctx := experimentContext(context.Background(), internal.ExperimentTranslateHTML)
for _, tc := range []struct {
name string
mi *internal.ModuleInfo
readme *internal.Readme
want template.HTML
}{
{
name: "valid markdown readme",
readme: &internal.Readme{
Filepath: "README.md",
Contents: "This package collects pithy sayings.\n\n" +
"It's part of a demonstration of\n" +
"[package versioning in Go](https://research.swtch.com/vgo1).",
},
want: template.HTML("<p>This package collects pithy sayings.</p>\n\n" +
"<p>It’s part of a demonstration of\n" +
`<a href="https://research.swtch.com/vgo1" rel="nofollow">package versioning in Go</a>.</p>` + "\n"),
},
{
name: "valid markdown readme with alternative case and extension",
readme: &internal.Readme{
Filepath: "README.MARKDOWN",
Contents: "This package collects pithy sayings.\n\n" +
"It's part of a demonstration of\n" +
"[package versioning in Go](https://research.swtch.com/vgo1).",
},
want: template.HTML("<p>This package collects pithy sayings.</p>\n\n" +
"<p>It’s part of a demonstration of\n" +
`<a href="https://research.swtch.com/vgo1" rel="nofollow">package versioning in Go</a>.</p>` + "\n"),
},
{
name: "not markdown readme",
readme: &internal.Readme{
Filepath: "README.rst",
Contents: "This package collects pithy sayings.\n\n" +
"It's part of a demonstration of\n" +
"[package versioning in Go](https://research.swtch.com/vgo1).",
},
want: template.HTML("<pre class=\"readme\">This package collects pithy sayings.\n\nIt&#39;s part of a demonstration of\n[package versioning in Go](https://research.swtch.com/vgo1).</pre>"),
},
{
name: "empty readme",
mi: &internal.ModuleInfo{},
want: "",
},
{
name: "sanitized readme",
readme: &internal.Readme{
Filepath: "README",
Contents: `<a onblur="alert(secret)" href="http://www.google.com">Google</a>`,
},
want: template.HTML(`<pre class="readme">&lt;a onblur=&#34;alert(secret)&#34; href=&#34;http://www.google.com&#34;&gt;Google&lt;/a&gt;</pre>`),
},
{
name: "relative image markdown is made absolute for GitHub",
mi: &internal.ModuleInfo{
SourceInfo: source.NewGitHubInfo("http://github.com/golang/go", "", "master"),
},
readme: &internal.Readme{
Filepath: "README.md",
Contents: "![Go logo](doc/logo.png)",
},
want: template.HTML("<p><img src=\"https://raw.githubusercontent.com/golang/go/master/doc/logo.png\" alt=\"Go logo\"/></p>\n"),
},
{
name: "relative image markdown is made absolute for GitLab",
mi: &internal.ModuleInfo{
SourceInfo: source.NewGitLabInfo("http://gitlab.com/gitlab-org/gitaly", "", "v1.0.0"),
},
readme: &internal.Readme{
Filepath: "README.md",
Contents: "![Gitaly benchmark timings.](doc/img/rugged-new-timings.png)",
},
want: template.HTML("<p><img src=\"http://gitlab.com/gitlab-org/gitaly/raw/v1.0.0/doc/img/rugged-new-timings.png\" alt=\"Gitaly benchmark timings.\"/></p>\n"),
},
{
name: "relative image markdown is left alone for unknown origins",
mi: &internal.ModuleInfo{},
readme: &internal.Readme{
Filepath: "README.md",
Contents: "![Go logo](doc/logo.png)",
},
want: template.HTML("<p><img src=\"doc/logo.png\" alt=\"Go logo\"/></p>\n"),
},
{
name: "module versions are referenced in relative images",
mi: &internal.ModuleInfo{
Version: "v0.56.3",
VersionType: version.TypeRelease,
SourceInfo: source.NewGitHubInfo("http://github.com/gohugoio/hugo", "", "v0.56.3"),
},
readme: &internal.Readme{
Filepath: "README.md",
Contents: "![Hugo logo](doc/logo.png)",
},
want: template.HTML("<p><img src=\"https://raw.githubusercontent.com/gohugoio/hugo/v0.56.3/doc/logo.png\" alt=\"Hugo logo\"/></p>\n"),
},
{
name: "image URLs relative to README directory",
mi: &internal.ModuleInfo{
Version: "v1.2.3",
VersionType: version.TypeRelease,
SourceInfo: source.NewGitHubInfo("https://github.com/some/repo", "", "v1.2.3"),
},
readme: &internal.Readme{
Filepath: "dir/sub/README.md",
Contents: "![alt](img/thing.png)",
},
want: template.HTML(`<p><img src="https://raw.githubusercontent.com/some/repo/v1.2.3/dir/sub/img/thing.png" alt="alt"/></p>` + "\n"),
},
{
name: "non-image links relative to README directory",
mi: &internal.ModuleInfo{
Version: "v1.2.3",
VersionType: version.TypeRelease,
SourceInfo: source.NewGitHubInfo("https://github.com/some/repo", "", "v1.2.3"),
},
readme: &internal.Readme{
Filepath: "dir/sub/README.md",
Contents: "[something](doc/thing.md)",
},
want: template.HTML(`<p><a href="https://github.com/some/repo/blob/v1.2.3/dir/sub/doc/thing.md" rel="nofollow">something</a></p>` + "\n"),
},
{
name: "image link in embedded HTML",
mi: &internal.ModuleInfo{
Version: "v0.3.3",
VersionType: version.TypeRelease,
SourceInfo: source.NewGitHubInfo("https://github.com/pdfcpu/pdfcpu", "", "v0.3.3"),
},
readme: &internal.Readme{
Filepath: "README.md",
Contents: "<img src=\"resources/logoSmall.png\" />\n\n# Heading\n",
},
want: template.HTML("<p><img src=\"https://raw.githubusercontent.com/pdfcpu/pdfcpu/v0.3.3/resources/logoSmall.png\"/></p>\n\n<h1 id=\"heading\">Heading</h1>\n"),
},
{
name: "image link in embedded HTML with surrounding p tag",
mi: &internal.ModuleInfo{
Version: "v1.2.3",
VersionType: version.TypeRelease,
SourceInfo: source.NewGitHubInfo("https://github.com/some/repo", "", "v1.2.3"),
},
readme: &internal.Readme{
Filepath: "README.md",
Contents: "<p align=\"center\"><img src=\"foo.png\" /></p>\n\n# Heading",
},
want: template.HTML("<p align=\"center\"><img src=\"https://raw.githubusercontent.com/some/repo/v1.2.3/foo.png\"/></p>\n\n<h1 id=\"heading\">Heading</h1>\n"),
},
{
name: "image link in embedded HTML with surrounding div",
mi: &internal.ModuleInfo{
Version: "v1.2.3",
VersionType: version.TypeRelease,
SourceInfo: source.NewGitHubInfo("https://github.com/some/repo", "", "v1.2.3"),
},
readme: &internal.Readme{
Filepath: "README.md",
Contents: "<div align=\"center\"><img src=\"foo.png\" /></div>\n\n# Heading",
},
want: template.HTML("<div align=\"center\"><img src=\"https://raw.githubusercontent.com/some/repo/v1.2.3/foo.png\"/></div>\n\n<h1 id=\"heading\">Heading</h1>\n"),
},
} {
t.Run(tc.name, func(t *testing.T) {
got := readmeHTML(ctx, tc.mi, tc.readme)
if diff := cmp.Diff(tc.want, got); diff != "" {
t.Errorf("readmeHTML(%v) mismatch (-want +got):\n%s", tc.mi, diff)
}
})
}
}
func TestPackageSubdir(t *testing.T) {
for _, test := range []struct {
pkgPath, modulePath string
want string
}{
// package at module root
{"github.com/pkg/errors", "github.com/pkg/errors", ""},
// package inside module
{"github.com/google/go-cmp/cmp", "github.com/google/go-cmp", "cmp"},
// stdlib package
{"context", stdlib.ModulePath, "context"},
} {
got := packageSubdir(test.pkgPath, test.modulePath)
if got != test.want {
t.Errorf("packageSubdir(%q, %q) = %q, want %q", test.pkgPath, test.modulePath, got, test.want)
}
}
}