feat(config): library.allow_delete, off by default, for deleting duplicate files
The one setting that lets Sonda delete files from the music folders. Off until the operator turns it on, in the file or with SONDA_ALLOW_DELETE; a value that is not true or false is an error, not ignored.
This commit is contained in:
parent
a64122efdd
commit
309160951e
2 changed files with 62 additions and 0 deletions
|
|
@ -11,6 +11,7 @@ import (
|
|||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"github.com/pelletier/go-toml/v2"
|
||||
|
|
@ -41,6 +42,10 @@ type Server struct {
|
|||
// in the database and are managed through the API.
|
||||
type Library struct {
|
||||
ScanWorkers int `toml:"scan_workers"` // parallel tag readers per scan
|
||||
// AllowDelete lets an admin delete the extra copies of a song from the music folders. It is the
|
||||
// one thing that makes Sonda write there, so it is off until the operator turns it on (and it
|
||||
// needs the folders mounted writable).
|
||||
AllowDelete bool `toml:"allow_delete"`
|
||||
}
|
||||
|
||||
// Database selects and configures the storage backend.
|
||||
|
|
@ -172,6 +177,14 @@ func Load(path string) (Config, error) {
|
|||
}
|
||||
|
||||
applyEnv(&cfg)
|
||||
// A typo here must not be ignored in silence: it decides whether Sonda may delete files.
|
||||
if v := os.Getenv("SONDA_ALLOW_DELETE"); v != "" {
|
||||
allow, err := strconv.ParseBool(v)
|
||||
if err != nil {
|
||||
return Config{}, fmt.Errorf("SONDA_ALLOW_DELETE must be true or false, got %q", v)
|
||||
}
|
||||
cfg.Library.AllowDelete = allow
|
||||
}
|
||||
if cfg.Storage.DataDir == "" {
|
||||
cfg.Storage.DataDir = defaultDataDir(cfg.Database)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -292,3 +292,52 @@ func TestLoadRefusesTheOldLastFMEnvironmentVariable(t *testing.T) {
|
|||
t.Errorf("the error repeats the key: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Deleting files from the music folders is the one thing Sonda does not do unless it is told to.
|
||||
func TestDeletingIsOffByDefault(t *testing.T) {
|
||||
cfg, err := Load("")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if cfg.Library.AllowDelete {
|
||||
t.Error("library.allow_delete is on by default")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAllowDeleteIsReadFromTheFile(t *testing.T) {
|
||||
cfg, err := Load(writeFile(t, t.TempDir(), "[library]\nallow_delete = true\n"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !cfg.Library.AllowDelete {
|
||||
t.Error("allow_delete = true in the file was not read")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAllowDeleteEnvironmentVariableWinsOverTheFile(t *testing.T) {
|
||||
p := writeFile(t, t.TempDir(), "[library]\nallow_delete = true\n")
|
||||
t.Setenv("SONDA_ALLOW_DELETE", "false")
|
||||
cfg, err := Load(p)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if cfg.Library.AllowDelete {
|
||||
t.Error("SONDA_ALLOW_DELETE=false did not turn it off")
|
||||
}
|
||||
t.Setenv("SONDA_ALLOW_DELETE", "true")
|
||||
cfg, err = Load("")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !cfg.Library.AllowDelete {
|
||||
t.Error("SONDA_ALLOW_DELETE=true did not turn it on")
|
||||
}
|
||||
}
|
||||
|
||||
// A typo in a setting that lets Sonda delete files must not be ignored in silence.
|
||||
func TestAllowDeleteEnvironmentVariableMustBeABoolean(t *testing.T) {
|
||||
t.Setenv("SONDA_ALLOW_DELETE", "yes please")
|
||||
if _, err := Load(""); err == nil || !strings.Contains(err.Error(), "SONDA_ALLOW_DELETE") {
|
||||
t.Errorf("got %v, want an error naming SONDA_ALLOW_DELETE", err)
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue