formats/config: Added encoder/decoder for git config files. (#97)

* WIP: Add config format parser.

* add decoder based on gcfg.

Portions of code taken from:
https://github.com/go-gcfg/gcfg/blob/5b9f94ee80b2331c3982477bd84be8edd857df33/read.go

* add git config encoder and config methods.

* use format/config in storage/filesystem for read

* use format/config in storage/filesystem to write

* formats/config: improve docs.

* formats/config: improve tests.

* formats/config: use our fork of gcfg; improve api.

* formats/config: improve api.

* storage/filesystem: fix gofmt

* formats/config: use NoSubsection constant.

* formats/config: add doc.go

* formats/config: requested sytle changes.

* formats/config: do not use *_test packages.

1 files changed, 90 insertions, 0 deletions

diff --git a/formats/config/decoder_test.go b/formats/config/decoder_test.go
new file mode 100644
index 0000000..412549f
--- /dev/null
+++ b/formats/config/decoder_test.go
@@ -0,0 +1,90 @@
+package config
+
+import (
+	"bytes"
+
+	. "gopkg.in/check.v1"
+)
+
+type DecoderSuite struct{}
+
+var _ = Suite(&DecoderSuite{})
+
+func (s *DecoderSuite) TestDecode(c *C) {
+	for idx, fixture := range fixtures {
+		r := bytes.NewReader([]byte(fixture.Raw))
+		d := NewDecoder(r)
+		cfg := &Config{}
+		err := d.Decode(cfg)
+		c.Assert(err, IsNil, Commentf("decoder error for fixture: %d", idx))
+		c.Assert(cfg, DeepEquals, fixture.Config, Commentf("bad result for fixture: %d", idx))
+	}
+}
+
+func (s *DecoderSuite) TestDecodeFailsWithIdentBeforeSection(c *C) {
+	t := `
+	key=value
+	[section]
+	key=value
+	`
+	decodeFails(c, t)
+}
+
+func (s *DecoderSuite) TestDecodeFailsWithEmptySectionName(c *C) {
+	t := `
+	[]
+	key=value
+	`
+	decodeFails(c, t)
+}
+
+func (s *DecoderSuite) TestDecodeFailsWithEmptySubsectionName(c *C) {
+	t := `
+	[remote ""]
+	key=value
+	`
+	decodeFails(c, t)
+}
+
+func (s *DecoderSuite) TestDecodeFailsWithBadSubsectionName(c *C) {
+	t := `
+	[remote origin"]
+	key=value
+	`
+	decodeFails(c, t)
+	t = `
+	[remote "origin]
+	key=value
+	`
+	decodeFails(c, t)
+}
+
+func (s *DecoderSuite) TestDecodeFailsWithTrailingGarbage(c *C) {
+	t := `
+	[remote]garbage
+	key=value
+	`
+	decodeFails(c, t)
+	t = `
+	[remote "origin"]garbage
+	key=value
+	`
+	decodeFails(c, t)
+}
+
+func (s *DecoderSuite) TestDecodeFailsWithGarbage(c *C) {
+	decodeFails(c, "---")
+	decodeFails(c, "????")
+	decodeFails(c, "[sect\nkey=value")
+	decodeFails(c, "sect]\nkey=value")
+	decodeFails(c, `[section]key="value`)
+	decodeFails(c, `[section]key=value"`)
+}
+
+func decodeFails(c *C, text string) {
+	r := bytes.NewReader([]byte(text))
+	d := NewDecoder(r)
+	cfg := &Config{}
+	err := d.Decode(cfg)
+	c.Assert(err, NotNil)
+}