diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b6979c..2ae21eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,12 @@ # Changelog -## v0.0.2 [unreleased] +## v0.0.2 [16/06/06] +- 16/06/05 refact(dao): change dao Upsert signature to remove mgo dependency (SFR) + refact(model): fix model JSON annotation for age + fix(test): fix statistics test for expected request count + refact(web): refactor web server in a separate file and main entry point + feat(test): add full web server test + chores(test): add benchmarking target and instruction - 16/06/01 chore(test): add go routine to statistics test (SFR) ## v0.0.1 [16/05/31] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5471dc1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,203 @@ + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile index af296bc..84dd1bb 100644 --- a/Makefile +++ b/Makefile @@ -60,6 +60,8 @@ clean: @rm -Rf *.log @rm -Rf *.out @rm -Rf *.lock + @rm -Rf *.mem + @rm -Rf *.test @rm -Rf build dependencies: @@ -91,6 +93,13 @@ setupTest: teardownTest test: setupTest @export MONGODB_SRV=mongodb://$(DOCKER_IP)/spirits; go test -v $(PKGS); make teardownTest +bench: + @go test -v -run TestSpiritHandlerGet -bench=. -memprofile=prof.mem github.com/sebastienfr/handsongo/web + +benchTool: bench + @echo "### TIP : type 'top 5' and 'list the first item'" + @go tool pprof --alloc_space web.test prof.mem + lint: @golint dao/... @golint model/... diff --git a/dao/spirit_dao.go b/dao/spirit_dao.go index abf40b3..a331326 100644 --- a/dao/spirit_dao.go +++ b/dao/spirit_dao.go @@ -2,7 +2,6 @@ package dao import ( "github.com/sebastienfr/handsongo/model" - "gopkg.in/mgo.v2" ) const ( @@ -32,7 +31,7 @@ type SpiritDAO interface { SaveSpirit(spirit *model.Spirit) error // UpsertSpirit updates or creates a spirit - UpsertSpirit(ID string, spirit *model.Spirit) (*mgo.ChangeInfo, error) + UpsertSpirit(ID string, spirit *model.Spirit) (bool, error) // DeleteSpirit deletes a spirits by its ID DeleteSpirit(ID string) error diff --git a/dao/spirit_dao_mock.go b/dao/spirit_dao_mock.go index 93a749b..1c6132a 100644 --- a/dao/spirit_dao_mock.go +++ b/dao/spirit_dao_mock.go @@ -2,10 +2,23 @@ package dao import ( "github.com/sebastienfr/handsongo/model" - "gopkg.in/mgo.v2" "time" ) +// MockedSpirit is the spirit returned by this mocked interface +var MockedSpirit = model.Spirit{ + Name: "Caroni", + Distiller: "Caroni", + Bottler: "Velier", + Country: "Trinidad", + Composition: "Molasse", + SpiritType: model.TypeRhum, + Age: 15, + BottlingDate: time.Date(2015, 01, 01, 0, 0, 0, 0, time.UTC), + Score: 8.5, + Comment: "heavy tire taste", +} + // SpiritDAOMock is the mocked implementation of the SpiritDAO type SpiritDAOMock struct { } @@ -17,40 +30,27 @@ func NewSpiritDAOMock() SpiritDAO { // GetSpiritByID returns a spirit by its ID func (s *SpiritDAOMock) GetSpiritByID(ID string) (*model.Spirit, error) { - return nil, nil + return &MockedSpirit, nil } // GetAllSpirits returns all spirits with paging capability func (s *SpiritDAOMock) GetAllSpirits(start, end int) ([]model.Spirit, error) { - return []model.Spirit{ - model.Spirit{ - Name: "Caroni", - Distiller: "Caroni", - Bottler: "Velier", - Country: "Trinidad", - Composition: "Molasse", - SpiritType: model.TypeRhum, - Age: 15, - BottlingDate: time.Date(2015, 01, 01, 0, 0, 0, 0, time.UTC), - Score: 8.5, - Comment: "heavy tire taste", - }, - }, nil + return []model.Spirit{MockedSpirit}, nil } // GetSpiritsByName returns all spirits by name func (s *SpiritDAOMock) GetSpiritsByName(name string) ([]model.Spirit, error) { - return nil, nil + return []model.Spirit{MockedSpirit}, nil } // GetSpiritsByType returns all spirits by type func (s *SpiritDAOMock) GetSpiritsByType(spiritType string) ([]model.Spirit, error) { - return nil, nil + return []model.Spirit{MockedSpirit}, nil } // GetSpiritsByTypeAndScore returns all spirits by type and score greater than parameter func (s *SpiritDAOMock) GetSpiritsByTypeAndScore(spiritType string, score uint8) ([]model.Spirit, error) { - return nil, nil + return []model.Spirit{MockedSpirit}, nil } // SaveSpirit saves the spirit @@ -59,8 +59,8 @@ func (s *SpiritDAOMock) SaveSpirit(spirit *model.Spirit) error { } // UpsertSpirit updates or creates a spirit -func (s *SpiritDAOMock) UpsertSpirit(ID string, spirit *model.Spirit) (*mgo.ChangeInfo, error) { - return nil, nil +func (s *SpiritDAOMock) UpsertSpirit(ID string, spirit *model.Spirit) (bool, error) { + return true, nil } // DeleteSpirit deletes a spirits by its ID diff --git a/dao/spirit_dao_mongo.go b/dao/spirit_dao_mongo.go index 0b224bb..aa075e8 100644 --- a/dao/spirit_dao_mongo.go +++ b/dao/spirit_dao_mongo.go @@ -104,11 +104,15 @@ func (s *SpiritDAOMongo) SaveSpirit(spirit *model.Spirit) error { } // UpsertSpirit updates or creates a spirit -func (s *SpiritDAOMongo) UpsertSpirit(ID string, spirit *model.Spirit) (*mgo.ChangeInfo, error) { +func (s *SpiritDAOMongo) UpsertSpirit(ID string, spirit *model.Spirit) (bool, error) { session := s.session.Copy() defer session.Close() c := session.DB("").C(collection) - return c.Upsert(bson.M{"_id": bson.ObjectIdHex(ID)}, spirit) + chg, err := c.Upsert(bson.M{"_id": bson.ObjectIdHex(ID)}, spirit) + if err != nil { + return false, err + } + return chg.Updated > 0, err } // DeleteSpirit deletes a spirits by its ID diff --git a/dao/spirit_dao_mongo_test.go b/dao/spirit_dao_mongo_test.go index 5a18894..636e2a9 100644 --- a/dao/spirit_dao_mongo_test.go +++ b/dao/spirit_dao_mongo_test.go @@ -17,7 +17,7 @@ func TestDAOMongo(t *testing.T) { } toSave := model.Spirit{ - Name: "Caroni", + Name: "Caroni 2000", Distiller: "Caroni", Bottler: "Velier", Country: "Trinidad", diff --git a/etc/caroni.json b/etc/caroni.json index bac6d92..7bbfedf 100644 --- a/etc/caroni.json +++ b/etc/caroni.json @@ -6,7 +6,7 @@ "region": "", "composition": "Molasse", "type": "rhum", - "distillationYear": 15, + "age": 15, "bottlingDate": "2015-01-01T00:00:00Z", "score": 8.5, "comment": "heavy tire taste" diff --git a/etc/clairin.json b/etc/clairin.json index 9aee94b..606bdf4 100644 --- a/etc/clairin.json +++ b/etc/clairin.json @@ -6,7 +6,7 @@ "region": "", "composition": "Cane juice", "type": "rhum", - "distillationYear": 5, + "age": 5, "bottlingDate": "2015-01-01T00:00:00Z", "score": 8.0, "comment": "fruity" diff --git a/handsongo.go b/handsongo.go index f07c25f..45bac2c 100644 --- a/handsongo.go +++ b/handsongo.go @@ -5,8 +5,6 @@ import ( "fmt" logger "github.com/Sirupsen/logrus" "github.com/codegangsta/cli" - "github.com/codegangsta/negroni" - "github.com/meatballhat/negroni-logrus" "github.com/sebastienfr/handsongo/dao" "github.com/sebastienfr/handsongo/utils" "github.com/sebastienfr/handsongo/web" @@ -112,38 +110,10 @@ func main() { logger.Warn("error setting log level, using debug as default") } - // get the mongodb dao - daoMongo, err := dao.GetSpiritDAO(db, dao.DAOMongo) - if err != nil { - logger.WithField("error", err).WithField("connection string", db).Fatal("unable to connect to mongo db") - } - - // web server - n := negroni.New() - - // new handler - handler := web.NewSpiritHandler(daoMongo) - // new router - router := web.NewRouter(handler) - - // add middleware for logging - n.Use(negronilogrus.NewMiddlewareFromLogger(logger.StandardLogger(), "spirit")) - - // add recovery middleware in case of panic in handler func - recovery := negroni.NewRecovery() - recovery.PrintStack = false - n.Use(recovery) - - // add statistics middleware - n.Use(web.NewStatisticsMiddleware(statisticsDuration)) - - // add as many middleware as you like - - // handler goes last - n.UseHandler(router.Mux) + webServer := web.BuildWebServer(db, dao.DAOMongo, statisticsDuration) // serve - n.Run(":" + strconv.Itoa(port)) + webServer.Run(":" + strconv.Itoa(port)) } // run the app diff --git a/model/model.go b/model/model.go index 766c368..854118e 100644 --- a/model/model.go +++ b/model/model.go @@ -30,7 +30,7 @@ type Spirit struct { Region string `json:"region" bson:"region"` Composition string `json:"composition" bson:"composition"` SpiritType string `json:"type" bson:"type"` - Age uint8 `json:"distillationYear" bson:"distillationYear"` + Age uint8 `json:"age" bson:"age"` BottlingDate time.Time `json:"bottlingDate" bson:"bottlingDate"` Score float32 `json:"score" bson:"score"` Comment string `json:"comment" bson:"comment"` diff --git a/utils/statistics_test.go b/utils/statistics_test.go index cee3498..c53f2e7 100644 --- a/utils/statistics_test.go +++ b/utils/statistics_test.go @@ -7,7 +7,7 @@ import ( const ( statPeriod = 500 * time.Millisecond - expectedCount = 1 + expectedCount = 2 emptyCount = 0 ) diff --git a/web/handler_test.go b/web/handler_test.go index b297eb9..c3a1e3b 100644 --- a/web/handler_test.go +++ b/web/handler_test.go @@ -35,28 +35,48 @@ func TestSpiritHandlerGet(t *testing.T) { t.Errorf("Unable to get JSON content %v", err) } - expected := model.Spirit{ - Name: "Caroni", - Distiller: "Caroni", - Bottler: "Velier", - Country: "Trinidad", - Composition: "Molasse", - SpiritType: model.TypeRhum, - Age: 15, - BottlingDate: time.Date(2015, 01, 01, 0, 0, 0, 0, time.UTC), - Score: 8.5, - Comment: "heavy tire taste", + if res.Code != http.StatusOK { + t.Error("Wrong response code") } - if expected != spiritOut[0] { - t.Errorf("Expected different from %v output %v", expected, spiritOut) + if dao.MockedSpirit != spiritOut[0] { + t.Errorf("Expected different from %v output %v", dao.MockedSpirit, spiritOut[0]) } +} + +func TestSpiritHandlerGetServer(t *testing.T) { - t.Logf("Test successfull expected \n %v \n is equal to result \n %v", expected, spiritOut[0]) + ts := httptest.NewServer(BuildWebServer("", dao.DAOMock, 250*time.Millisecond)) + defer ts.Close() + + res, err := http.Get(ts.URL + "/spirits") + if err != nil { + t.Error(err) + } + + var resSpirit []model.Spirit + err = json.NewDecoder(res.Body).Decode(&resSpirit) + + if err != nil { + t.Errorf("Unable to get JSON content %v", err) + } + + res.Body.Close() + + if res.StatusCode != http.StatusOK { + t.Error("Wrong response code") + } + + if resSpirit[0] != dao.MockedSpirit { + t.Error("Wrong response body") + } } func BenchmarkSpiritHandlerGet(t *testing.B) { + // tooling purpose + _ = new([45000]int) + // get mock dao daoMock, _ := dao.GetSpiritDAO("", dao.DAOMock) handler := NewSpiritHandler(daoMock) diff --git a/web/web-server.go b/web/web-server.go new file mode 100644 index 0000000..478b015 --- /dev/null +++ b/web/web-server.go @@ -0,0 +1,45 @@ +package web + +import ( + logger "github.com/Sirupsen/logrus" + "github.com/codegangsta/negroni" + "github.com/meatballhat/negroni-logrus" + "github.com/sebastienfr/handsongo/dao" + "time" +) + +// BuildWebServer constructs a new web server with the right DAO and spirits handler +func BuildWebServer(db string, daoType int, statisticsDuration time.Duration) *negroni.Negroni { + + // spirit dao + dao, err := dao.GetSpiritDAO(db, daoType) + if err != nil { + logger.WithField("error", err).WithField("connection string", db).Fatal("unable to connect to mongo db") + } + + // web server + n := negroni.New() + + // new handler + handler := NewSpiritHandler(dao) + // new router + router := NewRouter(handler) + + // add middleware for logging + n.Use(negronilogrus.NewMiddlewareFromLogger(logger.StandardLogger(), "spirit")) + + // add recovery middleware in case of panic in handler func + recovery := negroni.NewRecovery() + recovery.PrintStack = false + n.Use(recovery) + + // add statistics middleware + n.Use(NewStatisticsMiddleware(statisticsDuration)) + + // add as many middleware as you like + + // handler goes last + n.UseHandler(router.Mux) + + return n +}