From 573ce1982da2e754947453fdaf0d50204873acb4 Mon Sep 17 00:00:00 2001 From: René 'Necoro' Neumann Date: Sat, 25 Apr 2020 17:00:57 +0200 Subject: Larger restructuring --- internal/yaml/yaml.go | 138 ----------------------- internal/yaml/yaml_test.go | 273 --------------------------------------------- 2 files changed, 411 deletions(-) delete mode 100644 internal/yaml/yaml.go delete mode 100644 internal/yaml/yaml_test.go (limited to 'internal/yaml') diff --git a/internal/yaml/yaml.go b/internal/yaml/yaml.go deleted file mode 100644 index 23a38ef..0000000 --- a/internal/yaml/yaml.go +++ /dev/null @@ -1,138 +0,0 @@ -package yaml - -import ( - "fmt" - "io/ioutil" - - "gopkg.in/yaml.v3" - - C "github.com/Necoro/feed2imap-go/internal/config" - F "github.com/Necoro/feed2imap-go/internal/feed" - "github.com/Necoro/feed2imap-go/internal/log" -) - -type config struct { - C.GlobalOptions `yaml:",inline"` - GlobalConfig C.Map `yaml:",inline"` - Feeds []configGroupFeed -} - -type group struct { - Group string - Feeds []configGroupFeed -} - -type feed struct { - Name string - Url string - C.Options `yaml:",inline"` -} - -type configGroupFeed struct { - Target *string - Feed feed `yaml:",inline"` - Group group `yaml:",inline"` -} - -func (grpFeed *configGroupFeed) isGroup() bool { - return grpFeed.Group.Group != "" -} - -func (grpFeed *configGroupFeed) isFeed() bool { - return grpFeed.Feed.Name != "" || grpFeed.Feed.Url != "" -} - -func (grpFeed *configGroupFeed) target() string { - if grpFeed.Target != nil { - return *grpFeed.Target - } - if grpFeed.Feed.Name != "" { - return grpFeed.Feed.Name - } - - return grpFeed.Group.Group -} - -func parse(buf []byte) (config, error) { - parsedCfg := config{GlobalOptions: C.DefaultGlobalOptions} - - if err := yaml.Unmarshal(buf, &parsedCfg); err != nil { - return config{}, fmt.Errorf("while unmarshalling: %w", err) - } - //fmt.Printf("--- parsedCfg:\n%+v\n\n", parsedCfg) - - return parsedCfg, nil -} - -func appTarget(target []string, app string) []string { - switch { - case len(target) == 0 && app == "": - return []string{} - case len(target) == 0: - return []string{app} - case app == "": - return target - default: - return append(target, app) - } -} - -// Parse the group structure and populate the `Target` fields in the feeds -func buildFeeds(cfg []configGroupFeed, target []string, feeds *F.Feeds) error { - for idx := range cfg { - f := &cfg[idx] // cannot use `_, f := range cfg` as it returns copies(!), but we need the originals - target := appTarget(target, f.target()) - switch { - case f.isFeed() && f.isGroup(): - return fmt.Errorf("Entry with Target %s is both a Feed and a group", target) - - case f.isFeed(): - name := f.Feed.Name - if name == "" { - return fmt.Errorf("Unnamed feed") - } - - if feeds.Contains(name) { - return fmt.Errorf("Duplicate Feed Name '%s'", name) - } - feeds.Set(name, &F.Feed{ - Name: f.Feed.Name, - Target: target, - Url: f.Feed.Url, - Options: f.Feed.Options, - }) - - case f.isGroup(): - if err := buildFeeds(f.Group.Feeds, target, feeds); err != nil { - return err - } - } - } - - return nil -} - -func Load(path string) (*C.Config, *F.Feeds, error) { - log.Printf("Reading configuration file '%s'", path) - - buf, err := ioutil.ReadFile(path) - if err != nil { - return nil, nil, fmt.Errorf("while reading '%s': %w", path, err) - } - - var parsedCfg config - if parsedCfg, err = parse(buf); err != nil { - return nil, nil, err - } - - feeds := F.NewFeeds() - - if err := buildFeeds(parsedCfg.Feeds, []string{}, feeds); err != nil { - return nil, nil, fmt.Errorf("while parsing: %w", err) - } - - return &C.Config{ - GlobalOptions: parsedCfg.GlobalOptions, - GlobalConfig: parsedCfg.GlobalConfig, - }, feeds, nil -} diff --git a/internal/yaml/yaml_test.go b/internal/yaml/yaml_test.go deleted file mode 100644 index 9562ef8..0000000 --- a/internal/yaml/yaml_test.go +++ /dev/null @@ -1,273 +0,0 @@ -package yaml - -import ( - "reflect" - "strings" - "testing" - - C "github.com/Necoro/feed2imap-go/internal/config" - F "github.com/Necoro/feed2imap-go/internal/feed" -) - -func s(s string) *string { return &s } -func b(b bool) *bool { return &b } -func t(s string) []string { - if s == "" { - return []string{} - } - return strings.Split(s, ".") -} - -func TestBuildFeeds(tst *testing.T) { - tests := []struct { - name string - wantErr bool - target string - feeds []configGroupFeed - result F.Feeds - }{ - {name: "Empty input", wantErr: false, target: "", feeds: nil, result: F.Feeds{}}, - {name: "Empty Feed", wantErr: true, target: "", - feeds: []configGroupFeed{ - {Target: s("foo"), Feed: feed{Url: "google.de"}}, - }, result: F.Feeds{}}, - {name: "Empty Feed", wantErr: true, target: "", - feeds: []configGroupFeed{ - {Target: nil, Feed: feed{Url: "google.de"}}, - }, result: F.Feeds{}}, - {name: "Duplicate Feed Name", wantErr: true, target: "", - feeds: []configGroupFeed{ - {Target: nil, Feed: feed{Name: "Dup"}}, - {Target: nil, Feed: feed{Name: "Dup"}}, - }, result: F.Feeds{}}, - {name: "Simple", wantErr: false, target: "", - feeds: []configGroupFeed{ - {Target: s("foo"), Feed: feed{Name: "muh"}}, - }, - result: F.Feeds{"muh": &F.Feed{Name: "muh", Target: t("foo")}}, - }, - {name: "Simple With Target", wantErr: false, target: "moep", - feeds: []configGroupFeed{ - {Target: s("foo"), Feed: feed{Name: "muh"}}, - }, - result: F.Feeds{"muh": &F.Feed{Name: "muh", Target: t("moep.foo")}}, - }, - {name: "Simple With Nil Target", wantErr: false, target: "moep", - feeds: []configGroupFeed{ - {Target: nil, Feed: feed{Name: "muh"}}, - }, - result: F.Feeds{"muh": &F.Feed{Name: "muh", Target: t("moep.muh")}}, - }, - {name: "Simple With Empty Target", wantErr: false, target: "moep", - feeds: []configGroupFeed{ - {Target: s(""), Feed: feed{Name: "muh"}}, - }, - result: F.Feeds{"muh": &F.Feed{Name: "muh", Target: t("moep")}}, - }, - {name: "Multiple Feeds", wantErr: false, target: "moep", - feeds: []configGroupFeed{ - {Target: s("foo"), Feed: feed{Name: "muh"}}, - {Target: nil, Feed: feed{Name: "bar"}}, - }, - result: F.Feeds{ - "muh": &F.Feed{Name: "muh", Target: t("moep.foo")}, - "bar": &F.Feed{Name: "bar", Target: t("moep.bar")}, - }, - }, - {name: "Empty Group", wantErr: false, target: "", - feeds: []configGroupFeed{ - {Target: nil, Group: group{Group: "G1"}}, - }, - result: F.Feeds{}, - }, - {name: "Simple Group", wantErr: false, target: "", - feeds: []configGroupFeed{ - {Target: nil, Group: group{Group: "G1", Feeds: []configGroupFeed{ - {Target: s("bar"), Feed: feed{Name: "F1"}}, - {Target: s(""), Feed: feed{Name: "F2"}}, - {Target: nil, Feed: feed{Name: "F3"}}, - }}}, - }, - result: F.Feeds{ - "F1": &F.Feed{Name: "F1", Target: t("G1.bar")}, - "F2": &F.Feed{Name: "F2", Target: t("G1")}, - "F3": &F.Feed{Name: "F3", Target: t("G1.F3")}, - }, - }, - {name: "Nested Groups", wantErr: false, target: "", - feeds: []configGroupFeed{ - {Target: nil, Group: group{Group: "G1", Feeds: []configGroupFeed{ - {Target: nil, Feed: feed{Name: "F0"}}, - {Target: s("bar"), Group: group{Group: "G2", - Feeds: []configGroupFeed{{Target: nil, Feed: feed{Name: "F1"}}}}}, - {Target: s(""), Group: group{Group: "G3", - Feeds: []configGroupFeed{{Target: s("baz"), Feed: feed{Name: "F2"}}}}}, - {Target: nil, Group: group{Group: "G4", - Feeds: []configGroupFeed{{Target: nil, Feed: feed{Name: "F3"}}}}}, - }}}, - }, - result: F.Feeds{ - "F0": &F.Feed{Name: "F0", Target: t("G1.F0")}, - "F1": &F.Feed{Name: "F1", Target: t("G1.bar.F1")}, - "F2": &F.Feed{Name: "F2", Target: t("G1.baz")}, - "F3": &F.Feed{Name: "F3", Target: t("G1.G4.F3")}, - }, - }, - } - for _, tt := range tests { - tst.Run(tt.name, func(tst *testing.T) { - var feeds = F.Feeds{} - err := buildFeeds(tt.feeds, t(tt.target), feeds) - if (err != nil) != tt.wantErr { - tst.Errorf("buildFeeds() error = %v, wantErr %v", err, tt.wantErr) - return - } - if !tt.wantErr && !reflect.DeepEqual(feeds, tt.result) { - tst.Errorf("buildFeeds() got = %v, want %v", feeds, tt.result) - } - }) - } -} - -func defaultConfig(feeds []configGroupFeed, global C.Map) config { - return config{ - GlobalOptions: C.DefaultGlobalOptions, - GlobalConfig: global, - Feeds: feeds, - } -} - -//noinspection GoNilness,GoNilness -func TestParse(tst *testing.T) { - tests := []struct { - name string - inp string - wantErr bool - config config - }{ - {name: "Empty", - inp: "", wantErr: false, config: defaultConfig(nil, nil)}, - {name: "Trash", inp: "Something", wantErr: true}, - {name: "Simple config", - inp: "something: 1\nsomething_else: 2", wantErr: false, config: defaultConfig(nil, C.Map{"something": 1, "something_else": 2})}, - {name: "Known config", - inp: "whatever: 2\ndefault-email: foo@foobar.de\ntimeout: 60\nsomething: 1", wantErr: false, config: func() config { - c := defaultConfig(nil, C.Map{"something": 1, "whatever": 2}) - c.Timeout = 60 - c.DefaultEmail = "foo@foobar.de" - return c - }()}, - {name: "Config with feed", - inp: ` -something: 1 -feeds: - - name: Foo - url: whatever - target: bar - include-images: true - unknown-option: foo -`, - wantErr: false, - config: defaultConfig([]configGroupFeed{ - {Target: s("bar"), Feed: feed{ - Name: "Foo", - Url: "whatever", - Options: C.Options{ - MinFreq: 0, - InclImages: b(true), - }, - }}}, C.Map{"something": 1})}, - - {name: "Feeds", - inp: ` -feeds: - - name: Foo - url: whatever - min-frequency: 2 - - name: Shrubbery - url: google.de - target: bla - include-images: false -`, - wantErr: false, - config: defaultConfig([]configGroupFeed{ - {Target: nil, Feed: feed{ - Name: "Foo", - Url: "whatever", - Options: C.Options{ - MinFreq: 2, - InclImages: nil, - }, - }}, - {Target: s("bla"), Feed: feed{ - Name: "Shrubbery", - Url: "google.de", - Options: C.Options{ - MinFreq: 0, - InclImages: b(false), - }, - }}, - }, nil), - }, - {name: "Empty Group", - inp: ` -feeds: - - group: Foo - target: bla -`, - wantErr: false, - config: defaultConfig([]configGroupFeed{{Target: s("bla"), Group: group{"Foo", nil}}}, nil), - }, - {name: "Feeds and Groups", - inp: ` -feeds: - - name: Foo - url: whatever - - group: G1 - target: target - feeds: - - group: G2 - target: "" - feeds: - - name: F1 - url: google.de - - name: F2 - - group: G3 -`, - wantErr: false, - config: defaultConfig([]configGroupFeed{ - {Target: nil, Feed: feed{ - Name: "Foo", - Url: "whatever", - }}, - {Target: s("target"), Group: group{ - Group: "G1", - Feeds: []configGroupFeed{ - {Target: s(""), Group: group{ - Group: "G2", - Feeds: []configGroupFeed{ - {Target: nil, Feed: feed{Name: "F1", Url: "google.de"}}, - }}, - }, - {Target: nil, Feed: feed{Name: "F2"}}, - {Target: nil, Group: group{Group: "G3"}}, - }}, - }, - }, nil), - }, - } - - for _, tt := range tests { - tst.Run(tt.name, func(tst *testing.T) { - var buf = []byte(tt.inp) - got, err := parse(buf) - if (err != nil) != tt.wantErr { - tst.Errorf("parse() error = %v, wantErr %v", err, tt.wantErr) - return - } - if err == nil && !reflect.DeepEqual(got, tt.config) { - tst.Errorf("parse() got = %#v, want %#v", got, tt.config) - } - }) - } -} -- cgit v1.2.3-54-g00ecf