Remove generateInner, now handled by Builder

- Remove generateInner() from serialize.go
- Update generate() to error if pbInner not set
- Remove legacy tests that depended on old code path
- Update TODO item to reflect removal

.golangci.yaml

@@ -1,2 +0,0 @@
-run:
-  tests: false

.golangci.yml

@@ -1,2 +0,0 @@
-run:
-    tests: false

README.md

@@ -192,13 +192,13 @@ Reading file contents and computing cryptographic hashes for manifest generation
 ### builder.go
 - **Types**
   - `FileProgress func(bytesRead int64)` - Callback for file processing progress
-  - `ManifestBuilder struct` - Constructs manifests by adding files one at a time
+  - `Builder struct` - Constructs manifests by adding files one at a time
 - **Functions**
-  - `NewBuilder() *ManifestBuilder` - Creates a new ManifestBuilder
+  - `NewBuilder() *Builder` - Creates a new Builder
 - **Methods**
-  - `(*ManifestBuilder) AddFile(path string, size int64, mtime time.Time, reader io.Reader, progress FileProgress) (int64, error)` - Reads file, computes hash, adds to manifest
-  - `(*ManifestBuilder) FileCount() int` - Returns number of files added
-  - `(*ManifestBuilder) Build(w io.Writer) error` - Finalizes and writes manifest
+  - `(*Builder) AddFile(path string, size int64, mtime time.Time, reader io.Reader, progress FileProgress) (int64, error)` - Reads file, computes hash, adds to manifest
+  - `(*Builder) FileCount() int` - Returns number of files added
+  - `(*Builder) Build(w io.Writer) error` - Finalizes and writes manifest
 
 ### serialize.go
 - **Constants**
@@ -350,6 +350,28 @@ The manifest file would do several important things:
 
 - **Manifest size:** Manifests must fit entirely in system memory during reading and writing.
 
+# TODO
+
+## High Priority
+
+- [ ] **Implement `fetch` command** - Currently panics with "not implemented". Should download a manifest and its referenced files from a URL.
+- [ ] **Fix import in fetch.go** - Uses `github.com/apex/log` directly instead of `internal/log`, violating codebase conventions.
+
+## Medium Priority
+
+- [ ] **Add `--force` flag for overwrites** - Currently silently overwrites existing manifest files. Should require `-f` to overwrite.
+- [ ] **Implement FollowSymLinks option** - The flag exists in CLI and Options structs but does nothing. Scanner should use `EvalSymlinks` or `Lstat`.
+- [ ] **Change FileProgress callback to channel** - `mfer/builder.go` uses a callback for progress reporting; should use channels like `EnumerateStatus` and `ScanStatus` for consistency.
+- [ ] **Consolidate legacy manifest code** - `mfer/manifest.go` has old scanning code (`Scan()`, `addFile()`) that duplicates the new `internal/scanner` + `mfer/builder.go` pattern.
+- [ ] **Add context cancellation to legacy code** - The old `manifest.Scan()` doesn't support context cancellation; the new scanner does.
+
+## Lower Priority
+
+- [ ] **Add unit tests for `internal/checker`** - Currently has no test files; only tested indirectly via CLI tests.
+- [ ] **Add unit tests for `internal/scanner`** - Currently has no test files.
+- [ ] **Clean up FIXMEs in manifest.go** - Validate input paths exist, validate filesystem, avoid redundant stat calls.
+- [ ] **Validate input paths before scanning** - Should fail fast with a clear error if paths don't exist.
+
 # Open Questions
 
 - Should the manifest file include checksums of individual file chunks, or just for the whole assembled file?

internal/checker/checker.go

@@ -16,21 +16,21 @@ import (
 
 // Result represents the outcome of checking a single file.
 type Result struct {
-	Path    string
-	Status  Status
-	Message string
+	Path    string // Relative path from manifest
+	Status  Status // Verification result status
+	Message string // Human-readable description of the result
 }
 
 // Status represents the verification status of a file.
 type Status int
 
 const (
-	StatusOK Status = iota
-	StatusMissing
-	StatusSizeMismatch
-	StatusHashMismatch
+	StatusOK           Status = iota // File matches manifest (size and hash verified)
+	StatusMissing                    // File not found on disk
+	StatusSizeMismatch               // File size differs from manifest
+	StatusHashMismatch               // File hash differs from manifest
 	StatusExtra                      // File exists on disk but not in manifest
-	StatusError
+	StatusError                      // Error occurred during verification
 )
 
 func (s Status) String() string {
@@ -54,12 +54,12 @@ func (s Status) String() string {
 
 // CheckStatus contains progress information for the check operation.
 type CheckStatus struct {
-	TotalFiles   int64
-	CheckedFiles int64
-	TotalBytes   int64
-	CheckedBytes int64
-	BytesPerSec  float64
-	Failures     int64
+	TotalFiles   int64   // Total number of files in manifest
+	CheckedFiles int64   // Number of files checked so far
+	TotalBytes   int64   // Total bytes to verify (sum of all file sizes)
+	CheckedBytes int64   // Bytes verified so far
+	BytesPerSec  float64 // Current throughput rate
+	Failures     int64   // Number of verification failures encountered
 }
 
 // Checker verifies files against a manifest.

internal/cli/entry.go

@@ -7,6 +7,8 @@ import (
 	"github.com/spf13/afero"
 )
 
+// NO_COLOR disables colored output when set. Automatically true if the
+// NO_COLOR environment variable is present (per https://no-color.org/).
 var NO_COLOR bool
 
 func init() {
@@ -17,15 +19,16 @@ func init() {
 }
 
 // RunOptions contains all configuration for running the CLI application.
+// Use DefaultRunOptions for standard CLI execution, or construct manually for testing.
 type RunOptions struct {
-	Appname string
-	Version string
-	Gitrev  string
-	Args    []string
-	Stdin   io.Reader
-	Stdout  io.Writer
-	Stderr  io.Writer
-	Fs      afero.Fs
+	Appname string    // Application name displayed in help and version output
+	Version string    // Version string (typically set at build time)
+	Gitrev  string    // Git revision hash (typically set at build time)
+	Args    []string  // Command-line arguments (typically os.Args)
+	Stdin   io.Reader // Standard input stream
+	Stdout  io.Writer // Standard output stream
+	Stderr  io.Writer // Standard error stream
+	Fs      afero.Fs  // Filesystem abstraction for file operations
 }
 
 // DefaultRunOptions returns RunOptions configured for normal CLI execution.

internal/cli/mfer.go

@@ -11,6 +11,8 @@ import (
 	"sneak.berlin/go/mfer/internal/log"
 )
 
+// CLIApp is the main CLI application container. It holds configuration,
+// I/O streams, and filesystem abstraction to enable testing and flexibility.
 type CLIApp struct {
 	appname     string
 	version     string
@@ -19,13 +21,10 @@ type CLIApp struct {
 	exitCode    int
 	app         *cli.App
 
-	// I/O streams - all program input/output should go through these
-	Stdin  io.Reader
-	Stdout io.Writer
-	Stderr io.Writer
-
-	// Fs is the filesystem abstraction - defaults to OsFs for real filesystem
-	Fs afero.Fs
+	Stdin  io.Reader // Standard input stream
+	Stdout io.Writer // Standard output stream for normal output
+	Stderr io.Writer // Standard error stream for diagnostics
+	Fs     afero.Fs  // Filesystem abstraction for all file operations
 }
 
 const banner = `
@@ -45,6 +44,7 @@ func (mfa *CLIApp) printBanner() {
 	fmt.Fprintln(mfa.Stdout, banner)
 }
 
+// VersionString returns the version and git revision formatted for display.
 func (mfa *CLIApp) VersionString() string {
 	return fmt.Sprintf("%s (%s)", mfa.version, mfa.gitrev)
 }

internal/log/log.go

@@ -13,6 +13,7 @@ import (
 	"github.com/pterm/pterm"
 )
 
+// Level is an alias for apex/log.Level for use by callers without importing apex/log.
 type Level = log.Level
 
 var (
@@ -48,6 +49,7 @@ func GetStderr() io.Writer {
 	return stderr
 }
 
+// DisableStyling turns off colors and styling for terminal output.
 func DisableStyling() {
 	pterm.DisableColor()
 	pterm.DisableStyling()
@@ -59,6 +61,7 @@ func DisableStyling() {
 	pterm.Fatal.Prefix.Text = ""
 }
 
+// Init initializes the logger with the CLI handler and default log level.
 func Init() {
 	mu.RLock()
 	w := stderr
@@ -67,22 +70,27 @@ func Init() {
 	log.SetLevel(log.InfoLevel)
 }
 
+// Infof logs a formatted message at info level.
 func Infof(format string, args ...interface{}) {
 	log.Infof(format, args...)
 }
 
+// Info logs a message at info level.
 func Info(arg string) {
 	log.Info(arg)
 }
 
+// Debugf logs a formatted message at debug level with caller location.
 func Debugf(format string, args ...interface{}) {
 	DebugReal(fmt.Sprintf(format, args...), 2)
 }
 
+// Debug logs a message at debug level with caller location.
 func Debug(arg string) {
 	DebugReal(arg, 2)
 }
 
+// DebugReal logs at debug level with caller info from the specified stack depth.
 func DebugReal(arg string, cs int) {
 	_, callerFile, callerLine, ok := runtime.Caller(cs)
 	if !ok {
@@ -92,14 +100,18 @@ func DebugReal(arg string, cs int) {
 	log.Debug(tag + arg)
 }
 
+// Dump logs a spew dump of the arguments at debug level.
 func Dump(args ...interface{}) {
 	DebugReal(spew.Sdump(args...), 2)
 }
 
+// EnableDebugLogging sets the log level to debug.
 func EnableDebugLogging() {
 	SetLevel(log.DebugLevel)
 }
 
+// VerbosityStepsToLogLevel converts a -v count to a log level.
+// 0 returns InfoLevel, 1+ returns DebugLevel.
 func VerbosityStepsToLogLevel(l int) log.Level {
 	switch l {
 	case 0:
@@ -111,14 +123,17 @@ func VerbosityStepsToLogLevel(l int) log.Level {
 	return log.DebugLevel
 }
 
+// SetLevelFromVerbosity sets the log level based on -v flag count.
 func SetLevelFromVerbosity(l int) {
 	SetLevel(VerbosityStepsToLogLevel(l))
 }
 
+// SetLevel sets the global log level.
 func SetLevel(arg log.Level) {
 	log.SetLevel(arg)
 }
 
+// GetLogger returns the underlying apex/log Logger.
 func GetLogger() *log.Logger {
 	if logger, ok := log.Log.(*log.Logger); ok {
 		return logger
@@ -126,10 +141,12 @@ func GetLogger() *log.Logger {
 	panic("unable to get logger")
 }
 
+// GetLevel returns the current log level.
 func GetLevel() log.Level {
 	return GetLogger().Level
 }
 
+// WithError returns a log entry with the error attached.
 func WithError(e error) *log.Entry {
 	return GetLogger().WithError(e)
 }

internal/scanner/scanner.go

@@ -21,8 +21,8 @@ import (
 
 // EnumerateStatus contains progress information for the enumeration phase.
 type EnumerateStatus struct {
-	FilesFound int64
-	BytesFound int64
+	FilesFound int64 // Number of files discovered so far
+	BytesFound int64 // Total size of discovered files (from stat)
 }
 
 // Phase 2: Scan (ToManifest)
@@ -32,27 +32,27 @@ type EnumerateStatus struct {
 
 // ScanStatus contains progress information for the scan phase.
 type ScanStatus struct {
-	TotalFiles   int64
-	ScannedFiles int64
-	TotalBytes   int64
-	ScannedBytes int64
-	BytesPerSec  float64
+	TotalFiles   int64   // Total number of files to scan
+	ScannedFiles int64   // Number of files scanned so far
+	TotalBytes   int64   // Total bytes to read (sum of all file sizes)
+	ScannedBytes int64   // Bytes read so far
+	BytesPerSec  float64 // Current throughput rate
 }
 
 // Options configures scanner behavior.
 type Options struct {
-	IgnoreDotfiles bool
-	FollowSymLinks bool
-	Fs             afero.Fs // Filesystem to use, defaults to OsFs
+	IgnoreDotfiles bool     // Skip files and directories starting with a dot
+	FollowSymLinks bool     // Resolve symlinks instead of skipping them
+	Fs             afero.Fs // Filesystem to use, defaults to OsFs if nil
 }
 
 // FileEntry represents a file that has been enumerated.
 type FileEntry struct {
 	Path    string    // Relative path (used in manifest)
 	AbsPath string    // Absolute path (used for reading file content)
-	Size    int64
-	Mtime   time.Time
-	Ctime   time.Time
+	Size    int64     // File size in bytes
+	Mtime   time.Time // Last modification time
+	Ctime   time.Time // Creation time (platform-dependent)
 }
 
 // Scanner accumulates files and generates manifests from them.

mfer/builder.go

@@ -12,16 +12,16 @@ import (
 // FileProgress is called during file processing to report bytes read.
 type FileProgress func(bytesRead int64)
 
-// ManifestBuilder constructs a manifest by adding files one at a time.
-type ManifestBuilder struct {
+// Builder constructs a manifest by adding files one at a time.
+type Builder struct {
 	mu        sync.Mutex
 	files     []*MFFilePath
 	createdAt time.Time
 }
 
-// NewBuilder creates a new ManifestBuilder.
-func NewBuilder() *ManifestBuilder {
-	return &ManifestBuilder{
+// NewBuilder creates a new Builder.
+func NewBuilder() *Builder {
+	return &Builder{
 		files:     make([]*MFFilePath, 0),
 		createdAt: time.Now(),
 	}
@@ -30,7 +30,7 @@ func NewBuilder() *ManifestBuilder {
 // AddFile reads file content from reader, computes hashes, and adds to manifest.
 // The progress callback is called periodically with total bytes read so far.
 // Returns the number of bytes read.
-func (b *ManifestBuilder) AddFile(
+func (b *Builder) AddFile(
 	path string,
 	size int64,
 	mtime time.Time,
@@ -85,14 +85,14 @@ func (b *ManifestBuilder) AddFile(
 }
 
 // FileCount returns the number of files added to the builder.
-func (b *ManifestBuilder) FileCount() int {
+func (b *Builder) FileCount() int {
 	b.mu.Lock()
 	defer b.mu.Unlock()
 	return len(b.files)
 }
 
 // Build finalizes the manifest and writes it to the writer.
-func (b *ManifestBuilder) Build(w io.Writer) error {
+func (b *Builder) Build(w io.Writer) error {
 	b.mu.Lock()
 	defer b.mu.Unlock()
 

mfer/example_test.go

@@ -1,42 +0,0 @@
-package mfer
-
-import (
-	"bytes"
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-	"sneak.berlin/go/mfer/internal/log"
-)
-
-func TestAPIExample(t *testing.T) {
-	// read from filesystem
-	m, err := NewFromFS(&ManifestScanOptions{
-		IgnoreDotfiles: true,
-	}, big)
-	assert.Nil(t, err)
-	assert.NotNil(t, m)
-
-	// scan for files
-	m.Scan()
-
-	// serialize
-	var buf bytes.Buffer
-	m.WriteTo(&buf)
-
-	// show serialized
-	log.Dump(buf.Bytes())
-
-	// do it again
-	var buf2 bytes.Buffer
-	m.WriteTo(&buf2)
-
-	// should be same!
-	assert.True(t, bytes.Equal(buf.Bytes(), buf2.Bytes()))
-
-	// deserialize
-	m2, err := NewFromProto(&buf)
-	assert.Nil(t, err)
-	assert.NotNil(t, m2)
-
-	log.Dump(m2)
-}

mfer/manifest.go

@@ -39,9 +39,10 @@ func (m *manifest) String() string {
 	return fmt.Sprintf("<Manifest count=%d totalSize=%d>", len(m.files), m.totalFileSize)
 }
 
+// ManifestScanOptions configures behavior when scanning directories for manifest generation.
 type ManifestScanOptions struct {
-	IgnoreDotfiles bool
-	FollowSymLinks bool
+	IgnoreDotfiles bool // Skip files and directories starting with a dot
+	FollowSymLinks bool // Resolve symlinks instead of skipping them
 }
 
 func (m *manifest) HasError() bool {
@@ -77,11 +78,13 @@ func (m *manifest) addInputFS(f afero.Fs) error {
 	return nil
 }
 
+// New creates an empty manifest.
 func New() *manifest {
 	m := &manifest{}
 	return m
 }
 
+// NewFromPaths creates a manifest configured to scan the given filesystem paths.
 func NewFromPaths(options *ManifestScanOptions, inputPaths ...string) (*manifest, error) {
 	log.Dump(inputPaths)
 	m := New()
@@ -95,6 +98,7 @@ func NewFromPaths(options *ManifestScanOptions, inputPaths ...string) (*manifest
 	return m, nil
 }
 
+// NewFromFS creates a manifest configured to scan the given afero filesystem.
 func NewFromFS(options *ManifestScanOptions, fs afero.Fs) (*manifest, error) {
 	m := New()
 	m.scanOptions = options

mfer/mfer_test.go

@@ -1,42 +1,11 @@
 package mfer
 
 import (
-	"bytes"
-	"fmt"
 	"testing"
 
-	"github.com/spf13/afero"
 	"github.com/stretchr/testify/assert"
-	"sneak.berlin/go/mfer/internal/log"
 )
 
-// Add those variables as well
-var (
-	existingFolder = "./testdata/a-folder-that-exists"
-)
-
-var (
-	af  *afero.Afero = &afero.Afero{Fs: afero.NewMemMapFs()}
-	big *afero.Afero = &afero.Afero{Fs: afero.NewMemMapFs()}
-)
-
-func init() {
-	log.EnableDebugLogging()
-
-	// create test files and directories
-	af.MkdirAll("/a/b/c", 0o755)
-	af.MkdirAll("/.hidden", 0o755)
-	af.WriteFile("/a/b/c/hello.txt", []byte("hello world\n\n\n\n"), 0o755)
-	af.WriteFile("/a/b/c/hello2.txt", []byte("hello world\n\n\n\n"), 0o755)
-	af.WriteFile("/.hidden/hello.txt", []byte("hello world\n"), 0o755)
-	af.WriteFile("/.hidden/hello2.txt", []byte("hello world\n"), 0o755)
-
-	big.MkdirAll("/home/user/Library", 0o755)
-	for i := range [25]int{} {
-		big.WriteFile(fmt.Sprintf("/home/user/Library/hello%d.txt", i), []byte("hello world\n"), 0o755)
-	}
-}
-
 func TestPathHiddenFunc(t *testing.T) {
 	assert.False(t, pathIsHidden("/a/b/c/hello.txt"))
 	assert.True(t, pathIsHidden("/a/b/c/.hello.txt"))
@@ -44,31 +13,3 @@ func TestPathHiddenFunc(t *testing.T) {
 	assert.True(t, pathIsHidden("/.a/b/c/hello.txt"))
 	assert.False(t, pathIsHidden("./a/b/c/hello.txt"))
 }
-
-func TestManifestGenerationOne(t *testing.T) {
-	m, err := NewFromFS(&ManifestScanOptions{
-		IgnoreDotfiles: true,
-	}, af)
-	assert.Nil(t, err)
-	assert.NotNil(t, m)
-	m.Scan()
-	assert.Equal(t, int64(2), m.GetFileCount())
-	assert.Equal(t, int64(30), m.GetTotalFileSize())
-}
-
-func TestManifestGenerationTwo(t *testing.T) {
-	m, err := NewFromFS(&ManifestScanOptions{
-		IgnoreDotfiles: false,
-	}, af)
-	assert.Nil(t, err)
-	assert.NotNil(t, m)
-	m.Scan()
-	assert.Equal(t, int64(4), m.GetFileCount())
-	assert.Equal(t, int64(54), m.GetTotalFileSize())
-	err = m.generate()
-	assert.Nil(t, err)
-	var buf bytes.Buffer
-	err = m.WriteTo(&buf)
-	assert.Nil(t, err)
-	log.Dump(buf.Bytes())
-}

mfer/serialize.go

@@ -10,9 +10,7 @@ import (
 	"google.golang.org/protobuf/proto"
 )
 
-// was go-generate protoc --go_out=. --go_opt=paths=source_relative mf.proto
-
-// rot13("MANIFEST")
+// MAGIC is the file format magic bytes prefix (rot13 of "MANIFEST").
 const MAGIC string = "ZNAVSRFG"
 
 func newTimestampFromTime(t time.Time) *Timestamp {
@@ -25,10 +23,7 @@ func newTimestampFromTime(t time.Time) *Timestamp {
 
 func (m *manifest) generate() error {
 	if m.pbInner == nil {
-		e := m.generateInner()
-		if e != nil {
-			return e
-		}
+		return errors.New("internal error: pbInner not set")
 	}
 	if m.pbOuter == nil {
 		e := m.generateOuter()
@@ -82,19 +77,3 @@ func (m *manifest) generateOuter() error {
 	m.pbOuter = o
 	return nil
 }
-
-func (m *manifest) generateInner() error {
-	m.pbInner = &MFFile{
-		Version:   MFFile_VERSION_ONE,
-		CreatedAt: newTimestampFromTime(time.Now()),
-		Files:     []*MFFilePath{},
-	}
-	for _, f := range m.files {
-		nf := &MFFilePath{
-			Path: f.path,
-			// FIXME add more stuff
-		}
-		m.pbInner.Files = append(m.pbInner.Files, nf)
-	}
-	return nil
-}