hugo/resources/page/page_matcher_test.go

// Copyright 2020 The Hugo Authors. 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 page

import (
	"path/filepath"
	"testing"

	"github.com/gohugoio/hugo/common/hmaps"
	"github.com/gohugoio/hugo/common/loggers"
	"github.com/gohugoio/hugo/hugolib/sitesmatrix"

	qt "github.com/frankban/quicktest"
)

func TestPageMatcher(t *testing.T) {
	c := qt.New(t)

	opts := HugoInfoOptions{
		Conf: testConfig{environment: "development"},
	}
	developmentTestSite := &testSite{h: NewHugoInfo(opts)}

	opts = HugoInfoOptions{
		Conf: testConfig{environment: "production"},
	}
	productionTestSite := &testSite{h: NewHugoInfo(opts)}

	dec := cascadeConfigDecoder{}

	p1, p2, p3 := &testPage{path: "/p1", kind: "section", lang: "en", site: developmentTestSite},
		&testPage{path: "p2", kind: "page", lang: "no", site: productionTestSite},
		&testPage{path: "p3", kind: "page", lang: "en", site: developmentTestSite}

	c.Run("Matches", func(c *qt.C) {
		matches := func(m PageMatcher, p Page) bool {
			c.Assert(m.compileGlobs(), qt.IsNil)
			return m.Matches(p)
		}

		c.Assert(matches(PageMatcher{Kind: "section"}, p1), qt.Equals, true)
		c.Assert(matches(PageMatcher{Kind: "section"}, p2), qt.Equals, false)

		c.Assert(matches(PageMatcher{Kind: "page"}, p1), qt.Equals, false)
		c.Assert(matches(PageMatcher{Kind: "page"}, p2), qt.Equals, true)
		c.Assert(matches(PageMatcher{Kind: "page"}, p3), qt.Equals, true)

		c.Assert(matches(PageMatcher{Kind: "page", Path: "/p2"}, p1), qt.Equals, false)
		c.Assert(matches(PageMatcher{Kind: "page", Path: "/p2"}, p2), qt.Equals, true)
		c.Assert(matches(PageMatcher{Kind: "page", Path: "/p2"}, p3), qt.Equals, false)

		c.Assert(matches(PageMatcher{Path: "/p*"}, p1), qt.Equals, true)
		c.Assert(matches(PageMatcher{Path: "/p*"}, p2), qt.Equals, true)
		c.Assert(matches(PageMatcher{Path: "/p*"}, p3), qt.Equals, true)

		c.Assert(matches(PageMatcher{Environment: "development"}, p1), qt.Equals, true)
		c.Assert(matches(PageMatcher{Environment: "development"}, p2), qt.Equals, false)
		c.Assert(matches(PageMatcher{Environment: "development"}, p3), qt.Equals, true)

		c.Assert(matches(PageMatcher{Environment: "production"}, p1), qt.Equals, false)
		c.Assert(matches(PageMatcher{Environment: "production"}, p2), qt.Equals, true)
		c.Assert(matches(PageMatcher{Environment: "production"}, p3), qt.Equals, false)
	})

	c.Run("Decode", func(c *qt.C) {
		var v PageMatcher
		c.Assert(dec.decodePageMatcher(map[string]any{"kind": "foo"}, &v), qt.Not(qt.IsNil))
		c.Assert(dec.decodePageMatcher(map[string]any{"kind": "{foo,bar}"}, &v), qt.Not(qt.IsNil))
		c.Assert(dec.decodePageMatcher(map[string]any{"kind": "taxonomy"}, &v), qt.IsNil)
		c.Assert(dec.decodePageMatcher(map[string]any{"kind": "{taxonomy,foo}"}, &v), qt.IsNil)
		c.Assert(dec.decodePageMatcher(map[string]any{"kind": "{taxonomy,term}"}, &v), qt.IsNil)
		c.Assert(dec.decodePageMatcher(map[string]any{"kind": "*"}, &v), qt.IsNil)
		c.Assert(dec.decodePageMatcher(map[string]any{"kind": "home", "path": filepath.FromSlash("/a/b/**")}, &v), qt.IsNil)
		c.Assert(v, qt.DeepEquals, PageMatcher{Kind: "home", Path: "/a/b/**"})
	})

	c.Run("mapToPageMatcherParamsConfig", func(c *qt.C) {
		fn := func(m map[string]any) PageMatcherParamsConfig {
			v, err := dec.mapToPageMatcherParamsConfig(m)
			c.Assert(err, qt.IsNil)
			return v
		}
		c.Assert(fn(map[string]any{"_target": map[string]any{"kind": "page"}, "foo": "bar"}), qt.DeepEquals, PageMatcherParamsConfig{
			Params: hmaps.Params{},
			Fields: hmaps.Params{
				"foo": "bar",
			},
			Target: PageMatcher{Path: "", Kind: "page", Lang: "", Environment: ""},
		})

		c.Assert(fn(map[string]any{"target": map[string]any{"kind": "page"}, "params": map[string]any{"foo": "bar"}}), qt.DeepEquals, PageMatcherParamsConfig{
			Params: hmaps.Params{
				"foo": "bar",
			},
			Fields: hmaps.Params{},
			Target: PageMatcher{Path: "", Kind: "page", Lang: "", Environment: ""},
		})
	})
}

func TestDecodeCascadeConfig(t *testing.T) {
	c := qt.New(t)

	in := []map[string]any{
		{
			"params": map[string]any{
				"a": "av",
			},
			"target": map[string]any{
				"kind":        "page",
				"Environment": "production",
			},
		},
		{
			"params": map[string]any{
				"b": "bv",
			},
			"target": map[string]any{
				"kind": "page",
			},
		},
	}

	got, err := DecodeCascadeConfig(in)
	c.Assert(err, qt.IsNil)
	c.Assert(got, qt.IsNotNil)
	c.Assert(got.InitConfig(loggers.NewDefault(), nil, nil), qt.IsNil)
	c.Assert(got.c[0].Config.Cascades, qt.HasLen, 2)
	first := got.c[0].Config.Cascades[0]
	c.Assert(first, qt.DeepEquals, PageMatcherParamsConfig{
		Params: hmaps.Params{
			"a": "av",
		},
		Fields: hmaps.Params{},
		Target: PageMatcher{
			Kind:        "page",
			Sites:       sitesmatrix.Sites{},
			Environment: "production",
		},
	})

	c.Assert(got.c[0].SourceStructure, qt.DeepEquals, []PageMatcherParamsConfig{
		{
			Params: hmaps.Params{"a": string("av")},
			Fields: hmaps.Params{},
			Target: PageMatcher{Kind: "page", Environment: "production"},
		},
		{Params: hmaps.Params{"b": string("bv")}, Fields: hmaps.Params{}, Target: PageMatcher{Kind: "page"}},
	})

	got, err = DecodeCascadeConfig(nil)
	c.Assert(err, qt.IsNil)
	c.Assert(got.InitConfig(loggers.NewDefault(), nil, nil), qt.IsNil)
	c.Assert(got.Len(), qt.Equals, 0)
}

func TestDecodeCascadeConfigWithSitesMatrix(t *testing.T) {
	c := qt.New(t)

	in := []map[string]any{
		{
			"params": map[string]any{
				"a": "av",
			},
			"sites": map[string]any{
				"matrix": map[string]any{
					"roles": "pro",
				},
			},
			"target": map[string]any{
				"kind":        "page",
				"Environment": "production",
				"sites": map[string]any{
					"matrix": map[string]any{
						"languages": []string{"en", "{no,sv}"},
						"versions":  "v1**",
					},
				},
			},
		},
	}

	dims := sitesmatrix.NewTestingDimensions([]string{"en", "no", "sv"}, []string{"v1", "v2"}, []string{"free", "pro"})

	got, err := DecodeCascadeConfig(in)
	c.Assert(err, qt.IsNil)
	c.Assert(got, qt.IsNotNil)
	c.Assert(got.InitConfig(loggers.NewDefault(), nil, dims), qt.IsNil)
	v := got.c[0].Config.Cascades[0]
	c.Assert(v.Target.Kind, qt.Equals, "page")
	c.Assert(v.Target.Environment, qt.Equals, "production")

	matrix := v.Target.SitesMatrixCompiled
	c.Assert(matrix.HasVector(sitesmatrix.Vector{0, 0, 0}), qt.IsTrue)  // en, v1, free
	c.Assert(matrix.HasVector(sitesmatrix.Vector{0, 1, 0}), qt.IsFalse) // en, v2, free
}

type testConfig struct {
	environment  string
	running      bool
	workingDir   string
	multihost    bool
	multilingual bool
}

func (c testConfig) Environment() string {
	return c.environment
}

func (c testConfig) Running() bool {
	return c.running
}

func (c testConfig) WorkingDir() string {
	return c.workingDir
}

func (c testConfig) IsMultihost() bool {
	return c.multihost
}

func (c testConfig) IsMultilingual() bool {
	return c.multilingual
}

func TestIsGlobWithExtension(t *testing.T) {
	c := qt.New(t)

	c.Assert(isGlobWithExtension("index.md"), qt.Equals, true)
	c.Assert(isGlobWithExtension("foo/index.html"), qt.Equals, true)
	c.Assert(isGlobWithExtension("posts/page"), qt.Equals, false)
	c.Assert(isGlobWithExtension("pa.th/foo"), qt.Equals, false)
	c.Assert(isGlobWithExtension(""), qt.Equals, false)
	c.Assert(isGlobWithExtension("*.md?"), qt.Equals, true)
	c.Assert(isGlobWithExtension("*.md*"), qt.Equals, true)
	c.Assert(isGlobWithExtension("posts/*"), qt.Equals, false)
	c.Assert(isGlobWithExtension("*.md"), qt.Equals, true)
}