From dde130e84ef24b61574c3886f6fde11211c9aa4e Mon Sep 17 00:00:00 2001 From: Deluan Date: Wed, 2 Mar 2016 17:23:26 -0500 Subject: [PATCH] Small fixes to response marshaling, introduced tests for response formats --- api/api_test.go | 2 +- api/base_api_controller.go | 5 +- api/get_indexes.go | 2 +- api/get_indexes_test.go | 18 +++---- api/get_license_test.go | 10 ++-- api/get_music_folders_test.go | 10 ++-- api/ping_test.go | 15 +++--- api/responses/responses.go | 10 ++-- api/responses/responses_test.go | 90 +++++++++++++++++++++++++++++++++ tests/matchers.go | 33 ++++++++++++ 10 files changed, 154 insertions(+), 41 deletions(-) create mode 100644 api/responses/responses_test.go create mode 100644 tests/matchers.go diff --git a/api/api_test.go b/api/api_test.go index 0bbc1b729..a54ceb2f4 100644 --- a/api/api_test.go +++ b/api/api_test.go @@ -17,7 +17,7 @@ const ( ) func AddParams(endpoint string, params ...string) string { - url := fmt.Sprintf("%s?u=%s&p=%s&c=%s&v=%s", endpoint, testUser, testPassword, testClient, testVersion) + url := fmt.Sprintf("%s?u=%s&p=%s&c=%s&v=%s&f=json", endpoint, testUser, testPassword, testClient, testVersion) if len(params) > 0 { url = url + "&" + strings.Join(params, "&") } diff --git a/api/base_api_controller.go b/api/base_api_controller.go index ea71d1fb4..f213854bf 100644 --- a/api/base_api_controller.go +++ b/api/base_api_controller.go @@ -30,10 +30,7 @@ func (c *BaseAPIController) SendError(errorCode int, message ...interface{}) { func (c *BaseAPIController) SendResponse(response responses.Subsonic) { f := c.GetString("f") if f == "json" { - type jsonWrapper struct { - Subsonic responses.Subsonic `json:"subsonic-response"` - } - w := &jsonWrapper{Subsonic: response} + w := &responses.JsonWrapper{Subsonic: response} c.Data["json"] = &w c.ServeJSON() } else { diff --git a/api/get_indexes.go b/api/get_indexes.go index 69fa1ca31..00c3a423d 100644 --- a/api/get_indexes.go +++ b/api/get_indexes.go @@ -62,6 +62,6 @@ func (c *GetIndexesController) Get() { } response := c.NewEmpty() - response.ArtistIndex = &res + response.Indexes = &res c.SendResponse(response) } diff --git a/api/get_indexes_test.go b/api/get_indexes_test.go index e917f2ac6..0b3a7c404 100644 --- a/api/get_indexes_test.go +++ b/api/get_indexes_test.go @@ -7,18 +7,19 @@ import ( "github.com/deluan/gosonic/api/responses" "github.com/deluan/gosonic/consts" "github.com/deluan/gosonic/domain" - "github.com/deluan/gosonic/tests" "github.com/deluan/gosonic/tests/mocks" "github.com/deluan/gosonic/utils" + . "github.com/deluan/gosonic/tests" . "github.com/smartystreets/goconvey/convey" ) const ( - emptyResponse = `` + emptyResponse = `{"indexes":{"ignoredArticles":"The El La Los Las Le Les Os As O A","lastModified":"1"}` ) func TestGetIndexes(t *testing.T) { - tests.Init(t, false) + Init(t, false) + mockRepo := mocks.CreateMockArtistIndexRepo() utils.DefineSingleton(new(domain.ArtistIndexRepository), func() domain.ArtistIndexRepository { return mockRepo @@ -56,13 +57,8 @@ func TestGetIndexes(t *testing.T) { Convey("Status code should be 200", func() { So(w.Code, ShouldEqual, 200) }) - Convey("It should return valid XML", func() { - v := new(string) - err := xml.Unmarshal(w.Body.Bytes(), &v) - So(err, ShouldBeNil) - }) Convey("Then it should return an empty collection", func() { - So(w.Body.String(), ShouldContainSubstring, emptyResponse) + So(UnindentJSON(w.Body.Bytes()), ShouldContainSubstring, emptyResponse) }) }) Convey("When the index is not empty", func() { @@ -85,7 +81,7 @@ func TestGetIndexes(t *testing.T) { _, w := Get(AddParams("/rest/getIndexes.view", "ifModifiedSince=2"), "TestGetIndexes") - So(w.Body.String(), ShouldContainSubstring, emptyResponse) + So(UnindentJSON(w.Body.Bytes()), ShouldContainSubstring, emptyResponse) }) Convey("And it should return empty if 'ifModifiedSince' is the asme as tie index last update", func() { mockRepo.SetData(`[{"Id": "A","Artists": [ @@ -95,7 +91,7 @@ func TestGetIndexes(t *testing.T) { _, w := Get(AddParams("/rest/getIndexes.view", "ifModifiedSince=1"), "TestGetIndexes") - So(w.Body.String(), ShouldContainSubstring, emptyResponse) + So(UnindentJSON(w.Body.Bytes()), ShouldContainSubstring, emptyResponse) }) Reset(func() { mockRepo.SetData("[]", 0) diff --git a/api/get_license_test.go b/api/get_license_test.go index f4ac4da30..4598d7591 100644 --- a/api/get_license_test.go +++ b/api/get_license_test.go @@ -1,14 +1,13 @@ package api_test import ( - "encoding/xml" - "github.com/deluan/gosonic/tests" + . "github.com/deluan/gosonic/tests" . "github.com/smartystreets/goconvey/convey" "testing" ) func TestGetLicense(t *testing.T) { - tests.Init(t, false) + Init(t, false) _, w := Get(AddParams("/rest/getLicense.view"), "TestGetLicense") @@ -17,10 +16,7 @@ func TestGetLicense(t *testing.T) { So(w.Code, ShouldEqual, 200) }) Convey("The license should always be valid", func() { - v := new(string) - err := xml.Unmarshal(w.Body.Bytes(), &v) - So(err, ShouldBeNil) - So(w.Body.String(), ShouldContainSubstring, `license valid="true"`) + So(UnindentJSON(w.Body.Bytes()), ShouldContainSubstring, `"license":{"valid":true}`) }) }) diff --git a/api/get_music_folders_test.go b/api/get_music_folders_test.go index dc85bd011..dd131ead1 100644 --- a/api/get_music_folders_test.go +++ b/api/get_music_folders_test.go @@ -3,13 +3,12 @@ package api_test import ( "testing" - "encoding/xml" - "github.com/deluan/gosonic/tests" + . "github.com/deluan/gosonic/tests" . "github.com/smartystreets/goconvey/convey" ) func TestGetMusicFolders(t *testing.T) { - tests.Init(t, false) + Init(t, false) _, w := Get(AddParams("/rest/getMusicFolders.view"), "TestGetMusicFolders") @@ -18,10 +17,7 @@ func TestGetMusicFolders(t *testing.T) { So(w.Code, ShouldEqual, 200) }) Convey("The response should include the default folder", func() { - v := new(string) - err := xml.Unmarshal(w.Body.Bytes(), &v) - So(err, ShouldBeNil) - So(w.Body.String(), ShouldContainSubstring, `musicFolder id="0" name="iTunes Library"`) + So(UnindentJSON(w.Body.Bytes()), ShouldContainSubstring, `{"musicFolder":[{"id":"0","name":"iTunes Library"}]}`) }) }) } diff --git a/api/ping_test.go b/api/ping_test.go index c8d83d12c..dbf96d991 100644 --- a/api/ping_test.go +++ b/api/ping_test.go @@ -1,15 +1,15 @@ package api_test import ( - "encoding/xml" "github.com/deluan/gosonic/api/responses" - "github.com/deluan/gosonic/tests" + . "github.com/deluan/gosonic/tests" . "github.com/smartystreets/goconvey/convey" "testing" + "encoding/json" ) func TestPing(t *testing.T) { - tests.Init(t, false) + Init(t, false) _, w := Get(AddParams("/rest/ping.view"), "TestPing") @@ -21,10 +21,11 @@ func TestPing(t *testing.T) { So(w.Body.Len(), ShouldBeGreaterThan, 0) }) Convey("The result should be a valid ping response", func() { - v := responses.Subsonic{} - xml.Unmarshal(w.Body.Bytes(), &v) - So(v.Status, ShouldEqual, "ok") - So(v.Version, ShouldEqual, "1.0.0") + v := responses.JsonWrapper{} + err := json.Unmarshal(w.Body.Bytes(), &v) + So(err, ShouldBeNil) + So(v.Subsonic.Status, ShouldEqual, "ok") + So(v.Subsonic.Version, ShouldEqual, "1.0.0") }) }) diff --git a/api/responses/responses.go b/api/responses/responses.go index 4faf26615..77ec16b31 100644 --- a/api/responses/responses.go +++ b/api/responses/responses.go @@ -9,7 +9,11 @@ type Subsonic struct { Error *Error `xml:",omitempty" json:"error,omitempty"` License *License `xml:",omitempty" json:"license,omitempty"` MusicFolders *MusicFolders `xml:",omitempty" json:"musicFolders,omitempty"` - ArtistIndex *Indexes `xml:",omitempty" json:"indexes,omitempty"` + Indexes *Indexes `xml:",omitempty" json:"indexes,omitempty"` +} + +type JsonWrapper struct { + Subsonic Subsonic `json:"subsonic-response"` } type Error struct { @@ -31,7 +35,7 @@ type MusicFolder struct { type MusicFolders struct { XMLName xml.Name `xml:"musicFolders" json:"-"` - Folders []MusicFolder `xml:"musicFolders" json:"musicFolder"` + Folders []MusicFolder `xml:"musicFolders" json:"musicFolder,omitempty"` } type Artist struct { @@ -48,7 +52,7 @@ type Index struct { type Indexes struct { XMLName xml.Name `xml:"indexes" json:"-"` - Index []Index `xml:"indexes" json:"index"` + Index []Index `xml:"indexes" json:"index,omitempty"` LastModified string `xml:"lastModified,attr" json:"lastModified"` IgnoredArticles string `xml:"ignoredArticles,attr" json:"ignoredArticles"` } diff --git a/api/responses/responses_test.go b/api/responses/responses_test.go new file mode 100644 index 000000000..ce45ed123 --- /dev/null +++ b/api/responses/responses_test.go @@ -0,0 +1,90 @@ +package responses + +import ( + "testing" + . "github.com/smartystreets/goconvey/convey" + . "github.com/deluan/gosonic/tests" +) + +func TestSubsonicResponses(t *testing.T) { + + response := &Subsonic{Status: "ok", Version: "1.0.0"} + + Convey("Subject: Subsonic Responses", t, func(){ + Convey("EmptyResponse", func() { + Convey("XML", func() { + So(response, ShouldMatchXML, ``) + }) + Convey("JSON", func() { + So(response, ShouldMatchJSON, `{"status":"ok","version":"1.0.0"}`) + }) + }) + + Convey("License", func() { + response.License = &License{Valid: true} + Convey("XML", func() { + So(response, ShouldMatchXML, ``) + }) + Convey("JSON", func() { + So(response, ShouldMatchJSON, `{"license":{"valid":true},"status":"ok","version":"1.0.0"}`) + }) + }) + + Convey("MusicFolders", func() { + response.MusicFolders = &MusicFolders{} + + Convey("With data", func() { + folders := make([]MusicFolder, 2) + folders[0] = MusicFolder{Id: "111", Name: "aaa"} + folders[1] = MusicFolder{Id: "222", Name: "bbb"} + response.MusicFolders.Folders = folders + + Convey("XML", func() { + So(response, ShouldMatchXML, ``) + }) + Convey("JSON", func() { + So(response, ShouldMatchJSON, `{"musicFolders":{"musicFolder":[{"id":"111","name":"aaa"},{"id":"222","name":"bbb"}]},"status":"ok","version":"1.0.0"}`) + }) + }) + Convey("Without data", func() { + Convey("XML", func() { + So(response, ShouldMatchXML, ``) + }) + Convey("JSON", func() { + So(response, ShouldMatchJSON, `{"musicFolders":{},"status":"ok","version":"1.0.0"}`) + }) + }) + }) + + Convey("Indexes", func() { + artists := make([]Artist, 1) + artists[0] = Artist{Id: "111", Name: "aaa"} + response.Indexes = &Indexes{LastModified:"1", IgnoredArticles:"A"} + + Convey("With data", func() { + index := make([]Index, 1) + index[0] = Index{Name: "A", Artists: artists} + response.Indexes.Index = index + Convey("XML", func() { + So(response, ShouldMatchXML, ``) + }) + Convey("JSON", func() { + So(response, ShouldMatchJSON, `{"indexes":{"ignoredArticles":"A","index":[{"artist":[{"id":"111","name":"aaa"}],"name":"A"}],"lastModified":"1"},"status":"ok","version":"1.0.0"}`) + }) + }) + Convey("Without data", func() { + Convey("XML", func() { + So(response, ShouldMatchXML, ``) + }) + Convey("JSON", func() { + So(response, ShouldMatchJSON, `{"indexes":{"ignoredArticles":"A","lastModified":"1"},"status":"ok","version":"1.0.0"}`) + }) + }) + }) + + Reset(func() { + response = &Subsonic{Status: "ok", Version: "1.0.0"} + }) + }) + +} \ No newline at end of file diff --git a/tests/matchers.go b/tests/matchers.go new file mode 100644 index 000000000..65a1ff838 --- /dev/null +++ b/tests/matchers.go @@ -0,0 +1,33 @@ +package tests + +import ( + . "github.com/smartystreets/goconvey/convey" + "encoding/json" + "encoding/xml" + "fmt" +) + +func ShouldMatchXML(actual interface{}, expected ...interface{}) string { + xml, err := xml.Marshal(actual) + if err != nil { + return fmt.Sprintf("Malformed XML: %v", err) + } + return ShouldEqual(string(xml), expected[0].(string)) + +} + +func ShouldMatchJSON(actual interface{}, expected ...interface{}) string { + json, err := json.Marshal(actual) + if err != nil { + return fmt.Sprintf("Malformed JSON: %v", err) + } + s := UnindentJSON(json) + return ShouldEqual(s, expected[0].(string)) +} + +func UnindentJSON(j []byte) string { + var m = make(map[string]interface{}) + json.Unmarshal(j, &m) + s, _ := json.Marshal(m) + return string(s) +} \ No newline at end of file