Cutlery/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-10-31 10:37:24 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1682 from tw4452852/markdown

Browse Source 
markdown: reload template on each request and fix fake tests
This commit is contained in:
Matt Holt 2017-06-27 23:02:59 -06:00 committed by GitHub
commit 3bc925400b
13 changed files with 212 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
caddyhttp/markdown/markdown.go
View File

@ -53,6 +53,9 @@ type Config struct {
// Template(s) to render with // Template(s) to render with
Template *template.Template Template *template.Template
// a pair of template's name and its underlying file path
TemplateFiles map[string]string
} }
// ServeHTTP implements the http.Handler interface. // ServeHTTP implements the http.Handler interface.

182
caddyhttp/markdown/markdown_test.go
View File

@ -1,17 +1,15 @@
package markdown package markdown
import ( import (
"bufio"
"io/ioutil" "io/ioutil"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
"os" "os"
"path/filepath" "path/filepath"
"strings"
"testing" "testing"
"text/template" "text/template"
"time"
"github.com/mholt/caddy"
"github.com/mholt/caddy/caddyhttp/httpserver" "github.com/mholt/caddy/caddyhttp/httpserver"
"github.com/russross/blackfriday" "github.com/russross/blackfriday"
) )
@ -79,19 +77,26 @@ func TestMarkdown(t *testing.T) {
}), }),
} }
req, err := http.NewRequest("GET", "/blog/test.md", nil) get := func(url string) string {
if err != nil { req, err := http.NewRequest("GET", url, nil)
t.Fatalf("Could not create HTTP request: %v", err) if err != nil {
t.Fatalf("Could not create HTTP request: %v", err)
return ""
}
rec := httptest.NewRecorder()
code, err := md.ServeHTTP(rec, req)
if err != nil {
t.Fatal(err)
return ""
}
if code != http.StatusOK {
t.Fatalf("Wrong status, expected: %d and got %d", http.StatusOK, code)
return ""
}
return rec.Body.String()
} }
rec := httptest.NewRecorder() respBody := get("/blog/test.md")
md.ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("Wrong status, expected: %d and got %d", http.StatusOK, rec.Code)
}
respBody := rec.Body.String()
expectedBody := `<!DOCTYPE html> expectedBody := `<!DOCTYPE html>
<html> <html>
<head> <head>
@ -99,7 +104,6 @@ func TestMarkdown(t *testing.T) {
</head> </head>
<body> <body>
<h1>Header for: Markdown test 1</h1> <h1>Header for: Markdown test 1</h1>
Welcome to A Caddy website! Welcome to A Caddy website!
<h2>Welcome on the blog</h2> <h2>Welcome on the blog</h2>
@ -113,46 +117,22 @@ Welcome to A Caddy website!
</body> </body>
</html> </html>
` `
if !equalStrings(respBody, expectedBody) { respBody = get("/docflags/test.md")
t.Fatalf("Expected body: %v got: %v", expectedBody, respBody)
}
req, err = http.NewRequest("GET", "/docflags/test.md", nil)
if err != nil {
t.Fatalf("Could not create HTTP request: %v", err)
}
rec = httptest.NewRecorder()
md.ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("Wrong status, expected: %d and got %d", http.StatusOK, rec.Code)
}
respBody = rec.Body.String()
expectedBody = `Doc.var_string hello expectedBody = `Doc.var_string hello
Doc.var_bool <no value> Doc.var_bool true
DocFlags.var_string <no value> `
DocFlags.var_bool true`
if !equalStrings(respBody, expectedBody) { if respBody != expectedBody {
t.Fatalf("Expected body: %v got: %v", expectedBody, respBody) t.Fatalf("Expected body:\n%q\ngot:\n%q", expectedBody, respBody)
} }
req, err = http.NewRequest("GET", "/log/test.md", nil) respBody = get("/log/test.md")
if err != nil {
t.Fatalf("Could not create HTTP request: %v", err)
}
rec = httptest.NewRecorder()
md.ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("Wrong status, expected: %d and got %d", http.StatusOK, rec.Code)
}
respBody = rec.Body.String()
expectedBody = `<!DOCTYPE html> expectedBody = `<!DOCTYPE html>
<html> <html>
<head> <head>
<title>Markdown test 2</title> <title>Markdown test 2</title>
<meta charset="utf-8"> <meta charset="utf-8">
<link rel="stylesheet" href="/resources/css/log.css"> <link rel="stylesheet" href="/resources/css/log.css">
<link rel="stylesheet" href="/resources/css/default.css"> <link rel="stylesheet" href="/resources/css/default.css">
<script src="/resources/js/log.js"></script> <script src="/resources/js/log.js"></script>
@ -171,26 +151,11 @@ DocFlags.var_bool true`
</body> </body>
</html>` </html>`
if !equalStrings(respBody, expectedBody) { if respBody != expectedBody {
t.Fatalf("Expected body: %v got: %v", expectedBody, respBody) t.Fatalf("Expected body:\n%q\ngot:\n%q", expectedBody, respBody)
} }
req, err = http.NewRequest("GET", "/og/first.md", nil) respBody = get("/og/first.md")
if err != nil {
t.Fatalf("Could not create HTTP request: %v", err)
}
rec = httptest.NewRecorder()
currenttime := time.Now().Local().Add(-time.Second)
_ = os.Chtimes("testdata/og/first.md", currenttime, currenttime)
currenttime = time.Now().Local()
_ = os.Chtimes("testdata/og_static/og/first.md/index.html", currenttime, currenttime)
time.Sleep(time.Millisecond * 200)
md.ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("Wrong status, expected: %d and got %d", http.StatusOK, rec.Code)
}
respBody = rec.Body.String()
expectedBody = `<!DOCTYPE html> expectedBody = `<!DOCTYPE html>
<html> <html>
<head> <head>
@ -198,32 +163,18 @@ DocFlags.var_bool true`
</head> </head>
<body> <body>
<h1>Header for: first_post</h1> <h1>Header for: first_post</h1>
Welcome to title! Welcome to title!
<h1>Test h1</h1> <h1>Test h1</h1>
</body> </body>
</html>` </html>
`
if !equalStrings(respBody, expectedBody) { if respBody != expectedBody {
t.Fatalf("Expected body: %v got: %v", expectedBody, respBody) t.Fatalf("Expected body:\n%q\ngot:\n%q", expectedBody, respBody)
} }
} }
func equalStrings(s1, s2 string) bool {
s1 = strings.TrimSpace(s1)
s2 = strings.TrimSpace(s2)
in := bufio.NewScanner(strings.NewReader(s1))
for in.Scan() {
txt := strings.TrimSpace(in.Text())
if !strings.HasPrefix(strings.TrimSpace(s2), txt) {
return false
}
s2 = strings.Replace(s2, txt, "", 1)
}
return true
}
func setDefaultTemplate(filename string) *template.Template { func setDefaultTemplate(filename string) *template.Template {
buf, err := ioutil.ReadFile(filename) buf, err := ioutil.ReadFile(filename)
if err != nil { if err != nil {
@ -232,3 +183,70 @@ func setDefaultTemplate(filename string) *template.Template {
return template.Must(GetDefaultTemplate().Parse(string(buf))) return template.Must(GetDefaultTemplate().Parse(string(buf)))
} }
func TestTemplateReload(t *testing.T) {
const (
templateFile = "testdata/test.html"
targetFile = "testdata/hello.md"
)
c := caddy.NewTestController("http", `markdown {
template `+templateFile+`
}`)
err := ioutil.WriteFile(templateFile, []byte("hello {{.Doc.body}}"), 0644)
if err != nil {
t.Fatal(err)
}
err = ioutil.WriteFile(targetFile, []byte("caddy"), 0644)
if err != nil {
t.Fatal(err)
}
defer func() {
os.Remove(templateFile)
os.Remove(targetFile)
}()
config, err := markdownParse(c)
if err != nil {
t.Fatal(err)
}
md := Markdown{
Root: "./testdata",
FileSys: http.Dir("./testdata"),
Configs: config,
Next: httpserver.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
t.Fatalf("Next shouldn't be called")
return 0, nil
}),
}
req := httptest.NewRequest("GET", "/hello.md", nil)
get := func() string {
rec := httptest.NewRecorder()
code, err := md.ServeHTTP(rec, req)
if err != nil {
t.Fatal(err)
return ""
}
if code != http.StatusOK {
t.Fatalf("Wrong status, expected: %d and got %d", http.StatusOK, code)
return ""
}
return rec.Body.String()
}
if expect, got := "hello <p>caddy</p>\n", get(); expect != got {
t.Fatalf("Expected body:\n%q\nbut got:\n%q", expect, got)
}
// update template
err = ioutil.WriteFile(templateFile, []byte("hi {{.Doc.body}}"), 0644)
if err != nil {
t.Fatal(err)
}
if expect, got := "hi <p>caddy</p>\n", get(); expect != got {
t.Fatalf("Expected body:\n%q\nbut got:\n%q", expect, got)
}
}

31
caddyhttp/markdown/setup.go
View File

@ -44,10 +44,11 @@ func markdownParse(c *caddy.Controller) ([]*Config, error) {
for c.Next() { for c.Next() {
md := &Config{ md := &Config{
Renderer: blackfriday.HtmlRenderer(0, "", ""), Renderer: blackfriday.HtmlRenderer(0, "", ""),
Extensions: make(map[string]struct{}), Extensions: make(map[string]struct{}),
Template: GetDefaultTemplate(), Template: GetDefaultTemplate(),
IndexFiles: []string{}, IndexFiles: []string{},
TemplateFiles: make(map[string]string),
} }
// Get the path scope // Get the path scope
@ -115,28 +116,42 @@ func loadParams(c *caddy.Controller, mdc *Config) error {
fpath := filepath.ToSlash(filepath.Clean(cfg.Root + string(filepath.Separator) + tArgs[0])) fpath := filepath.ToSlash(filepath.Clean(cfg.Root + string(filepath.Separator) + tArgs[0]))
if err := SetTemplate(mdc.Template, "", fpath); err != nil { if err := SetTemplate(mdc.Template, "", fpath); err != nil {
c.Errf("default template parse error: %v", err) return c.Errf("default template parse error: %v", err)
} }
mdc.TemplateFiles[""] = fpath
return nil return nil
case 2: case 2:
fpath := filepath.ToSlash(filepath.Clean(cfg.Root + string(filepath.Separator) + tArgs[1])) fpath := filepath.ToSlash(filepath.Clean(cfg.Root + string(filepath.Separator) + tArgs[1]))
if err := SetTemplate(mdc.Template, tArgs[0], fpath); err != nil { if err := SetTemplate(mdc.Template, tArgs[0], fpath); err != nil {
c.Errf("template parse error: %v", err) return c.Errf("template parse error: %v", err)
} }
mdc.TemplateFiles[tArgs[0]] = fpath
return nil return nil
} }
case "templatedir": case "templatedir":
if !c.NextArg() { if !c.NextArg() {
return c.ArgErr() return c.ArgErr()
} }
_, err := mdc.Template.ParseGlob(c.Val())
pattern := c.Val()
_, err := mdc.Template.ParseGlob(pattern)
if err != nil { if err != nil {
c.Errf("template load error: %v", err) return c.Errf("template load error: %v", err)
} }
if c.NextArg() { if c.NextArg() {
return c.ArgErr() return c.ArgErr()
} }
paths, err := filepath.Glob(pattern)
if err != nil {
return c.Errf("glob %q failed: %v", pattern, err)
}
for _, path := range paths {
mdc.TemplateFiles[filepath.Base(path)] = path
}
return nil return nil
default: default:
return c.Err("Expected valid markdown configuration property") return c.Err("Expected valid markdown configuration property")

20
caddyhttp/markdown/setup_test.go
View File

@ -4,6 +4,7 @@ import (
"bytes" "bytes"
"fmt" "fmt"
"net/http" "net/http"
"reflect"
"testing" "testing"
"text/template" "text/template"
@ -59,9 +60,10 @@ func TestMarkdownParse(t *testing.T) {
".md": {}, ".md": {},
".txt": {}, ".txt": {},
}, },
Styles: []string{"/resources/css/blog.css"}, Styles: []string{"/resources/css/blog.css"},
Scripts: []string{"/resources/js/blog.js"}, Scripts: []string{"/resources/js/blog.js"},
Template: GetDefaultTemplate(), Template: GetDefaultTemplate(),
TemplateFiles: make(map[string]string),
}}}, }}},
{`markdown /blog { {`markdown /blog {
ext .md ext .md
@ -71,12 +73,12 @@ func TestMarkdownParse(t *testing.T) {
Extensions: map[string]struct{}{ Extensions: map[string]struct{}{
".md": {}, ".md": {},
}, },
Template: GetDefaultTemplate(), Template: setDefaultTemplate("./testdata/tpl_with_include.html"),
TemplateFiles: map[string]string{
"": "testdata/tpl_with_include.html",
},
}}}, }}},
} }
// Setup the extra template
tmpl := tests[1].expectedMarkdownConfig[0].Template
SetTemplate(tmpl, "", "./testdata/tpl_with_include.html")
for i, test := range tests { for i, test := range tests {
c := caddy.NewTestController("http", test.inputMarkdownConfig) c := caddy.NewTestController("http", test.inputMarkdownConfig)
@ -110,6 +112,10 @@ func TestMarkdownParse(t *testing.T) {
if ok, tx, ty := equalTemplates(actualMarkdownConfig.Template, test.expectedMarkdownConfig[j].Template); !ok { if ok, tx, ty := equalTemplates(actualMarkdownConfig.Template, test.expectedMarkdownConfig[j].Template); !ok {
t.Errorf("Test %d the %dth Markdown Config Templates did not match, expected %s to be %s", i, j, tx, ty) t.Errorf("Test %d the %dth Markdown Config Templates did not match, expected %s to be %s", i, j, tx, ty)
} }
if expect, got := test.expectedMarkdownConfig[j].TemplateFiles, actualMarkdownConfig.TemplateFiles; !reflect.DeepEqual(expect, got) {
t.Errorf("Test %d the %d Markdown config TemplateFiles did not match, expect %v, but got %v", i, j, expect, got)
}
} }
} }
} }

12
caddyhttp/markdown/template.go
View File

@ -38,8 +38,18 @@ func execTemplate(c *Config, mdata metadata.Metadata, meta map[string]string, fi
Files: files, Files: files,
} }
templateName := mdata.Template
// reload template on every request for now
// TODO: cache templates by a general plugin
if templateFile, ok := c.TemplateFiles[templateName]; ok {
err := SetTemplate(c.Template, templateName, templateFile)
if err != nil {
return nil, err
}
}
b := new(bytes.Buffer) b := new(bytes.Buffer)
if err := c.Template.ExecuteTemplate(b, mdata.Template, mdData); err != nil { if err := c.Template.ExecuteTemplate(b, templateName, mdData); err != nil {
return nil, err return nil, err
} }

14
caddyhttp/markdown/testdata/blog/test.md vendored Normal file
View File

@ -0,0 +1,14 @@
---
title: Markdown test 1
sitename: A Caddy website
---
## Welcome on the blog
Body
``` go
func getTrue() bool {
return true
}
```

2
caddyhttp/markdown/testdata/docflags/template.txt vendored Normal file
View File

@ -0,0 +1,2 @@
Doc.var_string {{.Doc.var_string}}
Doc.var_bool {{.Doc.var_bool}}

4
caddyhttp/markdown/testdata/docflags/test.md vendored Normal file
View File

@ -0,0 +1,4 @@
---
var_string: hello
var_bool: true
---

1
caddyhttp/markdown/testdata/header.html vendored Normal file
View File

@ -0,0 +1 @@
<h1>Header for: {{.Doc.title}}</h1>

14
caddyhttp/markdown/testdata/log/test.md vendored Normal file
View File

@ -0,0 +1,14 @@
---
title: Markdown test 2
sitename: A Caddy website
---
## Welcome on the blog
Body
``` go
func getTrue() bool {
return true
}
```

11
caddyhttp/markdown/testdata/markdown_tpl.html vendored Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html>
<head>
<title>{{.Doc.title}}</title>
</head>
<body>
{{.Include "header.html"}}
Welcome to {{.Doc.sitename}}!
{{.Doc.body}}
</body>
</html>

5
caddyhttp/markdown/testdata/og/first.md vendored Normal file
View File

@ -0,0 +1,5 @@
---
title: first_post
sitename: title
---
# Test h1

11
caddyhttp/markdown/testdata/tpl_with_include.html vendored Normal file
View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html>
<head>
<title>{{.Doc.title}}</title>
</head>
<body>
Welcome to {{.Doc.sitename}}!
<br><br>
{{.Doc.body}}
</body>
</html>