ruderich.org/simon/gswgf@v0.2.3/gswgf_test.go

// Copyright (C) 2019-2020  Simon Ruderich
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package gswgf

import (
	"io/ioutil"
	"log"
	"os"
	"path/filepath"
	"reflect"
	"regexp"
	"strings"
	"testing"

	"github.com/google/go-cmp/cmp"
)

type file struct {
	path string
	mode os.FileMode
	data string
}

func TestMain(t *testing.T) {
	var logBuilder strings.Builder
	{
		savedArgs := os.Args
		os.Args = []string{"test", "build"}

		savedFlags := log.Flags()
		log.SetFlags(0)
		log.SetOutput(&logBuilder)

		cmdPath = "../cmd"

		defer func() {
			os.Args = savedArgs
			log.SetFlags(savedFlags)
			log.SetOutput(os.Stderr)
		}()
	}
	err := os.Chdir("testdata")
	if err != nil {
		t.Fatal(err)
	}

	tests := []struct {
		name     string
		cfg      Config
		logExp   []string
		log2Exp  []string
		filesExp []file
	}{
		{"simple", simpleCfg, simpleLog, simpleLog2, simpleFiles},
		{"basic", basicCfg, basicLog, basicLog2, basicFiles},
		{"hooks", hooksCfg, hooksLog, hooksLog2, hooksFiles},
	}

	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			tmp, err := ioutil.TempDir("", "gswgf-test")
			if err != nil {
				t.Fatal(err)
			}
			defer os.RemoveAll(tmp)
			tc.cfg.TargetDir = tmp

			for i, x := range tc.filesExp {
				tc.filesExp[i].path = filepath.Join(tmp, x.path)
			}

			// First run
			logBuilder.Reset()
			err = main(tc.cfg)
			if err != nil {
				t.Errorf("err = %#v, want %#v", err, nil)
			}
			testDiff(t, tmp, &logBuilder, tc.logExp, tc.filesExp)

			// Second run must not change any files but may have
			// different log output
			logBuilder.Reset()
			err = main(tc.cfg)
			if err != nil {
				t.Errorf("err2 = %#v, want %#v", err, nil)
			}
			testDiff(t, tmp, &logBuilder, tc.log2Exp, tc.filesExp)
		})
	}
}
func testDiff(t *testing.T, tmp string, logBuilder *strings.Builder,
	logExp []string, filesExp []file) {

	logOut := strings.Split(logBuilder.String(), "\n")
	if !reflect.DeepEqual(logExp, logOut) {
		t.Errorf("logs: %s", cmp.Diff(logExp, logOut))
	}

	var files []file
	filepath.Walk(tmp, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			panic(err)
		}
		mode := info.Mode() & os.ModeType
		f := file{
			path: path,
			mode: mode,
		}
		if mode == 0 {
			data, err := ioutil.ReadFile(path)
			if err != nil {
				panic(err)
			}
			f.data = string(data)
		} else if mode == os.ModeSymlink {
			data, err := os.Readlink(path)
			if err != nil {
				panic(err)
			}
			f.data = string(data)
		}
		files = append(files, f)
		return nil
	})
	if !reflect.DeepEqual(filesExp, files) {
		cmpOpts := cmp.AllowUnexported(file{})
		t.Errorf("files: %s", cmp.Diff(filesExp, files, cmpOpts))
	}
}

var simpleCfg = Config{
	Version: 1,
}
var simpleLog = []string{
	`".hidden": copying`,
	`".hidden2": copying`,
	`".hidden3": copying`,
	`"index.adoc": converting with Asciidoctor`,
	`"sub/dir/.hidden": copying`,
	`"sub/dir/test.txt": copying`,
	`"sub/index.adoc": converting with Asciidoctor`,
	`"test.adoc": converting with Asciidoctor`,
	`"unknown": copying`,
	`"unknown.ext": copying`,
	"",
}
var simpleLog2 = []string{
	"",
}
var simpleFiles = []file{
	file{
		path: "",
		mode: os.ModeDir,
	},
	file{
		path: ".hidden",
		data: "Hidden files are copied as well\n",
	},
	file{
		path: ".hidden2",
		data: "Hidden files are copied as well ... {{.Data}}\n\n{{cite \"me\"}}\n",
	},
	file{
		path: ".hidden3",
		data: "Hidden files are copied as well!\n",
	},
	file{
		path: "index.html",
		data: "Title: Index\nBody: <div class=\"paragraph\">\n<p>Hello World!</p>\n</div>\n\nMeta: html5\n",
	},
	file{
		path: "sub",
		mode: os.ModeDir,
	},
	file{
		path: "sub/dir",
		mode: os.ModeDir,
	},
	file{
		path: "sub/dir/.hidden",
		data: "Hidden files are copied as well, even in sub directories\n",
	},
	file{
		path: "sub/dir/test.txt",
		data: "= Another file\n\nThis time in a sub-directory\n",
	},
	file{
		path: "sub/index.html",
		data: "SUB!\nTitle: Sub-Index\nBody: <div class=\"ulist\">\n<ul>\n<li>\n<p>a</p>\n</li>\n<li>\n<p>b</p>\n</li>\n<li>\n<p>c</p>\n</li>\n</ul>\n</div>\n\nMeta: html5\n",
	},
	file{
		path: "sub/test.html",
		mode: os.ModeSymlink,
		data: "../test.html",
	},
	file{
		path: "test.html",
		data: "Title: Test (test.adoc)\nBody: <div class=\"paragraph\">\n<p>Another file &#8230;&#8203; <a href=\"https://example.org/\" class=\"bare\">https://example.org/</a></p>\n</div>\n<div class=\"paragraph\">\n<p>Test: A (test.adoc)</p>\n</div>\n<div class=\"paragraph\">\n<p>Test: B (test.adoc)</p>\n</div>\n\nMeta: html5\n",
	},
	file{
		path: "unknown",
		data: "Files without extension are simply copied.\n",
	},
	file{
		path: "unknown.ext",
		data: "Files with unknown extensions are simply copied.\n",
	},
}

var basicCfg = Config{
	Version: 1,
	PathActions: append([]PathAction{
		PathAction{
			Regexp: regexp.MustCompile(`^index\.adoc$`),
			Action: Action{
				Converter: ConvertCopy{},
				// No extension given
			},
		},
		PathAction{
			Glob: "test.adoc",
			Action: Action{
				NoTemplate: true,
				Converter:  ConvertAsciidoctor{},
				NewExt:     ".htm",
			},
		},
		PathAction{
			Regexp: regexp.MustCompile(`.hidden$`),
			Action: Action{
				Ignore: true,
			},
		},
		PathAction{
			Ext: ".txt",
			Action: Action{
				Converter: ConvertAsciidoctor{},
				NewExt:    ".html",
			},
		},
		PathAction{
			Glob: "*/*.adoc",
			Action: Action{
				Copy: true,
			},
		},
		PathAction{
			Regexp: regexp.MustCompile(`.hidden3$`),
			Action: Action{
				Converter: ConvertCopy{},
				NewExt:    ".txt",
			},
		},
	}, DefaultPathActions...),
	PathLayouts: append([]PathLayout{
		PathLayout{
			Glob: "*/*/*.txt",
			Layout: Layout{
				Path: "layout2.html",
			},
		},
	}, DefaultPathLayouts...),
}
var basicLog = []string{
	`".hidden": ignoring`,
	`".hidden2": copying`,
	`".hidden3": converting with Copy`,
	`"index.adoc": converting with Copy`,
	`"sub/dir/.hidden": ignoring`,
	`"sub/dir/test.txt": converting with Asciidoctor`,
	`"sub/index.adoc": copying`,
	`"test.adoc": converting with Asciidoctor`,
	`"unknown": copying`,
	`"unknown.ext": copying`,
	"",
}
var basicLog2 = []string{
	`".hidden": ignoring`,
	`"sub/dir/.hidden": ignoring`,
	"",
}
var basicFiles = []file{
	file{
		path: "",
		mode: os.ModeDir,
	},
	file{
		path: ".hidden2",
		data: "Hidden files are copied as well ... {{.Data}}\n\n{{cite \"me\"}}\n",
	},
	file{
		path: ".hidden3.txt",
		data: "Title: \nBody: Hidden files are copied as well!\n\nMeta: \n",
	},
	file{
		path: "index",
		data: "Title: \nBody: = Index\n\nHello World!\n\nMeta: \n",
	},
	file{
		path: "sub",
		mode: os.ModeDir,
	},
	file{
		path: "sub/dir",
		mode: os.ModeDir,
	},
	file{
		path: "sub/dir/test.html",
		data: "Path2: sub/dir/test.txt\nTitle2: Another file\nBody2: <div class=\"paragraph\">\n<p>This time in a sub-directory</p>\n</div>\n\n",
	},
	file{
		path: "sub/index.adoc",
		data: "= Sub-Index\n:foo: bar\n\n- a\n- b\n- c\n\n////\nComment\n////\n",
	},
	file{
		path: "sub/test.html",
		mode: os.ModeSymlink,
		data: "../test.html",
	},
	file{
		path: "test.htm",
		data: "Title: {{.Title}}Test ({{.Path}})\nBody: <div class=\"paragraph\">\n<p>Another file &#8230;&#8203; <a href=\"https://example.org/\" class=\"bare\">https://example.org/</a></p>\n</div>\n<div class=\"paragraph\">\n<p>{{define \"Test\"}}\nTest: {{.}} ({{(args).Path}})\n{{end}}</p>\n</div>\n<div class=\"paragraph\">\n<p>{{template \"Test\" \"A\"}}\n{{template \"Test\" \"B\"}}</p>\n</div>\n\nMeta: html5\n",
	},
	file{
		path: "unknown",
		data: "Files without extension are simply copied.\n",
	},
	file{
		path: "unknown.ext",
		data: "Files with unknown extensions are simply copied.\n",
	},
}

var hooksCfg = Config{
	Version: 1,
	PathActions: append([]PathAction{
		PathAction{
			Regexp: regexp.MustCompile(`^index\.adoc$`),
			Action: Action{
				Converter: ConvertCopy{},
				// No extension given
			},
		},
		PathAction{
			Regexp: regexp.MustCompile(`.hidden$`),
			Action: Action{
				Ignore: true,
			},
		},
		PathAction{
			Ext: ".txt",
			Action: Action{
				Converter: ConvertAsciidoctor{},
				NewExt:    ".html",
			},
		},
		PathAction{
			Regexp: regexp.MustCompile(`.hidden3$`),
			Action: Action{
				Converter: ConvertCopy{},
				NewExt:    ".txt",
			},
		},
	}, DefaultPathActions...),
	PathLayouts: append([]PathLayout{
		PathLayout{
			Glob: "*/*/*.txt",
			Layout: Layout{
				Path: "layout2.html",
			},
		},
	}, DefaultPathLayouts...),
	ActionSelectionHook: func(path string, action Action) (Action, error) {
		if path == "unknown.ext" {
			if action.Copy != true {
				panic("unknown.ext: invalid action")
			}
			action.Copy = false
			action.Ignore = true
		}
		if path == ".hidden2" {
			if action.Copy != true {
				panic(".hidden2: invalid action")
			}
			action.Copy = false
			action.Converter = ConvertAsciidoctor{}
		}
		return action, nil
	},
	PreConvertHook: func(path string, args TemplateArgs) (TemplateArgs, error) {
		args.Path += "!"
		args.Body += "change"
		if path == ".hidden2" {
			args.Funcs["cite"] = func(x string) string {
				return "+++<cite>+++" + x + "+++</cite>+++"
			}
			args.Data = "42"
		}
		return args, nil
	},
	LayoutSelectionHook: func(path string, layout Layout) (Layout, error) {
		if path == "sub/index.adoc" {
			if layout.Path != "layout.html" {
				panic("sub/index.adoc: invalid layout")
			}
			layout.Path = "layout2.html"
		}
		if layout.Path == "layout2.html" {
			if path != "sub/index.adoc" && path != "sub/dir/test.txt" {
				panic(path + ": invalid layout")
			}
			layout.Path = "layout3.html"
		}
		return layout, nil
	},
	PreLayoutHook: func(path string, args TemplateArgs) (TemplateArgs, error) {
		args.Body += "<!-- comment -->"
		args.Funcs["foo"] = func(x string) string {
			return "<FOO>" + x + "</FOO>"
		}
		return args, nil
	},
	PostLayoutHook: func(path string, content string) (string, error) {
		if path == "index.adoc" {
			return "copy: " + content, nil
		}
		if path == "unknown" {
			panic("unknown should not use PostLayoutHook")
		}
		if path == "unknown.ext" {
			panic("unknown.ext should not use PostLayoutHook")
		}
		return content, nil
	},
}
var hooksLog = []string{
	`".hidden": ignoring`,
	`".hidden2": converting with Asciidoctor`,
	`".hidden3": converting with Copy`,
	`"index.adoc": converting with Copy`,
	`"sub/dir/.hidden": ignoring`,
	`"sub/dir/test.txt": converting with Asciidoctor`,
	`"sub/index.adoc": converting with Asciidoctor`,
	`"test.adoc": converting with Asciidoctor`,
	`"unknown": copying`,
	`"unknown.ext": ignoring`,
	"",
}
var hooksLog2 = []string{
	`".hidden": ignoring`,
	`"sub/dir/.hidden": ignoring`,
	`"unknown.ext": ignoring`,
	"",
}
var hooksFiles = []file{
	file{
		path: "",
		mode: os.ModeDir,
	},
	file{
		path: ".hidden2",
		data: "Title: \nBody: <div class=\"paragraph\">\n<p>Hidden files are copied as well &#8230;&#8203; 42</p>\n</div>\n<div class=\"paragraph\">\n<p><cite>me</cite>\nchange</p>\n</div>\n<!-- comment -->\nMeta: html5\n",
	},
	file{
		path: ".hidden3.txt",
		data: "Title: \nBody: Hidden files are copied as well!\nchange<!-- comment -->\nMeta: \n",
	},
	file{
		path: "index",
		data: "copy: Title: \nBody: = Index\n\nHello World!\nchange<!-- comment -->\nMeta: \n",
	},
	file{
		path: "sub",
		mode: os.ModeDir,
	},
	file{
		path: "sub/dir",
		mode: os.ModeDir,
	},
	file{
		path: "sub/dir/test.html",
		data: "Path3: sub/dir/test.txt\nTitle3: Another file\nBody3: <div class=\"paragraph\">\n<p>This time in a sub-directory\nchange</p>\n</div>\n<!-- comment -->\n\n<FOO>test</FOO>\n",
	},
	file{
		path: "sub/index.html",
		data: "Path3: sub/index.adoc\nTitle3: Sub-Index\nBody3: <div class=\"ulist\">\n<ul>\n<li>\n<p>a</p>\n</li>\n<li>\n<p>b</p>\n</li>\n<li>\n<p>c</p>\n</li>\n</ul>\n</div>\n<div class=\"paragraph\">\n<p>change</p>\n</div>\n<!-- comment -->\n\n<FOO>test</FOO>\n",
	},
	file{
		path: "sub/test.html",
		mode: os.ModeSymlink,
		data: "../test.html",
	},
	file{
		path: "test.html",
		data: "Title: Test (test.adoc!)\nBody: <div class=\"paragraph\">\n<p>Another file &#8230;&#8203; <a href=\"https://example.org/\" class=\"bare\">https://example.org/</a></p>\n</div>\n<div class=\"paragraph\">\n<p>Test: A (test.adoc!)</p>\n</div>\n<div class=\"paragraph\">\n<p>Test: B (test.adoc!)</p>\n</div>\n<div class=\"paragraph\">\n<p>change</p>\n</div>\n<!-- comment -->\nMeta: html5\n",
	},
	file{
		path: "unknown",
		data: "Files without extension are simply copied.\n",
	},
}