// Copyright 2016 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 hugolib import ( "encoding/json" "fmt" "html/template" "net/url" "os" "path/filepath" "regexp" "strings" "testing" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/tpl" "github.com/spf13/viper" "github.com/stretchr/testify/require" ) const ( baseURL = "http://foo/bar" ) func TestShortcodeCrossrefs(t *testing.T) { for _, relative := range []bool{true, false} { doTestShortcodeCrossrefs(t, relative) } } func doTestShortcodeCrossrefs(t *testing.T, relative bool) { testCommonResetState() viper.Set("baseURL", baseURL) var refShortcode string var expectedBase string if relative { refShortcode = "relref" expectedBase = "/bar" } else { refShortcode = "ref" expectedBase = baseURL } path := filepath.FromSlash("blog/post.md") in := fmt.Sprintf(`{{< %s "%s" >}}`, refShortcode, path) writeSource(t, "content/"+path, simplePageWithURL+": "+in) expected := fmt.Sprintf(`%s/simple/url/`, expectedBase) sites, err := newHugoSitesDefaultLanguage() require.NoError(t, err) require.NoError(t, sites.Build(BuildCfg{})) require.Len(t, sites.Sites[0].Pages, 1) output := string(sites.Sites[0].Pages[0].Content) if !strings.Contains(output, expected) { t.Errorf("Got\n%q\nExpected\n%q", output, expected) } } func TestShortcodeHighlight(t *testing.T) { testCommonResetState() if !helpers.HasPygments() { t.Skip("Skip test as Pygments is not installed") } viper.Set("PygmentsStyle", "bw") viper.Set("PygmentsUseClasses", false) for i, this := range []struct { in, expected string }{ {` {{< highlight java >}} void do(); {{< /highlight >}}`, "(?s)^\n
.*?void do().*?
\n$", }, {` {{< highlight java "style=friendly" >}} void do(); {{< /highlight >}}`, "(?s)^\n
.*?void.*?do.*?().*?
\n$", }, } { templ := tpl.New() p, _ := pageFromString(simplePage, "simple.md") output, err := HandleShortcodes(this.in, p, templ) if err != nil { t.Fatalf("[%d] Handle shortcode error", i) } matched, err := regexp.MatchString(this.expected, output) if err != nil { t.Fatalf("[%d] Regexp error", i) } if !matched { t.Errorf("[%d] unexpected rendering, got %s\n", i, output) } } } func TestShortcodeFigure(t *testing.T) { for i, this := range []struct { in, expected string }{ { `{{< figure src="/img/hugo-logo.png" >}}`, "(?s)^\n
.*?.*?
\n$", }, { // set alt `{{< figure src="/img/hugo-logo.png" alt="Hugo logo" >}}`, "(?s)^\n
.*?\"Hugo.*?
\n$", }, // set title { `{{< figure src="/img/hugo-logo.png" title="Hugo logo" >}}`, "(?s)^\n
.*?.*?
.*?

Hugo logo

.*?
.*?
\n$", }, // set attr and attrlink { `{{< figure src="/img/hugo-logo.png" attr="Hugo logo" attrlink="/img/hugo-logo.png" >}}`, "(?s)^\n
.*?.*?
.*?

.*?.*?Hugo logo.*?.*?

.*?
.*?
\n$", }, } { templ := tpl.New() p, _ := pageFromString(simplePage, "simple.md") output, err := HandleShortcodes(this.in, p, templ) matched, err := regexp.MatchString(this.expected, output) if err != nil { t.Fatalf("[%d] Regexp error", i) } if !matched { t.Errorf("[%d] unexpected rendering, got %s\n", i, output) } } } func TestShortcodeSpeakerdeck(t *testing.T) { for i, this := range []struct { in, expected string }{ { `{{< speakerdeck 4e8126e72d853c0060001f97 >}}`, "(?s)^$", }, } { templ := tpl.New() p, _ := pageFromString(simplePage, "simple.md") output, err := HandleShortcodes(this.in, p, templ) matched, err := regexp.MatchString(this.expected, output) if err != nil { t.Fatalf("[%d] Regexp error", i) } if !matched { t.Errorf("[%d] unexpected rendering, got %s\n", i, output) } } } func TestShortcodeYoutube(t *testing.T) { for i, this := range []struct { in, expected string }{ { `{{< youtube w7Ft2ymGmfc >}}`, "(?s)^\n
.*?.*?
\n$", }, // set class { `{{< youtube w7Ft2ymGmfc video>}}`, "(?s)^\n
.*?.*?
\n$", }, // set class and autoplay (using named params) { `{{< youtube id="w7Ft2ymGmfc" class="video" autoplay="true" >}}`, "(?s)^\n
.*?.*?
$", }, } { templ := tpl.New() p, _ := pageFromString(simplePage, "simple.md") output, err := HandleShortcodes(this.in, p, templ) matched, err := regexp.MatchString(this.expected, output) if err != nil { t.Fatalf("[%d] Regexp error", i) } if !matched { t.Errorf("[%d] unexpected rendering, got %s\n", i, output) } } } func TestShortcodeVimeo(t *testing.T) { for i, this := range []struct { in, expected string }{ { `{{< vimeo 146022717 >}}`, "(?s)^\n
.*?.*?
\n$", }, // set class { `{{< vimeo 146022717 video >}}`, "(?s)^\n
.*?.*?
\n$", }, // set class (using named params) { `{{< vimeo id="146022717" class="video" >}}`, "(?s)^
.*?.*?
$", }, } { templ := tpl.New() p, _ := pageFromString(simplePage, "simple.md") output, err := HandleShortcodes(this.in, p, templ) matched, err := regexp.MatchString(this.expected, output) if err != nil { t.Fatalf("[%d] Regexp error", i) } if !matched { t.Errorf("[%d] unexpected rendering, got %s\n", i, output) } } } func TestShortcodeGist(t *testing.T) { for i, this := range []struct { in, expected string }{ { `{{< gist spf13 7896402 >}}`, "(?s)^$", }, { `{{< gist spf13 7896402 "img.html" >}}`, "(?s)^$", }, } { templ := tpl.New() p, _ := pageFromString(simplePage, "simple.md") output, err := HandleShortcodes(this.in, p, templ) matched, err := regexp.MatchString(this.expected, output) if err != nil { t.Fatalf("[%d] Regexp error", i) } if !matched { t.Errorf("[%d] unexpected rendering, got %s\n", i, output) } } } func TestShortcodeTweet(t *testing.T) { for i, this := range []struct { in, resp, expected string }{ { `{{< tweet 666616452582129664 >}}`, `{"url":"https:\/\/twitter.com\/spf13\/status\/666616452582129664","author_name":"Steve Francia","author_url":"https:\/\/twitter.com\/spf13","html":"\u003Cblockquote class=\"twitter-tweet\"\u003E\u003Cp lang=\"en\" dir=\"ltr\"\u003EHugo 0.15 will have 30%+ faster render times thanks to this commit \u003Ca href=\"https:\/\/t.co\/FfzhM8bNhT\"\u003Ehttps:\/\/t.co\/FfzhM8bNhT\u003C\/a\u003E \u003Ca href=\"https:\/\/twitter.com\/hashtag\/gohugo?src=hash\"\u003E#gohugo\u003C\/a\u003E \u003Ca href=\"https:\/\/twitter.com\/hashtag\/golang?src=hash\"\u003E#golang\u003C\/a\u003E \u003Ca href=\"https:\/\/t.co\/ITbMNU2BUf\"\u003Ehttps:\/\/t.co\/ITbMNU2BUf\u003C\/a\u003E\u003C\/p\u003E— Steve Francia (@spf13) \u003Ca href=\"https:\/\/twitter.com\/spf13\/status\/666616452582129664\"\u003ENovember 17, 2015\u003C\/a\u003E\u003C\/blockquote\u003E\n\u003Cscript async src=\"\/\/platform.twitter.com\/widgets.js\" charset=\"utf-8\"\u003E\u003C\/script\u003E","width":550,"height":null,"type":"rich","cache_age":"3153600000","provider_name":"Twitter","provider_url":"https:\/\/twitter.com","version":"1.0"}`, `(?s)^

Hugo 0.15 will have 30%. faster render times thanks to this commit https://t.co/FfzhM8bNhT #gohugo #golang https://t.co/ITbMNU2BUf

— Steve Francia .@spf13. November 17, 2015
.*?$`, }, } { // overload getJSON to return mock API response from Twitter tweetFuncMap := template.FuncMap{ "getJSON": func(urlParts ...string) interface{} { var v interface{} err := json.Unmarshal([]byte(this.resp), &v) if err != nil { t.Fatalf("[%d] unexpected error in json.Unmarshal: %s", i, err) return err } return v }, } templ := tpl.New() templ.Lookup("").Funcs(tweetFuncMap) p, _ := pageFromString(simplePage, "simple.md") cacheFileID := viper.GetString("CacheDir") + url.QueryEscape("https://api.twitter.com/1/statuses/oembed.json?id=666616452582129664") defer os.Remove(cacheFileID) output, err := HandleShortcodes(this.in, p, templ) matched, err := regexp.MatchString(this.expected, output) if err != nil { t.Fatalf("[%d] Regexp error", i) } if !matched { t.Errorf("[%d] unexpected rendering, got %s\n", i, output) } } }