Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ac84ddf5a9 | ||
|
|
db18785bfc | ||
|
|
138d6e2545 | ||
|
|
41b7105b31 | ||
|
|
ddd4bdc2ac | ||
|
|
1fff54769d | ||
|
|
0c3e82ca0a | ||
|
|
eedb110be5 |
+1
-1
@@ -68,7 +68,7 @@ require (
|
|||||||
github.com/segmentio/asm v1.2.0 // indirect
|
github.com/segmentio/asm v1.2.0 // indirect
|
||||||
golang.org/x/crypto v0.51.0 // indirect
|
golang.org/x/crypto v0.51.0 // indirect
|
||||||
golang.org/x/sync v0.21.0 // indirect
|
golang.org/x/sync v0.21.0 // indirect
|
||||||
golang.org/x/sys v0.45.0 // indirect
|
golang.org/x/sys v0.45.0
|
||||||
golang.org/x/text v0.39.0 // indirect
|
golang.org/x/text v0.39.0 // indirect
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/claim"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/claim"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/search"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/search"
|
||||||
@@ -227,14 +228,22 @@ func writeHallNote(brainDir string, opts WriteNoteOptions) (string, error) {
|
|||||||
// The directory is created only once the note is known to be writable:
|
// The directory is created only once the note is known to be writable:
|
||||||
// a refused write leaves nothing behind, not even an empty hall dir
|
// a refused write leaves nothing behind, not even an empty hall dir
|
||||||
// (brain#21; provenance refusal joins the envelope refusal here).
|
// (brain#21; provenance refusal joins the envelope refusal here).
|
||||||
if err := os.MkdirAll(filepath.Dir(dest), 0o755); err != nil {
|
// Created through the brain root, never through a symlinked wing or
|
||||||
return "", fmt.Errorf("create hall dir: %w", err)
|
// hall directory (hyperguild#188).
|
||||||
|
rel, err := filepath.Rel(brainDir, dest)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("note path: %w", err)
|
||||||
}
|
}
|
||||||
if err := os.WriteFile(dest, []byte(final), 0o644); err != nil {
|
rel = filepath.ToSlash(rel)
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
if err := bfs.PutRegular(rel, []byte(final)); err != nil {
|
||||||
return "", fmt.Errorf("write: %w", err)
|
return "", fmt.Errorf("write: %w", err)
|
||||||
}
|
}
|
||||||
rel, _ := filepath.Rel(brainDir, dest)
|
return rel, nil
|
||||||
return filepath.ToSlash(rel), nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// scalarValues flattens frontmatter fields to key -> scalar value for
|
// scalarValues flattens frontmatter fields to key -> scalar value for
|
||||||
|
|||||||
@@ -127,18 +127,18 @@ func PromoteNote(brainDir string, opts PromoteOptions) (string, error) {
|
|||||||
}
|
}
|
||||||
fm.set("promoted_at", now)
|
fm.set("promoted_at", now)
|
||||||
|
|
||||||
if err := os.MkdirAll(filepath.Dir(dest), 0o755); err != nil {
|
// Write-then-delete: the source survives any write failure. Both go
|
||||||
return "", fmt.Errorf("create wing dir: %w", err)
|
// through the brain root (hyperguild#188).
|
||||||
}
|
|
||||||
// Write-then-delete: the source survives any write failure.
|
|
||||||
promoted, err := StampProvenance(fm.render()+body, opts.Origin, opts.WrittenBy)
|
promoted, err := StampProvenance(fm.render()+body, opts.Origin, opts.WrittenBy)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
if err := os.WriteFile(dest, []byte(promoted), 0o644); err != nil {
|
// Created with O_EXCL: a note that appeared after the collision check
|
||||||
|
// above is never overwritten.
|
||||||
|
if err := createBrainFile(brainDir, dest, []byte(promoted)); err != nil {
|
||||||
return "", fmt.Errorf("write promoted note: %w", err)
|
return "", fmt.Errorf("write promoted note: %w", err)
|
||||||
}
|
}
|
||||||
if err := os.Remove(src); err != nil {
|
if err := removeBrainFile(brainDir, src); err != nil {
|
||||||
return "", fmt.Errorf("promoted note written but source removal failed: %w", err)
|
return "", fmt.Errorf("promoted note written but source removal failed: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -196,14 +196,12 @@ func RejectNote(brainDir string, opts RejectOptions) (string, error) {
|
|||||||
fm.set("reject_reason", opts.Reason)
|
fm.set("reject_reason", opts.Reason)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := os.MkdirAll(filepath.Dir(dest), 0o755); err != nil {
|
// Write-then-delete: the source survives any write failure. Both go
|
||||||
return "", fmt.Errorf("create rejected dir: %w", err)
|
// through the brain root (hyperguild#188).
|
||||||
}
|
if err := createBrainFile(brainDir, dest, []byte(fm.render()+body)); err != nil {
|
||||||
// Write-then-delete: the source survives any write failure.
|
|
||||||
if err := os.WriteFile(dest, []byte(fm.render()+body), 0o644); err != nil {
|
|
||||||
return "", fmt.Errorf("write rejected note: %w", err)
|
return "", fmt.Errorf("write rejected note: %w", err)
|
||||||
}
|
}
|
||||||
if err := os.Remove(src); err != nil {
|
if err := removeBrainFile(brainDir, src); err != nil {
|
||||||
return "", fmt.Errorf("rejected note written but source removal failed: %w", err)
|
return "", fmt.Errorf("rejected note written but source removal failed: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,87 @@
|
|||||||
|
package api_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#188: promote and reject wrote the destination with
|
||||||
|
// os.MkdirAll + os.WriteFile by path, so a symlinked wing (promote) or a
|
||||||
|
// symlinked raw/rejected (reject) redirected the note; the raw source was
|
||||||
|
// then removed.
|
||||||
|
func TestPromoteAndRejectRefuseASymlinkedDestinationDirectory(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
raw := filepath.Join(brain, "raw")
|
||||||
|
require.NoError(t, os.MkdirAll(raw, 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(raw, "2026-10-05-n.md"), []byte("---\ntitle: n\n---\nbody\n"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(brain, "wiki", "lw")))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(raw, "rejected")))
|
||||||
|
|
||||||
|
_, err := api.PromoteNote(brain, api.PromoteOptions{Filename: "2026-10-05-n.md", Wing: "lw", Hall: "facts"})
|
||||||
|
assert.Error(t, err)
|
||||||
|
_, err = api.RejectNote(brain, api.RejectOptions{Filename: "2026-10-05-n.md"})
|
||||||
|
assert.Error(t, err)
|
||||||
|
ents, _ := os.ReadDir(outside)
|
||||||
|
assert.Empty(t, ents, "a note was written outside the brain")
|
||||||
|
_, err = os.Stat(filepath.Join(raw, "2026-10-05-n.md"))
|
||||||
|
assert.NoError(t, err, "the raw source is kept when the write is refused")
|
||||||
|
|
||||||
|
require.NoError(t, os.Remove(filepath.Join(raw, "rejected")))
|
||||||
|
_, err = api.PromoteNote(brain, api.PromoteOptions{Filename: "2026-10-05-n.md", Wing: "w", Hall: "facts"})
|
||||||
|
require.NoError(t, err, "positive control: promote into a real wing")
|
||||||
|
}
|
||||||
|
|
||||||
|
// StampProvenanceFile read and rewrote the note by path (provenance.ApplyFile).
|
||||||
|
func TestStampProvenanceFileRefusesANoteBehindASymlinkedDirectory(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
victim := filepath.Join(brain, "raw", "facts", "v.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("---\ntitle: v\n---\nuntouched\n"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki", "w"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "facts"), filepath.Join(brain, "wiki", "w", "alias")))
|
||||||
|
assert.Error(t, api.StampProvenanceFile(brain, "wiki/w/alias/v.md", "static", "x"))
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "---\ntitle: v\n---\nuntouched\n", string(got))
|
||||||
|
|
||||||
|
real := filepath.Join(brain, "wiki", "w", "facts", "r.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(real), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(real, []byte("---\ntitle: r\n---\nbody\n"), 0o644))
|
||||||
|
require.NoError(t, api.StampProvenanceFile(brain, "wiki/w/facts/r.md", "static", "x"), "positive control")
|
||||||
|
got, _ = os.ReadFile(real)
|
||||||
|
assert.Contains(t, string(got), "written_by: x")
|
||||||
|
}
|
||||||
|
|
||||||
|
// The same through an in-brain symlinked wing and raw/rejected, which
|
||||||
|
// os.Root alone would follow.
|
||||||
|
func TestPromoteAndRejectRefuseAnInBrainSymlinkedDestinationDirectory(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
raw := filepath.Join(brain, "raw")
|
||||||
|
require.NoError(t, os.MkdirAll(raw, 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(raw, "2026-10-05-n.md"), []byte("---\ntitle: n\n---\nbody\n"), 0o644))
|
||||||
|
target := filepath.Join(brain, "archive")
|
||||||
|
require.NoError(t, os.MkdirAll(target, 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "archive"), filepath.Join(brain, "wiki", "lw")))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "archive"), filepath.Join(raw, "rejected")))
|
||||||
|
|
||||||
|
_, err := api.PromoteNote(brain, api.PromoteOptions{Filename: "2026-10-05-n.md", Wing: "lw", Hall: "facts"})
|
||||||
|
assert.Error(t, err)
|
||||||
|
_, err = api.RejectNote(brain, api.RejectOptions{Filename: "2026-10-05-n.md"})
|
||||||
|
assert.Error(t, err)
|
||||||
|
ents, _ := os.ReadDir(target)
|
||||||
|
assert.Empty(t, ents, "a note was written at the in-brain link's target")
|
||||||
|
_, err = os.Stat(filepath.Join(raw, "2026-10-05-n.md"))
|
||||||
|
assert.NoError(t, err, "the raw source is kept")
|
||||||
|
|
||||||
|
require.NoError(t, os.Remove(filepath.Join(raw, "rejected")))
|
||||||
|
_, err = api.RejectNote(brain, api.RejectOptions{Filename: "2026-10-05-n.md"})
|
||||||
|
require.NoError(t, err, "positive control: reject into a real raw/rejected")
|
||||||
|
}
|
||||||
@@ -1,6 +1,10 @@
|
|||||||
package api
|
package api
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/provenance"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/provenance"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -11,11 +15,61 @@ func StampProvenance(content, origin, writtenBy string) (string, error) {
|
|||||||
return provenance.Apply(content, provenance.Stamp{Origin: origin, WrittenBy: writtenBy})
|
return provenance.Apply(content, provenance.Stamp{Origin: origin, WrittenBy: writtenBy})
|
||||||
}
|
}
|
||||||
|
|
||||||
// StampProvenanceFile applies StampProvenance to a brain-relative note path.
|
// StampProvenanceFile applies StampProvenance to a brain-relative note path,
|
||||||
|
// read and rewritten through the brain root (hyperguild#158).
|
||||||
func StampProvenanceFile(brainDir, relPath, origin, writtenBy string) error {
|
func StampProvenanceFile(brainDir, relPath, origin, writtenBy string) error {
|
||||||
_, abs, err := resolveWithin(brainDir, relPath)
|
rel, _, err := resolveWithin(brainDir, relPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return provenance.ApplyFile(abs, provenance.Stamp{Origin: origin, WrittenBy: writtenBy})
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
b, err := bfs.ReadRegular(rel)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read for provenance: %w", err)
|
||||||
|
}
|
||||||
|
out, err := provenance.Apply(string(b), provenance.Stamp{Origin: origin, WrittenBy: writtenBy})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if out == string(b) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := bfs.WriteRegular(rel, []byte(out)); err != nil {
|
||||||
|
return fmt.Errorf("write provenance: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// createBrainFile creates the file at abs (inside brainDir) through the
|
||||||
|
// brain root and fails if anything is already there.
|
||||||
|
func createBrainFile(brainDir, abs string, data []byte) error {
|
||||||
|
rel, err := filepath.Rel(brainDir, abs)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
return bfs.CreateRegular(filepath.ToSlash(rel), data)
|
||||||
|
}
|
||||||
|
|
||||||
|
// removeBrainFile removes the file at abs (inside brainDir) through the
|
||||||
|
// brain root.
|
||||||
|
func removeBrainFile(brainDir, abs string) error {
|
||||||
|
rel, err := filepath.Rel(brainDir, abs)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
return bfs.Remove(filepath.ToSlash(rel))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -23,6 +23,13 @@ func TestReadNoteRefusesSymlinksAndSurvivesSwapRaces(t *testing.T) {
|
|||||||
_, body, _, err := api.ReadNote(brain, "wiki/w/facts/leak.md")
|
_, body, _, err := api.ReadNote(brain, "wiki/w/facts/leak.md")
|
||||||
assert.Error(t, err)
|
assert.Error(t, err)
|
||||||
assert.NotContains(t, body, brainfstest.Sentinel)
|
assert.NotContains(t, body, brainfstest.Sentinel)
|
||||||
|
// A link to a file elsewhere in the brain: os.Root allows it, only the
|
||||||
|
// regular-file check refuses it (hyperguild#171).
|
||||||
|
brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "inlink.md")))
|
||||||
|
_, body, _, err = api.ReadNote(brain, "wiki/w/facts/inlink.md")
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.NotContains(t, body, brainfstest.Sentinel)
|
||||||
|
|
||||||
p := filepath.Join(facts, "r.md")
|
p := filepath.Join(facts, "r.md")
|
||||||
require.NoError(t, os.WriteFile(p, []byte("---\nx: y\n---\ninside"), 0o644))
|
require.NoError(t, os.WriteFile(p, []byte("---\nx: y\n---\ninside"), 0o644))
|
||||||
@@ -39,5 +46,7 @@ func TestReadNoteRefusesSymlinksAndSurvivesSwapRaces(t *testing.T) {
|
|||||||
return s
|
return s
|
||||||
}
|
}
|
||||||
brainfstest.AssertNoLeak(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, read)
|
brainfstest.AssertNoLeak(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, read)
|
||||||
|
inBrain := brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "---\nx: y\n---\ninside", inBrain, 1500*time.Millisecond, read)
|
||||||
brainfstest.AssertNoHang(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, 6*time.Second, func() { _ = read() })
|
brainfstest.AssertNoHang(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, 6*time.Second, func() { _ = read() })
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,36 @@
|
|||||||
|
package api_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#173: a directory symlink inside wiki/ that points elsewhere in
|
||||||
|
// the brain redirected brain_update's write (os.Root follows in-root
|
||||||
|
// intermediate symlinks). Every directory above the note must be real.
|
||||||
|
func TestUpdateNoteRefusesANoteBehindASymlinkedDirectory(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
victim := filepath.Join(brain, "raw", "facts", "v.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("---\ntitle: v\n---\nuntouched\n"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki", "w"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "facts"), filepath.Join(brain, "wiki", "w", "alias")))
|
||||||
|
|
||||||
|
_, _, _, err := api.UpdateNote(brain, api.UpdateNoteOptions{Path: "wiki/w/alias/v.md", Content: "replaced"})
|
||||||
|
assert.ErrorIs(t, err, brainfs.ErrNotRegular)
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Contains(t, string(got), "untouched")
|
||||||
|
|
||||||
|
real := filepath.Join(brain, "wiki", "w", "facts", "r.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(real), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(real, []byte("---\ntitle: r\n---\nold\n"), 0o644))
|
||||||
|
_, _, _, err = api.UpdateNote(brain, api.UpdateNoteOptions{Path: "wiki/w/facts/r.md", Content: "new"})
|
||||||
|
require.NoError(t, err, "positive control: a note in a real directory is updated")
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
package api_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#188: brain_write created a new note with os.MkdirAll +
|
||||||
|
// os.WriteFile by path, so a symlinked wing directory redirected the note
|
||||||
|
// elsewhere in the brain or outside it.
|
||||||
|
func TestWriteNoteRefusesASymlinkedWing(t *testing.T) {
|
||||||
|
for name, target := range map[string]func(t *testing.T, brain string) string{
|
||||||
|
"in-brain": func(t *testing.T, brain string) string {
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "raw"), 0o755))
|
||||||
|
return filepath.Join("..", "raw")
|
||||||
|
},
|
||||||
|
"outside": func(t *testing.T, _ string) string { return t.TempDir() },
|
||||||
|
} {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
||||||
|
link := target(t, brain)
|
||||||
|
require.NoError(t, os.Symlink(link, filepath.Join(brain, "wiki", "lw")))
|
||||||
|
_, err := api.WriteNote(brain, api.WriteNoteOptions{Wing: "lw", Hall: "facts", Filename: "n", Content: "learning"})
|
||||||
|
assert.Error(t, err)
|
||||||
|
resolved := link
|
||||||
|
if !filepath.IsAbs(resolved) {
|
||||||
|
resolved = filepath.Join(brain, "wiki", link)
|
||||||
|
}
|
||||||
|
_, serr := os.Stat(filepath.Join(resolved, "facts"))
|
||||||
|
assert.True(t, os.IsNotExist(serr), "a hall was created at the link's target")
|
||||||
|
|
||||||
|
_, err = api.WriteNote(brain, api.WriteNoteOptions{Wing: "w", Hall: "facts", Filename: "n", Content: "learning"})
|
||||||
|
require.NoError(t, err, "positive control: a real wing is written")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,125 @@
|
|||||||
|
package brain_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#174 / #157 slice 5b: DetectTunnels walked wiki/ and opened
|
||||||
|
// every note with a blocking os.Open, so a FIFO named *.md anywhere under
|
||||||
|
// wiki/ hung every brain_write and brain_update (wikiUpkeep -> AutoTunnel),
|
||||||
|
// and a symlinked note's title became a tunnel candidate.
|
||||||
|
func TestDetectTunnelsReturnsPromptlyWithAFIFOUnderWikiWithAndWithoutAWriter(t *testing.T) {
|
||||||
|
for _, withWriter := range []bool{false, true} {
|
||||||
|
t.Run(fmt.Sprintf("writer=%v", withWriter), func(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
facts := filepath.Join(b, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(facts, "ok.md"), []byte("---\ntitle: Zqinside Phrase\n---\n"), 0o644))
|
||||||
|
fifo := filepath.Join(facts, "f.md")
|
||||||
|
require.NoError(t, syscall.Mkfifo(fifo, 0o644))
|
||||||
|
if withWriter {
|
||||||
|
// A writer held open: a reader that opens the FIFO gets no
|
||||||
|
// EOF and parks, unless the FIFO is never opened.
|
||||||
|
w, err := os.OpenFile(fifo, os.O_RDWR, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
t.Cleanup(func() { _ = w.Close() })
|
||||||
|
}
|
||||||
|
done := make(chan []brain.TunnelCandidate, 1)
|
||||||
|
go func() {
|
||||||
|
cs, _ := brain.DetectTunnels(b, "text mentioning zqinside phrase here")
|
||||||
|
done <- cs
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case cs := <-done:
|
||||||
|
assert.Contains(t, fmt.Sprintf("%+v", cs), "Zqinside Phrase", "positive control")
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
if r, err := os.OpenFile(fifo, os.O_WRONLY|syscall.O_NONBLOCK, 0); err == nil {
|
||||||
|
_ = r.Close()
|
||||||
|
}
|
||||||
|
t.Fatal("DetectTunnels blocked on a FIFO")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDetectTunnelsRefusesSymlinkedNotesAndSurvivesSwapRaces(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
facts := filepath.Join(b, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
// The static note's title differs from the raced note's, so the
|
||||||
|
// harness's "inside was read" floor can only be met by reading r.md.
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(facts, "ok.md"), []byte("---\ntitle: Zqstatic Words\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(facts, "out.md")))
|
||||||
|
inBrain := brainfstest.WriteSentinelAt(t, filepath.Join(b, "raw", "s.md"))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "in.md")))
|
||||||
|
content := "zqstatic words, zqinside phrase and " + brainfstest.Sentinel
|
||||||
|
|
||||||
|
cs, err := brain.DetectTunnels(b, content)
|
||||||
|
require.NoError(t, err)
|
||||||
|
got := fmt.Sprintf("%+v", cs)
|
||||||
|
assert.Contains(t, got, "Zqstatic Words", "positive control")
|
||||||
|
assert.NotContains(t, got, brainfstest.Sentinel)
|
||||||
|
|
||||||
|
p := filepath.Join(facts, "r.md")
|
||||||
|
read := func() string {
|
||||||
|
cs, _ := brain.DetectTunnels(b, content)
|
||||||
|
return fmt.Sprintf("%+v", cs)
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeak(t, p, "---\ntitle: Zqinside Phrase\n---\n", 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "---\ntitle: Zqinside Phrase\n---\n", inBrain, 1500*time.Millisecond, read)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A wiki/ that is not a real directory yields no candidates and no error:
|
||||||
|
// AutoTunnel runs inside brain_write.
|
||||||
|
func TestDetectTunnelsSkipsAWikiThatIsNotARealDirectory(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "raw", "w", "facts"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(b, "raw", "w", "facts", "r.md"), []byte("---\ntitle: Zqrawonly Phrase\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink("raw", filepath.Join(b, "wiki")))
|
||||||
|
cs, err := brain.DetectTunnels(b, "zqrawonly phrase")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Empty(t, cs)
|
||||||
|
}
|
||||||
|
|
||||||
|
// An unreadable directory under wiki/ is a walk error and DetectTunnels
|
||||||
|
// reports it, as filepath.WalkDir did; it is not silently dropped.
|
||||||
|
func TestDetectTunnelsReportsAnUnreadableDirectoryUnderWiki(t *testing.T) {
|
||||||
|
if os.Geteuid() == 0 {
|
||||||
|
t.Skip("root ignores directory permissions")
|
||||||
|
}
|
||||||
|
b := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "w", "facts"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(b, "wiki", "w", "facts", "ok.md"), []byte("---\ntitle: Zqinside Phrase\n---\n"), 0o644))
|
||||||
|
locked := filepath.Join(b, "wiki", "other", "locked")
|
||||||
|
require.NoError(t, os.MkdirAll(locked, 0o755))
|
||||||
|
require.NoError(t, os.Chmod(locked, 0o000))
|
||||||
|
t.Cleanup(func() { _ = os.Chmod(locked, 0o755) })
|
||||||
|
_, err := brain.DetectTunnels(b, "zqinside phrase")
|
||||||
|
assert.ErrorIs(t, err, os.ErrPermission)
|
||||||
|
}
|
||||||
|
|
||||||
|
// _index.md files are generated, not notes: their title never becomes a
|
||||||
|
// candidate.
|
||||||
|
func TestDetectTunnelsSkipsIndexFiles(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
w := filepath.Join(b, "wiki", "w")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(w, "facts"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(w, "_index.md"), []byte("---\ntitle: Zqindex Words\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(w, "facts", "ok.md"), []byte("---\ntitle: Zqinside Phrase\n---\n"), 0o644))
|
||||||
|
cs, err := brain.DetectTunnels(b, "zqindex words and zqinside phrase")
|
||||||
|
require.NoError(t, err)
|
||||||
|
got := fmt.Sprintf("%+v", cs)
|
||||||
|
assert.Contains(t, got, "Zqinside Phrase", "positive control")
|
||||||
|
assert.NotContains(t, got, "Zqindex")
|
||||||
|
}
|
||||||
@@ -7,8 +7,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
@@ -32,7 +30,6 @@ func BuildWingIndex(brainDir, wing string) error {
|
|||||||
if w == "" {
|
if w == "" {
|
||||||
return fmt.Errorf("invalid wing %q", wing)
|
return fmt.Errorf("invalid wing %q", wing)
|
||||||
}
|
}
|
||||||
wingDir := filepath.Join(brainDir, "wiki", w)
|
|
||||||
// Listed and read through the brain root (hyperguild#157): a wing or
|
// Listed and read through the brain root (hyperguild#157): a wing or
|
||||||
// hall that is a symlink is not followed, and notes are regular files.
|
// hall that is a symlink is not followed, and notes are regular files.
|
||||||
bfs, err := brainfs.Open(brainDir)
|
bfs, err := brainfs.Open(brainDir)
|
||||||
@@ -63,8 +60,9 @@ func BuildWingIndex(brainDir, wing string) error {
|
|||||||
fmt.Fprintf(&b, "| %s | [%s](%s/%s.md) | %s |\n", e.Hall, e.Title, e.Hall, e.Slug, e.Created)
|
fmt.Fprintf(&b, "| %s | [%s](%s/%s.md) | %s |\n", e.Hall, e.Title, e.Hall, e.Slug, e.Created)
|
||||||
}
|
}
|
||||||
|
|
||||||
dest := filepath.Join(wingDir, "_index.md")
|
// Written through the brain root, never through a symlinked _index.md
|
||||||
return os.WriteFile(dest, []byte(b.String()), 0o644)
|
// (hyperguild#158).
|
||||||
|
return bfs.PutRegular("wiki/"+w+"/_index.md", []byte(b.String()))
|
||||||
}
|
}
|
||||||
|
|
||||||
// BuildAllWingIndexes regenerates _index.md for every wing under brain/wiki/.
|
// BuildAllWingIndexes regenerates _index.md for every wing under brain/wiki/.
|
||||||
@@ -116,23 +114,6 @@ func collectWingEntries(bfs *brainfs.Brain, wingRel string) ([]noteEntry, error)
|
|||||||
return out, nil
|
return out, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// readTitleAndCreated reads YAML frontmatter for title + created_at; falls
|
|
||||||
// back to slug and file mtime when absent.
|
|
||||||
func readTitleAndCreated(path, slug string) (string, string) {
|
|
||||||
f, err := os.Open(path)
|
|
||||||
if err != nil {
|
|
||||||
return slug, ""
|
|
||||||
}
|
|
||||||
defer func() { _ = f.Close() }()
|
|
||||||
title, created := parseTitleAndCreated(f)
|
|
||||||
if created == "" {
|
|
||||||
if info, err := os.Stat(path); err == nil {
|
|
||||||
created = info.ModTime().UTC().Format("2006-01-02")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return titleOrSlug(title, slug), created
|
|
||||||
}
|
|
||||||
|
|
||||||
// readTitleAndCreatedIn is readTitleAndCreated through the brain root,
|
// readTitleAndCreatedIn is readTitleAndCreated through the brain root,
|
||||||
// regular files only (hyperguild#157).
|
// regular files only (hyperguild#157).
|
||||||
func readTitleAndCreatedIn(bfs *brainfs.Brain, rel, slug string) (string, string) {
|
func readTitleAndCreatedIn(bfs *brainfs.Brain, rel, slug string) (string, string) {
|
||||||
|
|||||||
@@ -2,8 +2,9 @@ package brain
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"io/fs"
|
||||||
"path"
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -39,24 +40,29 @@ type TunnelCandidate struct {
|
|||||||
// A note's title is read from YAML frontmatter `title:`; failing that,
|
// A note's title is read from YAML frontmatter `title:`; failing that,
|
||||||
// the filename slug (sans `.md`, hyphens → spaces) is used.
|
// the filename slug (sans `.md`, hyphens → spaces) is used.
|
||||||
func DetectTunnels(brainDir, content string) ([]TunnelCandidate, error) {
|
func DetectTunnels(brainDir, content string) ([]TunnelCandidate, error) {
|
||||||
wikiDir := filepath.Join(brainDir, "wiki")
|
// Walked and read through the brain root, regular files only
|
||||||
if _, err := os.Stat(wikiDir); os.IsNotExist(err) {
|
// (hyperguild#174, #157): this runs inside every brain_write, so a FIFO
|
||||||
|
// must not block it and a symlinked note's title must not become a
|
||||||
|
// candidate.
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
if _, err := bfs.Lstat("wiki"); errors.Is(err, fs.ErrNotExist) {
|
||||||
return nil, nil
|
return nil, nil
|
||||||
} else if err != nil {
|
|
||||||
return nil, fmt.Errorf("stat wiki: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
lowerContent := strings.ToLower(content)
|
lowerContent := strings.ToLower(content)
|
||||||
|
|
||||||
var out []TunnelCandidate
|
var out []TunnelCandidate
|
||||||
err := filepath.WalkDir(wikiDir, func(path string, d os.DirEntry, err error) error {
|
var walkErr error
|
||||||
if err != nil {
|
err = bfs.WalkRegular("wiki", func(rel string) error {
|
||||||
return err
|
name := path.Base(rel)
|
||||||
}
|
if !strings.HasSuffix(name, ".md") || name == "_index.md" {
|
||||||
if d.IsDir() || !strings.HasSuffix(path, ".md") || d.Name() == "_index.md" {
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
title, _ := readTitleAndCreated(path, strings.TrimSuffix(d.Name(), ".md"))
|
title, _ := readTitleAndCreatedIn(bfs, rel, strings.TrimSuffix(name, ".md"))
|
||||||
title = strings.TrimSpace(title)
|
title = strings.TrimSpace(title)
|
||||||
if title == "" {
|
if title == "" {
|
||||||
return nil
|
return nil
|
||||||
@@ -78,17 +84,25 @@ func DetectTunnels(brainDir, content string) ([]TunnelCandidate, error) {
|
|||||||
if idx == -1 {
|
if idx == -1 {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
rel, err := filepath.Rel(brainDir, path)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
out = append(out, TunnelCandidate{
|
out = append(out, TunnelCandidate{
|
||||||
TargetPath: filepath.ToSlash(rel),
|
TargetPath: rel,
|
||||||
MatchedTerm: title,
|
MatchedTerm: title,
|
||||||
Exact: isWholeWord(haystack, idx, len(needle)),
|
Exact: isWholeWord(haystack, idx, len(needle)),
|
||||||
})
|
})
|
||||||
return nil
|
return nil
|
||||||
|
}, func(rel string, err error) {
|
||||||
|
// A wiki/ that is not a real directory yields no candidates, as
|
||||||
|
// filepath.WalkDir did; other walk errors still abort.
|
||||||
|
if rel == "wiki" && errors.Is(err, brainfs.ErrNotRegular) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if walkErr == nil {
|
||||||
|
walkErr = fmt.Errorf("%s: %w", rel, err)
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
if err == nil {
|
||||||
|
err = walkErr
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -161,35 +175,23 @@ func logFuzzyCandidates(brainDir, sourcePath string, cs []TunnelCandidate) error
|
|||||||
if len(cs) == 0 {
|
if len(cs) == 0 {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
rawDir := filepath.Join(brainDir, "raw")
|
// Appended through the brain root, never through a symlinked raw/ or
|
||||||
if err := os.MkdirAll(rawDir, 0o755); err != nil {
|
// log file (hyperguild#158).
|
||||||
return err
|
bfs, err := brainfs.Open(brainDir)
|
||||||
}
|
|
||||||
stamp := time.Now().UTC().Format("2006-01-02")
|
|
||||||
path := filepath.Join(rawDir, "tunnel-candidates-"+stamp+".md")
|
|
||||||
existed := fileExists(path)
|
|
||||||
f, err := os.OpenFile(path, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o644)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return fmt.Errorf("open brain: %w", err)
|
||||||
}
|
|
||||||
defer func() { _ = f.Close() }()
|
|
||||||
if !existed {
|
|
||||||
if _, err := f.WriteString("# Tunnel candidates " + stamp + "\n\nFuzzy cross-wing matches surfaced by AutoTunnel. Review and promote to a tunnel via `brain_tunnel` if relevant.\n\n"); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
stamp := time.Now().UTC().Format("2006-01-02")
|
||||||
|
rel := "raw/tunnel-candidates-" + stamp + ".md"
|
||||||
|
var buf strings.Builder
|
||||||
|
if _, err := bfs.Lstat(rel); errors.Is(err, fs.ErrNotExist) {
|
||||||
|
buf.WriteString("# Tunnel candidates " + stamp + "\n\nFuzzy cross-wing matches surfaced by AutoTunnel. Review and promote to a tunnel via `brain_tunnel` if relevant.\n\n")
|
||||||
}
|
}
|
||||||
for _, c := range cs {
|
for _, c := range cs {
|
||||||
line := fmt.Sprintf("- `%s` ↔ `%s` (term: %q)\n", sourcePath, c.TargetPath, c.MatchedTerm)
|
fmt.Fprintf(&buf, "- `%s` ↔ `%s` (term: %q)\n", sourcePath, c.TargetPath, c.MatchedTerm)
|
||||||
if _, err := f.WriteString(line); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
}
|
return bfs.AppendRegular(rel, []byte(buf.String()))
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func fileExists(p string) bool {
|
|
||||||
_, err := os.Stat(p)
|
|
||||||
return err == nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// WriteTunnel appends a bidirectional wikilink between sourcePath and
|
// WriteTunnel appends a bidirectional wikilink between sourcePath and
|
||||||
|
|||||||
@@ -0,0 +1,38 @@
|
|||||||
|
package brain_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#173: brain_tunnel's write followed a directory symlink inside
|
||||||
|
// wiki/ that points elsewhere in the brain.
|
||||||
|
func TestWriteTunnelRefusesATargetBehindASymlinkedDirectory(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
src := filepath.Join(b, "wiki", "a", "facts", "s.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(src), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(src, []byte("x\n"), 0o644))
|
||||||
|
victim := filepath.Join(b, "raw", "facts", "v.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched\n"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "b"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "facts"), filepath.Join(b, "wiki", "b", "facts")))
|
||||||
|
|
||||||
|
assert.ErrorIs(t, brain.WriteTunnel(b, "wiki/a/facts/s.md", "wiki/b/facts/v.md"), brainfs.ErrNotRegular)
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "untouched\n", string(got))
|
||||||
|
got, _ = os.ReadFile(src)
|
||||||
|
assert.Equal(t, "x\n", string(got), "the source is not rewritten either")
|
||||||
|
|
||||||
|
real := filepath.Join(b, "wiki", "c", "facts", "t.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(real), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(real, []byte("t\n"), 0o644))
|
||||||
|
require.NoError(t, brain.WriteTunnel(b, "wiki/a/facts/s.md", "wiki/c/facts/t.md"), "positive control: a tunnel between real directories is written")
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
package brain_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#158: BuildWingIndex wrote wiki/<wing>/_index.md with
|
||||||
|
// os.WriteFile, so a symlinked _index.md was written through.
|
||||||
|
func TestBuildWingIndexDoesNotWriteThroughASymlinkedIndex(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "w", "facts"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(b, "wiki", "w", "facts", "n.md"), []byte("---\ntitle: zqn\n---\n"), 0o644))
|
||||||
|
victim := filepath.Join(b, "raw", "v.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "v.md"), filepath.Join(b, "wiki", "w", "_index.md")))
|
||||||
|
assert.Error(t, brain.BuildWingIndex(b, "w"))
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
|
||||||
|
require.NoError(t, os.Remove(filepath.Join(b, "wiki", "w", "_index.md")))
|
||||||
|
require.NoError(t, brain.BuildWingIndex(b, "w"), "positive control")
|
||||||
|
idx, _ := os.ReadFile(filepath.Join(b, "wiki", "w", "_index.md"))
|
||||||
|
assert.Contains(t, string(idx), "zqn")
|
||||||
|
}
|
||||||
|
|
||||||
|
// AutoTunnel's fuzzy-candidate log appended to raw/tunnel-candidates-*.md
|
||||||
|
// with os.OpenFile, so a symlinked raw/ (or log file) was written through.
|
||||||
|
func TestAutoTunnelDoesNotAppendTheCandidateLogThroughASymlinkedRaw(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "a", "facts"), 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "b", "facts"), 0o755))
|
||||||
|
// "zq widget" matches as a substring of "zq widgets", a fuzzy candidate.
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(b, "wiki", "b", "facts", "t.md"), []byte("---\ntitle: Zq Widget\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(b, "raw")))
|
||||||
|
_ = brain.AutoTunnel(b, "wiki/a/facts/s.md", "about zq widgets")
|
||||||
|
ents, _ := os.ReadDir(outside)
|
||||||
|
assert.Empty(t, ents, "the candidate log was written outside the brain")
|
||||||
|
|
||||||
|
require.NoError(t, os.Remove(filepath.Join(b, "raw")))
|
||||||
|
require.NoError(t, brain.AutoTunnel(b, "wiki/a/facts/s.md", "about zq widgets"))
|
||||||
|
logs, _ := filepath.Glob(filepath.Join(b, "raw", "tunnel-candidates-*.md"))
|
||||||
|
assert.Len(t, logs, 1, "positive control: the fuzzy candidate is logged in the real raw/")
|
||||||
|
}
|
||||||
@@ -104,6 +104,17 @@ func (b *Brain) ReadDirRegular(relDir string) ([]string, error) {
|
|||||||
return names, nil
|
return names, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// cleanRel refuses a path that is not clean and local. realDir checks the
|
||||||
|
// cleaned parent, so the I/O must use that same path: os.Root resolves ".."
|
||||||
|
// after following a symlink, and a ".." after a symlinked directory would
|
||||||
|
// otherwise pass the check and redirect the read or write.
|
||||||
|
func cleanRel(rel string) error {
|
||||||
|
if rel == "" || path.Clean(rel) != rel || !filepath.IsLocal(rel) || strings.Contains(rel, "\\") {
|
||||||
|
return fmt.Errorf("%q: not a clean brain-relative path: %w", rel, ErrNotRegular)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// ReadDirDirs lists the real subdirectories directly in a brain-relative
|
// ReadDirDirs lists the real subdirectories directly in a brain-relative
|
||||||
// directory, by name. Every component of relDir must be a real directory
|
// directory, by name. Every component of relDir must be a real directory
|
||||||
// (ErrNotRegular otherwise); symlinks to directories are left out.
|
// (ErrNotRegular otherwise); symlinks to directories are left out.
|
||||||
@@ -125,9 +136,149 @@ func (b *Brain) ReadDirDirs(relDir string) ([]string, error) {
|
|||||||
return names, nil
|
return names, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// PutRegular creates or replaces a regular file at a brain-relative path,
|
||||||
|
// for creating writes (hyperguild#188, #158). Missing parent directories are
|
||||||
|
// created one component at a time through the root, and every existing
|
||||||
|
// component must be a real directory, so a symlinked directory cannot
|
||||||
|
// redirect the write elsewhere in the brain or outside it. An existing file
|
||||||
|
// is replaced only if it is regular (WriteRegular's checks); a new file is
|
||||||
|
// created with O_EXCL and confirmed to be the file that was opened. A
|
||||||
|
// directory swapped in after the checks is the #167 residual.
|
||||||
|
func (b *Brain) PutRegular(rel string, data []byte) error {
|
||||||
|
if err := cleanRel(rel); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := b.mkdirReal(path.Dir(rel)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if _, err := b.root.Lstat(rel); err == nil {
|
||||||
|
return b.WriteRegular(rel, data)
|
||||||
|
} else if !errors.Is(err, fs.ErrNotExist) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return b.createNew(rel, data)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateRegular creates a new regular file at a brain-relative path, with
|
||||||
|
// PutRegular's parent rules, and fails with fs.ErrExist if anything is
|
||||||
|
// already there: for writers that must never overwrite (promote, reject).
|
||||||
|
func (b *Brain) CreateRegular(rel string, data []byte) error {
|
||||||
|
if err := cleanRel(rel); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := b.mkdirReal(path.Dir(rel)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return b.createNew(rel, data)
|
||||||
|
}
|
||||||
|
|
||||||
|
// createNew creates rel with O_EXCL and writes data only after confirming
|
||||||
|
// the path is the regular file it created.
|
||||||
|
func (b *Brain) createNew(rel string, data []byte) error {
|
||||||
|
f, err := b.root.OpenFile(rel, os.O_WRONLY|os.O_CREATE|os.O_EXCL|syscall.O_NOFOLLOW|syscall.O_NONBLOCK, 0o644)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
hfi, herr := f.Stat()
|
||||||
|
lfi, lerr := b.root.Lstat(rel)
|
||||||
|
if herr != nil || lerr != nil || !lfi.Mode().IsRegular() || !os.SameFile(lfi, hfi) {
|
||||||
|
return fmt.Errorf("%s: changed while creating: %w", rel, ErrNotRegular)
|
||||||
|
}
|
||||||
|
if _, err := f.Write(data); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return f.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// AppendRegular appends data to a regular file at a brain-relative path,
|
||||||
|
// creating it (and missing parent directories, as PutRegular does) if it is
|
||||||
|
// absent. It writes only after confirming the path is the regular file it
|
||||||
|
// opened, so a final symlink or special file, or one swapped in, is refused.
|
||||||
|
func (b *Brain) AppendRegular(rel string, data []byte) error {
|
||||||
|
if err := cleanRel(rel); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := b.mkdirReal(path.Dir(rel)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if fi, err := b.root.Lstat(rel); err == nil && !fi.Mode().IsRegular() {
|
||||||
|
return fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
||||||
|
} else if err != nil && !errors.Is(err, fs.ErrNotExist) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
f, err := b.root.OpenFile(rel, os.O_WRONLY|os.O_APPEND|os.O_CREATE|syscall.O_NOFOLLOW|syscall.O_NONBLOCK, 0o644)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
hfi, herr := f.Stat()
|
||||||
|
lfi, lerr := b.root.Lstat(rel)
|
||||||
|
if herr != nil || lerr != nil || !lfi.Mode().IsRegular() || !os.SameFile(lfi, hfi) {
|
||||||
|
return fmt.Errorf("%s: changed while opening: %w", rel, ErrNotRegular)
|
||||||
|
}
|
||||||
|
if _, err := f.Write(data); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return f.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove removes the file at a clean brain-relative path through the root,
|
||||||
|
// refusing a path behind a symlinked directory. A final symlink is removed
|
||||||
|
// itself, never its target.
|
||||||
|
func (b *Brain) Remove(rel string) error {
|
||||||
|
if err := b.RealParent(rel); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return b.root.Remove(rel)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RealParent returns ErrNotRegular unless rel is clean and every directory
|
||||||
|
// above it is a real directory, for writers that do their own I/O (an atomic
|
||||||
|
// rename) but must not be redirected by a symlinked directory.
|
||||||
|
func (b *Brain) RealParent(rel string) error {
|
||||||
|
if err := cleanRel(rel); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return b.realDir(path.Dir(rel))
|
||||||
|
}
|
||||||
|
|
||||||
|
// mkdirReal makes sure every component of rel exists as a real directory,
|
||||||
|
// creating missing ones through the root; an existing component that is
|
||||||
|
// not a real directory is ErrNotRegular.
|
||||||
|
func (b *Brain) mkdirReal(rel string) error {
|
||||||
|
if rel == "." {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
prefix := ""
|
||||||
|
for _, part := range strings.Split(rel, "/") {
|
||||||
|
prefix = path.Join(prefix, part)
|
||||||
|
fi, err := b.root.Lstat(prefix)
|
||||||
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
|
if err := b.root.Mkdir(prefix, 0o755); err != nil && !errors.Is(err, fs.ErrExist) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fi, err = b.root.Lstat(prefix)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !fi.IsDir() {
|
||||||
|
return fmt.Errorf("%s: component %s is not a directory: %w", rel, prefix, ErrNotRegular)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// ReadRegular reads a brain-relative path, refusing anything that is not a
|
// ReadRegular reads a brain-relative path, refusing anything that is not a
|
||||||
// regular file, both before the open and on the opened handle.
|
// regular file, both before the open and on the opened handle.
|
||||||
func (b *Brain) ReadRegular(rel string) ([]byte, error) {
|
func (b *Brain) ReadRegular(rel string) ([]byte, error) {
|
||||||
|
if err := cleanRel(rel); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := b.realDir(path.Dir(rel)); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
fi, err := b.root.Lstat(rel)
|
fi, err := b.root.Lstat(rel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -154,6 +305,12 @@ func (b *Brain) readOpened(rel string) ([]byte, error) { return b.readOpenedMax(
|
|||||||
// ReadRegularMax is ReadRegular with a size limit, checked on the opened
|
// ReadRegularMax is ReadRegular with a size limit, checked on the opened
|
||||||
// handle before reading (max < 0 means no limit).
|
// handle before reading (max < 0 means no limit).
|
||||||
func (b *Brain) ReadRegularMax(rel string, max int64) ([]byte, error) {
|
func (b *Brain) ReadRegularMax(rel string, max int64) ([]byte, error) {
|
||||||
|
if err := cleanRel(rel); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := b.realDir(path.Dir(rel)); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
fi, err := b.root.Lstat(rel)
|
fi, err := b.root.Lstat(rel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -256,10 +413,20 @@ func (b *Brain) WalkRegular(relDir string, fn func(rel string) error, onErr func
|
|||||||
// O_NOFOLLOW (verified on go1.27), so the path is Lstat-ed through the root
|
// O_NOFOLLOW (verified on go1.27), so the path is Lstat-ed through the root
|
||||||
// first and the opened handle must be that same file (os.SameFile), which
|
// first and the opened handle must be that same file (os.SameFile), which
|
||||||
// also catches a swap between the two. O_NONBLOCK keeps a FIFO from blocking
|
// also catches a swap between the two. O_NONBLOCK keeps a FIFO from blocking
|
||||||
// the open. Intermediate in-brain symlinks are still followed (os.Root keeps
|
// the open. Every directory above the file must be a real directory
|
||||||
// the write inside the brain; hyperguild#167).
|
// (hyperguild#173); a directory swapped in after that check is the #167
|
||||||
|
// residual.
|
||||||
func (b *Brain) WriteRegular(rel string, data []byte) error {
|
func (b *Brain) WriteRegular(rel string, data []byte) error {
|
||||||
rel = filepath.ToSlash(rel)
|
if err := cleanRel(rel); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
// Every directory above the file must be real: os.Root follows an
|
||||||
|
// in-brain intermediate symlink, which would redirect the write
|
||||||
|
// elsewhere in the brain (hyperguild#173). A swap after this check is
|
||||||
|
// the #167 residual.
|
||||||
|
if err := b.realDir(path.Dir(rel)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
lfi, err := b.root.Lstat(rel)
|
lfi, err := b.root.Lstat(rel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
|
|||||||
@@ -218,7 +218,7 @@ func TestReadDirRegularListsOnlyRegularFilesAndRefusesSymlinkedComponents(t *tes
|
|||||||
// A final component swapped for a symlink to another regular file in the
|
// A final component swapped for a symlink to another regular file in the
|
||||||
// brain between the Lstat and the open: os.Root follows in-root links, so
|
// brain between the Lstat and the open: os.Root follows in-root links, so
|
||||||
// only comparing the two (os.SameFile) refuses it.
|
// only comparing the two (os.SameFile) refuses it.
|
||||||
func TestReadRegularNeverReturnsAnInBrainFileSwappedInBehindASymlink(t *testing.T) {
|
func TestReadRegularDoesNotReturnAnInBrainFileSwappedInBehindASymlink(t *testing.T) {
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "s.md"), []byte("zqsamefilesentinel"), 0o644))
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "s.md"), []byte("zqsamefilesentinel"), 0o644))
|
||||||
p := filepath.Join(dir, "r.md")
|
p := filepath.Join(dir, "r.md")
|
||||||
@@ -326,3 +326,206 @@ func TestReadDirDirsListsOnlyRealSubdirsAndRefusesSymlinkedComponents(t *testing
|
|||||||
_, err = b.ReadDirDirs("alias")
|
_, err = b.ReadDirDirs("alias")
|
||||||
assert.ErrorIs(t, err, ErrNotRegular)
|
assert.ErrorIs(t, err, ErrNotRegular)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// hyperguild#173: a file reached through a symlinked directory inside the
|
||||||
|
// brain is refused for reads and writes, so a caller-supplied path cannot be
|
||||||
|
// redirected to another part of the brain.
|
||||||
|
func TestReadAndWriteRegularRefuseAFileBehindASymlinkedDirectory(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "alias")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
_, err = b.ReadRegular("wiki/alias/v.md")
|
||||||
|
assert.ErrorIs(t, err, ErrNotRegular)
|
||||||
|
_, err = b.ReadRegularMax("wiki/alias/v.md", 100)
|
||||||
|
assert.ErrorIs(t, err, ErrNotRegular)
|
||||||
|
assert.ErrorIs(t, b.WriteRegular("wiki/alias/v.md", []byte("x")), ErrNotRegular)
|
||||||
|
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
got, err = b.ReadRegular("raw/v.md")
|
||||||
|
require.NoError(t, err, "positive control: the real path still reads")
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
}
|
||||||
|
|
||||||
|
// realDir checks the cleaned parent, so the I/O must use that same clean
|
||||||
|
// path: os.Root resolves ".." after following a symlink, and a ".." placed
|
||||||
|
// after a symlinked directory would otherwise pass the check and redirect.
|
||||||
|
func TestReadAndWriteRegularRefuseAPathThatIsNotClean(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw", "facts"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw", "facts"), filepath.Join(dir, "wiki", "alias")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
for _, rel := range []string{"wiki/alias/../v.md", "./raw/v.md", "raw//v.md", "/raw/v.md"} {
|
||||||
|
got, err := b.ReadRegular(rel)
|
||||||
|
assert.ErrorIs(t, err, ErrNotRegular, rel)
|
||||||
|
assert.NotContains(t, string(got), "untouched", rel)
|
||||||
|
_, err = b.ReadRegularMax(rel, 100)
|
||||||
|
assert.ErrorIs(t, err, ErrNotRegular, rel)
|
||||||
|
assert.ErrorIs(t, b.WriteRegular(rel, []byte("OVERWRITTEN")), ErrNotRegular, rel)
|
||||||
|
}
|
||||||
|
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#188: PutRegular creates or replaces a regular file through the
|
||||||
|
// root. Missing parent directories are created; an existing component that
|
||||||
|
// is not a real directory, a final symlink or special file, and an unclean
|
||||||
|
// path are refused, and nothing is created at a link's target.
|
||||||
|
func TestPutRegularCreatesOrReplacesOnlyThroughRealDirectories(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "inwing")))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(dir, "wiki", "outwing")))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki", "w"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "v.md"), filepath.Join(dir, "wiki", "w", "link.md")))
|
||||||
|
require.NoError(t, syscall.Mkfifo(filepath.Join(dir, "wiki", "w", "f.md"), 0o644))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
for _, rel := range []string{"wiki/inwing/facts/n.md", "wiki/outwing/facts/n.md", "wiki/w/link.md", "wiki/w/f.md", "wiki/w/../../raw/v.md", "/abs.md"} {
|
||||||
|
assert.ErrorIs(t, b.PutRegular(rel, []byte("x")), ErrNotRegular, rel)
|
||||||
|
}
|
||||||
|
ents, _ := os.ReadDir(outside)
|
||||||
|
assert.Empty(t, ents, "nothing created outside the brain")
|
||||||
|
_, err = os.Stat(filepath.Join(dir, "raw", "facts"))
|
||||||
|
assert.True(t, os.IsNotExist(err), "nothing created through the in-brain link")
|
||||||
|
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
|
||||||
|
require.NoError(t, b.PutRegular("wiki/new/facts/n.md", []byte("one")), "positive control: create with missing parents")
|
||||||
|
got, _ = os.ReadFile(filepath.Join(dir, "wiki", "new", "facts", "n.md"))
|
||||||
|
assert.Equal(t, "one", string(got))
|
||||||
|
require.NoError(t, b.PutRegular("wiki/new/facts/n.md", []byte("two")), "positive control: replace")
|
||||||
|
got, _ = os.ReadFile(filepath.Join(dir, "wiki", "new", "facts", "n.md"))
|
||||||
|
assert.Equal(t, "two", string(got))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAppendRegularCreatesOrAppendsOnlyThroughRealDirectories(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(dir, "outdir")))
|
||||||
|
require.NoError(t, os.Symlink("raw", filepath.Join(dir, "indir")))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("raw", "v.md"), filepath.Join(dir, "log.md")))
|
||||||
|
require.NoError(t, syscall.Mkfifo(filepath.Join(dir, "f.md"), 0o644))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
for _, rel := range []string{"outdir/l.md", "indir/v.md", "log.md", "f.md", "raw/../log.md"} {
|
||||||
|
assert.ErrorIs(t, b.AppendRegular(rel, []byte("x")), ErrNotRegular, rel)
|
||||||
|
}
|
||||||
|
ents, _ := os.ReadDir(outside)
|
||||||
|
assert.Empty(t, ents)
|
||||||
|
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
|
||||||
|
require.NoError(t, b.AppendRegular("logs/a.md", []byte("one\n")), "positive control: create")
|
||||||
|
require.NoError(t, b.AppendRegular("logs/a.md", []byte("two\n")), "positive control: append")
|
||||||
|
got, _ = os.ReadFile(filepath.Join(dir, "logs", "a.md"))
|
||||||
|
assert.Equal(t, "one\ntwo\n", string(got))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRealParentRefusesASymlinkedDirectoryOrUncleanPath(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "alias")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
assert.ErrorIs(t, b.RealParent("wiki/alias/x.md"), ErrNotRegular)
|
||||||
|
assert.ErrorIs(t, b.RealParent("wiki/../raw/x.md"), ErrNotRegular)
|
||||||
|
assert.NoError(t, b.RealParent("wiki/x.md"), "positive control")
|
||||||
|
}
|
||||||
|
|
||||||
|
// cleanRel must refuse an unclean path on its own: here the ".." resolves,
|
||||||
|
// after a symlinked directory, to a real regular file, so only the clean
|
||||||
|
// check stands between the call and that file.
|
||||||
|
func TestAppendRegularRefusesAnUncleanPathThatResolvesToARealFile(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw", "keep"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("raw", "keep"), filepath.Join(dir, "indir")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
assert.ErrorIs(t, b.AppendRegular("indir/../v.md", []byte("x")), ErrNotRegular)
|
||||||
|
assert.ErrorIs(t, b.PutRegular("indir/../v.md", []byte("x")), ErrNotRegular)
|
||||||
|
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRemoveRefusesAPathBehindASymlinkedDirectoryAndRemovesOnlyTheLink(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("keep"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "alias")))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw", "v.md"), filepath.Join(dir, "wiki", "link.md")))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "wiki", "n.md"), []byte("n"), 0o644))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
assert.ErrorIs(t, b.Remove("wiki/alias/v.md"), ErrNotRegular)
|
||||||
|
_, err = os.Stat(filepath.Join(dir, "raw", "v.md"))
|
||||||
|
assert.NoError(t, err, "the file behind the symlinked directory is kept")
|
||||||
|
require.NoError(t, b.Remove("wiki/link.md"))
|
||||||
|
_, err = os.Stat(filepath.Join(dir, "raw", "v.md"))
|
||||||
|
assert.NoError(t, err, "removing a final symlink never removes its target")
|
||||||
|
require.NoError(t, b.Remove("wiki/n.md"), "positive control")
|
||||||
|
_, err = os.Stat(filepath.Join(dir, "wiki", "n.md"))
|
||||||
|
assert.True(t, os.IsNotExist(err))
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateRegular is the only write path for promote and reject: it creates
|
||||||
|
// missing parents through the root, refuses an in-brain symlinked parent and
|
||||||
|
// an unclean path, and never replaces anything already there (fs.ErrExist,
|
||||||
|
// content unchanged), including a dangling link.
|
||||||
|
func TestCreateRegularCreatesOnlyNewFilesThroughRealDirectories(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw", "keep"), 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "inwing")))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("raw", "keep"), filepath.Join(dir, "indir")))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "wiki", "exists.md"), []byte("original"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink("nowhere.md", filepath.Join(dir, "wiki", "dangling.md")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
assert.ErrorIs(t, b.CreateRegular("wiki/inwing/facts/n.md", []byte("x")), ErrNotRegular)
|
||||||
|
_, err = os.Stat(filepath.Join(dir, "raw", "facts"))
|
||||||
|
assert.True(t, os.IsNotExist(err), "nothing created through the in-brain link")
|
||||||
|
assert.ErrorIs(t, b.CreateRegular("indir/../v.md", []byte("x")), ErrNotRegular)
|
||||||
|
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
|
||||||
|
assert.ErrorIs(t, b.CreateRegular("wiki/exists.md", []byte("x")), fs.ErrExist)
|
||||||
|
got, _ = os.ReadFile(filepath.Join(dir, "wiki", "exists.md"))
|
||||||
|
assert.Equal(t, "original", string(got))
|
||||||
|
assert.ErrorIs(t, b.CreateRegular("wiki/dangling.md", []byte("x")), fs.ErrExist)
|
||||||
|
_, err = os.Stat(filepath.Join(dir, "wiki", "nowhere.md"))
|
||||||
|
assert.True(t, os.IsNotExist(err), "nothing created at the dangling link's target")
|
||||||
|
|
||||||
|
require.NoError(t, b.CreateRegular("wiki/new/facts/n.md", []byte("one")), "positive control: create with missing parents")
|
||||||
|
got, _ = os.ReadFile(filepath.Join(dir, "wiki", "new", "facts", "n.md"))
|
||||||
|
assert.Equal(t, "one", string(got))
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
// Package brainfstest is the shared harness for hyperguild#157's swap-race
|
// Package brainfstest is the shared harness for hyperguild#157's swap-race
|
||||||
// tests: it keeps swapping a regular note, a symlink to an outside file, or a
|
// tests: it keeps swapping a regular note, a symlink to a sentinel target file
|
||||||
// FIFO (with a writer held open) into a path while a reader under test loops.
|
// (outside the brain, or inside it for hyperguild#171), or a FIFO (with a
|
||||||
// It observes two things: no sentinel byte from the outside file reaches the
|
// writer held open) into a path while a reader under test loops.
|
||||||
// reader's output, and the reader returns within a timeout. It does not cover
|
// It observes two things, over a sampled window only: no sentinel byte from
|
||||||
|
// the target reaches the reader's output, and the reader returns within a
|
||||||
|
// timeout. It does not cover
|
||||||
// hard links, other paths into the reader, or races it does not generate.
|
// hard links, other paths into the reader, or races it does not generate.
|
||||||
package brainfstest
|
package brainfstest
|
||||||
|
|
||||||
@@ -18,7 +20,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Sentinel marks the outside file's contents.
|
// Sentinel marks the target file's contents.
|
||||||
const Sentinel = "zqbrainfssentinelonefiftyseven"
|
const Sentinel = "zqbrainfssentinelonefiftyseven"
|
||||||
|
|
||||||
// outsideContent carries Sentinel in every field a reader might extract: the
|
// outsideContent carries Sentinel in every field a reader might extract: the
|
||||||
@@ -141,7 +143,7 @@ func AssertNoLeakFrom(t testing.TB, path, inside, target string, d time.Duration
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if leaks > 0 {
|
if leaks > 0 {
|
||||||
t.Fatalf("outside file leaked %d times in %d iterations", leaks, iters)
|
t.Fatalf("symlink target %s leaked %d times in %d iterations", target, leaks, iters)
|
||||||
}
|
}
|
||||||
if n := swaps.Load(); n == 0 {
|
if n := swaps.Load(); n == 0 {
|
||||||
t.Fatalf("no symlink was swapped into %s in %d iterations: the race did not run", path, iters)
|
t.Fatalf("no symlink was swapped into %s in %d iterations: the race did not run", path, iters)
|
||||||
|
|||||||
@@ -21,6 +21,11 @@ func TestReadExcerptRefusesSymlinksAndSurvivesSwapRaces(t *testing.T) {
|
|||||||
require.NoError(t, os.MkdirAll(facts, 0o755))
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(facts, "leak.md")))
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(facts, "leak.md")))
|
||||||
assert.NotContains(t, readExcerpt(brain, "wiki/w/facts/leak.md", 500), brainfstest.Sentinel)
|
assert.NotContains(t, readExcerpt(brain, "wiki/w/facts/leak.md", 500), brainfstest.Sentinel)
|
||||||
|
// A link to a file elsewhere in the brain: os.Root allows it, only the
|
||||||
|
// regular-file check refuses it (hyperguild#171).
|
||||||
|
inBrain := brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "inlink.md")))
|
||||||
|
assert.NotContains(t, readExcerpt(brain, "wiki/w/facts/inlink.md", 500), brainfstest.Sentinel)
|
||||||
|
|
||||||
p := filepath.Join(facts, "r.md")
|
p := filepath.Join(facts, "r.md")
|
||||||
require.NoError(t, os.WriteFile(p, []byte("---\nx: y\n---\ninside"), 0o644))
|
require.NoError(t, os.WriteFile(p, []byte("---\nx: y\n---\ninside"), 0o644))
|
||||||
@@ -28,6 +33,9 @@ func TestReadExcerptRefusesSymlinksAndSurvivesSwapRaces(t *testing.T) {
|
|||||||
brainfstest.AssertNoLeak(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, func() string {
|
brainfstest.AssertNoLeak(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, func() string {
|
||||||
return readExcerpt(brain, "wiki/w/facts/r.md", 500)
|
return readExcerpt(brain, "wiki/w/facts/r.md", 500)
|
||||||
})
|
})
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "---\nx: y\n---\ninside", inBrain, 1500*time.Millisecond, func() string {
|
||||||
|
return readExcerpt(brain, "wiki/w/facts/r.md", 500)
|
||||||
|
})
|
||||||
brainfstest.AssertNoHang(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, 6*time.Second, func() {
|
brainfstest.AssertNoHang(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, 6*time.Second, func() {
|
||||||
_ = readExcerpt(brain, "wiki/w/facts/r.md", 500)
|
_ = readExcerpt(brain, "wiki/w/facts/r.md", 500)
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -0,0 +1,36 @@
|
|||||||
|
package notes
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#188/#173: brain_edit's atomic rename must not be redirected by
|
||||||
|
// a symlinked directory inside the brain.
|
||||||
|
func TestEditRefusesANoteBehindASymlinkedDirectory(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
// Edit refuses a tree that is not the sync source before any path
|
||||||
|
// check, so the test needs a .git to reach the symlink refusal.
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, ".git"), 0o755))
|
||||||
|
victim := filepath.Join(b, "raw", "facts", "v.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("old text\n"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "w"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "facts"), filepath.Join(b, "wiki", "w", "alias")))
|
||||||
|
_, err := Edit(b, "wiki/w/alias/v.md", "old text", "new text", ScopeNotes)
|
||||||
|
assert.Error(t, err)
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "old text\n", string(got))
|
||||||
|
|
||||||
|
real := filepath.Join(b, "wiki", "w", "facts", "r.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(real), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(real, []byte("old text\n"), 0o644))
|
||||||
|
_, err = Edit(b, "wiki/w/facts/r.md", "old text", "new text", ScopeNotes)
|
||||||
|
require.NoError(t, err, "positive control: a note in a real directory is edited")
|
||||||
|
got, _ = os.ReadFile(real)
|
||||||
|
assert.Equal(t, "new text\n", string(got))
|
||||||
|
}
|
||||||
@@ -38,3 +38,31 @@ func TestReadScopedRefusesANoteOverMaxNoteBytes(t *testing.T) {
|
|||||||
_, err := ReadScoped(brain, "wiki/w/facts/big.md", ScopeNotes)
|
_, err := ReadScoped(brain, "wiki/w/facts/big.md", ScopeNotes)
|
||||||
assert.ErrorIs(t, err, ErrTooLarge)
|
assert.ErrorIs(t, err, ErrTooLarge)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// hyperguild#171 (review of #172, finding 1): os.Root alone refuses links that
|
||||||
|
// leave the brain, so the outside-target race above stays green for a reader
|
||||||
|
// that skips brainfs's Lstat and SameFile checks. An in-brain target (raw/,
|
||||||
|
// outside ScopeNotes) is what tells them apart.
|
||||||
|
func TestReadScopedDoesNotReturnAnInBrainSymlinkTargetStaticallyOrDuringASampledSwapRace(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
facts := filepath.Join(brain, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
target := brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "inlink.md")))
|
||||||
|
b, err := ReadScoped(brain, "wiki/w/facts/inlink.md", ScopeNotes)
|
||||||
|
assert.Error(t, err, "static in-brain link")
|
||||||
|
assert.NotContains(t, string(b), brainfstest.Sentinel, "static in-brain link")
|
||||||
|
|
||||||
|
p := filepath.Join(facts, "r.md")
|
||||||
|
require.NoError(t, os.WriteFile(p, []byte("inside"), 0o644))
|
||||||
|
b, err = ReadScoped(brain, "wiki/w/facts/r.md", ScopeNotes)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "inside", string(b), "positive control: a regular note reads")
|
||||||
|
|
||||||
|
read := func() string {
|
||||||
|
b, _ := ReadScoped(brain, "wiki/w/facts/r.md", ScopeNotes)
|
||||||
|
return string(b)
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "inside", target, 1500*time.Millisecond, read)
|
||||||
|
}
|
||||||
|
|||||||
@@ -28,7 +28,6 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
|
||||||
"regexp"
|
"regexp"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@@ -102,25 +101,6 @@ func Apply(content string, s Stamp) (string, error) {
|
|||||||
return out, nil
|
return out, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ApplyFile applies the stamp to the note at absPath in place.
|
|
||||||
func ApplyFile(absPath string, s Stamp) error {
|
|
||||||
b, err := os.ReadFile(absPath)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("read for provenance: %w", err)
|
|
||||||
}
|
|
||||||
out, err := Apply(string(b), s)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if out == string(b) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if err := os.WriteFile(absPath, []byte(out), 0o644); err != nil {
|
|
||||||
return fmt.Errorf("write provenance: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// plainGroups keeps the provably plain key groups of a frontmatter block.
|
// plainGroups keeps the provably plain key groups of a frontmatter block.
|
||||||
func plainGroups(block string) string {
|
func plainGroups(block string) string {
|
||||||
lines := strings.Split(strings.TrimSuffix(block, "\n"), "\n")
|
lines := strings.Split(strings.TrimSuffix(block, "\n"), "\n")
|
||||||
|
|||||||
@@ -12,6 +12,8 @@ import (
|
|||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
)
|
)
|
||||||
|
|
||||||
// hyperguild#157 option 1: search walked and read the brain by path, so a
|
// hyperguild#157 option 1: search walked and read the brain by path, so a
|
||||||
@@ -189,3 +191,49 @@ func TestHydrateRefusesASymlink(t *testing.T) {
|
|||||||
assert.Error(t, err)
|
assert.Error(t, err)
|
||||||
assert.NotContains(t, r.Excerpt, sentinel157)
|
assert.NotContains(t, r.Excerpt, sentinel157)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// hyperguild#171: os.Root refuses links that leave the brain on its own, so
|
||||||
|
// the outside-target cases above would stay green for a caller that read
|
||||||
|
// without brainfs's Lstat and SameFile checks. These targets are inside the
|
||||||
|
// brain (raw/, which is not a search root).
|
||||||
|
func inBrainTarget(t *testing.T, brain string) string {
|
||||||
|
t.Helper()
|
||||||
|
return brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestQueryDoesNotReturnAnInBrainSymlinkTargetDuringASampledSwapRace(t *testing.T) {
|
||||||
|
brain, facts, _ := searchBrain(t)
|
||||||
|
target := inBrainTarget(t, brain)
|
||||||
|
read := func() string {
|
||||||
|
// Both terms, so the regular note is a possible hit: a reader that
|
||||||
|
// never returns the inside note would pass vacuously (#177 floor).
|
||||||
|
rs, _ := Query(brain, QueryOptions{Query: brainfstest.Sentinel + " zqinside", Limit: 10})
|
||||||
|
s := ""
|
||||||
|
for _, r := range rs {
|
||||||
|
s += r.Title + r.Excerpt
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeakFrom(t, filepath.Join(facts, "r.md"), "# r\n\nzqinside", target, 1500*time.Millisecond, read)
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "inlink.md")))
|
||||||
|
assert.NotContains(t, read(), brainfstest.Sentinel, "static in-brain link")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHydrateRefusesAnInBrainSymlinkAndDoesNotReturnItsTargetDuringASampledSwapRace(t *testing.T) {
|
||||||
|
brain, facts, _ := searchBrain(t)
|
||||||
|
target := inBrainTarget(t, brain)
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "inlink.md")))
|
||||||
|
r, err := hydrate(brain, "wiki/w/facts/inlink.md")
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.NotContains(t, r.Excerpt+r.Title, brainfstest.Sentinel)
|
||||||
|
|
||||||
|
p := filepath.Join(facts, "r.md")
|
||||||
|
require.NoError(t, os.WriteFile(p, []byte("# r\n\nzqinside"), 0o644))
|
||||||
|
r, err = hydrate(brain, "wiki/w/facts/r.md")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, r.Excerpt, "zqinside", "positive control: a regular note hydrates")
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "# r\n\nzqinside", target, 1500*time.Millisecond, func() string {
|
||||||
|
r, _ := hydrate(brain, "wiki/w/facts/r.md")
|
||||||
|
return r.Title + r.Excerpt
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,14 +2,17 @@ package session
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"sync/atomic"
|
||||||
"syscall"
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
)
|
)
|
||||||
|
|
||||||
// session_log passed the caller's session_id straight into
|
// session_log passed the caller's session_id straight into
|
||||||
@@ -90,3 +93,85 @@ func TestAppendReturnsPromptlyOnAFIFOLogWithNoReader(t *testing.T) {
|
|||||||
t.Fatal("Append blocked on a FIFO log with no reader")
|
t.Fatal("Append blocked on a FIFO log with no reader")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// hyperguild#173: session_log followed a symlinked sessions dir.
|
||||||
|
func TestAppendRefusesASymlinkedSessionsDir(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
elsewhere := filepath.Join(root, "elsewhere")
|
||||||
|
require.NoError(t, os.MkdirAll(elsewhere, 0o755))
|
||||||
|
dir := filepath.Join(root, "sessions")
|
||||||
|
require.NoError(t, os.Symlink("elsewhere", dir))
|
||||||
|
assert.Error(t, Append(dir, "s", Entry{SessionID: "s"}))
|
||||||
|
ents, _ := os.ReadDir(elsewhere)
|
||||||
|
assert.Empty(t, ents, "a log was created through the symlinked dir")
|
||||||
|
}
|
||||||
|
|
||||||
|
// The sessions dir is swapped (RENAME_EXCHANGE) with a symlink to a
|
||||||
|
// directory outside the brain while Append runs. Append opens through an
|
||||||
|
// os.Root on the sessions dir's parent, so a swap can redirect it only
|
||||||
|
// inside that parent (the #167 residual), never outside it.
|
||||||
|
func TestAppendNeverCreatesALogOutsideTheParentUnderADirSwapRace(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
dir := filepath.Join(brain, "sessions")
|
||||||
|
other := filepath.Join(brain, "sessions.link")
|
||||||
|
require.NoError(t, os.MkdirAll(dir, 0o755))
|
||||||
|
require.NoError(t, os.Symlink(outside, other))
|
||||||
|
var stop atomic.Bool
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
defer close(done)
|
||||||
|
for !stop.Load() {
|
||||||
|
_ = unix.Renameat2(unix.AT_FDCWD, dir, unix.AT_FDCWD, other, unix.RENAME_EXCHANGE)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
ok := 0
|
||||||
|
for i := 0; i < 20000; i++ {
|
||||||
|
if Append(dir, fmt.Sprintf("s%d", i), Entry{SessionID: "s"}) == nil {
|
||||||
|
ok++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
stop.Store(true)
|
||||||
|
<-done
|
||||||
|
ents, _ := os.ReadDir(outside)
|
||||||
|
assert.Empty(t, ents, "logs were created outside the brain")
|
||||||
|
assert.Positive(t, ok, "positive control: appends to the real dir succeed")
|
||||||
|
}
|
||||||
|
|
||||||
|
// The log file is swapped between a regular file and a symlink to another
|
||||||
|
// file in the brain while Append runs: Append writes only after confirming
|
||||||
|
// the path is the regular file it opened, so the other file never grows.
|
||||||
|
func TestAppendNeverWritesThroughALogSwappedForASymlink(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
dir := filepath.Join(brain, "sessions")
|
||||||
|
require.NoError(t, os.MkdirAll(dir, 0o755))
|
||||||
|
victim := filepath.Join(brain, "victim.md")
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched\n"), 0o644))
|
||||||
|
log := filepath.Join(dir, "s.jsonl")
|
||||||
|
var stop atomic.Bool
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
defer close(done)
|
||||||
|
tmp := log + ".swap"
|
||||||
|
for i := 0; !stop.Load(); i++ {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
if i%2 == 0 {
|
||||||
|
_ = os.WriteFile(tmp, nil, 0o644)
|
||||||
|
} else {
|
||||||
|
_ = os.Symlink(filepath.Join("..", "victim.md"), tmp)
|
||||||
|
}
|
||||||
|
_ = os.Rename(tmp, log)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
ok := 0
|
||||||
|
for i := 0; i < 20000; i++ {
|
||||||
|
if Append(dir, "s", Entry{SessionID: "s"}) == nil {
|
||||||
|
ok++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
stop.Store(true)
|
||||||
|
<-done
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "untouched\n", string(got), "a log line was written through the swapped-in symlink")
|
||||||
|
assert.Positive(t, ok, "positive control: appends to the regular log succeed")
|
||||||
|
}
|
||||||
|
|||||||
@@ -65,14 +65,42 @@ func Append(sessionsDir, sessionID string, entry Entry) error {
|
|||||||
if err := checkID(sessionID); err != nil {
|
if err := checkID(sessionID); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := os.MkdirAll(sessionsDir, 0o755); err != nil {
|
// Opened through an os.Root on the sessions dir's parent (the brain dir),
|
||||||
|
// so a sessions dir swapped for a symlink after the check below can
|
||||||
|
// redirect the log only inside that parent, never outside it (#173; the
|
||||||
|
// in-brain swap is the #167 residual).
|
||||||
|
parentDir, name := filepath.Dir(sessionsDir), filepath.Base(sessionsDir)
|
||||||
|
if err := os.MkdirAll(parentDir, 0o755); err != nil {
|
||||||
|
return fmt.Errorf("create sessions parent: %w", err)
|
||||||
|
}
|
||||||
|
root, err := os.OpenRoot(parentDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("open sessions parent: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = root.Close() }()
|
||||||
|
if err := root.Mkdir(name, 0o755); err != nil && !errors.Is(err, fs.ErrExist) {
|
||||||
return fmt.Errorf("create sessions dir: %w", err)
|
return fmt.Errorf("create sessions dir: %w", err)
|
||||||
}
|
}
|
||||||
path := filepath.Join(sessionsDir, sessionID+".jsonl")
|
// The sessions dir itself must be a real directory, not a symlink that
|
||||||
f, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY|syscall.O_NOFOLLOW|syscall.O_NONBLOCK, 0o644)
|
// redirects the log elsewhere (hyperguild#173).
|
||||||
|
if fi, err := root.Lstat(name); err != nil {
|
||||||
|
return fmt.Errorf("stat sessions dir: %w", err)
|
||||||
|
} else if !fi.IsDir() {
|
||||||
|
return fmt.Errorf("sessions dir %s is not a real directory", sessionsDir)
|
||||||
|
}
|
||||||
|
logRel := name + "/" + sessionID + ".jsonl"
|
||||||
|
f, err := root.OpenFile(logRel, os.O_CREATE|os.O_APPEND|os.O_WRONLY|syscall.O_NOFOLLOW|syscall.O_NONBLOCK, 0o644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("open session log: %w", err)
|
return fmt.Errorf("open session log: %w", err)
|
||||||
}
|
}
|
||||||
|
// os.Root follows an in-root final symlink even with O_NOFOLLOW, so
|
||||||
|
// confirm, before writing, that the path is the regular file we opened.
|
||||||
|
hfi, herr := f.Stat()
|
||||||
|
lfi, lerr := root.Lstat(logRel)
|
||||||
|
if herr != nil || lerr != nil || !lfi.Mode().IsRegular() || !os.SameFile(lfi, hfi) {
|
||||||
|
_ = f.Close()
|
||||||
|
return fmt.Errorf("session log %s is not a regular file", logRel)
|
||||||
|
}
|
||||||
|
|
||||||
line, err := json.Marshal(entry)
|
line, err := json.Marshal(entry)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -42,6 +42,11 @@ func TestSyncRefusesSymlinkedNotesAndSurvivesSwapRaces(t *testing.T) {
|
|||||||
brain := t.TempDir()
|
brain := t.TempDir()
|
||||||
writeNote(t, brain, "wiki/w/facts/ok.md", "inside note")
|
writeNote(t, brain, "wiki/w/facts/ok.md", "inside note")
|
||||||
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(brain, "wiki", "w", "facts", "leak.md")))
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(brain, "wiki", "w", "facts", "leak.md")))
|
||||||
|
// A link to a file elsewhere in the brain: os.Root allows it, only the
|
||||||
|
// regular-file checks refuse it (hyperguild#171). raw/ is not a scan root,
|
||||||
|
// so its sentinel can only arrive through the link.
|
||||||
|
inBrain := brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(brain, "wiki", "w", "facts", "inlink.md")))
|
||||||
|
|
||||||
emb := &recordingEmbedder{}
|
emb := &recordingEmbedder{}
|
||||||
store := &stubStore{}
|
store := &stubStore{}
|
||||||
@@ -51,6 +56,7 @@ func TestSyncRefusesSymlinkedNotesAndSurvivesSwapRaces(t *testing.T) {
|
|||||||
assert.NotContains(t, emb.all(), brainfstest.Sentinel)
|
assert.NotContains(t, emb.all(), brainfstest.Sentinel)
|
||||||
for p := range store.upserts {
|
for p := range store.upserts {
|
||||||
assert.NotContains(t, p, "leak.md")
|
assert.NotContains(t, p, "leak.md")
|
||||||
|
assert.NotContains(t, p, "inlink.md")
|
||||||
}
|
}
|
||||||
|
|
||||||
p := filepath.Join(brain, "knowledge", "r.md")
|
p := filepath.Join(brain, "knowledge", "r.md")
|
||||||
@@ -61,6 +67,7 @@ func TestSyncRefusesSymlinkedNotesAndSurvivesSwapRaces(t *testing.T) {
|
|||||||
return e.all()
|
return e.all()
|
||||||
}
|
}
|
||||||
brainfstest.AssertNoLeak(t, p, "inside", 1500*time.Millisecond, sync)
|
brainfstest.AssertNoLeak(t, p, "inside", 1500*time.Millisecond, sync)
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "inside", inBrain, 1500*time.Millisecond, sync)
|
||||||
brainfstest.AssertNoHang(t, p, "inside", 1500*time.Millisecond, 6*time.Second, func() { _ = sync() })
|
brainfstest.AssertNoHang(t, p, "inside", 1500*time.Millisecond, 6*time.Second, func() { _ = sync() })
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -3,8 +3,6 @@ package wiki
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
@@ -50,8 +48,8 @@ func RebuildIndex(brainDir, date string) error {
|
|||||||
sb.WriteString("\n")
|
sb.WriteString("\n")
|
||||||
}
|
}
|
||||||
|
|
||||||
dest := filepath.Join(brainDir, "wiki", "index.md")
|
// Written through the brain root, never through a symlink (#158).
|
||||||
return os.WriteFile(dest, []byte(sb.String()), 0o644)
|
return bfs.PutRegular("wiki/index.md", []byte(sb.String()))
|
||||||
}
|
}
|
||||||
|
|
||||||
// pageFirstSentence reads the page through the brain root, regular files
|
// pageFirstSentence reads the page through the brain root, regular files
|
||||||
|
|||||||
@@ -3,8 +3,7 @@ package wiki
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -27,14 +26,14 @@ func AppendLog(brainDir, source string, pages, warnings []string, date string) e
|
|||||||
}
|
}
|
||||||
sb.WriteString("\n")
|
sb.WriteString("\n")
|
||||||
|
|
||||||
logPath := filepath.Join(brainDir, "log.md")
|
// Appended through the brain root, never through a symlink (#158).
|
||||||
f, err := os.OpenFile(logPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o644)
|
bfs, err := brainfs.Open(brainDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("open log: %w", err)
|
return fmt.Errorf("open brain: %w", err)
|
||||||
}
|
}
|
||||||
if _, err = f.WriteString(sb.String()); err != nil {
|
defer func() { _ = bfs.Close() }()
|
||||||
f.Close() //nolint:errcheck
|
if err := bfs.AppendRegular("log.md", []byte(sb.String())); err != nil {
|
||||||
return fmt.Errorf("write log: %w", err)
|
return fmt.Errorf("write log: %w", err)
|
||||||
}
|
}
|
||||||
return f.Close()
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,35 @@
|
|||||||
|
package wiki
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#158: RebuildIndex wrote wiki/index.md and AppendLog appended
|
||||||
|
// log.md with os.WriteFile / os.OpenFile, so a symlinked file was written
|
||||||
|
// through.
|
||||||
|
func TestRebuildIndexAndAppendLogDoNotWriteThroughSymlinks(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "concepts"), 0o755))
|
||||||
|
victim := filepath.Join(b, "raw", "v.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw", "v.md"), filepath.Join(b, "wiki", "index.md")))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("raw", "v.md"), filepath.Join(b, "log.md")))
|
||||||
|
|
||||||
|
assert.Error(t, RebuildIndex(b, "2026-10-05"))
|
||||||
|
assert.Error(t, AppendLog(b, "src", []string{"p"}, nil, "2026-10-05"))
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
|
||||||
|
require.NoError(t, os.Remove(filepath.Join(b, "wiki", "index.md")))
|
||||||
|
require.NoError(t, os.Remove(filepath.Join(b, "log.md")))
|
||||||
|
require.NoError(t, RebuildIndex(b, "2026-10-05"), "positive control")
|
||||||
|
require.NoError(t, AppendLog(b, "src", []string{"p"}, nil, "2026-10-05"), "positive control")
|
||||||
|
l, _ := os.ReadFile(filepath.Join(b, "log.md"))
|
||||||
|
assert.Contains(t, string(l), "src")
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user