x/box-o-sand
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Filling in tree walker and asserting it yields simplates

Browse Source
This commit is contained in:
Dan Buch 2012-12-25 14:22:21 -05:00
parent dc4fe12631
commit d246fc20a0
3 changed files with 194 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gotime/smplt/simplate.go
View File

@ -16,6 +16,12 @@ const (
) )
var ( var (
SIMPLATE_TYPES = []string{
SIMPLATE_TYPE_JSON,
SIMPLATE_TYPE_NEGOTIATED,
SIMPLATE_TYPE_RENDERED,
SIMPLATE_TYPE_STATIC,
}
simplateGenFileTmpl = template.Must(template.New("smpltgen").Parse(strings.Replace(` simplateGenFileTmpl = template.Must(template.New("smpltgen").Parse(strings.Replace(`
/* GENERATED FILE - DO NOT EDIT */ /* GENERATED FILE - DO NOT EDIT */
/* Rebuild with simplate filesystem parsing thingy! */ /* Rebuild with simplate filesystem parsing thingy! */
@ -80,7 +86,7 @@ type SimplatePage struct {
Body string Body string
} }
func SimplateFromString(filename, content string) *Simplate { func NewSimplateFromString(filename, content string) *Simplate {
rawPages := strings.Split(content, " ") rawPages := strings.Split(content, " ")
nbreaks := len(rawPages) - 1 nbreaks := len(rawPages) - 1

138
gotime/smplt/smplt_test.go
View File

@ -10,6 +10,7 @@ import (
"os" "os"
"os/exec" "os/exec"
"path" "path"
"sort"
"strings" "strings"
"testing" "testing"
"time" "time"
@ -80,22 +81,42 @@ var (
tmpdir = path.Join(os.TempDir(), tmpdir = path.Join(os.TempDir(),
fmt.Sprintf("smplt_test-%d", time.Now().UTC().UnixNano())) fmt.Sprintf("smplt_test-%d", time.Now().UTC().UnixNano()))
smpltgenDir = path.Join(tmpdir, "src", "smpltgen") smpltgenDir = path.Join(tmpdir, "src", "smpltgen")
testSiteRoot = path.Join(tmpdir, "test-site")
goCmd string goCmd string
noCleanup bool
testSiteFiles = map[string]string{
"hams/bone/derp": BASIC_NEGOTIATED_SIMPLATE,
"shill/cans.txt": BASIC_RENDERED_TXT_SIMPLATE,
"hat/v.json": BASIC_JSON_SIMPLATE,
"silmarillion.handlebar.mustache.moniker.html": "<html>INVALID AS BUTT</html>",
"Big CMS/Owns_UR Contents/flurb.txt": BASIC_STATIC_TXT_SIMPLATE,
}
) )
func init() { func init() {
err := os.Setenv("GOPATH", strings.Join([]string{tmpdir, os.Getenv("GOPATH")}, ":")) err := os.Setenv("GOPATH", strings.Join([]string{tmpdir, os.Getenv("GOPATH")}, ":"))
if err != nil { if err != nil {
if noCleanup {
log.Fatal(err) log.Fatal(err)
} else {
panic(err)
}
} }
cmd, err := exec.LookPath("go") cmd, err := exec.LookPath("go")
if err != nil { if err != nil {
if noCleanup {
log.Fatal(err) log.Fatal(err)
} else {
panic(err)
}
} }
goCmdAddr := &goCmd goCmdAddr := &goCmd
*goCmdAddr = cmd *goCmdAddr = cmd
noCleanupAddr := &noCleanup
*noCleanupAddr = len(os.Getenv("SMPLT_TEST_NOCLEANUP")) > 0
} }
func mkTmpDir() { func mkTmpDir() {
@ -112,8 +133,37 @@ func rmTmpDir() {
} }
} }
func mkTestSite() string {
mkTmpDir()
for filePath, content := range testSiteFiles {
fullPath := path.Join(testSiteRoot, filePath)
err := os.MkdirAll(path.Dir(fullPath), os.ModeDir|os.ModePerm)
if err != nil {
panic(err)
}
f, err := os.Create(fullPath)
if err != nil {
panic(err)
}
_, err = f.WriteString(content)
if err != nil {
panic(err)
}
err = f.Close()
if err != nil {
panic(err)
}
}
return testSiteRoot
}
func writeRenderedTemplate() (string, error) { func writeRenderedTemplate() (string, error) {
s := SimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE) s := NewSimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE)
outfileName := path.Join(smpltgenDir, s.OutputName()) outfileName := path.Join(smpltgenDir, s.OutputName())
outf, err := os.Create(outfileName) outf, err := os.Create(outfileName)
if err != nil { if err != nil {
@ -141,7 +191,9 @@ func runGoCommandOnSmpltgen(command string) error {
return err return err
} }
if noCleanup {
log.Println(out.String()) log.Println(out.String())
}
return nil return nil
} }
@ -154,7 +206,7 @@ func buildRenderedTemplate() error {
} }
func TestSimplateKnowsItsFilename(t *testing.T) { func TestSimplateKnowsItsFilename(t *testing.T) {
s := SimplateFromString("hasty-decisions.txt", "herpherpderpherp") s := NewSimplateFromString("hasty-decisions.txt", "herpherpderpherp")
if s.Filename != "hasty-decisions.txt" { if s.Filename != "hasty-decisions.txt" {
t.Errorf("Simplate filename incorrectly assigned as %s instead of %s", t.Errorf("Simplate filename incorrectly assigned as %s instead of %s",
s.Filename, "hasty-decisions.txt") s.Filename, "hasty-decisions.txt")
@ -162,7 +214,7 @@ func TestSimplateKnowsItsFilename(t *testing.T) {
} }
func TestSimplateKnowsItsContentType(t *testing.T) { func TestSimplateKnowsItsContentType(t *testing.T) {
s := SimplateFromString("hasty-decisions.js", "function herp() { return 'derp'; }") s := NewSimplateFromString("hasty-decisions.js", "function herp() { return 'derp'; }")
expected := mime.TypeByExtension(".js") expected := mime.TypeByExtension(".js")
if s.ContentType != expected { if s.ContentType != expected {
@ -172,42 +224,42 @@ func TestSimplateKnowsItsContentType(t *testing.T) {
} }
func TestStaticSimplateKnowsItsOutputName(t *testing.T) { func TestStaticSimplateKnowsItsOutputName(t *testing.T) {
s := SimplateFromString("nothing.txt", "foo\nham\n") s := NewSimplateFromString("nothing.txt", "foo\nham\n")
if s.OutputName() != "nothing.txt" { if s.OutputName() != "nothing.txt" {
t.Errorf("Static simplate output name is wrong!: %v", s.OutputName()) t.Errorf("Static simplate output name is wrong!: %v", s.OutputName())
} }
} }
func TestRenderedSimplateKnowsItsOutputName(t *testing.T) { func TestRenderedSimplateKnowsItsOutputName(t *testing.T) {
s := SimplateFromString("flip/dippy slippy/snork.d/basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE) s := NewSimplateFromString("flip/dippy slippy/snork.d/basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE)
if s.OutputName() != "flip-SLASH-dippy-SPACE-slippy-SLASH-snork-DOT-d-SLASH-basic-rendered-DOT-txt.go" { if s.OutputName() != "flip-SLASH-dippy-SPACE-slippy-SLASH-snork-DOT-d-SLASH-basic-rendered-DOT-txt.go" {
t.Errorf("Rendered simplate output name is wrong!: %v", s.OutputName()) t.Errorf("Rendered simplate output name is wrong!: %v", s.OutputName())
} }
} }
func TestDetectsRenderedSimplate(t *testing.T) { func TestDetectsRenderedSimplate(t *testing.T) {
s := SimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE) s := NewSimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE)
if s.Type != SIMPLATE_TYPE_RENDERED { if s.Type != SIMPLATE_TYPE_RENDERED {
t.Errorf("Simplate detected as %s instead of %s", s.Type, SIMPLATE_TYPE_RENDERED) t.Errorf("Simplate detected as %s instead of %s", s.Type, SIMPLATE_TYPE_RENDERED)
} }
} }
func TestDetectsStaticSimplate(t *testing.T) { func TestDetectsStaticSimplate(t *testing.T) {
s := SimplateFromString("basic-static.txt", BASIC_STATIC_TXT_SIMPLATE) s := NewSimplateFromString("basic-static.txt", BASIC_STATIC_TXT_SIMPLATE)
if s.Type != SIMPLATE_TYPE_STATIC { if s.Type != SIMPLATE_TYPE_STATIC {
t.Errorf("Simplate detected as %s instead of %s", s.Type, SIMPLATE_TYPE_STATIC) t.Errorf("Simplate detected as %s instead of %s", s.Type, SIMPLATE_TYPE_STATIC)
} }
} }
func TestDetectsJSONSimplates(t *testing.T) { func TestDetectsJSONSimplates(t *testing.T) {
s := SimplateFromString("basic.json", BASIC_JSON_SIMPLATE) s := NewSimplateFromString("basic.json", BASIC_JSON_SIMPLATE)
if s.Type != SIMPLATE_TYPE_JSON { if s.Type != SIMPLATE_TYPE_JSON {
t.Errorf("Simplate detected as %s instead of %s", s.Type, SIMPLATE_TYPE_JSON) t.Errorf("Simplate detected as %s instead of %s", s.Type, SIMPLATE_TYPE_JSON)
} }
} }
func TestDetectsNegotiatedSimplates(t *testing.T) { func TestDetectsNegotiatedSimplates(t *testing.T) {
s := SimplateFromString("hork", BASIC_NEGOTIATED_SIMPLATE) s := NewSimplateFromString("hork", BASIC_NEGOTIATED_SIMPLATE)
if s.Type != SIMPLATE_TYPE_NEGOTIATED { if s.Type != SIMPLATE_TYPE_NEGOTIATED {
t.Errorf("Simplate detected as %s instead of %s", t.Errorf("Simplate detected as %s instead of %s",
s.Type, SIMPLATE_TYPE_NEGOTIATED) s.Type, SIMPLATE_TYPE_NEGOTIATED)
@ -215,7 +267,7 @@ func TestDetectsNegotiatedSimplates(t *testing.T) {
} }
func TestAssignsNoGoPagesToStaticSimplates(t *testing.T) { func TestAssignsNoGoPagesToStaticSimplates(t *testing.T) {
s := SimplateFromString("basic-static.txt", BASIC_STATIC_TXT_SIMPLATE) s := NewSimplateFromString("basic-static.txt", BASIC_STATIC_TXT_SIMPLATE)
if s.InitPage != nil { if s.InitPage != nil {
t.Errorf("Static simplate had init page assigned!: %v", s.InitPage) t.Errorf("Static simplate had init page assigned!: %v", s.InitPage)
} }
@ -226,14 +278,14 @@ func TestAssignsNoGoPagesToStaticSimplates(t *testing.T) {
} }
func TestAssignsAnInitPageToRenderedSimplates(t *testing.T) { func TestAssignsAnInitPageToRenderedSimplates(t *testing.T) {
s := SimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE) s := NewSimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE)
if s.InitPage == nil { if s.InitPage == nil {
t.Errorf("Rendered simplate had no init page assigned!: %v", s.InitPage) t.Errorf("Rendered simplate had no init page assigned!: %v", s.InitPage)
} }
} }
func TestAssignsOneLogicPageToRenderedSimplates(t *testing.T) { func TestAssignsOneLogicPageToRenderedSimplates(t *testing.T) {
s := SimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE) s := NewSimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE)
if len(s.LogicPages) != 1 { if len(s.LogicPages) != 1 {
t.Errorf("Rendered simplate unexpected number "+ t.Errorf("Rendered simplate unexpected number "+
"of logic pages assigned!: %v", len(s.LogicPages)) "of logic pages assigned!: %v", len(s.LogicPages))
@ -241,21 +293,21 @@ func TestAssignsOneLogicPageToRenderedSimplates(t *testing.T) {
} }
func TestAssignsOneTemplatePageToRenderedSimplates(t *testing.T) { func TestAssignsOneTemplatePageToRenderedSimplates(t *testing.T) {
s := SimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE) s := NewSimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE)
if s.TemplatePage == nil { if s.TemplatePage == nil {
t.Errorf("Rendered simplate had no template page assigned!: %v", s.TemplatePage) t.Errorf("Rendered simplate had no template page assigned!: %v", s.TemplatePage)
} }
} }
func TestAssignsAnInitPageToJSONSimplates(t *testing.T) { func TestAssignsAnInitPageToJSONSimplates(t *testing.T) {
s := SimplateFromString("basic.json", BASIC_JSON_SIMPLATE) s := NewSimplateFromString("basic.json", BASIC_JSON_SIMPLATE)
if s.InitPage == nil { if s.InitPage == nil {
t.Errorf("JSON simplate had no init page assigned!: %v", s.InitPage) t.Errorf("JSON simplate had no init page assigned!: %v", s.InitPage)
} }
} }
func TestAssignsOneLogicPageToJSONSimplates(t *testing.T) { func TestAssignsOneLogicPageToJSONSimplates(t *testing.T) {
s := SimplateFromString("basic.json", BASIC_JSON_SIMPLATE) s := NewSimplateFromString("basic.json", BASIC_JSON_SIMPLATE)
if len(s.LogicPages) != 1 { if len(s.LogicPages) != 1 {
t.Errorf("Rendered simplate unexpected number "+ t.Errorf("Rendered simplate unexpected number "+
"of logic pages assigned!: %v", len(s.LogicPages)) "of logic pages assigned!: %v", len(s.LogicPages))
@ -263,21 +315,21 @@ func TestAssignsOneLogicPageToJSONSimplates(t *testing.T) {
} }
func TestAssignsNoTemplatePageToJSONSimplates(t *testing.T) { func TestAssignsNoTemplatePageToJSONSimplates(t *testing.T) {
s := SimplateFromString("basic.json", BASIC_JSON_SIMPLATE) s := NewSimplateFromString("basic.json", BASIC_JSON_SIMPLATE)
if s.TemplatePage != nil { if s.TemplatePage != nil {
t.Errorf("JSON simplate had a template page assigned!: %v", s.TemplatePage) t.Errorf("JSON simplate had a template page assigned!: %v", s.TemplatePage)
} }
} }
func TestAssignsAnInitPageToNegotiatedSimplates(t *testing.T) { func TestAssignsAnInitPageToNegotiatedSimplates(t *testing.T) {
s := SimplateFromString("basic-negotiated.txt", BASIC_NEGOTIATED_SIMPLATE) s := NewSimplateFromString("basic-negotiated.txt", BASIC_NEGOTIATED_SIMPLATE)
if s.InitPage == nil { if s.InitPage == nil {
t.Errorf("Negotiated simplate had no init page assigned!: %v", s.InitPage) t.Errorf("Negotiated simplate had no init page assigned!: %v", s.InitPage)
} }
} }
func TestAssignsAtLeastOneLogicPageToNegotiatedSimplates(t *testing.T) { func TestAssignsAtLeastOneLogicPageToNegotiatedSimplates(t *testing.T) {
s := SimplateFromString("basic-negotiated.txt", BASIC_NEGOTIATED_SIMPLATE) s := NewSimplateFromString("basic-negotiated.txt", BASIC_NEGOTIATED_SIMPLATE)
if len(s.LogicPages) < 1 { if len(s.LogicPages) < 1 {
t.Errorf("Negotiated simplate unexpected number "+ t.Errorf("Negotiated simplate unexpected number "+
"of logic pages assigned!: %v", len(s.LogicPages)) "of logic pages assigned!: %v", len(s.LogicPages))
@ -285,14 +337,14 @@ func TestAssignsAtLeastOneLogicPageToNegotiatedSimplates(t *testing.T) {
} }
func TestAssignsNoTemplatePageToNegotiatedSimplates(t *testing.T) { func TestAssignsNoTemplatePageToNegotiatedSimplates(t *testing.T) {
s := SimplateFromString("basic-negotiated.txt", BASIC_NEGOTIATED_SIMPLATE) s := NewSimplateFromString("basic-negotiated.txt", BASIC_NEGOTIATED_SIMPLATE)
if s.TemplatePage != nil { if s.TemplatePage != nil {
t.Errorf("Negotiated simplate had a template page assigned!: %v", s.TemplatePage) t.Errorf("Negotiated simplate had a template page assigned!: %v", s.TemplatePage)
} }
} }
func TestRenderedSimplateCanExecuteToWriter(t *testing.T) { func TestRenderedSimplateCanExecuteToWriter(t *testing.T) {
s := SimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE) s := NewSimplateFromString("basic-rendered.txt", BASIC_RENDERED_TXT_SIMPLATE)
var out bytes.Buffer var out bytes.Buffer
err := s.Execute(&out) err := s.Execute(&out)
if err != nil { if err != nil {
@ -302,7 +354,7 @@ func TestRenderedSimplateCanExecuteToWriter(t *testing.T) {
func TestRenderedSimplateOutputIsValidGoSource(t *testing.T) { func TestRenderedSimplateOutputIsValidGoSource(t *testing.T) {
mkTmpDir() mkTmpDir()
if len(os.Getenv("SMPLT_TEST_NOCLEANUP")) > 0 { if noCleanup {
fmt.Println("tmpdir =", tmpdir) fmt.Println("tmpdir =", tmpdir)
} else { } else {
defer rmTmpDir() defer rmTmpDir()
@ -324,7 +376,7 @@ func TestRenderedSimplateOutputIsValidGoSource(t *testing.T) {
func TestRenderedSimplateCanBeCompiled(t *testing.T) { func TestRenderedSimplateCanBeCompiled(t *testing.T) {
mkTmpDir() mkTmpDir()
if len(os.Getenv("SMPLT_TEST_NOCLEANUP")) > 0 { if noCleanup {
fmt.Println("tmpdir =", tmpdir) fmt.Println("tmpdir =", tmpdir)
} else { } else {
defer rmTmpDir() defer rmTmpDir()
@ -348,3 +400,45 @@ func TestRenderedSimplateCanBeCompiled(t *testing.T) {
return return
} }
} }
func TestTreeWalkerRequiresValidDirectoryRoot(t *testing.T) {
_, err := NewTreeWalker("/dev/null")
if err == nil {
t.Errorf("New tree walker failed to reject invalid dir!")
return
}
}
func TestTreeWalkerYieldsSimplates(t *testing.T) {
siteRoot := mkTestSite()
if noCleanup {
fmt.Println("tmpdir =", tmpdir)
} else {
defer rmTmpDir()
}
tw, err := NewTreeWalker(siteRoot)
if err != nil {
t.Error(err)
return
}
n := 0
simplates, err := tw.Simplates()
if err != nil {
t.Error(err)
}
for simplate := range simplates {
if sort.SearchStrings(SIMPLATE_TYPES, simplate.Type) < 0 {
t.Errorf("Simplate yielded with invalid type: %v", simplate.Type)
return
}
n++
}
if n != 5 {
t.Errorf("Tree walking yielded unexpected number of files: %v", n)
}
}

66
gotime/smplt/tree_walker.go Normal file
View File

@ -0,0 +1,66 @@
package smplt
import (
"errors"
"io/ioutil"
"log"
"os"
"path/filepath"
)
var (
InvalidTreeWalkerRoot = errors.New("Invalid tree climber root given")
)
type TreeWalker struct {
Root string
}
func NewTreeWalker(dirRoot string) (*TreeWalker, error) {
fi, err := os.Stat(dirRoot)
if err != nil {
return nil, err
}
if !fi.IsDir() {
return nil, InvalidTreeWalkerRoot
}
return &TreeWalker{Root: dirRoot}, nil
}
func (me *TreeWalker) Simplates() (<-chan *Simplate, error) {
schan := make(chan *Simplate)
go func() {
filepath.Walk(me.Root,
func(path string, info os.FileInfo, err error) error {
if err != nil {
log.Println("TreeWalker error:", err)
return nil
}
if info.IsDir() {
return nil
}
f, err := os.Open(path)
if err != nil {
return err
}
defer f.Close()
content, err := ioutil.ReadAll(f)
if err != nil {
return err
}
schan <- NewSimplateFromString(path, string(content))
return nil
})
close(schan)
}()
return (<-chan *Simplate)(schan), nil
}