Scaffolds a **directory** bundle — the only shape that can own local files, so the other kind would hand an author a page their pictures cannot live beside. What it writes is a draft: title, today's date, `draft: true`. A tool that publishes the moment it runs publishes by accident, and drafts are honoured now. This is the first thing that writes into somebody's content directory, so it goes through os.Root like every read does (ADR-0031), and it never overwrites: an existing bundle is an error. Two bugs found by running it rather than by testing it: A key of `../escape` did not fail. It never left the site root — path.Join collapses `..` first — but it wrote a real directory *inside* the root and outside content/, which is not an escape and not a bundle either. Refused outright now, the same guard the include path needed for the same reason. The test asserts what should be true — content/ is the only thing this creates — because the weaker assertion I wrote first would have passed. `khosra new posts/x -site dir` silently ignored -site, because Go's flag package stops at the first non-flag argument, and then failed complaining there was no site root. Parsed in rounds now, so either order works. main() crossed the function-length warning as a result, so it became a dispatch table with runServe beside it — the warning was right about the code.
90 lines
2.8 KiB
Go
90 lines
2.8 KiB
Go
package scaffold
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"khosra/internal/content"
|
|
)
|
|
|
|
func TestNewWritesADirectoryBundleThatScansAsADraft(t *testing.T) {
|
|
dir := t.TempDir()
|
|
written, err := New(dir, "posts/hello-world", "", "")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// A directory bundle, because only that shape can own local files (content-model.md).
|
|
if written != "content/posts/hello-world/index.en.md" {
|
|
t.Errorf("wrote %q, want a directory bundle", written)
|
|
}
|
|
data, err := os.ReadFile(filepath.Join(dir, written))
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// Parsed by the engine's own parser, not by eye: the scaffold has to be something khosra can read.
|
|
b, err := content.Parse(strings.TrimPrefix(written, "content/"), data)
|
|
if err != nil {
|
|
t.Fatalf("the engine cannot parse its own scaffold: %v\n%s", err, data)
|
|
}
|
|
if b.Title != "Hello world" {
|
|
t.Errorf("title = %q, want one derived from the slug", b.Title)
|
|
}
|
|
if !b.Draft {
|
|
t.Error("a scaffold must be a draft: a tool that publishes when it runs publishes by accident")
|
|
}
|
|
if b.Date.IsZero() {
|
|
t.Error("no date was written")
|
|
}
|
|
if b.Key != "posts/hello-world" {
|
|
t.Errorf("key = %q", b.Key)
|
|
}
|
|
}
|
|
|
|
func TestNewHonoursLanguageAndTitle(t *testing.T) {
|
|
dir := t.TempDir()
|
|
written, err := New(dir, "pages/about", "bn", "পরিচিতি")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if written != "content/pages/about/index.bn.md" {
|
|
t.Errorf("wrote %q, want the Bengali variant", written)
|
|
}
|
|
data, _ := os.ReadFile(filepath.Join(dir, written))
|
|
if !strings.Contains(string(data), "title: পরিচিতি") {
|
|
t.Errorf("the given title should be used verbatim:\n%s", data)
|
|
}
|
|
}
|
|
|
|
func TestNewNeverOverwritesAndNeverEscapes(t *testing.T) {
|
|
dir := t.TempDir()
|
|
if _, err := New(dir, "posts/twice", "", ""); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if _, err := New(dir, "posts/twice", "", ""); err == nil {
|
|
t.Error("a second run must refuse rather than replace someone's writing")
|
|
}
|
|
// os.Root refuses an escape, and the key is normalised and trimmed before it is used at all (ADR-0031).
|
|
for _, key := range []string{"../outside", "posts/../../outside", "", "/"} {
|
|
if _, err := New(dir, key, "", ""); err == nil {
|
|
t.Errorf("New(%q) should have failed", key)
|
|
}
|
|
}
|
|
if _, err := os.Stat(filepath.Join(filepath.Dir(dir), "outside")); err == nil {
|
|
t.Fatal("something was written outside the site root")
|
|
}
|
|
// The weaker check above is not enough: `../outside` does not escape the root, it lands *inside* it and
|
|
// outside content/, because path.Join collapses `..` before os.Root ever sees the name. So assert what
|
|
// should be true — content/ is the only thing this ever creates.
|
|
entries, err := os.ReadDir(dir)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
for _, e := range entries {
|
|
if e.Name() != "content" {
|
|
t.Errorf("created %q at the site root; only content/ should ever appear", e.Name())
|
|
}
|
|
}
|
|
}
|