![\"Hands-On](\"https://d255esdrn735hr.cloudfront.net/sites/default/files/imagecache/ppv4_main_book_cover/B10763_MockupCover_new.png\")
\r\n\r\nThis is the code repository for [Hands-On Dependency Injection in Go](https://www.packtpub.com/application-development/hands-dependency-injection-go?utm_source=github&utm_medium=repository&utm_campaign=9781789132762 ), published by Packt.\r\n\r\n**Develop clean Go code that is easier to read, maintain, and test**\r\n\r\n## What is this book about?\r\nHands-On Dependency Injection in Go takes you on a journey, refactoring existing code to adopt dependency injection (DI) using various methods available in Go.\r\n\r\nThis book covers the following exciting features:\r\n* Understand the benefits of dependency injection \r\n* Explore SOLID design principles and how they relate to Go \r\n* Analyze various dependency injection patterns available in Go \r\n* Leverage DI to produce high quality, loosely coupled Go code \r\n* Refactor existing Go code to adopt dependency injection \r\n* Discover tools to improve your code's testability and test coverage \r\n* Generate and interpret Go dependency graphs \r\n\r\nIf you feel this book is for you, get your [copy](https://www.amazon.com/dp/1789132762) today!\r\n\r\n![](\"https://raw.githubusercontent.com/PacktPublishing/GitHub/master/GitHub.png\")
\r\n\r\n## Instructions and Navigations\r\nAll of the code is organized into folders. For example, ch02.\r\n\r\nThe code will look like the following:\r\n```\r\nhtml, body, #map {\r\n height: 100%; \r\n margin: 0;\r\n padding: 0\r\n}\r\n```\r\n\r\n**Following is what you need for this book:**\r\nHands-On Dependency Injection in Go is for programmers with a few year s experience in any language and a basic understanding of Go. If you wish to produce clean, loosely coupled code that is inherently easier to test, this book is for you.\r\n\r\n## Getting the source\r\n\r\nThe easiest way to obtain the source code is to use `go get`. \r\nThis will ensure that the code is placed in the correct directory and should be then runnable and testable.\r\n\r\nTo download this repo use `go get github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/...`\r\n\r\n## Code Organization\r\n\r\nIn this repository, there is 1 folder for every chapter of the book, named chXX where XX is the chapter number.\r\n\r\nThe code provided are expanded versions of the code presented in the book. While it will compile and typically\r\nwill not throw an error when passed into `go test` it is not designed to be executed.\r\n\r\nFrom chapter 4 onwards, there is an `acme` directory included with the code that chapter.\r\nThe `acme` directory is the code for the sample service presented in the book with the changes discussed in that chapter\r\nalready applied.\r\n\r\nYou will also find 2 additional directories in the root of the repository:\r\n \r\n * **resources** - this directory contains an SQL file that should be used to populate a MySQL database. This database\r\n is used by the sample service \r\n * **vendor** - this is standard go vendor directory which contains the external packages required by the sample service\r\n\r\n## Setting up the MySQL database\r\n\r\nThe easiest way to create and populate the database required by the sample service is by running the following:\r\n\r\n`mysql < ./resources/create.sql`\r\n\r\nDepending on your settings you may want to provide a username and password like this:\r\n\r\n`mysql -u [your username] -p < ./resources/create.sql`\r\n\r\nThis will create a database called `acme` with 1 table and 4 records.\r\n\r\n## Creating a free account on CurrencyLayer\r\n\r\nThe sample service uses a free currency conversion service. In order to successfully run all the examples, you will need\r\nto sign up [here](https://currencylayer.com/) and obtain an API Key.\r\n\r\n## Configuring the sample service\r\n\r\nNow that you have your MySQL and CurrencyLayer credentials you can create a config for the sample service.\r\n\r\n1. Copy `default-config.json` (found next to this file) to `config.json`\r\n1. Open `config.json` in your favorite editor\r\n1. Add your database credentials to the `\"dsn\"` setting. Should be in the form: \r\n`\"[username]:[password]@tcp(localhost:3306)/[database name]?autocommit=true\"`\r\n1. Add your API Key to the `\"exchangeRateAPIKey\"` setting. Should be in the form: `\"1234567890abcdef1234567890abcdef\"`\r\n\r\n## Running the sample service for a particular chapter\r\n\r\nTo run sample service for a particular chapter:\r\n \r\n1. First make sure you are in the base of this repository:\r\n`cd $GOPATH/src/github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/` \r\n1. Use a command similar to the following (which is for ch04):\r\n`ACME_CONFIG=$GOPATH/src/github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/config.json go run ./ch04/acme/main.go` \r\n\r\n### Special instructions for chapters 10-12\r\n\r\nAs we have multiple files and tests in the `main` package, we cannot use the standard `go run ./ch10/acme/main.go` to run the service.\r\n\r\nInstead we need to modify the command to `go run ./ch10/acme/main.go ./ch10/acme/wire_gen.go`\r\n\r\n## Running tests for a chapter\r\n\r\nTo run sample service for a particular chapter you can use a command similar to the follow (which is for ch04):\r\n\r\n1. First make sure you are in the base of this repository:\r\n`cd $GOPATH/src/github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/` \r\n1. Use a command similar to the following (which is for ch04):\r\n`ACME_CONFIG=$GOPATH/src/github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/config.json go test ./ch04/...` \r\n\r\nWith the following software and hardware list you can run all code files present in the book (Chapter 1-12).\r\n### Software and Hardware List\r\n| Chapter | Software required | OS required |\r\n| -------- | ------------------------------------ | -----------------------------------|\r\n| 1-12 | Go 1.10.x+ | Windows, Mac OS X, and Linux (Any) |\r\n| 4-12 | MySQL 5.7.x+ | Windows, Mac OS X, and Linux (Any) |\r\n| 4-12 | CurrencyLayer | Windows, Mac OS X, and Linux (Any) |\r\n\r\n### Related products\r\n* Mastering Go [[Packt]](https://www.packtpub.com/networking-and-servers/mastering-go?utm_source=github&utm_medium=repository&utm_campaign=9781788626545 ) [[Amazon]](https://www.amazon.com/dp/1788626540)\r\n\r\n* Go Standard Library Cookbook [[Packt]](https://www.packtpub.com/application-development/go-standard-library-cookbook?utm_source=github&utm_medium=repository&utm_campaign=9781788475273 ) [[Amazon]](https://www.amazon.com/dp/1788475275)\r\n\r\n\r\n## Get to Know the Author\r\n**Corey Scott**\r\nis a senior software engineer currently living in Melbourne, Australia. He’s been programming professionally since 2000, with the last 5 years spent building large-scale distributed services in Go.\r\nAn occasional technical speaker and blogger on a variety of software-related topics, he is passionate about designing and building quality software. He believes that software engineering is a craft that should be honed, debated, and continuously improved. He takes a pragmatic, non-zealot approach to coding and is always up for a good debate about software engineering, continuous delivery, testing, or clean coding.\r\n\r\n\r\n## Other books by the authors\r\n\r\n\r\n### Suggestions and Feedback\r\n[Click here](https://docs.google.com/forms/d/e/1FAIpQLSdy7dATC6QmEL81FIUuymZ0Wy9vH1jHkvpY57OiMeKGqib_Ow/viewform) if you have any feedback or suggestions.\r\n\r\n\r\n### Download a free PDF\n\n If you have already purchased a print or Kindle version of this book, you can get a DRM-free PDF version at no cost.https://packt.link/free-ebook/9781789132762
" }, { "path": "ch01/01_defining_depenency_injection/01_interface.go", "content": "package defining_depenency_injection\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n)\n\n// Saver persists the supplied bytes\ntype Saver interface {\n\tSave(data []byte) error\n}\n\n// SavePerson will validate and persist the supplied person\nfunc SavePerson(person *Person, saver Saver) error {\n\t// validate the inputs\n\terr := person.validate()\n\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// encode person to bytes\n\tbytes, err := person.encode()\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// save the person and return the result\n\treturn saver.Save(bytes)\n}\n\n// Person data object\ntype Person struct {\n\tName string\n\tPhone string\n}\n\n// validate the person object\nfunc (p *Person) validate() error {\n\tif p.Name == \"\" {\n\t\treturn errors.New(\"name missing\")\n\t}\n\n\tif p.Phone == \"\" {\n\t\treturn errors.New(\"phone missing\")\n\t}\n\n\treturn nil\n}\n\n// convert the person into bytes\nfunc (p *Person) encode() ([]byte, error) {\n\treturn json.Marshal(p)\n}\n" }, { "path": "ch01/01_defining_depenency_injection/02_function_literal.go", "content": "package defining_depenency_injection\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n)\n\n// LoadPerson will load the requested person by ID.\n// Errors include: invalid ID, missing person and failure to load or decode.\nfunc LoadPerson(ID int, decodePerson func(data []byte) *Person) (*Person, error) {\n\t// validate the input\n\tif ID <= 0 {\n\t\treturn nil, fmt.Errorf(\"invalid ID '%d' supplied\", ID)\n\t}\n\n\t// load from storage\n\tbytes, err := loadPerson(ID)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// decode bytes and return\n\treturn decodePerson(bytes), nil\n}\n\n// load person as bytes from storage\nfunc loadPerson(ID int) ([]byte, error) {\n\t// TODO: implement\n\treturn nil, errors.New(\"not implemented\")\n}\n" }, { "path": "ch01/01_defining_depenency_injection/03_test_without_nfs_test.go", "content": "package defining_depenency_injection\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\nfunc TestSavePerson_happyPath(t *testing.T) {\n\t// input\n\tin := &Person{\n\t\tName: \"Sophia\",\n\t\tPhone: \"0123456789\",\n\t}\n\n\t// mock the NFS\n\tmockNFS := &mockSaver{}\n\tmockNFS.On(\"Save\", mock.Anything).Return(nil).Once()\n\n\t// Call Save\n\tresultErr := SavePerson(in, mockNFS)\n\n\t// validate result\n\tassert.NoError(t, resultErr)\n\tassert.True(t, mockNFS.AssertExpectations(t))\n}\n\n// mock implementation of Saver\ntype mockSaver struct {\n\tmock.Mock\n}\n\n// Save implements Saver\nfunc (m *mockSaver) Save(data []byte) error {\n\toutputs := m.Mock.Called(data)\n\n\treturn outputs.Error(0)\n}\n" }, { "path": "ch01/01_defining_depenency_injection/04_fail_test_without_nfs_test.go", "content": "package defining_depenency_injection\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\nfunc TestSavePerson_nfsAlwaysFails(t *testing.T) {\n\t// input\n\tin := &Person{\n\t\tName: \"Sophia\",\n\t\tPhone: \"0123456789\",\n\t}\n\n\t// mock the NFS\n\tmockNFS := &mockSaver{}\n\tmockNFS.On(\"Save\", mock.Anything).Return(errors.New(\"save failed\")).Once()\n\n\t// Call Save\n\tresultErr := SavePerson(in, mockNFS)\n\n\t// validate result\n\tassert.Error(t, resultErr)\n\tassert.True(t, mockNFS.AssertExpectations(t))\n}\n" }, { "path": "ch01/02_code_smells/01_code_bloat/01_switch_type.go", "content": "package code_bloat\n\nimport (\n\t\"strconv\"\n)\n\nfunc AppendValue(buffer []byte, in interface{}) []byte {\n\tvar value []byte\n\n\t// convert input to []byte\n\tswitch concrete := in.(type) {\n\tcase []byte:\n\t\tvalue = concrete\n\n\tcase string:\n\t\tvalue = []byte(concrete)\n\n\tcase int64:\n\t\tvalue = []byte(strconv.FormatInt(concrete, 10))\n\n\tcase bool:\n\t\tvalue = []byte(strconv.FormatBool(concrete))\n\n\tcase float64:\n\t\tvalue = []byte(strconv.FormatFloat(concrete, 'e', 3, 64))\n\t}\n\n\tbuffer = append(buffer, value...)\n\treturn buffer\n}\n" }, { "path": "ch01/02_code_smells/02_resistance_to_change/01_shotgun_surgey.go", "content": "package _2_resistance_to_change\n\nimport (\n\t\"database/sql\"\n\t\"io\"\n)\n\n// Renderer will render a person to the supplied writer\ntype Renderer struct{}\n\nfunc (r Renderer) render(name, phone string, output io.Writer) {\n\t// output the person\n}\n\n// Validator will validate the supplied person has all the required fields\ntype Validator struct{}\n\nfunc (v Validator) validate(name, phone string) error {\n\t// validate the person\n\treturn nil\n}\n\n// Saver will save the supplied person to the DB\ntype Saver struct{}\n\nfunc (s *Saver) Save(db *sql.DB, name, phone string) {\n\t// save the person to db\n}\n" }, { "path": "ch01/02_code_smells/03_wasted_effort/01_excessive_comments.go", "content": "package wasted_effort\n\n// Excessive comments\nfunc outputOrderedPeopleA(in []*Person) {\n\t// This code orders people by name.\n\t// In cases where the name is the same, it will order by phone number.\n\t// The sort algorithm used is a bubble sort\n\t// WARNING: this sort will change the items of the input array\n\tfor range in {\n\t\t// ... sort code removed ...\n\t}\n\n\toutputPeople(in)\n}\n\n// Comments replaced with descriptive names\nfunc outputOrderedPeopleB(in []*Person) {\n\tsortPeople(in)\n\toutputPeople(in)\n}\n\nfunc outputPeople(in []*Person) {\n\t// TODO: implement\n}\n\n// any special instructions that MUST be documented relating to the sort should go here\nfunc sortPeople(in []*Person) {\n\t// TODO: implement\n}\n\n// Person data object\ntype Person struct {\n\tName string\n\tPhone string\n}\n" }, { "path": "ch01/02_code_smells/03_wasted_effort/02_complicated_go.go", "content": "package wasted_effort\n\nimport (\n\t\"image\"\n\t\"image/color\"\n\t\"math\"\n)\n\nfunc d(r, v float64, i *image.RGBA, c color.Color) {\n\tfor a := float64(0); a < 360; a++ {\n\t\tra := math.Pi * 2 * a / 360\n\t\tx := r*math.Sin(ra) + v\n\t\ty := r*math.Cos(ra) + v\n\t\ti.Set(int(x), int(y), c)\n\t}\n}\n" }, { "path": "ch01/02_code_smells/04_tight_coupling/01_circular_dependencies/config/config.go", "content": "// +build bad\n\npackage config\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch01/02_code_smells/04_tight_coupling/01_circular_dependencies/payment\"\n)\n\n// Config defines the JSON format of the config file\ntype Config struct {\n\t// Address is the host and port to bind to.\n\t// Default 0.0.0.0:8080\n\tAddress string\n\n\t// DefaultCurrency is the default currency of the system\n\tDefaultCurrency payment.Currency\n}\n\n// Load will load the JSON config from the file supplied\nfunc Load(filename string) (*Config, error) {\n\t// TODO: load currency from file\n\treturn nil, errors.New(\"not implemented yet\")\n}\n" }, { "path": "ch01/02_code_smells/04_tight_coupling/01_circular_dependencies/payment/currency.go", "content": "// +build bad\n\npackage payment\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch01/02_code_smells/04_tight_coupling/01_circular_dependencies/config\"\n)\n\n// Currency is custom type for currency\ntype Currency string\n\n// Processor processes payments\ntype Processor struct {\n\tConfig *config.Config\n}\n\n// Pay makes a payment in the default currency\nfunc (p *Processor) Pay(amount float64) error {\n\t// TODO: implement me\n\treturn errors.New(\"not implemented yet\")\n}\n" }, { "path": "ch01/02_code_smells/04_tight_coupling/02_object_orgy.go", "content": "package _4_tight_coupling\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n)\n\ntype PageLoader struct {\n}\n\nfunc (o *PageLoader) LoadPage(url string) ([]byte, error) {\n\tb := newFetcher()\n\n\t// check cache\n\tpayload, err := b.cache.Get(url)\n\tif err == nil {\n\t\t// found in cache\n\t\treturn payload, nil\n\t}\n\n\t// call upstream\n\tresp, err := b.httpClient.Get(url)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer resp.Body.Close()\n\n\t// extract data from HTTP response\n\tpayload, err = ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// save to cache asynchronously\n\tgo func(key string, value []byte) {\n\t\tb.cache.Set(key, value)\n\t}(url, payload)\n\n\t// return\n\treturn payload, nil\n}\n\ntype Fetcher struct {\n\thttpClient http.Client\n\tcache *Cache\n}\n\nfunc newFetcher() *Fetcher {\n\treturn &Fetcher{}\n}\n\ntype Cache struct {\n\t// not implemented\n}\n\nfunc (c *Cache) Get(key string) ([]byte, error) {\n\t// not implemented\n\treturn nil, errors.New(\"not implemented\")\n}\n\nfunc (c *Cache) Set(key string, data []byte) error {\n\t// not implemented\n\treturn errors.New(\"not implemented\")\n}\n" }, { "path": "ch01/02_code_smells/04_tight_coupling/03_feature_envy.go", "content": "package _4_tight_coupling\n\nimport (\n\t\"errors\"\n\t\"time\"\n)\n\ntype searchRequest struct {\n\tquery string\n\tstart time.Time\n\tend time.Time\n}\n\nfunc (request searchRequest) validate() error {\n\tif request.query == \"\" {\n\t\treturn errors.New(\"search term is missing\")\n\t}\n\tif request.start.IsZero() || request.start.After(time.Now()) {\n\t\treturn errors.New(\"start time is missing or invalid\")\n\t}\n\tif request.end.IsZero() || request.end.Before(request.start) {\n\t\treturn errors.New(\"end time is missing or invalid\")\n\t}\n\n\treturn nil\n}\n\ntype searchResults struct {\n\tresult string\n}\n\nfunc doSearchWithEnvy(request searchRequest) ([]searchResults, error) {\n\t// validate request\n\tif request.query == \"\" {\n\t\treturn nil, errors.New(\"search term is missing\")\n\t}\n\tif request.start.IsZero() || request.start.After(time.Now()) {\n\t\treturn nil, errors.New(\"start time is missing or invalid\")\n\t}\n\tif request.end.IsZero() || request.end.Before(request.start) {\n\t\treturn nil, errors.New(\"end time is missing or invalid\")\n\t}\n\n\treturn performSearch(request)\n}\n\nfunc doSearchWithoutEnvy(request searchRequest) ([]searchResults, error) {\n\terr := request.validate()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn performSearch(request)\n}\n\nfunc performSearch(request searchRequest) ([]searchResults, error) {\n\t// TODO: implement\n\treturn nil, errors.New(\"not implemented\")\n}\n" }, { "path": "ch02/01_single_responsibility_principle/01_responsibility_vs_change.go", "content": "package srp\n\nimport (\n\t\"fmt\"\n\t\"io\"\n)\n\n// CalculatorV1 calculates the test coverage for a directory and it's sub-directories\ntype CalculatorV1 struct {\n\t// coverage data populated by `Calculate()` method\n\tdata map[string]float64\n}\n\n// Calculate will calculate the coverage\nfunc (c *CalculatorV1) Calculate(path string) error {\n\t// run `go test -cover ./[path]/...` and store the results\n\treturn nil\n}\n\n// Output will print the coverage data to the supplied writer\nfunc (c *CalculatorV1) Output(writer io.Writer) {\n\tfor path, result := range c.data {\n\t\tfmt.Fprintf(writer, \"%s -> %.1f\\n\", path, result)\n\t}\n}\n" }, { "path": "ch02/01_single_responsibility_principle/02_responsibility_vs_change.go", "content": "package srp\n\nimport (\n\t\"fmt\"\n\t\"io\"\n)\n\n// CalculatorV2 calculates the test coverage for a directory and it's sub-directories\ntype CalculatorV2 struct {\n\t// coverage data populated by `Calculate()` method\n\tdata map[string]float64\n}\n\n// Calculate will calculate the coverage\nfunc (c *CalculatorV2) Calculate(path string) error {\n\t// run `go test -cover ./[path]/...` and store the results\n\treturn nil\n}\n\n// Output will print the coverage data to the supplied writer\nfunc (c CalculatorV2) Output(writer io.Writer) {\n\tfor path, result := range c.data {\n\t\tfmt.Fprintf(writer, \"%s -> %.1f\\n\", path, result)\n\t}\n}\n\n// OutputCSV will print the coverage data to the supplied writer\nfunc (c CalculatorV2) OutputCSV(writer io.Writer) {\n\tfor path, result := range c.data {\n\t\tfmt.Fprintf(writer, \"%s,%.1f\\n\", path, result)\n\t}\n}\n" }, { "path": "ch02/01_single_responsibility_principle/03_responsibility_vs_change.go", "content": "package srp\n\nimport (\n\t\"fmt\"\n\t\"io\"\n)\n\n// CalculatorV3 calculates the test coverage for a directory and it's sub-directories\ntype CalculatorV3 struct {\n\t// coverage data populated by `Calculate()` method\n\tdata map[string]float64\n}\n\n// Calculate will calculate the coverage\nfunc (c *CalculatorV3) Calculate(path string) error {\n\t// run `go test -cover ./[path]/...` and store the results\n\treturn nil\n}\n\nfunc (c *CalculatorV3) getData() map[string]float64 {\n\t// copy and return the map\n\treturn nil\n}\n\ntype Printer interface {\n\tOutput(data map[string]float64)\n}\n\ntype DefaultPrinter struct {\n\tWriter io.Writer\n}\n\n// Output implements Printer\nfunc (d *DefaultPrinter) Output(data map[string]float64) {\n\tfor path, result := range data {\n\t\tfmt.Fprintf(d.Writer, \"%s -> %.1f\\n\", path, result)\n\t}\n}\n\ntype CSVPrinter struct {\n\tWriter io.Writer\n}\n\n// Output implements Printer\nfunc (d *CSVPrinter) Output(data map[string]float64) {\n\tfor path, result := range data {\n\t\tfmt.Fprintf(d.Writer, \"%s,%.1f\\n\", path, result)\n\t}\n}\n" }, { "path": "ch02/01_single_responsibility_principle/04_long_method.go", "content": "package srp\n\nimport (\n\t\"database/sql\"\n\t\"encoding/json\"\n\t\"net/http\"\n\t\"strconv\"\n)\n\nfunc loadUserHandlerLong(resp http.ResponseWriter, req *http.Request) {\n\terr := req.ParseForm()\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\tuserID, err := strconv.ParseInt(req.Form.Get(\"UserID\"), 10, 64)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusPreconditionFailed)\n\t\treturn\n\t}\n\n\trow := DB.QueryRow(\"SELECT * FROM Users WHERE ID = ?\", userID)\n\n\tperson := &Person{}\n\terr = row.Scan(&person.ID, &person.Name, &person.Phone)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tencoder := json.NewEncoder(resp)\n\terr = encoder.Encode(person)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n}\n\nvar DB *sql.DB\n\ntype Person struct {\n\tID int64\n\tName string\n\tPhone string\n}\n" }, { "path": "ch02/01_single_responsibility_principle/04_long_method_test.go", "content": "package srp\n\nimport (\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"net/url\"\n\t\"os\"\n\t\"testing\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestLoadUserHandler(t *testing.T) {\n\t// build request\n\treq := &http.Request{\n\t\tForm: url.Values{},\n\t}\n\treq.Form.Add(\"UserID\", \"1234\")\n\n\t// call function under test\n\tresp := httptest.NewRecorder()\n\tloadUserHandlerLong(resp, req)\n\n\t// validate result\n\tassert.Equal(t, http.StatusOK, resp.Code)\n\n\texpectedBody := `{\"ID\":1,\"Name\":\"Bob\",\"Phone\":\"0123456789\"}` + \"\\n\"\n\tassert.Equal(t, expectedBody, resp.Body.String())\n}\n\nfunc TestMain(m *testing.M) {\n\t// create fake DB for this test\n\tvar mock sqlmock.Sqlmock\n\tDB, mock, _ = sqlmock.New()\n\n\t// config fake response\n\tmock.ExpectQuery(\".*\").WillReturnRows(\n\t\tsqlmock.NewRows([]string{\"ID\", \"Name\", \"Phone\"}).AddRow(\n\t\t\t1, \"Bob\", \"0123456789\"))\n\n\tos.Exit(m.Run())\n}\n" }, { "path": "ch02/01_single_responsibility_principle/05_srp_method.go", "content": "package srp\n\nimport (\n\t\"encoding/json\"\n\t\"net/http\"\n\t\"strconv\"\n)\n\nfunc loadUserHandlerSRP(resp http.ResponseWriter, req *http.Request) {\n\tuserID, err := extractIDFromRequest(req)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusPreconditionFailed)\n\t\treturn\n\t}\n\n\tperson, err := loadPersonByID(userID)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\toutputPerson(resp, person)\n}\n\nfunc extractIDFromRequest(req *http.Request) (int64, error) {\n\terr := req.ParseForm()\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\treturn strconv.ParseInt(req.Form.Get(\"UserID\"), 10, 64)\n}\n\nfunc loadPersonByID(userID int64) (*Person, error) {\n\trow := DB.QueryRow(\"SELECT * FROM Users WHERE userID = ?\", userID)\n\n\tperson := &Person{}\n\terr := row.Scan(person.ID, person.Name, person.Phone)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn person, nil\n}\n\nfunc outputPerson(resp http.ResponseWriter, person *Person) {\n\tencoder := json.NewEncoder(resp)\n\terr := encoder.Encode(person)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n}\n" }, { "path": "ch02/02_open_closed_principle/01_open_closed_failure.go", "content": "package ocp\n\nimport (\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc BuildOutputOCPFail(response http.ResponseWriter, format string, person Person) {\n\tvar err error\n\n\tswitch format {\n\tcase \"csv\":\n\t\terr = outputCSV(response, person)\n\n\tcase \"json\":\n\t\terr = outputJSON(response, person)\n\t}\n\n\tif err != nil {\n\t\t// output a server error and quit\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tresponse.WriteHeader(http.StatusOK)\n}\n\n// output the person as CSV and return error when failing to do so\nfunc outputCSV(writer io.Writer, person Person) error {\n\t// TODO: implement\n\treturn nil\n}\n\n// output the person as JSON and return error when failing to do so\nfunc outputJSON(writer io.Writer, person Person) error {\n\t// TODO: implement\n\treturn nil\n}\n\n// A data transfer object that represents a person\ntype Person struct {\n\tName string\n\tEmail string\n}\n" }, { "path": "ch02/02_open_closed_principle/02_open_closed_success.go", "content": "package ocp\n\nimport (\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc BuildOutputOCPSuccess(response http.ResponseWriter, formatter PersonFormatter, person Person) {\n\terr := formatter.Format(response, person)\n\tif err != nil {\n\t\t// output a server error and quit\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tresponse.WriteHeader(http.StatusOK)\n}\n\ntype PersonFormatter interface {\n\tFormat(writer io.Writer, person Person) error\n}\n\n// output the person as CSV\ntype CSVPersonFormatter struct{}\n\n// Format implements the PersonFormatter interface\nfunc (c *CSVPersonFormatter) Format(writer io.Writer, person Person) error {\n\t// TODO: implement\n\treturn nil\n}\n\n// output the person as JSON\ntype JSONPersonFormatter struct{}\n\n// Format implements the PersonFormatter interface\nfunc (j *JSONPersonFormatter) Format(writer io.Writer, person Person) error {\n\t// TODO: implement\n\treturn nil\n}\n" }, { "path": "ch02/02_open_closed_principle/03_shotgun_surgery.go", "content": "package ocp\n\nimport (\n\t\"net/http\"\n\t\"strconv\"\n)\n\nfunc GetUserHandlerV1(resp http.ResponseWriter, req *http.Request) {\n\t// validate inputs\n\terr := req.ParseForm()\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\tuserID, err := strconv.ParseInt(req.Form.Get(\"UserID\"), 10, 64)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusPreconditionFailed)\n\t\treturn\n\t}\n\n\tuser := loadUser(userID)\n\toutputUser(resp, user)\n}\n\nfunc DeleteUserHandlerV1(resp http.ResponseWriter, req *http.Request) {\n\t// validate inputs\n\terr := req.ParseForm()\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\tuserID, err := strconv.ParseInt(req.Form.Get(\"UserID\"), 10, 64)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusPreconditionFailed)\n\t\treturn\n\t}\n\n\tdeleteUser(userID)\n}\n\nfunc loadUser(userID int64) interface{} {\n\t// TODO: implement\n\treturn nil\n}\n\nfunc deleteUser(userID int64) {\n\t// TODO: implement\n}\n\nfunc outputUser(resp http.ResponseWriter, user interface{}) {\n\t// TODO: implement\n}\n" }, { "path": "ch02/02_open_closed_principle/04_after_shotgun_surgery.go", "content": "package ocp\n\nimport (\n\t\"errors\"\n\t\"net/http\"\n\t\"net/url\"\n\t\"strconv\"\n)\n\nfunc GetUserHandlerV2(resp http.ResponseWriter, req *http.Request) {\n\t// validate inputs\n\terr := req.ParseForm()\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\tuserID, err := extractUserID(req.Form)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusPreconditionFailed)\n\t\treturn\n\t}\n\n\tuser := loadUser(userID)\n\toutputUser(resp, user)\n}\n\nfunc DeleteUserHandlerV2(resp http.ResponseWriter, req *http.Request) {\n\t// validate inputs\n\terr := req.ParseForm()\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\tuserID, err := extractUserID(req.Form)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusPreconditionFailed)\n\t\treturn\n\t}\n\n\tdeleteUser(userID)\n}\n\nfunc extractUserID(values url.Values) (int64, error) {\n\tuserID, err := strconv.ParseInt(values.Get(\"UserID\"), 10, 64)\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\n\tif userID <= 0 {\n\t\treturn 0, errors.New(\"userID must be positive\")\n\t}\n\n\treturn userID, nil\n}\n" }, { "path": "ch02/02_open_closed_principle/05_composition.go", "content": "package ocp\n\nimport (\n\t\"database/sql\"\n)\n\ntype rowConverter struct {\n}\n\n// populate the supplied Person from *sql.Row or *sql.Rows object\nfunc (d *rowConverter) populate(in *Person, scan func(dest ...interface{}) error) error {\n\treturn scan(in.Name, in.Email)\n}\n\ntype LoadPerson struct {\n\t// compose the row converter into this loader\n\trowConverter\n}\n\nfunc (loader *LoadPerson) ByID(id int) (Person, error) {\n\trow := loader.loadFromDB(id)\n\n\tperson := Person{}\n\t// call the composed \"abstract class\"\n\terr := loader.populate(&person, row.Scan)\n\n\treturn person, err\n}\n\nfunc (loader *LoadPerson) loadFromDB(id int) *sql.Row {\n\t// TODO: implement\n\treturn nil\n}\n\ntype LoadAll struct {\n\t// compose the row converter into this loader\n\trowConverter\n}\n\nfunc (loader *LoadPerson) All() ([]Person, error) {\n\trows := loader.loadAllFromDB()\n\tdefer rows.Close()\n\n\tvar output []Person\n\tfor rows.Next() {\n\t\tperson := Person{}\n\n\t\t// call the composed \"abstract class\"\n\t\terr := loader.populate(&person, rows.Scan)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\treturn output, nil\n}\n\nfunc (loader *LoadPerson) loadAllFromDB() *sql.Rows {\n\t// TODO: implement\n\treturn nil\n}\n" }, { "path": "ch02/02_open_closed_principle/06_handler_struct.go", "content": "package ocp\n\nimport (\n\t\"net/http\"\n)\n\n// a HTTP health check handler in long form\ntype healthCheckLong struct {\n}\n\nfunc (h *healthCheckLong) ServeHTTP(resp http.ResponseWriter, _ *http.Request) {\n\tresp.WriteHeader(http.StatusNoContent)\n}\n\nfunc healthCheckLongUsage() {\n\thttp.Handle(\"/health\", &healthCheckLong{})\n}\n" }, { "path": "ch02/02_open_closed_principle/07_handler_func.go", "content": "package ocp\n\nimport (\n\t\"net/http\"\n)\n\n// a HTTP health check handler in short form\nfunc healthCheckShort(resp http.ResponseWriter, _ *http.Request) {\n\tresp.WriteHeader(http.StatusNoContent)\n}\n\nfunc healthCheckShortUsage() {\n\thttp.Handle(\"/health\", http.HandlerFunc(healthCheckShort))\n}\n" }, { "path": "ch02/03_liskov_substitution_principle/01_violation/example.go", "content": "package lsp_violation\n\nfunc Go(vehicle actions) {\n\tif sled, ok := vehicle.(*Sled); ok {\n\t\tsled.pushStart()\n\t} else {\n\t\tvehicle.startEngine()\n\t}\n\n\tvehicle.drive()\n}\n\ntype actions interface {\n\tdrive()\n\tstartEngine()\n}\n\ntype Vehicle struct {\n}\n\nfunc (v Vehicle) drive() {\n\t// TODO: implement\n}\n\nfunc (v Vehicle) startEngine() {\n\t// TODO: implement\n}\n\nfunc (v Vehicle) stopEngine() {\n\t// TODO: implement\n}\n\ntype Car struct {\n\tVehicle\n}\n\ntype Sled struct {\n\tVehicle\n}\n\nfunc (s Sled) startEngine() {\n\t// override so that is does nothing\n}\n\nfunc (s Sled) stopEngine() {\n\t// override so that is does nothing\n}\n\nfunc (s Sled) pushStart() {\n\t// TODO: implement\n}\n" }, { "path": "ch02/03_liskov_substitution_principle/02_fixed/example.go", "content": "package fixedv1\n\nfunc Go(vehicle actions) {\n\tswitch concrete := vehicle.(type) {\n\tcase poweredActions:\n\t\tconcrete.startEngine()\n\n\tcase unpoweredActions:\n\t\tconcrete.pushStart()\n\t}\n\n\tvehicle.drive()\n}\n\ntype actions interface {\n\tdrive()\n}\n\ntype poweredActions interface {\n\tactions\n\tstartEngine()\n\tstopEngine()\n}\n\ntype unpoweredActions interface {\n\tactions\n\tpushStart()\n}\n\ntype Vehicle struct {\n}\n\nfunc (v Vehicle) drive() {\n\t// TODO: implement\n}\n\ntype PoweredVehicle struct {\n\tVehicle\n}\n\nfunc (v PoweredVehicle) startEngine() {\n\t// common engine start code\n}\n\ntype Car struct {\n\tPoweredVehicle\n}\n\ntype Sled struct {\n\tVehicle\n}\n\nfunc (s Sled) pushStart() {\n\t// do nothing\n}\n" }, { "path": "ch02/03_liskov_substitution_principle/03_fixed/example.go", "content": "package fixedv2\n\nfunc Go(vehicle actions) {\n\tvehicle.start()\n\tvehicle.drive()\n}\n\ntype actions interface {\n\tstart()\n\tdrive()\n}\n\ntype Car struct {\n\tpoweredVehicle\n}\n\nfunc (c Car) start() {\n\tc.poweredVehicle.startEngine()\n}\n\nfunc (c Car) drive() {\n\t// TODO: implement\n}\n\ntype poweredVehicle struct {\n}\n\nfunc (p poweredVehicle) startEngine() {\n\t// common engine start code\n}\n\ntype Sled struct {\n}\n\nfunc (s Sled) start() {\n\t// push start\n}\n\nfunc (s Sled) drive() {\n\t// TODO: implement\n}\n" }, { "path": "ch02/03_liskov_substitution_principle/04_behaviour.go", "content": "package lsp\n\ntype Collection interface {\n\tAdd(item interface{})\n\tGet(index int) interface{}\n}\n\ntype CollectionImpl struct {\n\titems []interface{}\n}\n\nfunc (c *CollectionImpl) Add(item interface{}) {\n\tc.items = append(c.items, item)\n}\n\nfunc (c *CollectionImpl) Get(index int) interface{} {\n\treturn c.items[index]\n}\n\ntype ReadOnlyCollection struct {\n\tCollectionImpl\n}\n\nfunc (ro *ReadOnlyCollection) Add(item interface{}) {\n\t// intentionally does nothing\n}\n" }, { "path": "ch02/03_liskov_substitution_principle/05_behaviour_fixed.go", "content": "package lsp\n\ntype ImmutableCollection interface {\n\tGet(index int) interface{}\n}\n\ntype MutableCollection interface {\n\tImmutableCollection\n\tAdd(item interface{})\n}\n\ntype ReadOnlyCollectionV2 struct {\n\titems []interface{}\n}\n\nfunc (ro *ReadOnlyCollectionV2) Get(index int) interface{} {\n\treturn ro.items[index]\n}\n\ntype CollectionImplV2 struct {\n\tReadOnlyCollectionV2\n}\n\nfunc (c *CollectionImplV2) Add(item interface{}) {\n\tc.items = append(c.items, item)\n}\n" }, { "path": "ch02/04_interface_segregation_principle/01_fat_interface.go", "content": "package isp\n\nimport (\n\t\"context\"\n)\n\ntype Item struct {\n\tKey string\n\tPayload []byte\n}\n\ntype FatDbInterface interface {\n\tBatchGetItem(IDs ...int) ([]Item, error)\n\tBatchGetItemWithContext(ctx context.Context, IDs ...int) ([]Item, error)\n\n\tBatchPutItem(items ...Item) error\n\tBatchPutItemWithContext(ctx context.Context, items ...Item) error\n\n\tDeleteItem(ID int) error\n\tDeleteItemWithContext(ctx context.Context, item Item) error\n\n\tGetItem(ID int) (Item, error)\n\tGetItemWithContext(ctx context.Context, ID int) (Item, error)\n\n\tPutItem(item Item) error\n\tPutItemWithContext(ctx context.Context, item Item) error\n\n\tQuery(query string, args ...interface{}) ([]Item, error)\n\tQueryWithContext(ctx context.Context, query string, args ...interface{}) ([]Item, error)\n\n\tUpdateItem(item Item) error\n\tUpdateItemWithContext(ctx context.Context, item Item) error\n}\n\ntype Cache struct {\n\tdb FatDbInterface\n}\n\nfunc (c *Cache) Get(key string) interface{} {\n\t// code removed\n\n\t// load from DB\n\t_, _ = c.db.GetItem(42)\n\n\t// code removed\n\treturn nil\n}\n\nfunc (c *Cache) Set(key string, value interface{}) {\n\t// code removed\n\n\t// save to DB\n\t_ = c.db.PutItem(Item{})\n\n\t// code removed\n}\n" }, { "path": "ch02/04_interface_segregation_principle/02_thin_interface.go", "content": "package isp\n\ntype myDB interface {\n\tGetItem(ID int) (Item, error)\n\tPutItem(item Item) error\n}\n\ntype CacheV2 struct {\n\tdb myDB\n}\n\nfunc (c *CacheV2) Get(key string) interface{} {\n\t// code removed\n\n\t// load from DB\n\t_, _ = c.db.GetItem(42)\n\n\t// code removed\n\treturn nil\n}\n\nfunc (c *CacheV2) Set(key string, value interface{}) {\n\t// code removed\n\n\t// save from DB\n\t_ = c.db.PutItem(Item{})\n\n\t// code removed\n}\n" }, { "path": "ch02/04_interface_segregation_principle/03_repeated_inputs.go", "content": "package isp\n\nimport (\n\t\"context\"\n\t\"errors\"\n)\n\nfunc Encrypt(ctx context.Context, data []byte) ([]byte, error) {\n\t// As this operation make take too long, we need to be able to kill it\n\tstop := ctx.Done()\n\tresult := make(chan []byte, 1)\n\n\tgo func() {\n\t\tdefer close(result)\n\n\t\t// pull the encryption key from context\n\t\tkeyRaw := ctx.Value(\"encryption-key\")\n\t\tif keyRaw == nil {\n\t\t\tpanic(\"encryption key not found in context\")\n\t\t}\n\t\tkey := keyRaw.([]byte)\n\n\t\t// perform encryption\n\t\tciperText := performEncryption(key, data)\n\n\t\t// signal complete by sending the result\n\t\tresult <- ciperText\n\t}()\n\n\tselect {\n\tcase ciperText := <-result:\n\t\t// happy path\n\t\treturn ciperText, nil\n\n\tcase <-stop:\n\t\t// cancelled\n\t\treturn nil, errors.New(\"operation cancelled\")\n\t}\n}\n\nfunc performEncryption(key []byte, data []byte) []byte {\n\t// TODO: implement\n\treturn nil\n}\n" }, { "path": "ch02/04_interface_segregation_principle/04_repeated_inputs.go", "content": "package isp\n\nimport (\n\t\"errors\"\n)\n\ntype Value interface {\n\tValue(key interface{}) interface{}\n}\n\ntype Monitor interface {\n\tDone() <-chan struct{}\n}\n\nfunc EncryptV2(keyValue Value, monitor Monitor, data []byte) ([]byte, error) {\n\t// As this operation make take too long, we need to be able to kill it\n\tstop := monitor.Done()\n\tresult := make(chan []byte, 1)\n\n\tgo func() {\n\t\tdefer close(result)\n\n\t\t// pull the encryption key from Value\n\t\tkeyRaw := keyValue.Value(\"encryption-key\")\n\t\tif keyRaw == nil {\n\t\t\tpanic(\"encryption key not found in context\")\n\t\t}\n\t\tkey := keyRaw.([]byte)\n\n\t\t// perform encryption\n\t\tciperText := performEncryption(key, data)\n\n\t\t// signal complete by sending the result\n\t\tresult <- ciperText\n\t}()\n\n\tselect {\n\tcase ciperText := <-result:\n\t\t// happy path\n\t\treturn ciperText, nil\n\n\tcase <-stop:\n\t\t// cancelled\n\t\treturn nil, errors.New(\"operation cancelled\")\n\t}\n}\n" }, { "path": "ch02/04_interface_segregation_principle/05_repeated_inputs.go", "content": "package isp\n\nimport (\n\t\"context\"\n)\n\nfunc UseEncryptV2() {\n\t// create a context\n\tctx, cancel := context.WithCancel(context.Background())\n\tdefer cancel()\n\n\t// store the key\n\tctx = context.WithValue(ctx, \"encryption-key\", \"-secret-\")\n\n\t// call the function\n\t_, _ = EncryptV2(ctx, ctx, []byte(\"my data\"))\n}\n" }, { "path": "ch02/04_interface_segregation_principle/06_implicit_interfaces.go", "content": "package isp\n\nimport (\n\t\"fmt\"\n)\n\ntype Talker interface {\n\tSayHello() string\n}\n\ntype Dog struct{}\n\n// The method implicitly implements the Talker interface\nfunc (d Dog) SayHello() string {\n\treturn \"Woof!\"\n}\n\nfunc Speak() {\n\tvar talker Talker\n\ttalker = Dog{}\n\n\tfmt.Print(talker.SayHello())\n}\n" }, { "path": "ch03/01_optimizing_for_humans/01_not_so_simple.go", "content": "package humans\n\nimport (\n\t\"bytes\"\n\t\"strconv\"\n\t\"strings\"\n)\n\nfunc NotSoSimple(ID int64, name string, age int, registered bool) string {\n\tout := &bytes.Buffer{}\n\tout.WriteString(strconv.FormatInt(ID, 10))\n\tout.WriteString(\"-\")\n\tout.WriteString(strings.Replace(name, \" \", \"_\", -1))\n\tout.WriteString(\"-\")\n\tout.WriteString(strconv.Itoa(age))\n\tout.WriteString(\"-\")\n\tout.WriteString(strconv.FormatBool(registered))\n\treturn out.String()\n}\n" }, { "path": "ch03/01_optimizing_for_humans/02_start_simple.go", "content": "package humans\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n)\n\nfunc Simpler(ID int64, name string, age int, registered bool) string {\n\tnameWithNoSpaces := strings.Replace(name, \" \", \"_\", -1)\n\treturn fmt.Sprintf(\"%d-%s-%d-%t\", ID, nameWithNoSpaces, age, registered)\n}\n" }, { "path": "ch03/01_optimizing_for_humans/03_too_abstract.go", "content": "package humans\n\nimport (\n\t\"io/ioutil\"\n\t\"net/http\"\n)\n\ntype myGetter interface {\n\tGet(url string) (*http.Response, error)\n}\n\nfunc TooAbstract(getter myGetter, url string) ([]byte, error) {\n\tresp, err := getter.Get(url)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer resp.Body.Close()\n\n\treturn ioutil.ReadAll(resp.Body)\n}\n" }, { "path": "ch03/01_optimizing_for_humans/04_common_concept.go", "content": "package humans\n\nimport (\n\t\"io/ioutil\"\n\t\"net/http\"\n)\n\nfunc CommonConcept(url string) ([]byte, error) {\n\tresp, err := http.Get(url)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer resp.Body.Close()\n\n\treturn ioutil.ReadAll(resp.Body)\n}\n" }, { "path": "ch03/01_optimizing_for_humans/05_boolean_param.go", "content": "package humans\n\nimport (\n\t\"time\"\n)\n\ntype Pet struct {\n\tName string\n\tDog bool\n\tBorn time.Time\n}\n\nfunc NewPet(name string, isDog bool) Pet {\n\treturn Pet{\n\t\tName: name,\n\t\tDog: isDog,\n\t\tBorn: time.Now(),\n\t}\n}\n\nfunc CreatePetsV1() {\n\tNewPet(\"Fido\", true)\n}\n" }, { "path": "ch03/01_optimizing_for_humans/06_hidden_boolean.go", "content": "package humans\n\nconst (\n\tisDog = true\n\tisCat = false\n)\n\nfunc NewDog(name string) Pet {\n\treturn NewPet(name, isDog)\n}\n\nfunc NewCat(name string) Pet {\n\treturn NewPet(name, isCat)\n}\n\nfunc CreatePetsV2() {\n\tNewDog(\"Fido\")\n}\n" }, { "path": "ch03/01_optimizing_for_humans/07_wide_formatter.go", "content": "package humans\n\ntype WideFormatter interface {\n\tToCSV(pets []Pet) ([]byte, error)\n\tToGOB(pets []Pet) ([]byte, error)\n\tToJSON(pets []Pet) ([]byte, error)\n}\n" }, { "path": "ch03/01_optimizing_for_humans/08_thin_formatters.go", "content": "package humans\n\ntype ThinFormatter interface {\n\tFormat(pets []Pet) ([]byte, error)\n}\n\ntype CSVFormatter struct{}\n\nfunc (f CSVFormatter) Format(pets []Pet) ([]byte, error) {\n\t// convert slice of pets to CSV\n\treturn nil, nil\n}\n\ntype GOBFormatter struct{}\n\nfunc (f GOBFormatter) Format(pets []Pet) ([]byte, error) {\n\t// convert slice of pets to GOB\n\treturn nil, nil\n}\n\ntype JSONFormatter struct{}\n\nfunc (f JSONFormatter) Format(pets []Pet) ([]byte, error) {\n\t// convert slice of pets to JSON\n\treturn nil, nil\n}\n" }, { "path": "ch03/01_optimizing_for_humans/09_extra_config.go", "content": "package humans\n\n// PetFetcher searches the data store for pets whos name matches the search string.\n// Limit is optional (default is 100). Offset is optional (default 0).\n// sortBy is optional (default name). sortAscending is optional\nfunc PetFetcher(search string, limit int, offset int, sortBy string, sortAscending bool) []Pet {\n\treturn []Pet{}\n}\n\nfunc PetFetcherTypicalUsage() {\n\t_ = PetFetcher(\"Fido\", 0, 0, \"\", true)\n}\n" }, { "path": "ch03/02_unit_tests/01_loader.go", "content": "package unit_tests\n\nimport (\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\ntype Loader interface {\n\tLoad(ID int) (*Pet, error)\n}\n\nfunc TestLoadAndPrint_happyPath(t *testing.T) {\n\tresult := &bytes.Buffer{}\n\tLoadAndPrint(&happyPathLoader{}, 1, result)\n\tassert.Contains(t, result.String(), \"Pet named\")\n}\n\nfunc TestLoadAndPrint_notFound(t *testing.T) {\n\tresult := &bytes.Buffer{}\n\tLoadAndPrint(&missingLoader{}, 1, result)\n\tassert.Contains(t, result.String(), \"no such pet\")\n}\n\nfunc TestLoadAndPrint_error(t *testing.T) {\n\tresult := &bytes.Buffer{}\n\tLoadAndPrint(&errorLoader{}, 1, result)\n\tassert.Contains(t, result.String(), \"failed to load\")\n}\n\nfunc LoadAndPrint(loader Loader, ID int, dest io.Writer) {\n\tloadedPet, err := loader.Load(ID)\n\tif err != nil {\n\t\tfmt.Fprintf(dest, \"failed to load pet with ID %d with error: %s\", ID, err)\n\t\treturn\n\t}\n\n\tif loadedPet == nil {\n\t\tfmt.Fprintf(dest, \"no such pet found\")\n\t\treturn\n\t}\n\n\tfmt.Fprintf(dest, \"Pet named %s loaded\", loadedPet.Name)\n}\n\n// implements Loader\ntype happyPathLoader struct {\n}\n\nfunc (l *happyPathLoader) Load(ID int) (*Pet, error) {\n\treturn &Pet{}, nil\n}\n\n// implements Loader\ntype missingLoader struct {\n}\n\nfunc (l *missingLoader) Load(ID int) (*Pet, error) {\n\treturn nil, nil\n}\n\n// implements Loader\ntype errorLoader struct {\n}\n\nfunc (l *errorLoader) Load(ID int) (*Pet, error) {\n\treturn nil, errors.New(\"failed\")\n}\n" }, { "path": "ch03/02_unit_tests/02_language_feature.go", "content": "package unit_tests\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\ntype Pet struct {\n\tName string\n}\n\nfunc NewPet(name string) *Pet {\n\treturn &Pet{\n\t\tName: name,\n\t}\n}\n\nfunc TestLanguageFeatures(t *testing.T) {\n\tpetFish := NewPet(\"Goldie\")\n\tassert.IsType(t, &Pet{}, petFish)\n}\n" }, { "path": "ch03/02_unit_tests/03_simple_test.go", "content": "package unit_tests\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc concat(a, b string) string {\n\treturn a + b\n}\n\nfunc TestTooSimple(t *testing.T) {\n\ta := \"Hello \"\n\tb := \"World\"\n\texpected := \"Hello World\"\n\n\tassert.Equal(t, expected, concat(a, b))\n}\n" }, { "path": "ch03/02_unit_tests/04_test_from_api.go", "content": "package unit_tests\n\nimport (\n\t\"database/sql\"\n)\n\ntype PetSaver struct{}\n\n// save the supplied pet and return the ID\nfunc (p PetSaver) Save(pet Pet) (int, error) {\n\terr := p.validate(pet)\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\n\tresult, err := p.save(pet)\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\n\treturn p.extractID(result)\n}\n\n// ensure the pet record is complete\nfunc (p PetSaver) validate(pet Pet) error {\n\treturn nil\n}\n\n// save to the datastore\nfunc (p PetSaver) save(pet Pet) (sql.Result, error) {\n\treturn nil, nil\n}\n\n// extract the ID from the result\nfunc (p PetSaver) extractID(result sql.Result) (int, error) {\n\treturn 0, nil\n}\n" }, { "path": "ch03/02_unit_tests/05_repeated_code.go", "content": "package unit_tests\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\n// Round the supplied number to the nearest integer\nfunc Round(in float64) int {\n\treturn 0\n}\n\nfunc TestRound_down(t *testing.T) {\n\tin := float64(1.1)\n\texpected := 1\n\n\tresult := Round(in)\n\tassert.Equal(t, expected, result)\n}\n\nfunc TestRound_up(t *testing.T) {\n\tin := float64(3.7)\n\texpected := 4\n\n\tresult := Round(in)\n\tassert.Equal(t, expected, result)\n}\n\nfunc TestRound_noChange(t *testing.T) {\n\tin := float64(6.0)\n\texpected := 6\n\n\tresult := Round(in)\n\tassert.Equal(t, expected, result)\n}\n" }, { "path": "ch03/02_unit_tests/06_tdt.go", "content": "package unit_tests\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestRound(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin float64\n\t\texpected int\n\t}{\n\t\t{\n\t\t\tdesc: \"round down\",\n\t\t\tin: 1.1,\n\t\t\texpected: 1,\n\t\t},\n\t\t{\n\t\t\tdesc: \"round up\",\n\t\t\tin: 3.7,\n\t\t\texpected: 4,\n\t\t},\n\t\t{\n\t\t\tdesc: \"unchanged\",\n\t\t\tin: 6.0,\n\t\t\texpected: 6,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\tin := scenario.in\n\n\t\tresult := Round(in)\n\t\tassert.Equal(t, scenario.expected, result)\n\t}\n}\n" }, { "path": "ch03/02_unit_tests/07_person_loader.go", "content": "package unit_tests\n\nimport (\n\t\"errors\"\n)\n\nvar ErrNotFound = errors.New(\"person not found\")\n\ntype Person struct {\n\tName string\n}\n\n//go:generate mockery -name PersonLoader -testonly -inpkg -case=underscore\ntype PersonLoader interface {\n\tLoad(ID int) (*Person, error)\n}\n\nfunc LoadPersonName(loader PersonLoader, ID int) (string, error) {\n\tperson, err := loader.Load(ID)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\treturn person.Name, nil\n}\n" }, { "path": "ch03/02_unit_tests/08_stub.go", "content": "package unit_tests\n\n// Stubbed implementation of PersonLoader\ntype PersonLoaderStub struct {\n\tPerson *Person\n\tError error\n}\n\nfunc (p *PersonLoaderStub) Load(ID int) (*Person, error) {\n\treturn p.Person, p.Error\n}\n" }, { "path": "ch03/02_unit_tests/09_stub_tdt.go", "content": "package unit_tests\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestLoadPersonNameStubs(t *testing.T) {\n\t// this value does not matter as the stub ignores it\n\tfakeID := 1\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tloaderStub *PersonLoaderStub\n\t\texpectedName string\n\t\texpectErr bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tloaderStub: &PersonLoaderStub{\n\t\t\t\tPerson: &Person{Name: \"Sophia\"},\n\t\t\t},\n\t\t\texpectedName: \"Sophia\",\n\t\t\texpectErr: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"input error\",\n\t\t\tloaderStub: &PersonLoaderStub{\n\t\t\t\tError: ErrNotFound,\n\t\t\t},\n\t\t\texpectedName: \"\",\n\t\t\texpectErr: true,\n\t\t},\n\t\t{\n\t\t\tdesc: \"system error path\",\n\t\t\tloaderStub: &PersonLoaderStub{\n\t\t\t\tError: errors.New(\"something failed\"),\n\t\t\t},\n\t\t\texpectedName: \"\",\n\t\t\texpectErr: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\tresult, resultErr := LoadPersonName(scenario.loaderStub, fakeID)\n\n\t\tassert.Equal(t, scenario.expectedName, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectErr, resultErr != nil, scenario.desc)\n\t}\n}\n" }, { "path": "ch03/02_unit_tests/10_mocks.go", "content": "package unit_tests\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\nfunc TestLoadPersonName(t *testing.T) {\n\t// this value does not matter as the stub ignores it\n\tfakeID := 1\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMock func(stub *PersonLoaderMock)\n\t\texpectedName string\n\t\texpectErr bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMock: func(loaderMock *PersonLoaderMock) {\n\t\t\t\tloaderMock.On(\"Load\", mock.Anything).\n\t\t\t\t\tReturn(&Person{Name: \"Sophia\"}, nil).\n\t\t\t\t\tOnce()\n\t\t\t},\n\t\t\texpectedName: \"Sophia\",\n\t\t\texpectErr: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"input error\",\n\t\t\tconfigureMock: func(loaderMock *PersonLoaderMock) {\n\t\t\t\tloaderMock.On(\"Load\", mock.Anything).\n\t\t\t\t\tReturn(nil, ErrNotFound).\n\t\t\t\t\tOnce()\n\t\t\t},\n\t\t\texpectedName: \"\",\n\t\t\texpectErr: true,\n\t\t},\n\t\t{\n\t\t\tdesc: \"system error path\",\n\t\t\tconfigureMock: func(loaderMock *PersonLoaderMock) {\n\t\t\t\tloaderMock.On(\"Load\", mock.Anything).\n\t\t\t\t\tReturn(nil, errors.New(\"something failed\")).\n\t\t\t\t\tOnce()\n\t\t\t},\n\t\t\texpectedName: \"\",\n\t\t\texpectErr: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\tmockLoader := &PersonLoaderMock{}\n\t\tscenario.configureMock(mockLoader)\n\n\t\tresult, resultErr := LoadPersonName(mockLoader, fakeID)\n\n\t\tassert.Equal(t, scenario.expectedName, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectErr, resultErr != nil, scenario.desc)\n\t\tassert.True(t, mockLoader.AssertExpectations(t), scenario.desc)\n\t}\n}\n\n// Mocked implementation of PersonLoader\ntype PersonLoaderMock struct {\n\tmock.Mock\n}\n\nfunc (p *PersonLoaderMock) Load(ID int) (*Person, error) {\n\toutputs := p.Mock.Called(ID)\n\n\tperson := outputs.Get(0)\n\terr := outputs.Error(1)\n\n\tif person != nil {\n\t\treturn person.(*Person), err\n\t}\n\n\treturn nil, err\n}\n" }, { "path": "ch03/03_test_induced_damage/01_io_closer.go", "content": "package test_damage\n\nimport (\n\t\"io\"\n)\n\nfunc WriteAndClose(destination io.WriteCloser, contents string) error {\n\tdefer destination.Close()\n\n\t_, err := destination.Write([]byte(contents))\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn nil\n}\n" }, { "path": "ch03/03_test_induced_damage/02_json.go", "content": "package test_damage\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n)\n\nfunc PrintAsJSON(destination io.Writer, plant Plant) error {\n\tbytes, err := json.Marshal(plant)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tdestination.Write(bytes)\n\treturn nil\n}\n\ntype Plant struct {\n\tName string\n}\n" }, { "path": "ch03/04_visualizing_dependencies/depgraph.sh", "content": "#!/usr/bin/env bash\n\n# Note:\n# This script should be run in the base directory of the project/service\n\n# Inputs\n#\n# This cuts down on typing by allowing you to enter only the sub-directory you wish to graph; instead of the entire\n# package\nprefix=\"./\"\nPKG=${1#$prefix}\n\n# Constants\n#\n# Save the file on the desktop (so it's easy to find)\nDEST_FILE=~/Desktop/depgraph.png\n\n# Calculate the package in the current directory and assume this is the base or project package\nBASE_PKG=$(go list)\nEXCLUSIONS=\"$BASE_PKG/vendor\"\nBASE_PKG_DELIMITED=$(echo $BASE_PKG | sed 's/\\//\\\\\\//g')\n\n# Generate\ngodepgraph -s \\\n -o \"$BASE_PKG\" \\\n -p \"$EXCLUSIONS\" \\\n $BASE_PKG/${PKG} |\n sed \"s/$BASE_PKG_DELIMITED//g\" | dot -Tpng -o $DEST_FILE\n\n# Open\nopen $DEST_FILE\n" }, { "path": "ch03/fake.go", "content": "package Hands_On_Dependency_Injection_in_Go\n\nfunc init() {\n\t// This file is included so that Go tools (like `go list`) will find Go code in this directory and not error\n}\n" }, { "path": "ch04/01_welcome/01_bad_names.go", "content": "package welcome\n\ntype HouseV1 struct {\n\ta string\n\tb int\n\tt int\n\tp float64\n}\n" }, { "path": "ch04/01_welcome/02_improved_names.go", "content": "package welcome\n\ntype HouseV2 struct {\n\taddress string\n\tbedrooms int\n\ttoilets int\n\tprice float64\n}\n" }, { "path": "ch04/01_welcome/03_long_method.go", "content": "package welcome\n\nimport (\n\t\"database/sql\"\n\t\"encoding/json\"\n\t\"net/http\"\n\t\"strconv\"\n)\n\nfunc longMethod(resp http.ResponseWriter, req *http.Request) {\n\terr := req.ParseForm()\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusPreconditionFailed)\n\t\treturn\n\t}\n\tuserID, err := strconv.ParseInt(req.Form.Get(\"UserID\"), 10, 64)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusPreconditionFailed)\n\t\treturn\n\t}\n\n\trow := DB.QueryRow(\"SELECT * FROM people WHERE ID = ?\", userID)\n\n\tperson := &Person{}\n\terr = row.Scan(&person.ID, &person.Name, &person.Phone)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tencoder := json.NewEncoder(resp)\n\terr = encoder.Encode(person)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n}\n\nvar DB *sql.DB\n\ntype Person struct {\n\tID int64\n\tName string\n\tPhone string\n}\n" }, { "path": "ch04/01_welcome/04_long_method_test.go", "content": "package welcome\n\nimport (\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"net/url\"\n\t\"testing\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLongMethod_happyPath(t *testing.T) {\n\t// build request\n\trequest := &http.Request{}\n\trequest.PostForm = url.Values{}\n\trequest.PostForm.Add(\"UserID\", \"123\")\n\n\t// mock the database\n\tvar mockDB sqlmock.Sqlmock\n\tvar err error\n\n\tDB, mockDB, err = sqlmock.New()\n\trequire.NoError(t, err)\n\tmockDB.ExpectQuery(\"SELECT .* FROM people WHERE ID = ?\").\n\t\tWithArgs(123).\n\t\tWillReturnRows(sqlmock.NewRows([]string{\"ID\", \"Name\", \"Phone\"}).AddRow(123, \"May\", \"0123456789\"))\n\n\t// build response\n\tresponse := httptest.NewRecorder()\n\n\t// call method\n\tlongMethod(response, request)\n\n\t// validate response\n\trequire.Equal(t, http.StatusOK, response.Code)\n\n\t// validate the JSON\n\tresponseBytes, err := ioutil.ReadAll(response.Body)\n\trequire.NoError(t, err)\n\n\texpectedJSON := `{\"ID\":123,\"Name\":\"May\",\"Phone\":\"0123456789\"}` + \"\\n\"\n\tassert.Equal(t, expectedJSON, string(responseBytes))\n}\n" }, { "path": "ch04/01_welcome/05_short_methods.go", "content": "package welcome\n\nimport (\n\t\"encoding/json\"\n\t\"net/http\"\n\t\"strconv\"\n)\n\nfunc shortMethods(resp http.ResponseWriter, req *http.Request) {\n\tuserID, err := extractUserID(req)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tperson, err := loadPerson(userID)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\toutputPerson(resp, person)\n}\n\nfunc extractUserID(req *http.Request) (int64, error) {\n\terr := req.ParseForm()\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\n\treturn strconv.ParseInt(req.Form.Get(\"UserID\"), 10, 64)\n}\n\nfunc loadPerson(userID int64) (*Person, error) {\n\trow := DB.QueryRow(\"SELECT * FROM people WHERE ID = ?\", userID)\n\n\tperson := &Person{}\n\terr := row.Scan(&person.ID, &person.Name, &person.Phone)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn person, nil\n}\n\nfunc outputPerson(resp http.ResponseWriter, person *Person) {\n\tencoder := json.NewEncoder(resp)\n\terr := encoder.Encode(person)\n\tif err != nil {\n\t\tresp.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n}\n" }, { "path": "ch04/03_known_issues/01_data_and_rest/get_example.go", "content": "//+build ignore\n\npackage data_and_rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/01/data\"\n)\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *data.Person) error {\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(person)\n}\n" }, { "path": "ch04/03_known_issues/02_config_coupling/config.go", "content": "package config_coupling\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/03_known_issues/02_config_coupling/currency\"\n)\n\ntype Config struct {\n\tDefaultCurrency currency.Currency `json:\"default_currency\"`\n}\n" }, { "path": "ch04/03_known_issues/02_config_coupling/currency/currency.go", "content": "package currency\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n)\n\n// Currency is a custom type; used for convenience and code readability\ntype Currency string\n\n// UnmarshalJSON implements json.Unmarshaler\nfunc (c *Currency) UnmarshalJSON(in []byte) error {\n\tvar s string\n\terr := json.Unmarshal(in, &s)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tcurrency, valid := validCurrencies[s]\n\tif !valid {\n\t\treturn fmt.Errorf(\"'%s' is not a valid currency\", s)\n\t}\n\n\t*c = currency\n\n\treturn nil\n}\n\nconst (\n\tAUD = Currency(\"AUD\")\n\tCNY = Currency(\"CNY\")\n\tEUR = Currency(\"EUR\")\n\tUSD = Currency(\"USD\")\n)\n\n// a map of valid currencies\nvar validCurrencies = map[string]Currency{\n\tstring(AUD): AUD,\n\tstring(CNY): CNY,\n\tstring(EUR): EUR,\n\tstring(USD): USD,\n}\n" }, { "path": "ch04/acme/internal/config/config.go", "content": "package config\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// App is the application config\nvar App *Config\n\n// Config defines the JSON format for the config file\ntype Config struct {\n\t// DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n\tDSN string\n\n\t// Address is the IP address and port to bind this rest to\n\tAddress string\n\n\t// BasePrice is the price of registration\n\tBasePrice float64\n\n\t// ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n\tExchangeRateBaseURL string\n\n\t// ExchangeRateAPIKey is the API for the exchange rate API\n\tExchangeRateAPIKey string\n}\n\n// Load returns the config loaded from environment\nfunc init() {\n\tfilename, found := os.LookupEnv(DefaultEnvVar)\n\tif !found {\n\t\tlogging.L.Error(\"failed to locate file specified by %s\", DefaultEnvVar)\n\t\treturn\n\t}\n\n\t_ = load(filename)\n}\n\nfunc load(filename string) error {\n\tApp = &Config{}\n\tbytes, err := ioutil.ReadFile(filename)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to read config file. err: %s\", err)\n\t\treturn err\n\t}\n\n\terr = json.Unmarshal(bytes, App)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to parse config file. err : %s\", err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n" }, { "path": "ch04/acme/internal/config/config_test.go", "content": "package config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoad(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin string\n\t\texpectedConfig *Config\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tin: \"../../../../default-config.json\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tDSN: \"[insert your db config here]\",\n\t\t\t\tAddress: \"0.0.0.0:8080\",\n\t\t\t\tBasePrice: 100.00,\n\t\t\t\tExchangeRateBaseURL: \"http://apilayer.net\",\n\t\t\t\tExchangeRateAPIKey: \"[insert your API key here]\",\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"invalid path\",\n\t\t\tin: \"invalid.json\",\n\t\t\texpectedConfig: &Config{},\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\tresultErr := load(scenario.in)\n\t\t\trequire.Equal(t, scenario.expectError, resultErr != nil, \"err: %s\", resultErr)\n\t\t\tassert.Equal(t, scenario.expectedConfig, App, scenario.desc)\n\t\t})\n\t}\n\n}\n" }, { "path": "ch04/acme/internal/logging/logging.go", "content": "package logging\n\nimport (\n\t\"fmt\"\n)\n\n// L is the global instance of the logger\nvar L = &LoggerStdOut{}\n\n// LoggerStdOut logs to std out\ntype LoggerStdOut struct{}\n\n// Debug logs messages at DEBUG level\nfunc (l LoggerStdOut) Debug(message string, args ...interface{}) {\n\tfmt.Printf(\"[DEBUG] \"+message, args...)\n}\n\n// Info logs messages at INFO level\nfunc (l LoggerStdOut) Info(message string, args ...interface{}) {\n\tfmt.Printf(\"[INFO] \"+message, args...)\n}\n\n// Warn logs messages at WARN level\nfunc (l LoggerStdOut) Warn(message string, args ...interface{}) {\n\tfmt.Printf(\"[WARN] \"+message, args...)\n}\n\n// Error logs messages at ERROR level\nfunc (l LoggerStdOut) Error(message string, args ...interface{}) {\n\tfmt.Printf(\"[ERROR] \"+message, args...)\n}\n" }, { "path": "ch04/acme/internal/modules/data/data.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/logging\"\n\t// import the MySQL Driver\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\nfunc getDB() (*sql.DB, error) {\n\tif db == nil {\n\t\tif config.App == nil {\n\t\t\treturn nil, errors.New(\"config is not initialized\")\n\t\t}\n\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", config.App.DSN)\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc Save(in *Person) (int, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// perform DB insert\n\tquery := \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tresult, err := db.Exec(query, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\treturn int(id), nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc LoadAll() ([]*Person, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// perform DB select\n\tquery := \"SELECT id, fullname, phone, currency, price FROM person\"\n\trows, err := db.Query(query)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\tlogging.L.Error(\"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\tlogging.L.Warn(\"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc Load(ID int) (*Person, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// perform DB select\n\tquery := \"SELECT id, fullname, phone, currency, price FROM person WHERE id = ? LIMIT 1\"\n\trow := db.QueryRow(query, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\tlogging.L.Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\tlogging.L.Error(\"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n" }, { "path": "ch04/acme/internal/modules/data/data_test.go", "content": "package data\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestData_happyPath(t *testing.T) {\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// save\n\tresultID, err := Save(in)\n\trequire.Nil(t, err)\n\tassert.True(t, resultID > 0)\n\n\t// load\n\treturned, err := Load(resultID)\n\trequire.NoError(t, err)\n\n\tin.ID = resultID\n\tassert.Equal(t, in, returned)\n\n\t// load all\n\tall, err := LoadAll()\n\trequire.NoError(t, err)\n\tassert.True(t, len(all) > 0)\n}\n" }, { "path": "ch04/acme/internal/modules/exchange/converter.go", "content": "package exchange\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/logging\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct{}\n\n// Do will perform the conversion\nfunc (c *Converter) Do(basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tconfig.App.ExchangeRateBaseURL,\n\t\tconfig.App.ExchangeRateAPIKey,\n\t\tcurrency)\n\n\t// perform request\n\tresponse, err := http.Get(url)\n\tif err != nil {\n\t\tlogging.L.Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tlogging.L.Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tlogging.L.Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tlogging.L.Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tlogging.L.Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n" }, { "path": "ch04/acme/internal/modules/get/get.go", "content": "package get\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when the requested person is not in the database\n\terrPersonNotFound = errors.New(\"person not found\")\n)\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\t// load person from the data layer\n\tperson, err := data.Load(ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn person, err\n}\n" }, { "path": "ch04/acme/internal/modules/get/go_test.go", "content": "package get\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetter_Do(t *testing.T) {\n\t// inputs\n\tID := 1\n\tname := \"John\"\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, ID, person.ID)\n\tassert.Equal(t, name, person.FullName)\n}\n" }, { "path": "ch04/acme/internal/modules/list/list.go", "content": "package list\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when there are no people in the database\n\terrPeopleNotFound = errors.New(\"no people found\")\n)\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n}\n\n// Do will load the people from the data layer\nfunc (l *Lister) Do() ([]*data.Person, error) {\n\t// load all people\n\tpeople, err := l.load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(people) == 0 {\n\t\t// special processing for 0 people returned\n\t\treturn nil, errPeopleNotFound\n\t}\n\n\treturn people, nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n\tpeople, err := data.LoadAll()\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPeopleNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn people, nil\n}\n" }, { "path": "ch04/acme/internal/modules/list/list_test.go", "content": "package list\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLister_Do(t *testing.T) {\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.True(t, len(persons) >= 4)\n}\n" }, { "path": "ch04/acme/internal/modules/register/register.go", "content": "package register\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/exchange\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\t// validation errors\n\terrNameMissing = errors.New(\"name is missing\")\n\terrPhoneMissing = errors.New(\"phone is missing\")\n\terrCurrencyMissing = errors.New(\"currency is missing\")\n\terrInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n\t// a little trick to make checking for supported currencies easier\n\tsupportedCurrencies = map[string]struct{}{\n\t\t\"AUD\": {},\n\t\t\"CNY\": {},\n\t\t\"EUR\": {},\n\t\t\"GBP\": {},\n\t\t\"JPY\": {},\n\t\t\"MYR\": {},\n\t\t\"SGD\": {},\n\t\t\"USD\": {},\n\t}\n)\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(in *data.Person) (int, error) {\n\t// validate the request\n\terr := r.validateInput(in)\n\tif err != nil {\n\t\tlogging.L.Warn(\"input validation failed with err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// get price in the requested currency\n\tprice, err := r.getPrice(in.Currency)\n\tif err != nil {\n\t\treturn defaultPersonID, err\n\t}\n\n\t// save registration\n\tid, err := r.save(in, price)\n\tif err != nil {\n\t\t// no need to log here as we expect the data layer to do so\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *data.Person) error {\n\tif in.FullName == \"\" {\n\t\treturn errNameMissing\n\t}\n\tif in.Phone == \"\" {\n\t\treturn errPhoneMissing\n\t}\n\tif in.Currency == \"\" {\n\t\treturn errCurrencyMissing\n\t}\n\n\tif _, found := supportedCurrencies[in.Currency]; !found {\n\t\treturn errInvalidCurrency\n\t}\n\n\t// happy path\n\treturn nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(currency string) (float64, error) {\n\tconverter := &exchange.Converter{}\n\tprice, err := converter.Do(config.App.BasePrice, currency)\n\tif err != nil {\n\t\tlogging.L.Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(in *data.Person, price float64) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tCurrency: in.Currency,\n\t\tPrice: price,\n\t}\n\treturn data.Save(person)\n}\n" }, { "path": "ch04/acme/internal/modules/register/register_test.go", "content": "package register\n\nimport (\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterer_Do(t *testing.T) {\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233345\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{}\n\tID, err := registerer.Do(in)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.True(t, ID > 0)\n}\n" }, { "path": "ch04/acme/internal/rest/common_test.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"net\"\n)\n\nfunc getOpenPort() (string, error) {\n\tlistener, err := net.Listen(\"tcp\", \"127.0.0.1:0\")\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\taddress := listener.Addr().String()\n\tlistener.Close()\n\n\treturn address, nil\n}\n\nfunc startServer(ctx context.Context) (string, error) {\n\t// get open port\n\taddress, err := getOpenPort()\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\t// start a server\n\tserver := New(address)\n\tgo server.Listen(ctx.Done())\n\n\t// wait for server to be ready\n\tdialer := &net.Dialer{}\n\tfor {\n\t\tconn, _ := dialer.DialContext(ctx, \"tcp\", address)\n\t\tif conn != nil {\n\t\t\tdefer conn.Close()\n\n\t\t\treturn address, nil\n\t\t}\n\n\t\tselect {\n\t\tcase <-ctx.Done():\n\t\t\treturn \"\", ctx.Err()\n\n\t\tdefault:\n\t\t\t// try again\n\t\t}\n\t}\n\n\treturn address, nil\n}\n" }, { "path": "ch04/acme/internal/rest/get.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/get\"\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tgetter := get.Getter{}\n\tperson, err := getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[\"id\"]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\tlogging.L.Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\tlogging.L.Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *data.Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n" }, { "path": "ch04/acme/internal/rest/get_test.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetHandler_ServeHTTP(t *testing.T) {\n\t// ensure the test always fails by giving it a timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// Create and start a server\n\t// With out current implementation, we cannot test this handler without a full server as we need the mux.\n\taddress, err := startServer(ctx)\n\trequire.NoError(t, err)\n\n\t// build inputs\n\tresponse, err := http.Get(\"http://\" + address + \"/person/1/\")\n\n\t// validate outputs\n\trequire.NoError(t, err)\n\trequire.Equal(t, http.StatusOK, response.StatusCode)\n\n\texpectedPayload := []byte(`{\"id\":1,\"name\":\"John\",\"phone\":\"0123456780\",\"currency\":\"USD\",\"price\":100}` + \"\\n\")\n\tpayload, _ := ioutil.ReadAll(response.Body)\n\tdefer response.Body.Close()\n\n\tassert.Equal(t, expectedPayload, payload)\n}\n" }, { "path": "ch04/acme/internal/rest/list.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/list\"\n)\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// attempt loadAll\n\tlister := list.Lister{}\n\tpeople, err := lister.Do()\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, people)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*data.Person) error {\n\toutput := &listResponseFormat{\n\t\tPeople: make([]*listResponseItemFormat, len(people)),\n\t}\n\n\tfor index, record := range people {\n\t\toutput.People[index] = &listResponseItemFormat{\n\t\t\tID: record.ID,\n\t\t\tFullName: record.FullName,\n\t\t\tPhone: record.Phone,\n\t\t}\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n\tPeople []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n}\n" }, { "path": "ch04/acme/internal/rest/list_test.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestListHandler_ServeHTTP(t *testing.T) {\n\t// ensure the test always fails by giving it a timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// Create and start a server\n\t// With out current implementation, we cannot test this handler without a full server as we need the mux.\n\taddress, err := startServer(ctx)\n\trequire.NoError(t, err)\n\n\t// build inputs\n\tresponse, err := http.Get(\"http://\" + address + \"/person/list\")\n\n\t// validate outputs\n\trequire.NoError(t, err)\n\trequire.Equal(t, http.StatusOK, response.StatusCode)\n\n\texpectedPayload := []byte(`{\"people\":[{\"id\":1,\"name\":\"John\",\"phone\":\"0123456780\"},{\"id\":2,\"name\":\"Paul\",\"phone\":\"0123456781\"},{\"id\":3,\"name\":\"George\",\"phone\":\"0123456782\"},{\"id\":4,\"name\":\"Ringo\",\"phone\":\"0123456783\"}`)\n\tpayload, _ := ioutil.ReadAll(response.Body)\n\tdefer response.Body.Close()\n\n\t// we have to use contains because other tests add more records\n\tassert.Contains(t, string(payload), string(expectedPayload))\n}\n" }, { "path": "ch04/acme/internal/rest/not_found.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n" }, { "path": "ch04/acme/internal/rest/not_found_test.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNotFoundHandler_ServeHTTP(t *testing.T) {\n\t// ensure the test always fails by giving it a timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// Create and start a server\n\t// With out current implementation, we cannot test this handler without a full server as we need the mux.\n\taddress, err := startServer(ctx)\n\trequire.NoError(t, err)\n\n\t// build inputs\n\tresponse, err := http.Get(\"http://\" + address + \"/some-bad-address\")\n\n\t// validate outputs\n\trequire.NoError(t, err)\n\trequire.Equal(t, http.StatusNotFound, response.StatusCode)\n}\n" }, { "path": "ch04/acme/internal/rest/register.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/modules/register\"\n)\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// register person\n\tid, err := h.register(requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(requestPayload *registerRequest) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\tregisterer := ®ister.Registerer{}\n\treturn registerer.Do(person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch04/acme/internal/rest/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\t// ensure the test always fails by giving it a timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// Create and start a server\n\t// With out current implementation, we cannot test this handler without a full server as we need the mux.\n\taddress, err := startServer(ctx)\n\trequire.NoError(t, err)\n\n\t// build inputs\n\tvalidRequest := buildValidRequest()\n\tresponse, err := http.Post(\"http://\"+address+\"/person/register\", \"application/json\", validRequest)\n\n\t// validate outputs\n\trequire.NoError(t, err)\n\trequire.Equal(t, http.StatusCreated, response.StatusCode)\n\tdefer response.Body.Close()\n\n\t// call should output the location to the new person\n\theaderLocation := response.Header.Get(\"Location\")\n\tassert.Contains(t, headerLocation, \"/person/\")\n}\n\nfunc buildValidRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch04/acme/internal/rest/server.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/gorilla/mux\"\n)\n\n// New will create and initialize the server\nfunc New(address string) *Server {\n\treturn &Server{\n\t\taddress: address,\n\t\thandlerGet: &GetHandler{},\n\t\thandlerList: &ListHandler{},\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: &RegisterHandler{},\n\t}\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n\taddress string\n\tserver *http.Server\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n\trouter := s.buildRouter()\n\n\t// create the HTTP server\n\ts.server = &http.Server{\n\t\tHandler: router,\n\t\tAddr: s.address,\n\t}\n\n\t// listen for shutdown\n\tgo func() {\n\t\t// wait for shutdown signal\n\t\t<-stop\n\n\t\t_ = s.server.Close()\n\t}()\n\n\t// start the HTTP server\n\t_ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n\trouter := mux.NewRouter()\n\n\t// map URL endpoints to HTTP handlers\n\trouter.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n\trouter.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n\trouter.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n\t// convert a \"catch all\" not found handler\n\trouter.NotFoundHandler = s.handlerNotFound\n\n\treturn router\n}\n" }, { "path": "ch04/acme/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch04/acme/internal/rest\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// start REST server\n\tserver := rest.New(config.App.Address)\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch04/fake.go", "content": "package ch04\n\nfunc init() {\n\t// This file is included so that Go tools (like `go list`) will find Go code in this directory and not error\n}\n" }, { "path": "ch05/02_advantages/01_function.go", "content": "package advantages\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"log\"\n)\n\nfunc SaveConfig(filename string, cfg *Config) error {\n\t// convert to JSON\n\tdata, err := json.Marshal(cfg)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// save file\n\terr = ioutil.WriteFile(filename, data, 0666)\n\tif err != nil {\n\t\tlog.Printf(\"failed to save file '%s' with err: %s\", filename, err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\ntype Config struct {\n\tHost string\n\tPort int\n}\n" }, { "path": "ch05/02_advantages/02_monkey_patched.go", "content": "package advantages\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n)\n\nfunc SaveConfigPatched(filename string, cfg *Config) error {\n\t// convert to JSON\n\tdata, err := json.Marshal(cfg)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// save file\n\terr = writeFile(filename, data, 0666)\n\tif err != nil {\n\t\tlog.Printf(\"failed to save file '%s' with err: %s\", filename, err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// Custom type that allows us to Monkey Patch\nvar writeFile = ioutil.WriteFile\n\n// Usage\nfunc SaveConfigPatchedUsage() {\n\tcfg := &Config{\n\t\t// build the config\n\t}\n\n\terr := SaveConfigPatched(\"myfile.json\", cfg)\n\tif err != nil {\n\t\tfmt.Printf(\"failed with err: %s\", err)\n\t}\n}\n" }, { "path": "ch05/02_advantages/03_injected_lambda.go", "content": "package advantages\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"os\"\n)\n\nfunc SaveConfigInjected(writer fileWriter, filename string, cfg *Config) error {\n\t// convert to JSON\n\tdata, err := json.Marshal(cfg)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// save file\n\terr = writer(filename, data, 0666)\n\tif err != nil {\n\t\tlog.Printf(\"failed to save file '%s' with err: %s\", filename, err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// This custom type is not strictly needed but it does make the function\n// signature a little cleaner\ntype fileWriter func(filename string, data []byte, perm os.FileMode) error\n\n// Usage\nfunc SaveConfigInjectedUsage() {\n\tcfg := &Config{\n\t\t// build the config\n\t}\n\n\terr := SaveConfigInjected(ioutil.WriteFile, \"myfile.json\", cfg)\n\tif err != nil {\n\t\tfmt.Printf(\"failed with err: %s\", err)\n\t}\n}\n" }, { "path": "ch05/02_advantages/04_as_object.go", "content": "package advantages\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"os\"\n)\n\ntype ConfigSaver struct {\n\tFileWriter func(filename string, data []byte, perm os.FileMode) error\n}\n\nfunc (c ConfigSaver) Save(filename string, cfg *Config) error {\n\t// convert to JSON\n\tdata, err := json.Marshal(cfg)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// save file\n\terr = c.FileWriter(filename, data, 0666)\n\tif err != nil {\n\t\tlog.Printf(\"failed to save file '%s' with err: %s\", filename, err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// Usage\nfunc ConfigSaverUsage() {\n\tcfg := &Config{\n\t\t// build the config\n\t}\n\n\tsaver := &ConfigSaver{\n\t\tFileWriter: ioutil.WriteFile,\n\t}\n\n\terr := saver.Save(\"myfile.json\", cfg)\n\tif err != nil {\n\t\tfmt.Printf(\"failed with err: %s\", err)\n\t}\n}\n" }, { "path": "ch05/02_advantages/05_math_rand.go", "content": "package advantages\n\n// A Rand is a source of random numbers.\ntype Rand struct {\n\tsrc Source\n\n\t// code removed\n}\n\n// Int returns a non-negative pseudo-random int.\nfunc (r *Rand) Int() int {\n\t// code changed for brevity\n\tvalue := r.src.Int63()\n\treturn int(value)\n}\n\n/*\n * Top-level convenience functions\n */\n\nvar globalRand = New(&lockedSource{})\n\n// Int returns a non-negative pseudo-random int from the default Source.\nfunc Int() int { return globalRand.Int() }\n\n/*\n * Code below here has been modified so that it compiles but does nothing.\n * The original code is: https://golang.org/src/math/rand/rand.go\n */\n\n// New returns a new Rand that uses random values from src\n// to generate other random values.\nfunc New(src Source) *Rand {\n\t// code changed for brevity\n\treturn &Rand{\n\t\tsrc: src,\n\t}\n}\n\ntype lockedSource struct {\n\t// code removed\n}\n\nfunc (l *lockedSource) Int63() int64 {\n\t// code removed\n\treturn 0\n}\n\n// A Source represents a source of uniformly-distributed\n// pseudo-random int64 values in the range [0, 1<<63).\ntype Source interface {\n\tInt63() int64\n\n\t// code removed\n}\n" }, { "path": "ch05/02_advantages/06_math_rand_test.go", "content": "package advantages\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestInt(t *testing.T) {\n\t// monkey patch\n\tdefer func(original *Rand) {\n\t\t// restore patch after use\n\t\tglobalRand = original\n\t}(globalRand)\n\n\t// swap out for a predictable outcome\n\tglobalRand = New(&stubSource{})\n\t// end monkey patch\n\n\t// call the function\n\tresult := Int()\n\tassert.Equal(t, 234, result)\n}\n\n// this is a stubbed implementation of Source that returns a predictable value\ntype stubSource struct {\n}\n\nfunc (s *stubSource) Int63() int64 {\n\treturn 234\n}\n" }, { "path": "ch05/03_applying/01_simple_sqlmock_test.go", "content": "package applying\n\nimport (\n\t\"database/sql\"\n\t\"testing\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\trequire.NoError(t, err)\n\n\t// clean up afterwards\n\tdefer testDb.Close()\n\n\t// define the query we are expecting as regular expression\n\tqueryRegex := `\\QINSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\\E`\n\n\t// configure the mock db\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// inputs\n\tperson := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := SavePerson(testDb, person)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc SavePerson(db *sql.DB, in *Person) (int, error) {\n\t// perform DB insert\n\tquery := \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tresult, err := db.Exec(query, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\treturn int(id), nil\n}\n" }, { "path": "ch05/03_applying/02_load.go", "content": "package applying\n\nimport (\n\t\"database/sql\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nconst (\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nfunc TestLoad_happyPath(t *testing.T) {\n\texpectedResult := &Person{\n\t\tID: 2,\n\t\tFullName: \"Paul\",\n\t\tPhone: \"0123456789\",\n\t\tCurrency: \"CAD\",\n\t\tPrice: 23.45,\n\t}\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlLoadByID)\n\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\n\t// monkey patching the database\n\tdefer func(original sql.DB) {\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t}(*db)\n\n\tdb = testDb\n\t// end of monkey patch\n\n\t// call function\n\tresult, err := Load(2)\n\n\t// validate results\n\tassert.Equal(t, expectedResult, result)\n\tassert.NoError(t, err)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc Load(ID int) (*Person, error) {\n\t// code removed/faked for brevity\n\treturn &Person{\n\t\tID: 2,\n\t\tFullName: \"Paul\",\n\t\tPhone: \"0123456789\",\n\t\tCurrency: \"CAD\",\n\t\tPrice: 23.45,\n\t}, nil\n}\n\n// code removed for brevity\nvar db = &sql.DB{}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n" }, { "path": "ch05/04_disadvantages/01_verbose.go", "content": "package disadvantages\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"log\"\n)\n\nfunc SaveConfig(filename string, cfg *Config) error {\n\t// convert to JSON\n\tdata, err := json.Marshal(cfg)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// save file\n\terr = writeFile(filename, data, 0666)\n\tif err != nil {\n\t\tlog.Printf(\"failed to save file '%s' with err: %s\", filename, err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// Custom type that allows\nvar writeFile = ioutil.WriteFile\n\ntype Config struct {\n\tHost string\n\tPort int\n}\n" }, { "path": "ch05/04_disadvantages/02_verbose_test.go", "content": "package disadvantages\n\nimport (\n\t\"os\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestSaveConfig(t *testing.T) {\n\t// inputs\n\tfilename := \"my-config.json\"\n\tcfg := &Config{\n\t\tHost: \"localhost\",\n\t\tPort: 1234,\n\t}\n\n\t// monkey patch the file writer\n\tdefer func(original func(filename string, data []byte, perm os.FileMode) error) {\n\t\t// restore the original\n\t\twriteFile = original\n\t}(writeFile)\n\n\twriteFile = func(filename string, data []byte, perm os.FileMode) error {\n\t\t// output error\n\t\treturn nil\n\t}\n\n\t// call the function\n\terr := SaveConfig(filename, cfg)\n\n\t// validate the result\n\tassert.NoError(t, err)\n}\n" }, { "path": "ch05/04_disadvantages/03_refactored_test.go", "content": "package disadvantages\n\nimport (\n\t\"os\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestSaveConfig_refactored(t *testing.T) {\n\t// inputs\n\tfilename := \"my-config.json\"\n\tcfg := &Config{\n\t\tHost: \"localhost\",\n\t\tPort: 1234,\n\t}\n\n\t// monkey patch the file writer\n\tdefer restoreWriteFile(writeFile)\n\n\twriteFile = mockWriteFile(nil)\n\n\t// call the function\n\terr := SaveConfig(filename, cfg)\n\n\t// validate the result\n\tassert.NoError(t, err)\n}\n\nfunc mockWriteFile(result error) func(filename string, data []byte, perm os.FileMode) error {\n\treturn func(filename string, data []byte, perm os.FileMode) error {\n\t\treturn result\n\t}\n}\n\n// remove the restore function to reduce from 3 lines to 1\nfunc restoreWriteFile(original func(filename string, data []byte, perm os.FileMode) error) {\n\t// restore the original\n\twriteFile = original\n}\n" }, { "path": "ch05/acme/internal/config/config.go", "content": "package config\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// App is the application config\nvar App *Config\n\n// Config defines the JSON format for the config file\ntype Config struct {\n\t// DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n\tDSN string\n\n\t// Address is the IP address and port to bind this rest to\n\tAddress string\n\n\t// BasePrice is the price of registration\n\tBasePrice float64\n\n\t// ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n\tExchangeRateBaseURL string\n\n\t// ExchangeRateAPIKey is the API for the exchange rate API\n\tExchangeRateAPIKey string\n}\n\n// Load returns the config loaded from environment\nfunc init() {\n\tfilename, found := os.LookupEnv(DefaultEnvVar)\n\tif !found {\n\t\tlogging.L.Error(\"failed to locate file specified by %s\", DefaultEnvVar)\n\t\treturn\n\t}\n\n\t_ = load(filename)\n}\n\nfunc load(filename string) error {\n\tApp = &Config{}\n\tbytes, err := ioutil.ReadFile(filename)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to read config file. err: %s\", err)\n\t\treturn err\n\t}\n\n\terr = json.Unmarshal(bytes, App)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to parse config file. err : %s\", err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n" }, { "path": "ch05/acme/internal/config/config_test.go", "content": "package config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoad(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin string\n\t\texpectedConfig *Config\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tin: \"../../../../default-config.json\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tDSN: \"[insert your db config here]\",\n\t\t\t\tAddress: \"0.0.0.0:8080\",\n\t\t\t\tBasePrice: 100.00,\n\t\t\t\tExchangeRateBaseURL: \"http://apilayer.net\",\n\t\t\t\tExchangeRateAPIKey: \"[insert your API key here]\",\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"invalid path\",\n\t\t\tin: \"invalid.json\",\n\t\t\texpectedConfig: &Config{},\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\tresultErr := load(scenario.in)\n\t\t\trequire.Equal(t, scenario.expectError, resultErr != nil, \"err: %s\", resultErr)\n\t\t\tassert.Equal(t, scenario.expectedConfig, App, scenario.desc)\n\t\t})\n\t}\n\n}\n" }, { "path": "ch05/acme/internal/logging/logging.go", "content": "package logging\n\nimport (\n\t\"fmt\"\n)\n\n// L is the global instance of the logger\nvar L = &LoggerStdOut{}\n\n// LoggerStdOut logs to std out\ntype LoggerStdOut struct{}\n\n// Debug logs messages at DEBUG level\nfunc (l LoggerStdOut) Debug(message string, args ...interface{}) {\n\tfmt.Printf(\"[DEBUG] \"+message, args...)\n}\n\n// Info logs messages at INFO level\nfunc (l LoggerStdOut) Info(message string, args ...interface{}) {\n\tfmt.Printf(\"[INFO] \"+message, args...)\n}\n\n// Warn logs messages at WARN level\nfunc (l LoggerStdOut) Warn(message string, args ...interface{}) {\n\tfmt.Printf(\"[WARN] \"+message, args...)\n}\n\n// Error logs messages at ERROR level\nfunc (l LoggerStdOut) Error(message string, args ...interface{}) {\n\tfmt.Printf(\"[ERROR] \"+message, args...)\n}\n" }, { "path": "ch05/acme/internal/modules/data/data.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/logging\"\n\t// import the MySQL Driver\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tsqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\nvar getDB = func() (*sql.DB, error) {\n\tif db == nil {\n\t\tif config.App == nil {\n\t\t\treturn nil, errors.New(\"config is not initialized\")\n\t\t}\n\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", config.App.DSN)\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc Save(in *Person) (int, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// perform DB insert\n\tresult, err := db.Exec(sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn int(id), nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc LoadAll() ([]*Person, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// perform DB select\n\trows, err := db.Query(sqlLoadAll)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\tlogging.L.Error(\"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\tlogging.L.Warn(\"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc Load(ID int) (*Person, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// perform DB select\n\trow := db.QueryRow(sqlLoadByID, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\tlogging.L.Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\tlogging.L.Error(\"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n\nfunc init() {\n\t// ensure the config is loaded and the db initialized\n\t_, _ = getDB()\n}\n" }, { "path": "ch05/acme/internal/modules/data/data_test.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// monkey patching starts here\n\tdefer func(original sql.DB) {\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t}(*db)\n\n\t// replace db for this test\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(in)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_insertError(t *testing.T) {\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnError(errors.New(\"failed to insert\"))\n\n\t// monkey patching starts here\n\tdefer func(original sql.DB) {\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t}(*db)\n\n\t// replace db for this test\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(in)\n\n\t// validate result\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_getDBError(t *testing.T) {\n\t// monkey patching starts here\n\tdefer func(original func() (*sql.DB, error)) {\n\t\t// restore original DB (after test)\n\t\tgetDB = original\n\t}(getDB)\n\n\t// replace getDB() function for this test\n\tgetDB = func() (*sql.DB, error) {\n\t\treturn nil, errors.New(\"getDB() failed\")\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(in)\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n}\n\nfunc TestLoadAll_tableDrivenTest(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResults []*Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(1, \"John\", \"0123456789\", \"AUD\", 12.34))\n\t\t\t},\n\t\t\texpectedResults: []*Person{\n\t\t\t\t{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"AUD\",\n\t\t\t\t\tPrice: 12.34,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResults: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey patch the db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tresults, err := LoadAll()\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResults, results, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\nfunc TestLoad_tableDrivenTest(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResult *Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\t\t\t},\n\t\t\texpectedResult: &Person{\n\t\t\t\tID: 2,\n\t\t\t\tFullName: \"Paul\",\n\t\t\t\tPhone: \"0123456789\",\n\t\t\t\tCurrency: \"CAD\",\n\t\t\t\tPrice: 23.45,\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResult: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tresult, err := Load(2)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResult, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n" }, { "path": "ch05/acme/internal/modules/exchange/converter.go", "content": "package exchange\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/logging\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct{}\n\n// Do will perform the conversion\nfunc (c *Converter) Do(basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tconfig.App.ExchangeRateBaseURL,\n\t\tconfig.App.ExchangeRateAPIKey,\n\t\tcurrency)\n\n\t// perform request\n\tresponse, err := http.Get(url)\n\tif err != nil {\n\t\tlogging.L.Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tlogging.L.Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tlogging.L.Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tlogging.L.Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tlogging.L.Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n" }, { "path": "ch05/acme/internal/modules/get/get.go", "content": "package get\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when the requested person is not in the database\n\terrPersonNotFound = errors.New(\"person not found\")\n)\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\t// load person from the data layer\n\tperson, err := loader(ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are hiding the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn person, err\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.Load\n" }, { "path": "ch05/acme/internal/modules/get/go_test.go", "content": "package get\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetter_Do_happyPath(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(ID int) (*data.Person, error) {\n\t\tresult := &data.Person{\n\t\t\tID: 1234,\n\t\t\tFullName: \"Doug\",\n\t\t}\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, ID, person.ID)\n\tassert.Equal(t, \"Doug\", person.FullName)\n}\n\nfunc TestGetter_Do_noSuchPerson(t *testing.T) {\n\t// inputs\n\tID := 5678\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(ID int) (*data.Person, error) {\n\t\tvar result *data.Person\n\t\tresultErr := data.ErrNotFound\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Equal(t, errPersonNotFound, err)\n\tassert.Nil(t, person)\n}\n\nfunc TestGetter_Do_error(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(ID int) (*data.Person, error) {\n\t\tvar result *data.Person\n\t\tresultErr := errors.New(\"failed to load person\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Nil(t, person)\n}\n" }, { "path": "ch05/acme/internal/modules/list/list.go", "content": "package list\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when there are no people in the database\n\terrPeopleNotFound = errors.New(\"no people found\")\n)\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n}\n\n// Do will load the people from the data layer\nfunc (l *Lister) Do() ([]*data.Person, error) {\n\t// load all people\n\tpeople, err := l.load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(people) == 0 {\n\t\t// special processing for 0 people returned\n\t\treturn nil, errPeopleNotFound\n\t}\n\n\treturn people, nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n\tpeople, err := loader()\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPeopleNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn people, nil\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.LoadAll\n" }, { "path": "ch05/acme/internal/modules/list/list_test.go", "content": "package list\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLister_Do_happyPath(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func() ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func() ([]*data.Person, error) {\n\t\tresult := []*data.Person{\n\t\t\t{\n\t\t\t\tID: 1234,\n\t\t\t\tFullName: \"Sally\",\n\t\t\t},\n\t\t\t{\n\t\t\t\tID: 5678,\n\t\t\t\tFullName: \"Jane\",\n\t\t\t},\n\t\t}\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, len(persons))\n}\n\nfunc TestLister_Do_noResults(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func() ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func() ([]*data.Person, error) {\n\t\tvar result []*data.Person\n\t\tresultErr := data.ErrNotFound\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Equal(t, errPeopleNotFound, err)\n\tassert.Equal(t, 0, len(persons))\n}\n\nfunc TestLister_Do_error(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func() ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func() ([]*data.Person, error) {\n\t\tvar result []*data.Person\n\t\tresultErr := errors.New(\"failed to load people\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, len(persons))\n}\n" }, { "path": "ch05/acme/internal/modules/register/register.go", "content": "package register\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/exchange\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\t// validation errors\n\terrNameMissing = errors.New(\"name is missing\")\n\terrPhoneMissing = errors.New(\"phone is missing\")\n\terrCurrencyMissing = errors.New(\"currency is missing\")\n\terrInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n\t// a little trick to make checking for supported currencies easier\n\tsupportedCurrencies = map[string]struct{}{\n\t\t\"AUD\": {},\n\t\t\"CNY\": {},\n\t\t\"EUR\": {},\n\t\t\"GBP\": {},\n\t\t\"JPY\": {},\n\t\t\"MYR\": {},\n\t\t\"SGD\": {},\n\t\t\"USD\": {},\n\t}\n)\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(in *data.Person) (int, error) {\n\t// validate the request\n\terr := r.validateInput(in)\n\tif err != nil {\n\t\tlogging.L.Warn(\"input validation failed with err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// get price in the requested currency\n\tprice, err := r.getPrice(in.Currency)\n\tif err != nil {\n\t\treturn defaultPersonID, err\n\t}\n\n\t// save registration\n\tid, err := r.save(in, price)\n\tif err != nil {\n\t\t// no need to log here as we expect the data layer to do so\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *data.Person) error {\n\tif in.FullName == \"\" {\n\t\treturn errNameMissing\n\t}\n\tif in.Phone == \"\" {\n\t\treturn errPhoneMissing\n\t}\n\tif in.Currency == \"\" {\n\t\treturn errCurrencyMissing\n\t}\n\n\tif _, found := supportedCurrencies[in.Currency]; !found {\n\t\treturn errInvalidCurrency\n\t}\n\n\t// happy path\n\treturn nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(currency string) (float64, error) {\n\tconverter := &exchange.Converter{}\n\tprice, err := converter.Do(config.App.BasePrice, currency)\n\tif err != nil {\n\t\tlogging.L.Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(in *data.Person, price float64) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tCurrency: in.Currency,\n\t\tPrice: price,\n\t}\n\treturn saver(person)\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar saver = data.Save\n" }, { "path": "ch05/acme/internal/modules/register/register_test.go", "content": "package register\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterer_Do_happyPath(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(in *data.Person) (int, error)) {\n\t\t// restore original\n\t\tsaver = original\n\t}(saver)\n\n\t// replace method\n\tsaver = func(in *data.Person) (int, error) {\n\t\tresult := 888\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{}\n\tID, err := registerer.Do(in)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 888, ID)\n}\n\nfunc TestRegisterer_Do_error(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(in *data.Person) (int, error)) {\n\t\t// restore original\n\t\tsaver = original\n\t}(saver)\n\n\t// replace method\n\tsaver = func(in *data.Person) (int, error) {\n\t\tvar result int\n\t\tresultErr := errors.New(\"failed to save\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{}\n\tID, err := registerer.Do(in)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, ID)\n}\n" }, { "path": "ch05/acme/internal/rest/common_test.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"net\"\n)\n\nfunc getOpenPort() (string, error) {\n\tlistener, err := net.Listen(\"tcp\", \"127.0.0.1:0\")\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\taddress := listener.Addr().String()\n\tlistener.Close()\n\n\treturn address, nil\n}\n\nfunc startServer(ctx context.Context) (string, error) {\n\t// get open port\n\taddress, err := getOpenPort()\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\t// start a server\n\tserver := New(address)\n\tgo server.Listen(ctx.Done())\n\n\t// wait for server to be ready\n\tdialer := &net.Dialer{}\n\tfor {\n\t\tconn, _ := dialer.DialContext(ctx, \"tcp\", address)\n\t\tif conn != nil {\n\t\t\tdefer conn.Close()\n\n\t\t\treturn address, nil\n\t\t}\n\n\t\tselect {\n\t\tcase <-ctx.Done():\n\t\t\treturn \"\", ctx.Err()\n\n\t\tdefault:\n\t\t\t// try again\n\t\t}\n\t}\n\n\treturn address, nil\n}\n" }, { "path": "ch05/acme/internal/rest/get.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/get\"\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tgetter := get.Getter{}\n\tperson, err := getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[\"id\"]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\tlogging.L.Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\tlogging.L.Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *data.Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n" }, { "path": "ch05/acme/internal/rest/get_test.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetHandler_ServeHTTP(t *testing.T) {\n\t// ensure the test always fails by giving it a timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// Create and start a server\n\t// With out current implementation, we cannot test this handler without a full server as we need the mux.\n\taddress, err := startServer(ctx)\n\trequire.NoError(t, err)\n\n\t// build inputs\n\tresponse, err := http.Get(\"http://\" + address + \"/person/1/\")\n\n\t// validate outputs\n\trequire.NoError(t, err)\n\trequire.Equal(t, http.StatusOK, response.StatusCode)\n\n\texpectedPayload := []byte(`{\"id\":1,\"name\":\"John\",\"phone\":\"0123456780\",\"currency\":\"USD\",\"price\":100}` + \"\\n\")\n\tpayload, _ := ioutil.ReadAll(response.Body)\n\tdefer response.Body.Close()\n\n\tassert.Equal(t, expectedPayload, payload)\n}\n" }, { "path": "ch05/acme/internal/rest/list.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/list\"\n)\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// attempt loadAll\n\tlister := list.Lister{}\n\tpeople, err := lister.Do()\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, people)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*data.Person) error {\n\toutput := &listResponseFormat{\n\t\tPeople: make([]*listResponseItemFormat, len(people)),\n\t}\n\n\tfor index, record := range people {\n\t\toutput.People[index] = &listResponseItemFormat{\n\t\t\tID: record.ID,\n\t\t\tFullName: record.FullName,\n\t\t\tPhone: record.Phone,\n\t\t}\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n\tPeople []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n}\n" }, { "path": "ch05/acme/internal/rest/list_test.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestListHandler_ServeHTTP(t *testing.T) {\n\t// ensure the test always fails by giving it a timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// Create and start a server\n\t// With out current implementation, we cannot test this handler without a full server as we need the mux.\n\taddress, err := startServer(ctx)\n\trequire.NoError(t, err)\n\n\t// build inputs\n\tresponse, err := http.Get(\"http://\" + address + \"/person/list\")\n\n\t// validate outputs\n\trequire.NoError(t, err)\n\trequire.Equal(t, http.StatusOK, response.StatusCode)\n\n\texpectedPayload := []byte(`{\"people\":[{\"id\":1,\"name\":\"John\",\"phone\":\"0123456780\"},{\"id\":2,\"name\":\"Paul\",\"phone\":\"0123456781\"},{\"id\":3,\"name\":\"George\",\"phone\":\"0123456782\"},{\"id\":4,\"name\":\"Ringo\",\"phone\":\"0123456783\"}`)\n\tpayload, _ := ioutil.ReadAll(response.Body)\n\tdefer response.Body.Close()\n\n\t// we have to use contains because other tests add more records\n\tassert.Contains(t, string(payload), string(expectedPayload))\n}\n" }, { "path": "ch05/acme/internal/rest/not_found.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n" }, { "path": "ch05/acme/internal/rest/not_found_test.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNotFoundHandler_ServeHTTP(t *testing.T) {\n\t// ensure the test always fails by giving it a timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// Create and start a server\n\t// With out current implementation, we cannot test this handler without a full server as we need the mux.\n\taddress, err := startServer(ctx)\n\trequire.NoError(t, err)\n\n\t// build inputs\n\tresponse, err := http.Get(\"http://\" + address + \"/some-bad-address\")\n\n\t// validate outputs\n\trequire.NoError(t, err)\n\trequire.Equal(t, http.StatusNotFound, response.StatusCode)\n}\n" }, { "path": "ch05/acme/internal/rest/register.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/modules/register\"\n)\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// register person\n\tid, err := h.register(requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(requestPayload *registerRequest) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\tregisterer := ®ister.Registerer{}\n\treturn registerer.Do(person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch05/acme/internal/rest/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\t// ensure the test always fails by giving it a timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// Create and start a server\n\t// With out current implementation, we cannot test this handler without a full server as we need the mux.\n\taddress, err := startServer(ctx)\n\trequire.NoError(t, err)\n\n\t// build inputs\n\tvalidRequest := buildValidRequest()\n\tresponse, err := http.Post(\"http://\"+address+\"/person/register\", \"application/json\", validRequest)\n\n\t// validate outputs\n\trequire.NoError(t, err)\n\trequire.Equal(t, http.StatusCreated, response.StatusCode)\n\tdefer response.Body.Close()\n\n\t// call should output the location to the new person\n\theaderLocation := response.Header.Get(\"Location\")\n\tassert.Contains(t, headerLocation, \"/person/\")\n}\n\nfunc buildValidRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch05/acme/internal/rest/server.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/gorilla/mux\"\n)\n\n// New will create and initialize the server\nfunc New(address string) *Server {\n\treturn &Server{\n\t\taddress: address,\n\t\thandlerGet: &GetHandler{},\n\t\thandlerList: &ListHandler{},\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: &RegisterHandler{},\n\t}\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n\taddress string\n\tserver *http.Server\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n\trouter := s.buildRouter()\n\n\t// create the HTTP server\n\ts.server = &http.Server{\n\t\tHandler: router,\n\t\tAddr: s.address,\n\t}\n\n\t// listen for shutdown\n\tgo func() {\n\t\t// wait for shutdown signal\n\t\t<-stop\n\n\t\t_ = s.server.Close()\n\t}()\n\n\t// start the HTTP server\n\t_ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n\trouter := mux.NewRouter()\n\n\t// map URL endpoints to HTTP handlers\n\trouter.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n\trouter.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n\trouter.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n\t// convert a \"catch all\" not found handler\n\trouter.NotFoundHandler = s.handlerNotFound\n\n\treturn router\n}\n" }, { "path": "ch05/acme/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch05/acme/internal/rest\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// start REST server\n\tserver := rest.New(config.App.Address)\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch05/fake.go", "content": "package ch05\n\nfunc init() {\n\t// This file is included so that Go tools (like `go list`) will find Go code in this directory and not error\n}\n" }, { "path": "ch06/01_constructor_injection/01_welcome_email.go", "content": "package constructor_injection\n\nimport (\n\t\"errors\"\n)\n\nfunc NewWelcomeSender(in *Mailer) (*WelcomeSender, error) {\n\t// guard clause\n\tif in == nil {\n\t\treturn nil, errors.New(\"programmer error: mailer must not provided\")\n\t}\n\n\treturn &WelcomeSender{\n\t\tmailer: in,\n\t}, nil\n}\n\nfunc NewWelcomeSenderNoGuard(in *Mailer) *WelcomeSender {\n\treturn &WelcomeSender{\n\t\tmailer: in,\n\t}\n}\n\n// WelcomeSender sends a Welcome email to new users\ntype WelcomeSender struct {\n\tmailer *Mailer\n}\n\nfunc (w *WelcomeSender) Send(to string) error {\n\tbody := w.buildMessage()\n\n\treturn w.mailer.Send(to, body)\n}\n\n// build and return the message body\nfunc (w *WelcomeSender) buildMessage() string {\n\treturn \"\"\n}\n\n// Mailer sends and receives emails\ntype Mailer struct {\n\tHost string\n\tPort string\n\tUsername string\n\tPassword string\n}\n\nfunc (m *Mailer) Send(to string, body string) error {\n\t// send email\n\treturn nil\n}\n\nfunc (m *Mailer) Receive(address string) (string, error) {\n\t// receive email\n\treturn \"\", nil\n}\n" }, { "path": "ch06/01_constructor_injection/01_welcome_email_test.go", "content": "package constructor_injection\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestNewWelcomeSender_happyPath(t *testing.T) {\n\tsender, err := NewWelcomeSender(&Mailer{})\n\tassert.NotNil(t, sender)\n\tassert.NoError(t, err)\n}\n\nfunc TestNewWelcomeSender_guardClause(t *testing.T) {\n\tsender, err := NewWelcomeSender(nil)\n\tassert.Nil(t, sender)\n\tassert.Error(t, err)\n}\n\nfunc TestNewWelcomeSenderNoGuard_happyPath(t *testing.T) {\n\tsender := NewWelcomeSenderNoGuard(&Mailer{})\n\tassert.NotNil(t, sender)\n}\n" }, { "path": "ch06/01_constructor_injection/02_mailer_interface.go", "content": "package constructor_injection\n\n// Mailer sends and receives emails\ntype MailerInterface interface {\n\tSend(to string, body string) error\n\tReceive(address string) (string, error)\n}\n" }, { "path": "ch06/01_constructor_injection/03_sender_interface.go", "content": "package constructor_injection\n\ntype Sender interface {\n\tSend(to string, body string) error\n}\n\nfunc NewWelcomeSenderV2(in Sender) *WelcomeSenderV2 {\n\treturn &WelcomeSenderV2{\n\t\tsender: in,\n\t}\n}\n\n// WelcomeSenderV2 sends a Welcome email to new users\ntype WelcomeSenderV2 struct {\n\tsender Sender\n}\n\nfunc (w *WelcomeSenderV2) Send(to string) error {\n\tbody := w.buildMessage()\n\n\treturn w.sender.Send(to, body)\n}\n\n// build and return the message body\nfunc (w *WelcomeSenderV2) buildMessage() string {\n\treturn \"\"\n}\n" }, { "path": "ch06/01_constructor_injection/05_duck_typing.go", "content": "package constructor_injection\n\nimport (\n\t\"fmt\"\n)\n\ntype Talker interface {\n\tSpeak() string\n\tShout() string\n}\n\ntype Dog struct{}\n\nfunc (d Dog) Speak() string {\n\treturn \"Woof!\"\n}\n\nfunc (d Dog) Shout() string {\n\treturn \"WOOF!\"\n}\n\nfunc SpeakExample() {\n\tvar talker Talker\n\ttalker = Dog{}\n\n\tfmt.Print(talker.Speak())\n}\n" }, { "path": "ch06/02_advantages/01_easy_to_implement.go", "content": "package advantages\n\n// WelcomeSender sends a Welcome email to new users\ntype WelcomeSender struct {\n\tMailer *Mailer\n}\n\nfunc (w *WelcomeSender) Send(to string) error {\n\tbody := w.buildMessage()\n\n\treturn w.Mailer.Send(to, body)\n}\n\n// build and return the message body\nfunc (w *WelcomeSender) buildMessage() string {\n\treturn \"\"\n}\n\n// Mailer will send an email\ntype Mailer struct{}\n\nfunc (m *Mailer) Send(to string, body string) error {\n\t// send email\n\treturn nil\n}\n" }, { "path": "ch06/02_advantages/01_easy_to_implement_example_test.go", "content": "package advantages_test\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/02_advantages\"\n)\n\nfunc ExampleWelcomeSender_Send() {\n\twelcomeSender := &advantages.WelcomeSender{\n\t\tMailer: &advantages.Mailer{},\n\t}\n\twelcomeSender.Send(\"me@home.com\")\n}\n" }, { "path": "ch06/02_advantages/02_easy_to_implement.go", "content": "package advantages\n\nfunc NewWelcomeSenderV2(mailer *Mailer) *WelcomeSenderV2 {\n\treturn &WelcomeSenderV2{\n\t\tmailer: mailer,\n\t}\n}\n\n// WelcomeSenderV2 sends a Welcome email to new users\ntype WelcomeSenderV2 struct {\n\tmailer *Mailer\n}\n\nfunc (w *WelcomeSenderV2) Send(to string) error {\n\tbody := w.buildMessage()\n\n\treturn w.mailer.Send(to, body)\n}\n\n// build and return the message body\nfunc (w *WelcomeSenderV2) buildMessage() string {\n\treturn \"\"\n}\n" }, { "path": "ch06/02_advantages/02_easy_to_implement_example_test.go", "content": "package advantages_test\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/02_advantages\"\n)\n\nfunc ExampleWelcomeSenderV2_Send() {\n\twelcomeSender := advantages.NewWelcomeSenderV2(&advantages.Mailer{})\n\twelcomeSender.Send(\"me@home.com\")\n}\n" }, { "path": "ch06/02_advantages/03_predictable.go", "content": "package advantages\n\nimport (\n\t\"errors\"\n)\n\ntype Engine interface {\n\tStart()\n\tIncreasePower()\n\tDecreasePower()\n\tStop()\n\tIsRunning() bool\n}\n\ntype Car struct {\n\tEngine Engine\n}\n\nfunc (c *Car) Drive() error {\n\tif c.Engine == nil {\n\t\treturn errors.New(\"engine ie missing\")\n\t}\n\n\t// use the engine\n\tc.Engine.Start()\n\tc.Engine.IncreasePower()\n\n\treturn nil\n}\n\nfunc (c *Car) Stop() error {\n\tif c.Engine == nil {\n\t\treturn errors.New(\"engine ie missing\")\n\t}\n\n\t// use the engine\n\tc.Engine.DecreasePower()\n\tc.Engine.Stop()\n\n\treturn nil\n}\n" }, { "path": "ch06/02_advantages/04_predictable.go", "content": "package advantages\n\nimport (\n\t\"errors\"\n)\n\nfunc NewCarV2(engine Engine) (*CarV2, error) {\n\tif engine == nil {\n\t\treturn nil, errors.New(\"invalid engine supplied\")\n\t}\n\n\treturn &CarV2{\n\t\tengine: engine,\n\t}, nil\n}\n\ntype CarV2 struct {\n\tengine Engine\n}\n\nfunc (c *CarV2) Drive() error {\n\t// use the engine\n\tc.engine.Start()\n\tc.engine.IncreasePower()\n\n\treturn nil\n}\n\nfunc (c *CarV2) Stop() error {\n\t// use the engine\n\tc.engine.DecreasePower()\n\tc.engine.Stop()\n\n\treturn nil\n}\n" }, { "path": "ch06/02_advantages/05_encapsulation.go", "content": "package advantages\n\nimport (\n\t\"errors\"\n)\n\nfunc (c *CarV2) FillPetrolTank() error {\n\t// use the engine\n\tif c.engine.IsRunning() {\n\t\treturn errors.New(\"cannot fill the tank while the engine is running\")\n\t}\n\n\t// fill the tank!\n\treturn c.fill()\n}\n\nfunc (c CarV2) fill() error {\n\t// TODO: implement\n\treturn nil\n}\n" }, { "path": "ch06/02_advantages/06_encapsulation.go", "content": "package advantages\n\nimport (\n\t\"errors\"\n)\n\nfunc (c *CarV2) FillPetrolTankV2(engine Engine) error {\n\t// use the engine\n\tif engine.IsRunning() {\n\t\treturn errors.New(\"cannot fill the tank while the engine is running\")\n\t}\n\n\t// fill the tank!\n\treturn c.fill()\n}\n" }, { "path": "ch06/03_applying/01/01_register_handler_before.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/01/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/01/register\"\n)\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// register person\n\tid, err := h.register(requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(requestPayload *registerRequest) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\tregisterer := ®ister.Registerer{}\n\treturn registerer.Do(person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch06/03_applying/01/data/person.go", "content": "package data\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n" }, { "path": "ch06/03_applying/01/register/register.go", "content": "package register\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/01/data\"\n)\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(in *data.Person) (int, error) {\n\t// fake implementation\n\treturn 0, nil\n}\n" }, { "path": "ch06/03_applying/02/01_register_handler.go", "content": "package rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/02/register\"\n)\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n\tregisterer *register.Registerer\n}\n" }, { "path": "ch06/03_applying/02/data/person.go", "content": "package data\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n" }, { "path": "ch06/03_applying/02/register/register.go", "content": "package register\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/01/data\"\n)\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(in *data.Person) (int, error) {\n\t// fake implementation\n\treturn 0, nil\n}\n" }, { "path": "ch06/03_applying/03/data/person.go", "content": "package data\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n" }, { "path": "ch06/03_applying/03/mock_register_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/03/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockRegisterModel is an autogenerated mock type for the RegisterModel type\ntype MockRegisterModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: in\nfunc (_m *MockRegisterModel) Do(in *data.Person) (int, error) {\n\tret := _m.Called(in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(*data.Person) int); ok {\n\t\tr0 = rf(in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(*data.Person) error); ok {\n\t\tr1 = rf(in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch06/03_applying/03/register_test.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\t\"testing\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockRegisterModel\n\t\texpectedStatus int\n\t\texpectedHeader string\n\t}{\n\t\t// scenarios go here\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// test goes here\n\t\t})\n\t}\n}\n" }, { "path": "ch06/03_applying/04/data/person.go", "content": "package data\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n" }, { "path": "ch06/03_applying/04/mock_register_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/04/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockRegisterModel is an autogenerated mock type for the RegisterModel type\ntype MockRegisterModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: in\nfunc (_m *MockRegisterModel) Do(in *data.Person) (int, error) {\n\tret := _m.Called(in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(*data.Person) int); ok {\n\t\tr0 = rf(in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(*data.Person) error); ok {\n\t\tr1 = rf(in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch06/03_applying/04/register.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/04/data\"\n)\n\n// RegisterModel will validate and save a registration\ntype RegisterModel interface {\n\tDo(in *data.Person) (int, error)\n}\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n\tregisterer RegisterModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// implementation goes here\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch06/03_applying/04/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockRegisterModel\n\t\texpectedStatus int\n\t\texpectedHeader string\n\t}{\n\t\t// scenarios go here\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockRegisterModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := &RegisterHandler{\n\t\t\t\tregisterer: mockRegisterModel,\n\t\t\t}\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code)\n\n\t\t\t// call should output the location to the new person\n\t\t\tresultHeader := response.Header().Get(\"Location\")\n\t\t\tassert.Equal(t, scenario.expectedHeader, resultHeader)\n\n\t\t\t// validate the mock was used as we expected\n\t\t\tassert.True(t, mockRegisterModel.AssertExpectations(t))\n\t\t})\n\t}\n}\n\nfunc buildValidRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch06/03_applying/05/data/person.go", "content": "package data\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n" }, { "path": "ch06/03_applying/05/fakes.go", "content": "package reset\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/05/data\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n\n// Fake/Stub implementations to make the compiler happy\n\ntype Server struct {\n\taddress string\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\nfunc NewGetHandler(_ GetModel) *GetHandler {\n\treturn &GetHandler{}\n}\n\ntype GetModel interface {\n\tDo(ID int) (*data.Person, error)\n}\n\ntype GetHandler struct{}\n\nfunc (g *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {}\n\nfunc NewListHandler(_ ListModel) *ListHandler {\n\treturn &ListHandler{}\n}\n\ntype ListModel interface {\n\tDo() ([]*data.Person, error)\n}\n\ntype ListHandler struct {\n}\n\nfunc (l *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {}\n\nfunc NewRegisterHandler(_ RegisterModel) *RegisterHandler {\n\treturn &RegisterHandler{}\n}\n\ntype RegisterModel interface {\n\tDo(in *data.Person) (int, error)\n}\n\ntype RegisterHandler struct {\n}\n\nfunc (r *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {}\n" }, { "path": "ch06/03_applying/05/get/getter.go", "content": "package get\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/05/data\"\n)\n\n// Stub implementation so that the example compiles\ntype Getter struct{}\n\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\treturn nil, nil\n}\n" }, { "path": "ch06/03_applying/05/list/lister.go", "content": "package list\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/05/data\"\n)\n\n// Stub implementation so that the example compiles\ntype Lister struct{}\n\nfunc (l *Lister) Do() ([]*data.Person, error) {\n\treturn nil, nil\n}\n" }, { "path": "ch06/03_applying/05/register/registerer.go", "content": "package register\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/05/data\"\n)\n\n// Stub implementation so that the example compiles\ntype Registerer struct{}\n\nfunc (r *Registerer) Do(in *data.Person) (int, error) {\n\treturn 0, nil\n}\n" }, { "path": "ch06/03_applying/05/server.go", "content": "package reset\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/05/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/05/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/03_applying/05/register\"\n)\n\n// New will create and initialize the server\nfunc New(address string) *Server {\n\treturn &Server{\n\t\taddress: address,\n\t\thandlerGet: NewGetHandler(&get.Getter{}),\n\t\thandlerList: NewListHandler(&list.Lister{}),\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: NewRegisterHandler(®ister.Registerer{}),\n\t}\n}\n" }, { "path": "ch06/04_disadvantages/01_lots_of_changes.go", "content": "package disadvantages\n\n// Dealer will shuffle a deck of cards and deal them to the players\nfunc DealCards() (player1 []Card, player2 []Card) {\n\t// create a new deck of cards\n\tcards := newDeck()\n\n\t// shuffle the cards\n\tshuffler := &myShuffler{}\n\tshuffler.Shuffle(cards)\n\n\t// deal\n\tplayer1 = append(player1, cards[0])\n\tplayer2 = append(player2, cards[1])\n\n\tplayer1 = append(player1, cards[2])\n\tplayer2 = append(player2, cards[3])\n\treturn\n}\n\n// returns a new deck of cards\nfunc newDeck() []Card {\n\treturn []Card{\n\t\t// code removed\n\t}\n}\n\n// Shuffler will shuffle (randomize) the supplied cards\ntype Shuffler interface {\n\tShuffle(cards []Card)\n}\n\n// Card is single Playing Card\ntype Card struct {\n\tSuit string\n\tValue string\n}\n\n// implements Shuffler\ntype myShuffler struct{}\n\n// Shuffle implements shuffler\nfunc (m *myShuffler) Shuffle(cards []Card) {\n\t// randomize the cards\n}\n" }, { "path": "ch06/04_disadvantages/02_overuse.go", "content": "package disadvantages\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"net/http\"\n)\n\nconst downstreamServer = \"http://www.example.com\"\n\n// FetchRates rates from downstream service\ntype FetchRates struct{}\n\nfunc (f *FetchRates) Fetch() ([]Rate, error) {\n\t// build the URL from which to fetch the rates\n\turl := downstreamServer + \"/rates\"\n\n\t// build request\n\trequest, err := http.NewRequest(\"GET\", url, nil)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// fetch rates\n\tresponse, err := http.DefaultClient.Do(request)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer response.Body.Close()\n\n\t// read the content of the response\n\tdata, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// convert JSON bytes to Go structs\n\tout := &downstreamResponse{}\n\terr = json.Unmarshal(data, out)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn out.Rates, nil\n}\n\n// response format from the downstream service\ntype downstreamResponse struct {\n\tRates []Rate `json:\"rates\"`\n}\n\ntype Rate struct {\n\tCode string\n\tValue float64\n}\n" }, { "path": "ch06/04_disadvantages/03_non_obvious.go", "content": "package disadvantages\n\nimport (\n\t\"errors\"\n)\n\n// NewClient creates and initialises the client\nfunc NewClient(service DepService) Client {\n\treturn &clientImpl{\n\t\tservice: service,\n\t}\n}\n\n// Client is the exported API\ntype Client interface {\n\tDoSomethingUseful() (bool, error)\n}\n\n// implement Client\ntype clientImpl struct {\n\tservice DepService\n}\n\nfunc (c *clientImpl) DoSomethingUseful() (bool, error) {\n\t// this function does something useful\n\treturn false, errors.New(\"not implemented\")\n}\n\ntype DepService interface {\n\tDoSomethingElse()\n}\n" }, { "path": "ch06/04_disadvantages/04_non_obvious_example_test.go", "content": "package disadvantages_test\n\nfunc Example() {\n\n}\n\n// StubClient is a stub implementation of disadvantages.Client interface\ntype StubClient struct{}\n\n// DoSomethingUseful implements disadvantages.Client\nfunc (s *StubClient) DoSomethingUseful() (bool, error) {\n\treturn true, nil\n}\n" }, { "path": "ch06/04_disadvantages/05_constructors.go", "content": "package disadvantages\n\ntype InnerService struct {\n\tinnerDep Dependency\n}\n\nfunc NewInnerService(innerDep Dependency) *InnerService {\n\treturn &InnerService{\n\t\tinnerDep: innerDep,\n\t}\n}\n\ntype OuterService struct {\n\t// composition\n\tinnerService *InnerService\n\n\touterDep Dependency\n}\n\nfunc NewOuterService(outerDep Dependency, innerDep Dependency) *OuterService {\n\treturn &OuterService{\n\t\tinnerService: NewInnerService(innerDep),\n\t\touterDep: outerDep,\n\t}\n}\n\n// fake type to satisfy the compiler\ntype Dependency interface {\n}\n" }, { "path": "ch06/acme/internal/config/config.go", "content": "package config\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// App is the application config\nvar App *Config\n\n// Config defines the JSON format for the config file\ntype Config struct {\n\t// DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n\tDSN string\n\n\t// Address is the IP address and port to bind this rest to\n\tAddress string\n\n\t// BasePrice is the price of registration\n\tBasePrice float64\n\n\t// ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n\tExchangeRateBaseURL string\n\n\t// ExchangeRateAPIKey is the API for the exchange rate API\n\tExchangeRateAPIKey string\n}\n\n// Load returns the config loaded from environment\nfunc init() {\n\tfilename, found := os.LookupEnv(DefaultEnvVar)\n\tif !found {\n\t\tlogging.L.Error(\"failed to locate file specified by %s\", DefaultEnvVar)\n\t\treturn\n\t}\n\n\t_ = load(filename)\n}\n\nfunc load(filename string) error {\n\tApp = &Config{}\n\tbytes, err := ioutil.ReadFile(filename)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to read config file. err: %s\", err)\n\t\treturn err\n\t}\n\n\terr = json.Unmarshal(bytes, App)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to parse config file. err : %s\", err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n" }, { "path": "ch06/acme/internal/config/config_test.go", "content": "package config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoad(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin string\n\t\texpectedConfig *Config\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tin: \"../../../../default-config.json\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tDSN: \"[insert your db config here]\",\n\t\t\t\tAddress: \"0.0.0.0:8080\",\n\t\t\t\tBasePrice: 100.00,\n\t\t\t\tExchangeRateBaseURL: \"http://apilayer.net\",\n\t\t\t\tExchangeRateAPIKey: \"[insert your API key here]\",\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"invalid path\",\n\t\t\tin: \"invalid.json\",\n\t\t\texpectedConfig: &Config{},\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\tresultErr := load(scenario.in)\n\t\t\trequire.Equal(t, scenario.expectError, resultErr != nil, \"err: %s\", resultErr)\n\t\t\tassert.Equal(t, scenario.expectedConfig, App, scenario.desc)\n\t\t})\n\t}\n\n}\n" }, { "path": "ch06/acme/internal/logging/logging.go", "content": "package logging\n\nimport (\n\t\"fmt\"\n)\n\n// L is the global instance of the logger\nvar L = &LoggerStdOut{}\n\n// LoggerStdOut logs to std out\ntype LoggerStdOut struct{}\n\n// Debug logs messages at DEBUG level\nfunc (l LoggerStdOut) Debug(message string, args ...interface{}) {\n\tfmt.Printf(\"[DEBUG] \"+message, args...)\n}\n\n// Info logs messages at INFO level\nfunc (l LoggerStdOut) Info(message string, args ...interface{}) {\n\tfmt.Printf(\"[INFO] \"+message, args...)\n}\n\n// Warn logs messages at WARN level\nfunc (l LoggerStdOut) Warn(message string, args ...interface{}) {\n\tfmt.Printf(\"[WARN] \"+message, args...)\n}\n\n// Error logs messages at ERROR level\nfunc (l LoggerStdOut) Error(message string, args ...interface{}) {\n\tfmt.Printf(\"[ERROR] \"+message, args...)\n}\n" }, { "path": "ch06/acme/internal/modules/data/data.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/logging\"\n\t// import the MySQL Driver\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tsqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\nvar getDB = func() (*sql.DB, error) {\n\tif db == nil {\n\t\tif config.App == nil {\n\t\t\treturn nil, errors.New(\"config is not initialized\")\n\t\t}\n\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", config.App.DSN)\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc Save(in *Person) (int, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// perform DB insert\n\tresult, err := db.Exec(sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn int(id), nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc LoadAll() ([]*Person, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// perform DB select\n\trows, err := db.Query(sqlLoadAll)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\tlogging.L.Error(\"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\tlogging.L.Warn(\"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc Load(ID int) (*Person, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// perform DB select\n\trow := db.QueryRow(sqlLoadByID, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\tlogging.L.Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\tlogging.L.Error(\"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n\nfunc init() {\n\t// ensure the config is loaded and the db initialized\n\t_, _ = getDB()\n}\n" }, { "path": "ch06/acme/internal/modules/data/data_test.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// monkey patching starts here\n\tdefer func(original sql.DB) {\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t}(*db)\n\n\t// replace db for this test\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(in)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_insertError(t *testing.T) {\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnError(errors.New(\"failed to insert\"))\n\n\t// monkey patching starts here\n\tdefer func(original sql.DB) {\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t}(*db)\n\n\t// replace db for this test\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(in)\n\n\t// validate result\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_getDBError(t *testing.T) {\n\t// monkey patching starts here\n\tdefer func(original func() (*sql.DB, error)) {\n\t\t// restore original DB (after test)\n\t\tgetDB = original\n\t}(getDB)\n\n\t// replace getDB() function for this test\n\tgetDB = func() (*sql.DB, error) {\n\t\treturn nil, errors.New(\"getDB() failed\")\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(in)\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n}\n\nfunc TestLoadAll_tableDrivenTest(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResults []*Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(1, \"John\", \"0123456789\", \"AUD\", 12.34))\n\t\t\t},\n\t\t\texpectedResults: []*Person{\n\t\t\t\t{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"AUD\",\n\t\t\t\t\tPrice: 12.34,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResults: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey patch the db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tresults, err := LoadAll()\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResults, results, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\nfunc TestLoad_tableDrivenTest(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResult *Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\t\t\t},\n\t\t\texpectedResult: &Person{\n\t\t\t\tID: 2,\n\t\t\t\tFullName: \"Paul\",\n\t\t\t\tPhone: \"0123456789\",\n\t\t\t\tCurrency: \"CAD\",\n\t\t\t\tPrice: 23.45,\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResult: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tresult, err := Load(2)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResult, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n" }, { "path": "ch06/acme/internal/modules/exchange/converter.go", "content": "package exchange\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/logging\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct{}\n\n// Do will perform the conversion\nfunc (c *Converter) Do(basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tconfig.App.ExchangeRateBaseURL,\n\t\tconfig.App.ExchangeRateAPIKey,\n\t\tcurrency)\n\n\t// perform request\n\tresponse, err := http.Get(url)\n\tif err != nil {\n\t\tlogging.L.Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tlogging.L.Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tlogging.L.Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tlogging.L.Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tlogging.L.Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n" }, { "path": "ch06/acme/internal/modules/get/get.go", "content": "package get\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when the requested person is not in the database\n\terrPersonNotFound = errors.New(\"person not found\")\n)\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\t// load person from the data layer\n\tperson, err := loader(ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are hiding the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn person, err\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.Load\n" }, { "path": "ch06/acme/internal/modules/get/go_test.go", "content": "package get\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetter_Do_happyPath(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(ID int) (*data.Person, error) {\n\t\tresult := &data.Person{\n\t\t\tID: 1234,\n\t\t\tFullName: \"Doug\",\n\t\t}\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, ID, person.ID)\n\tassert.Equal(t, \"Doug\", person.FullName)\n}\n\nfunc TestGetter_Do_noSuchPerson(t *testing.T) {\n\t// inputs\n\tID := 5678\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(ID int) (*data.Person, error) {\n\t\tvar result *data.Person\n\t\tresultErr := data.ErrNotFound\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Equal(t, errPersonNotFound, err)\n\tassert.Nil(t, person)\n}\n\nfunc TestGetter_Do_error(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(ID int) (*data.Person, error) {\n\t\tvar result *data.Person\n\t\tresultErr := errors.New(\"failed to load person\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Nil(t, person)\n}\n" }, { "path": "ch06/acme/internal/modules/list/list.go", "content": "package list\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when there are no people in the database\n\terrPeopleNotFound = errors.New(\"no people found\")\n)\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n}\n\n// Do will load the people from the data layer\nfunc (l *Lister) Do() ([]*data.Person, error) {\n\t// load all people\n\tpeople, err := l.load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(people) == 0 {\n\t\t// special processing for 0 people returned\n\t\treturn nil, errPeopleNotFound\n\t}\n\n\treturn people, nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n\tpeople, err := loader()\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPeopleNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn people, nil\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.LoadAll\n" }, { "path": "ch06/acme/internal/modules/list/list_test.go", "content": "package list\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLister_Do_happyPath(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func() ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func() ([]*data.Person, error) {\n\t\tresult := []*data.Person{\n\t\t\t{\n\t\t\t\tID: 1234,\n\t\t\t\tFullName: \"Sally\",\n\t\t\t},\n\t\t\t{\n\t\t\t\tID: 5678,\n\t\t\t\tFullName: \"Jane\",\n\t\t\t},\n\t\t}\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, len(persons))\n}\n\nfunc TestLister_Do_noResults(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func() ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func() ([]*data.Person, error) {\n\t\tvar result []*data.Person\n\t\tresultErr := data.ErrNotFound\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Equal(t, errPeopleNotFound, err)\n\tassert.Equal(t, 0, len(persons))\n}\n\nfunc TestLister_Do_error(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func() ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func() ([]*data.Person, error) {\n\t\tvar result []*data.Person\n\t\tresultErr := errors.New(\"failed to load people\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, len(persons))\n}\n" }, { "path": "ch06/acme/internal/modules/register/register.go", "content": "package register\n\nimport (\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/exchange\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\t// validation errors\n\terrNameMissing = errors.New(\"name is missing\")\n\terrPhoneMissing = errors.New(\"phone is missing\")\n\terrCurrencyMissing = errors.New(\"currency is missing\")\n\terrInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n\t// a little trick to make checking for supported currencies easier\n\tsupportedCurrencies = map[string]struct{}{\n\t\t\"AUD\": {},\n\t\t\"CNY\": {},\n\t\t\"EUR\": {},\n\t\t\"GBP\": {},\n\t\t\"JPY\": {},\n\t\t\"MYR\": {},\n\t\t\"SGD\": {},\n\t\t\"USD\": {},\n\t}\n)\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(in *data.Person) (int, error) {\n\t// validate the request\n\terr := r.validateInput(in)\n\tif err != nil {\n\t\tlogging.L.Warn(\"input validation failed with err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// get price in the requested currency\n\tprice, err := r.getPrice(in.Currency)\n\tif err != nil {\n\t\treturn defaultPersonID, err\n\t}\n\n\t// save registration\n\tid, err := r.save(in, price)\n\tif err != nil {\n\t\t// no need to log here as we expect the data layer to do so\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *data.Person) error {\n\tif in.FullName == \"\" {\n\t\treturn errNameMissing\n\t}\n\tif in.Phone == \"\" {\n\t\treturn errPhoneMissing\n\t}\n\tif in.Currency == \"\" {\n\t\treturn errCurrencyMissing\n\t}\n\n\tif _, found := supportedCurrencies[in.Currency]; !found {\n\t\treturn errInvalidCurrency\n\t}\n\n\t// happy path\n\treturn nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(currency string) (float64, error) {\n\tconverter := &exchange.Converter{}\n\tprice, err := converter.Do(config.App.BasePrice, currency)\n\tif err != nil {\n\t\tlogging.L.Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(in *data.Person, price float64) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tCurrency: in.Currency,\n\t\tPrice: price,\n\t}\n\treturn saver(person)\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar saver = data.Save\n" }, { "path": "ch06/acme/internal/modules/register/register_test.go", "content": "package register\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterer_Do_happyPath(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(in *data.Person) (int, error)) {\n\t\t// restore original\n\t\tsaver = original\n\t}(saver)\n\n\t// replace method\n\tsaver = func(in *data.Person) (int, error) {\n\t\tresult := 888\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{}\n\tID, err := registerer.Do(in)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 888, ID)\n}\n\nfunc TestRegisterer_Do_error(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(in *data.Person) (int, error)) {\n\t\t// restore original\n\t\tsaver = original\n\t}(saver)\n\n\t// replace method\n\tsaver = func(in *data.Person) (int, error) {\n\t\tvar result int\n\t\tresultErr := errors.New(\"failed to save\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{}\n\tID, err := registerer.Do(in)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, ID)\n}\n" }, { "path": "ch06/acme/internal/rest/get.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// key in the mux where the ID is stored\n\tmuxVarID = \"id\"\n)\n\n// GetModel will load a registration\n//go:generate mockery -name=GetModel -case underscore -testonly -inpkg -note @generated\ntype GetModel interface {\n\tDo(ID int) (*data.Person, error)\n}\n\n// NewGetHandler is the constructor for GetHandler\nfunc NewGetHandler(model GetModel) *GetHandler {\n\treturn &GetHandler{\n\t\tgetter: model,\n\t}\n}\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n\tgetter GetModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tperson, err := h.getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[muxVarID]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\tlogging.L.Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\tlogging.L.Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *data.Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n" }, { "path": "ch06/acme/internal/rest/get_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockGetModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\toutput := &data.Person{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"USD\",\n\t\t\t\t\tPrice: 100,\n\t\t\t\t}\n\n\t\t\t\tmockGetModel := &MockGetModel{}\n\t\t\t\tmockGetModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockGetModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\",\"currency\":\"USD\",\"price\":100}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is invalid)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/x/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"x\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is missing)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person//\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency fail\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"requested registration does not exist\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"person not found\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockGetModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewGetHandler(mockGetModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\t\t})\n\t}\n}\n" }, { "path": "ch06/acme/internal/rest/list.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n)\n\n// ListModel will load all registrations\n//go:generate mockery -name=ListModel -case underscore -testonly -inpkg -note @generated\ntype ListModel interface {\n\tDo() ([]*data.Person, error)\n}\n\n// NewLister is the constructor for ListHandler\nfunc NewListHandler(model ListModel) *ListHandler {\n\treturn &ListHandler{\n\t\tlister: model,\n\t}\n}\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n\tlister ListModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// attempt loadAll\n\tpeople, err := h.lister.Do()\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, people)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*data.Person) error {\n\toutput := &listResponseFormat{\n\t\tPeople: make([]*listResponseItemFormat, len(people)),\n\t}\n\n\tfor index, record := range people {\n\t\toutput.People[index] = &listResponseItemFormat{\n\t\t\tID: record.ID,\n\t\t\tFullName: record.FullName,\n\t\t\tPhone: record.Phone,\n\t\t}\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n\tPeople []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n}\n" }, { "path": "ch06/acme/internal/rest/list_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestListHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockListModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\toutput := []*data.Person{\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 2,\n\t\t\t\t\t\tFullName: \"Paul\",\n\t\t\t\t\t\tPhone: \"0123456781\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 3,\n\t\t\t\t\t\tFullName: \"George\",\n\t\t\t\t\t\tPhone: \"0123456782\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"Ringo\",\n\t\t\t\t\t\tPhone: \"0123456783\",\n\t\t\t\t\t},\n\t\t\t\t}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\"},{\"id\":2,\"name\":\"Paul\",\"phone\":\"0123456781\"},{\"id\":3,\"name\":\"George\",\"phone\":\"0123456782\"},{\"id\":1,\"name\":\"Ringo\",\"phone\":\"0123456783\"}]}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"no data\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\t// no data\n\t\t\t\toutput := []*data.Person{}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[]}` + \"\\n\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockListModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewListHandler(mockListModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\n\t\t})\n\t}\n}\n" }, { "path": "ch06/acme/internal/rest/mock_get_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockGetModel is an autogenerated mock type for the GetModel type\ntype MockGetModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ID\nfunc (_m *MockGetModel) Do(ID int) (*data.Person, error) {\n\tret := _m.Called(ID)\n\n\tvar r0 *data.Person\n\tif rf, ok := ret.Get(0).(func(int) *data.Person); ok {\n\t\tr0 = rf(ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(int) error); ok {\n\t\tr1 = rf(ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch06/acme/internal/rest/mock_list_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockListModel is an autogenerated mock type for the ListModel type\ntype MockListModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields:\nfunc (_m *MockListModel) Do() ([]*data.Person, error) {\n\tret := _m.Called()\n\n\tvar r0 []*data.Person\n\tif rf, ok := ret.Get(0).(func() []*data.Person); ok {\n\t\tr0 = rf()\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func() error); ok {\n\t\tr1 = rf()\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch06/acme/internal/rest/mock_register_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockRegisterModel is an autogenerated mock type for the RegisterModel type\ntype MockRegisterModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: in\nfunc (_m *MockRegisterModel) Do(in *data.Person) (int, error) {\n\tret := _m.Called(in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(*data.Person) int); ok {\n\t\tr0 = rf(in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(*data.Person) error); ok {\n\t\tr1 = rf(in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch06/acme/internal/rest/not_found.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n" }, { "path": "ch06/acme/internal/rest/not_found_test.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNotFoundHandler_ServeHTTP(t *testing.T) {\n\t// build inputs\n\tresponse := httptest.NewRecorder()\n\trequest := &http.Request{}\n\n\t// call handler\n\tnotFoundHandler(response, request)\n\n\t// validate outputs\n\trequire.Equal(t, http.StatusNotFound, response.Code)\n}\n" }, { "path": "ch06/acme/internal/rest/register.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/data\"\n)\n\n// RegisterModel will validate and save a registration\n//go:generate mockery -name=RegisterModel -case underscore -testonly -inpkg -note @generated\ntype RegisterModel interface {\n\tDo(in *data.Person) (int, error)\n}\n\n// NewRegisterHandler is the constructor for RegisterHandler\nfunc NewRegisterHandler(model RegisterModel) *RegisterHandler {\n\treturn &RegisterHandler{\n\t\tregisterer: model,\n\t}\n}\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n\tregisterer RegisterModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// register person\n\tid, err := h.register(requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(requestPayload *registerRequest) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\treturn h.registerer.Do(person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch06/acme/internal/rest/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockRegisterModel\n\t\texpectedStatus int\n\t\texpectedHeader string\n\t}{\n\t\t{\n\t\t\tdesc: \"Happy Path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// valid downstream configuration\n\t\t\t\tresultID := 1234\n\t\t\t\tvar resultErr error\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(resultID, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusCreated,\n\t\t\texpectedHeader: \"/person/1234/\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Bad Input / User Error\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tinvalidRequest := bytes.NewBufferString(`this is not valid JSON`)\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", invalidRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// Dependency should not be called\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Dependency Failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// call to the dependency failed\n\t\t\t\tresultErr := errors.New(\"something failed\")\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(0, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockRegisterModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewRegisterHandler(mockRegisterModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code)\n\n\t\t\t// call should output the location to the new person\n\t\t\tresultHeader := response.Header().Get(\"Location\")\n\t\t\tassert.Equal(t, scenario.expectedHeader, resultHeader)\n\n\t\t\t// validate the mock was used as we expected\n\t\t\tassert.True(t, mockRegisterModel.AssertExpectations(t))\n\t\t})\n\t}\n}\n\nfunc buildValidRegisterRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch06/acme/internal/rest/server.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/gorilla/mux\"\n)\n\n// New will create and initialize the server\nfunc New(address string,\n\tgetModel GetModel,\n\tlistModel ListModel,\n\tregisterModel RegisterModel) *Server {\n\n\treturn &Server{\n\t\taddress: address,\n\t\thandlerGet: NewGetHandler(getModel),\n\t\thandlerList: NewListHandler(listModel),\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: NewRegisterHandler(registerModel),\n\t}\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n\taddress string\n\tserver *http.Server\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n\trouter := s.buildRouter()\n\n\t// create the HTTP server\n\ts.server = &http.Server{\n\t\tHandler: router,\n\t\tAddr: s.address,\n\t}\n\n\t// listen for shutdown\n\tgo func() {\n\t\t// wait for shutdown signal\n\t\t<-stop\n\n\t\t_ = s.server.Close()\n\t}()\n\n\t// start the HTTP server\n\t_ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n\trouter := mux.NewRouter()\n\n\t// map URL endpoints to HTTP handlers\n\trouter.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n\trouter.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n\trouter.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n\t// convert a \"catch all\" not found handler\n\trouter.NotFoundHandler = s.handlerNotFound\n\n\treturn router\n}\n" }, { "path": "ch06/acme/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch06/acme/internal/rest\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// build model layer\n\tgetModel := &get.Getter{}\n\tlistModel := &list.Lister{}\n\tregisterModel := ®ister.Registerer{}\n\n\t// start REST server\n\tserver := rest.New(config.App.Address, getModel, listModel, registerModel)\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch06/fake.go", "content": "package ch06\n\nfunc init() {\n\t// This file is included so that Go tools (like `go list`) will find Go code in this directory and not error\n}\n" }, { "path": "ch06/pcov-html", "content": "#!/usr/bin/env bash\n\nif [ \"$1\" == \"\" ]; then\n\techo \"No input file. Usage: pcov-html ./your-package-dir/\"\n\texit 1\nfi\n\n# Inputs\n# Trim any ... from the end of the supplied directory\nDIR=${1%...}\n# Ensure there is a / at the end of the directory\nPKG_DIR=${DIR%/}/\n\n# Generated coverage\ngo test $PKG_DIR -coverprofile=$PKG_DIR/coverage.out ${@:1}\n\n# Convert coverage to HTML\ngo tool cover -html=$PKG_DIR/coverage.out\n\n# Clean up after ourselves\nrm $PKG_DIR/coverage.out\n" }, { "path": "ch07/01_method_injection/01_fprint.go", "content": "package method_injection\n\nimport (\n\t\"fmt\"\n\t\"os\"\n)\n\nfunc ExampleA() {\n\tfmt.Fprint(os.Stdout, \"Hello World\")\n}\n" }, { "path": "ch07/01_method_injection/02_http_request.go", "content": "package method_injection\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"net/http\"\n)\n\nfunc ExampleB() {\n\t// added to make the compiler happy\n\tbody := &bytes.Buffer{}\n\n\t// example is here\n\treq, err := http.NewRequest(\"POST\", \"/login\", body)\n\n\t// added to make the compiler happy\n\tfmt.Printf(\"req: %#v / err: %s\", req, err)\n}\n" }, { "path": "ch07/01_method_injection/03_fprint.go", "content": "package method_injection\n\nimport (\n\t\"io\"\n)\n\n// Fprint formats using the default formats for its operands and writes to w.\n// It returns the number of bytes written and any write error encountered.\nfunc Fprint(w io.Writer, a ...interface{}) (n int, err error) {\n\treturn\n}\n" }, { "path": "ch07/01_method_injection/04_http_request.go", "content": "package method_injection\n\nimport (\n\t\"io\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/url\"\n)\n\nfunc NewRequest(method, url string, body io.Reader) (*http.Request, error) {\n\t// validate method\n\tm, err := validateMethod(method)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// validate URL\n\tu, err := validateURL(url)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// process body (if exists)\n\tvar b io.ReadCloser\n\tif body != nil {\n\t\t// read body\n\t\tb = ioutil.NopCloser(body)\n\t}\n\n\t// build Request and return\n\treq := &http.Request{\n\t\tURL: u,\n\t\tMethod: m,\n\t\tBody: b,\n\t}\n\n\treturn req, nil\n}\n\nfunc validateMethod(method string) (string, error) {\n\treturn \"\", nil\n}\n\nfunc validateURL(url string) (*url.URL, error) {\n\treturn nil, nil\n}\n" }, { "path": "ch07/01_method_injection/05_timestamp_writer_v1.go", "content": "package method_injection\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"time\"\n)\n\n// TimeStampWriterV1 will output the supplied message to writer preceded with a timestamp\nfunc TimeStampWriterV1(writer io.Writer, message string) {\n\ttimestamp := time.Now().Format(time.RFC3339)\n\tfmt.Fprintf(writer, \"%s -> %s\", timestamp, message)\n}\n" }, { "path": "ch07/01_method_injection/06_timestamp_writer_v2.go", "content": "package method_injection\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"time\"\n)\n\n// TimeStampWriterV2 will output the supplied message to writer preceded with a timestamp\nfunc TimeStampWriterV2(writer io.Writer, message string) error {\n\tif writer == nil {\n\t\treturn errors.New(\"writer cannot be nil\")\n\t}\n\n\ttimestamp := time.Now().Format(time.RFC3339)\n\tfmt.Fprintf(writer, \"%s -> %s\", timestamp, message)\n\n\treturn nil\n}\n" }, { "path": "ch07/01_method_injection/07_timestamp_writer_v3.go", "content": "package method_injection\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"time\"\n)\n\n// TimeStampWriterV3 will output the supplied message to writer preceded with a timestamp\nfunc TimeStampWriterV3(writer io.Writer, message string) {\n\tif writer == nil {\n\t\t// default to Standard Out\n\t\twriter = os.Stdout\n\t}\n\n\ttimestamp := time.Now().Format(time.RFC3339)\n\tfmt.Fprintf(writer, \"%s -> %s\", timestamp, message)\n}\n" }, { "path": "ch07/02_advantages/01_handler_v1.go", "content": "package advantages\n\nimport (\n\t\"encoding/json\"\n\t\"net/http\"\n)\n\nfunc HandlerV1(response http.ResponseWriter, request *http.Request) {\n\tgarfield := &Animal{\n\t\tType: \"Cat\",\n\t\tName: \"Garfield\",\n\t}\n\n\t// encode as JSON and output\n\tencoder := json.NewEncoder(response)\n\terr := encoder.Encode(garfield)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tresponse.WriteHeader(http.StatusOK)\n}\n\ntype Animal struct {\n\tType string\n\tName string\n}\n" }, { "path": "ch07/02_advantages/02_handler_v2.go", "content": "package advantages\n\nimport (\n\t\"encoding/json\"\n\t\"net/http\"\n)\n\nfunc HandlerV2(response http.ResponseWriter, request *http.Request) {\n\tgarfield := &Animal{\n\t\tType: \"Cat\",\n\t\tName: \"Garfield\",\n\t}\n\n\t// encode as JSON and output\n\toutputAnimal(response, garfield)\n}\n\nfunc outputAnimal(response http.ResponseWriter, animal *Animal) {\n\tencoder := json.NewEncoder(response)\n\terr := encoder.Encode(animal)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\t// Happy Path\n\tresponse.WriteHeader(http.StatusOK)\n}\n" }, { "path": "ch07/02_advantages/03_handler_v3.go", "content": "package advantages\n\nimport (\n\t\"encoding/json\"\n\t\"net/http\"\n)\n\nfunc HandlerV3(response http.ResponseWriter, request *http.Request) {\n\tgarfield := &Animal{\n\t\tType: \"Cat\",\n\t\tName: \"Garfield\",\n\t}\n\n\t// encode as JSON and output\n\toutputJSON(response, garfield)\n}\n\nfunc outputJSON(response http.ResponseWriter, data interface{}) {\n\tencoder := json.NewEncoder(response)\n\terr := encoder.Encode(data)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\t// Happy Path\n\tresponse.WriteHeader(http.StatusOK)\n}\n" }, { "path": "ch07/02_advantages/04_context_influence.go", "content": "package advantages\n\nimport (\n\t\"io\"\n\t\"net\"\n\t\"os\"\n)\n\nfunc WriteLog(writer io.Writer, message string) error {\n\t_, err := writer.Write([]byte(message))\n\treturn err\n}\n\nfunc Usage() {\n\t// Write to console\n\tWriteLog(os.Stdout, \"Hello World!\")\n\n\t// Write to file\n\tfile, _ := os.Create(\"my-log.log\")\n\tWriteLog(file, \"Hello World!\")\n\n\t// Write to TCP connection\n\ttcpPipe, _ := net.Dial(\"tcp\", \"127.0.0.1:1234\")\n\tWriteLog(tcpPipe, \"Hello World!\")\n}\n" }, { "path": "ch07/02_advantages/05_person_loader.go", "content": "package advantages\n\nimport (\n\t\"database/sql\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"net/http\"\n)\n\nvar (\n\t// thrown when the supplied order does not exist in the database\n\terrNotFound = errors.New(\"order not found\")\n)\n\n// Loads orders based on supplied owner and order ID\ntype OrderLoader interface {\n\tloadOrder(owner Owner, orderID int) (Order, error)\n}\n\n// NewLoadOrderHandler creates a new instance of LoadOrderHandler\nfunc NewLoadOrderHandler(loader OrderLoader) *LoadOrderHandler {\n\treturn &LoadOrderHandler{\n\t\tloader: loader,\n\t}\n}\n\n// LoadOrderHandler is a HTTP handler that loads orders based on the current user and supplied user ID\ntype LoadOrderHandler struct {\n\tloader OrderLoader\n}\n\n// ServeHTTP implements http.Handler\nfunc (l *LoadOrderHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract user from supplied authentication credentials\n\tcurrentUser, err := l.authenticateUser(request)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusUnauthorized)\n\t\treturn\n\t}\n\n\t// extract order ID from request\n\torderID, err := l.extractOrderID(request)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// load order using the current user as a request-scoped dependency\n\t// (with method injection)\n\torder, err := l.loader.loadOrder(currentUser, orderID)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\t// output order\n\tencoder := json.NewEncoder(response)\n\terr = encoder.Encode(order)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tresponse.WriteHeader(http.StatusOK)\n}\n\n// AuthenticatedLoader will load orders for based on the supplied owner\ntype AuthenticatedLoader struct {\n\t// This pool is expensive to create. We will want to create it once and then reuse it.\n\tdb *sql.DB\n}\n\n// load the order from the database based on owner and order ID\nfunc (a *AuthenticatedLoader) loadByOwner(owner Owner, orderID int) (*Order, error) {\n\torder, err := a.load(orderID)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif order.OwnerID != owner.ID() {\n\t\t// Return not found so we do not leak information to hackers\n\t\treturn nil, errNotFound\n\t}\n\n\t// happy path\n\treturn order, nil\n}\n\nfunc (a *AuthenticatedLoader) load(orderID int) (*Order, error) {\n\t// load order from DB\n\treturn &Order{OwnerID: 1}, nil\n}\n\ntype Owner interface {\n\tID() int\n}\n\ntype Order struct {\n\tOwnerID int\n\n\t// other order details\n}\n\ntype User struct {\n\tid int\n\n\t// other attributes\n}\n\nfunc (u *User) ID() int {\n\treturn u.id\n}\n\n// Extract the user from the request (e.g. from a JWT token).\nfunc (l *LoadOrderHandler) authenticateUser(request *http.Request) (*User, error) {\n\treturn &User{id: 1}, nil\n}\n\n// Extract the order ID from the request (e.g. from the URL or HTTP POST body)\nfunc (l *LoadOrderHandler) extractOrderID(request *http.Request) (int, error) {\n\treturn 2, nil\n}\n" }, { "path": "ch07/04_disadvantages/01_data_struct.go", "content": "package disadvantages\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n)\n\n// Load people from the database\ntype PersonLoader struct {\n}\n\nfunc (d *PersonLoader) Load(db *sql.DB, ID int) (*Person, error) {\n\treturn nil, errors.New(\"not implemented\")\n}\n\nfunc (d *PersonLoader) LoadAll(db *sql.DB) ([]*Person, error) {\n\treturn nil, errors.New(\"not implemented\")\n}\n\ntype Person struct {\n\tName string\n\tAge int\n}\n" }, { "path": "ch07/04_disadvantages/02_ux_improvement.go", "content": "package disadvantages\n\ntype MyPersonLoader interface {\n\tLoad(ID int) (*Person, error)\n}\n" }, { "path": "ch07/04_disadvantages/03_many_params.go", "content": "package disadvantages\n\nimport (\n\t\"io\"\n)\n\ntype Generator struct{}\n\nfunc (g *Generator) Generate(storage Storage, template io.Reader, destination io.Writer, renderer Renderer, formatter Formatter, params ...interface{}) {\n\n}\n\ntype Storage interface {\n\tLoad() []interface{}\n}\n\ntype Renderer interface {\n\tRender(template io.Reader, params ...interface{}) []byte\n}\n\ntype Formatter interface {\n\tFormat([]byte) []byte\n}\n" }, { "path": "ch07/04_disadvantages/04_many_params_v2.go", "content": "package disadvantages\n\nimport (\n\t\"io\"\n)\n\nfunc NewGeneratorV2(storage Storage, renderer Renderer, formatter Formatter) *GeneratorV2 {\n\treturn &GeneratorV2{\n\t\tstorage: storage,\n\t\trenderer: renderer,\n\t\tformatter: formatter,\n\t}\n}\n\ntype GeneratorV2 struct {\n\tstorage Storage\n\trenderer Renderer\n\tformatter Formatter\n}\n\nfunc (g *GeneratorV2) Generate(template io.Reader, destination io.Writer, params ...interface{}) {\n\n}\n" }, { "path": "ch07/acme/internal/config/config.go", "content": "package config\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// App is the application config\nvar App *Config\n\n// Config defines the JSON format for the config file\ntype Config struct {\n\t// DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n\tDSN string\n\n\t// Address is the IP address and port to bind this rest to\n\tAddress string\n\n\t// BasePrice is the price of registration\n\tBasePrice float64\n\n\t// ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n\tExchangeRateBaseURL string\n\n\t// ExchangeRateAPIKey is the API for the exchange rate API\n\tExchangeRateAPIKey string\n}\n\n// Load returns the config loaded from environment\nfunc init() {\n\tfilename, found := os.LookupEnv(DefaultEnvVar)\n\tif !found {\n\t\tlogging.L.Error(\"failed to locate file specified by %s\", DefaultEnvVar)\n\t\treturn\n\t}\n\n\t_ = load(filename)\n}\n\nfunc load(filename string) error {\n\tApp = &Config{}\n\tbytes, err := ioutil.ReadFile(filename)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to read config file. err: %s\", err)\n\t\treturn err\n\t}\n\n\terr = json.Unmarshal(bytes, App)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to parse config file. err : %s\", err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n" }, { "path": "ch07/acme/internal/config/config_test.go", "content": "package config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoad(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin string\n\t\texpectedConfig *Config\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tin: \"../../../../default-config.json\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tDSN: \"[insert your db config here]\",\n\t\t\t\tAddress: \"0.0.0.0:8080\",\n\t\t\t\tBasePrice: 100.00,\n\t\t\t\tExchangeRateBaseURL: \"http://apilayer.net\",\n\t\t\t\tExchangeRateAPIKey: \"[insert your API key here]\",\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"invalid path\",\n\t\t\tin: \"invalid.json\",\n\t\t\texpectedConfig: &Config{},\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\tresultErr := load(scenario.in)\n\t\t\trequire.Equal(t, scenario.expectError, resultErr != nil, \"err: %s\", resultErr)\n\t\t\tassert.Equal(t, scenario.expectedConfig, App, scenario.desc)\n\t\t})\n\t}\n\n}\n" }, { "path": "ch07/acme/internal/logging/logging.go", "content": "package logging\n\nimport (\n\t\"fmt\"\n)\n\n// L is the global instance of the logger\nvar L = &LoggerStdOut{}\n\n// LoggerStdOut logs to std out\ntype LoggerStdOut struct{}\n\n// Debug logs messages at DEBUG level\nfunc (l LoggerStdOut) Debug(message string, args ...interface{}) {\n\tfmt.Printf(\"[DEBUG] \"+message, args...)\n}\n\n// Info logs messages at INFO level\nfunc (l LoggerStdOut) Info(message string, args ...interface{}) {\n\tfmt.Printf(\"[INFO] \"+message, args...)\n}\n\n// Warn logs messages at WARN level\nfunc (l LoggerStdOut) Warn(message string, args ...interface{}) {\n\tfmt.Printf(\"[WARN] \"+message, args...)\n}\n\n// Error logs messages at ERROR level\nfunc (l LoggerStdOut) Error(message string, args ...interface{}) {\n\tfmt.Printf(\"[ERROR] \"+message, args...)\n}\n" }, { "path": "ch07/acme/internal/modules/data/data.go", "content": "package data\n\nimport (\n\t// import the MySQL Driver\n\t\"context\"\n\t\"database/sql\"\n\t\"errors\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/logging\"\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tsqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\nvar getDB = func() (*sql.DB, error) {\n\tif db == nil {\n\t\tif config.App == nil {\n\t\t\treturn nil, errors.New(\"config is not initialized\")\n\t\t}\n\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", config.App.DSN)\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc Save(ctx context.Context, in *Person) (int, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB insert\n\tresult, err := db.ExecContext(subCtx, sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn int(id), nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc LoadAll(ctx context.Context) ([]*Person, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trows, err := db.QueryContext(subCtx, sqlLoadAll)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\tlogging.L.Error(\"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\tlogging.L.Warn(\"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc Load(ctx context.Context, ID int) (*Person, error) {\n\tdb, err := getDB()\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trow := db.QueryRowContext(subCtx, sqlLoadByID, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\tlogging.L.Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\tlogging.L.Error(\"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n\nfunc init() {\n\t// ensure the config is loaded and the db initialized\n\t_, _ = getDB()\n}\n" }, { "path": "ch07/acme/internal/modules/data/data_test.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// monkey patching starts here\n\tdefer func(original sql.DB) {\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t}(*db)\n\n\t// replace db for this test\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(ctx, in)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_insertError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnError(errors.New(\"failed to insert\"))\n\n\t// monkey patching starts here\n\tdefer func(original sql.DB) {\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t}(*db)\n\n\t// replace db for this test\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(ctx, in)\n\n\t// validate result\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_getDBError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patching starts here\n\tdefer func(original func() (*sql.DB, error)) {\n\t\t// restore original DB (after test)\n\t\tgetDB = original\n\t}(getDB)\n\n\t// replace getDB() function for this test\n\tgetDB = func() (*sql.DB, error) {\n\t\treturn nil, errors.New(\"getDB() failed\")\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(ctx, in)\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n}\n\nfunc TestLoadAll_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResults []*Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(1, \"John\", \"0123456789\", \"AUD\", 12.34))\n\t\t\t},\n\t\t\texpectedResults: []*Person{\n\t\t\t\t{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"AUD\",\n\t\t\t\t\tPrice: 12.34,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResults: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey patch the db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tresults, err := LoadAll(ctx)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResults, results, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\nfunc TestLoad_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResult *Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\t\t\t},\n\t\t\texpectedResult: &Person{\n\t\t\t\tID: 2,\n\t\t\t\tFullName: \"Paul\",\n\t\t\t\tPhone: \"0123456789\",\n\t\t\t\tCurrency: \"CAD\",\n\t\t\t\tPrice: 23.45,\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResult: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tresult, err := Load(ctx, 2)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResult, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n" }, { "path": "ch07/acme/internal/modules/exchange/converter.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/logging\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct{}\n\n// Do will perform the conversion\nfunc (c *Converter) Do(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(ctx, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(ctx context.Context, currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tconfig.App.ExchangeRateBaseURL,\n\t\tconfig.App.ExchangeRateAPIKey,\n\t\tcurrency)\n\n\t// perform request\n\treq, err := http.NewRequest(\"GET\", url, nil)\n\tif err != nil {\n\t\tlogging.L.Warn(\"[exchange] failed to create request. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the upstream call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// replace the default context with our custom one\n\treq = req.WithContext(subCtx)\n\n\t// perform the HTTP request\n\tresponse, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tlogging.L.Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tlogging.L.Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tlogging.L.Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tlogging.L.Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tlogging.L.Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n" }, { "path": "ch07/acme/internal/modules/get/get.go", "content": "package get\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when the requested person is not in the database\n\terrPersonNotFound = errors.New(\"person not found\")\n)\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\t// load person from the data layer\n\tperson, err := loader(context.TODO(), ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are hiding the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn person, err\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.Load\n" }, { "path": "ch07/acme/internal/modules/get/go_test.go", "content": "package get\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetter_Do_happyPath(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, ID int) (*data.Person, error) {\n\t\tresult := &data.Person{\n\t\t\tID: 1234,\n\t\t\tFullName: \"Doug\",\n\t\t}\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, ID, person.ID)\n\tassert.Equal(t, \"Doug\", person.FullName)\n}\n\nfunc TestGetter_Do_noSuchPerson(t *testing.T) {\n\t// inputs\n\tID := 5678\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, ID int) (*data.Person, error) {\n\t\tvar result *data.Person\n\t\tresultErr := data.ErrNotFound\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Equal(t, errPersonNotFound, err)\n\tassert.Nil(t, person)\n}\n\nfunc TestGetter_Do_error(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, ID int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, ID int) (*data.Person, error) {\n\t\tvar result *data.Person\n\t\tresultErr := errors.New(\"failed to load person\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Nil(t, person)\n}\n" }, { "path": "ch07/acme/internal/modules/list/list.go", "content": "package list\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when there are no people in the database\n\terrPeopleNotFound = errors.New(\"no people found\")\n)\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n}\n\n// Do will load the people from the data layer\nfunc (l *Lister) Do() ([]*data.Person, error) {\n\t// load all people\n\tpeople, err := l.load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(people) == 0 {\n\t\t// special processing for 0 people returned\n\t\treturn nil, errPeopleNotFound\n\t}\n\n\treturn people, nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n\tpeople, err := loader(context.TODO())\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPeopleNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn people, nil\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.LoadAll\n" }, { "path": "ch07/acme/internal/modules/list/list_test.go", "content": "package list\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLister_Do_happyPath(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context) ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context) ([]*data.Person, error) {\n\t\tresult := []*data.Person{\n\t\t\t{\n\t\t\t\tID: 1234,\n\t\t\t\tFullName: \"Sally\",\n\t\t\t},\n\t\t\t{\n\t\t\t\tID: 5678,\n\t\t\t\tFullName: \"Jane\",\n\t\t\t},\n\t\t}\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, len(persons))\n}\n\nfunc TestLister_Do_noResults(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context) ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context) ([]*data.Person, error) {\n\t\tvar result []*data.Person\n\t\tresultErr := data.ErrNotFound\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Equal(t, errPeopleNotFound, err)\n\tassert.Equal(t, 0, len(persons))\n}\n\nfunc TestLister_Do_error(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context) ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context) ([]*data.Person, error) {\n\t\tvar result []*data.Person\n\t\tresultErr := errors.New(\"failed to load people\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, len(persons))\n}\n" }, { "path": "ch07/acme/internal/modules/register/register.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/exchange\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\t// validation errors\n\terrNameMissing = errors.New(\"name is missing\")\n\terrPhoneMissing = errors.New(\"phone is missing\")\n\terrCurrencyMissing = errors.New(\"currency is missing\")\n\terrInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n\t// a little trick to make checking for supported currencies easier\n\tsupportedCurrencies = map[string]struct{}{\n\t\t\"AUD\": {},\n\t\t\"CNY\": {},\n\t\t\"EUR\": {},\n\t\t\"GBP\": {},\n\t\t\"JPY\": {},\n\t\t\"MYR\": {},\n\t\t\"SGD\": {},\n\t\t\"USD\": {},\n\t}\n)\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(ctx context.Context, in *data.Person) (int, error) {\n\t// validate the request\n\terr := r.validateInput(in)\n\tif err != nil {\n\t\tlogging.L.Warn(\"input validation failed with err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// get price in the requested currency\n\tprice, err := r.getPrice(ctx, in.Currency)\n\tif err != nil {\n\t\treturn defaultPersonID, err\n\t}\n\n\t// save registration\n\tid, err := r.save(ctx, in, price)\n\tif err != nil {\n\t\t// no need to log here as we expect the data layer to do so\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *data.Person) error {\n\tif in.FullName == \"\" {\n\t\treturn errNameMissing\n\t}\n\tif in.Phone == \"\" {\n\t\treturn errPhoneMissing\n\t}\n\tif in.Currency == \"\" {\n\t\treturn errCurrencyMissing\n\t}\n\n\tif _, found := supportedCurrencies[in.Currency]; !found {\n\t\treturn errInvalidCurrency\n\t}\n\n\t// happy path\n\treturn nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(ctx context.Context, currency string) (float64, error) {\n\tconverter := &exchange.Converter{}\n\tprice, err := converter.Do(ctx, config.App.BasePrice, currency)\n\tif err != nil {\n\t\tlogging.L.Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(ctx context.Context, in *data.Person, price float64) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tCurrency: in.Currency,\n\t\tPrice: price,\n\t}\n\treturn saver(ctx, person)\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar saver = data.Save\n" }, { "path": "ch07/acme/internal/modules/register/register_test.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterer_Do_happyPath(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(ctx context.Context, in *data.Person) (int, error)) {\n\t\t// restore original\n\t\tsaver = original\n\t}(saver)\n\n\t// replace method\n\tsaver = func(ctx context.Context, in *data.Person) (int, error) {\n\t\tresult := 888\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 888, ID)\n}\n\nfunc TestRegisterer_Do_error(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(ctx context.Context, in *data.Person) (int, error)) {\n\t\t// restore original\n\t\tsaver = original\n\t}(saver)\n\n\t// replace method\n\tsaver = func(ctx context.Context, in *data.Person) (int, error) {\n\t\tvar result int\n\t\tresultErr := errors.New(\"failed to save\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, ID)\n}\n" }, { "path": "ch07/acme/internal/rest/get.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// key in the mux where the ID is stored\n\tmuxVarID = \"id\"\n)\n\n// GetModel will load a registration\n//go:generate mockery -name=GetModel -case underscore -testonly -inpkg -note @generated\ntype GetModel interface {\n\tDo(ID int) (*data.Person, error)\n}\n\n// NewGetHandler is the constructor for GetHandler\nfunc NewGetHandler(model GetModel) *GetHandler {\n\treturn &GetHandler{\n\t\tgetter: model,\n\t}\n}\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n\tgetter GetModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tperson, err := h.getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[muxVarID]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\tlogging.L.Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\tlogging.L.Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *data.Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n" }, { "path": "ch07/acme/internal/rest/get_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockGetModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\toutput := &data.Person{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"USD\",\n\t\t\t\t\tPrice: 100,\n\t\t\t\t}\n\n\t\t\t\tmockGetModel := &MockGetModel{}\n\t\t\t\tmockGetModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockGetModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\",\"currency\":\"USD\",\"price\":100}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is invalid)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/x/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"x\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is missing)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person//\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency fail\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"requested registration does not exist\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"person not found\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockGetModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewGetHandler(mockGetModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\t\t})\n\t}\n}\n" }, { "path": "ch07/acme/internal/rest/list.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n)\n\n// ListModel will load all registrations\n//go:generate mockery -name=ListModel -case underscore -testonly -inpkg -note @generated\ntype ListModel interface {\n\tDo() ([]*data.Person, error)\n}\n\n// NewLister is the constructor for ListHandler\nfunc NewListHandler(model ListModel) *ListHandler {\n\treturn &ListHandler{\n\t\tlister: model,\n\t}\n}\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n\tlister ListModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// attempt loadAll\n\tpeople, err := h.lister.Do()\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, people)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*data.Person) error {\n\toutput := &listResponseFormat{\n\t\tPeople: make([]*listResponseItemFormat, len(people)),\n\t}\n\n\tfor index, record := range people {\n\t\toutput.People[index] = &listResponseItemFormat{\n\t\t\tID: record.ID,\n\t\t\tFullName: record.FullName,\n\t\t\tPhone: record.Phone,\n\t\t}\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n\tPeople []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n}\n" }, { "path": "ch07/acme/internal/rest/list_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestListHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockListModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\toutput := []*data.Person{\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 2,\n\t\t\t\t\t\tFullName: \"Paul\",\n\t\t\t\t\t\tPhone: \"0123456781\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 3,\n\t\t\t\t\t\tFullName: \"George\",\n\t\t\t\t\t\tPhone: \"0123456782\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"Ringo\",\n\t\t\t\t\t\tPhone: \"0123456783\",\n\t\t\t\t\t},\n\t\t\t\t}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\"},{\"id\":2,\"name\":\"Paul\",\"phone\":\"0123456781\"},{\"id\":3,\"name\":\"George\",\"phone\":\"0123456782\"},{\"id\":1,\"name\":\"Ringo\",\"phone\":\"0123456783\"}]}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"no data\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\t// no data\n\t\t\t\toutput := []*data.Person{}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[]}` + \"\\n\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockListModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewListHandler(mockListModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\n\t\t})\n\t}\n}\n" }, { "path": "ch07/acme/internal/rest/mock_get_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockGetModel is an autogenerated mock type for the GetModel type\ntype MockGetModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ID\nfunc (_m *MockGetModel) Do(ID int) (*data.Person, error) {\n\tret := _m.Called(ID)\n\n\tvar r0 *data.Person\n\tif rf, ok := ret.Get(0).(func(int) *data.Person); ok {\n\t\tr0 = rf(ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(int) error); ok {\n\t\tr1 = rf(ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch07/acme/internal/rest/mock_list_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockListModel is an autogenerated mock type for the ListModel type\ntype MockListModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields:\nfunc (_m *MockListModel) Do() ([]*data.Person, error) {\n\tret := _m.Called()\n\n\tvar r0 []*data.Person\n\tif rf, ok := ret.Get(0).(func() []*data.Person); ok {\n\t\tr0 = rf()\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func() error); ok {\n\t\tr1 = rf()\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch07/acme/internal/rest/mock_register_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockRegisterModel is an autogenerated mock type for the RegisterModel type\ntype MockRegisterModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ctx, in\nfunc (_m *MockRegisterModel) Do(ctx context.Context, in *data.Person) (int, error) {\n\tret := _m.Called(ctx, in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(context.Context, *data.Person) int); ok {\n\t\tr0 = rf(ctx, in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, *data.Person) error); ok {\n\t\tr1 = rf(ctx, in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch07/acme/internal/rest/not_found.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n" }, { "path": "ch07/acme/internal/rest/not_found_test.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNotFoundHandler_ServeHTTP(t *testing.T) {\n\t// build inputs\n\tresponse := httptest.NewRecorder()\n\trequest := &http.Request{}\n\n\t// call handler\n\tnotFoundHandler(response, request)\n\n\t// validate outputs\n\trequire.Equal(t, http.StatusNotFound, response.Code)\n}\n" }, { "path": "ch07/acme/internal/rest/register.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/data\"\n)\n\n// RegisterModel will validate and save a registration\n//go:generate mockery -name=RegisterModel -case underscore -testonly -inpkg -note @generated\ntype RegisterModel interface {\n\tDo(ctx context.Context, in *data.Person) (int, error)\n}\n\n// NewRegisterHandler is the constructor for RegisterHandler\nfunc NewRegisterHandler(model RegisterModel) *RegisterHandler {\n\treturn &RegisterHandler{\n\t\tregisterer: model,\n\t}\n}\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n\tregisterer RegisterModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// set latency budget for this API\n\tsubCtx, cancel := context.WithTimeout(request.Context(), 1500*time.Millisecond)\n\tdefer cancel()\n\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// call the business logic using the request data and context\n\tid, err := h.register(subCtx, requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(ctx context.Context, requestPayload *registerRequest) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\treturn h.registerer.Do(ctx, person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch07/acme/internal/rest/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockRegisterModel\n\t\texpectedStatus int\n\t\texpectedHeader string\n\t}{\n\t\t{\n\t\t\tdesc: \"Happy Path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// valid downstream configuration\n\t\t\t\tresultID := 1234\n\t\t\t\tvar resultErr error\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(resultID, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusCreated,\n\t\t\texpectedHeader: \"/person/1234/\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Bad Input / User Error\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tinvalidRequest := bytes.NewBufferString(`this is not valid JSON`)\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", invalidRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// Dependency should not be called\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Dependency Failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// call to the dependency failed\n\t\t\t\tresultErr := errors.New(\"something failed\")\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(0, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockRegisterModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewRegisterHandler(mockRegisterModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code)\n\n\t\t\t// call should output the location to the new person\n\t\t\tresultHeader := response.Header().Get(\"Location\")\n\t\t\tassert.Equal(t, scenario.expectedHeader, resultHeader)\n\n\t\t\t// validate the mock was used as we expected\n\t\t\tassert.True(t, mockRegisterModel.AssertExpectations(t))\n\t\t})\n\t}\n}\n\nfunc buildValidRegisterRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch07/acme/internal/rest/server.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/gorilla/mux\"\n)\n\n// New will create and initialize the server\nfunc New(address string,\n\tgetModel GetModel,\n\tlistModel ListModel,\n\tregisterModel RegisterModel) *Server {\n\n\treturn &Server{\n\t\taddress: address,\n\t\thandlerGet: NewGetHandler(getModel),\n\t\thandlerList: NewListHandler(listModel),\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: NewRegisterHandler(registerModel),\n\t}\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n\taddress string\n\tserver *http.Server\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n\trouter := s.buildRouter()\n\n\t// create the HTTP server\n\ts.server = &http.Server{\n\t\tHandler: router,\n\t\tAddr: s.address,\n\t}\n\n\t// listen for shutdown\n\tgo func() {\n\t\t// wait for shutdown signal\n\t\t<-stop\n\n\t\t_ = s.server.Close()\n\t}()\n\n\t// start the HTTP server\n\t_ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n\trouter := mux.NewRouter()\n\n\t// map URL endpoints to HTTP handlers\n\trouter.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n\trouter.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n\trouter.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n\t// convert a \"catch all\" not found handler\n\trouter.NotFoundHandler = s.handlerNotFound\n\n\treturn router\n}\n" }, { "path": "ch07/acme/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch07/acme/internal/rest\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// build model layer\n\tgetModel := &get.Getter{}\n\tlistModel := &list.Lister{}\n\tregisterModel := ®ister.Registerer{}\n\n\t// start REST server\n\tserver := rest.New(config.App.Address, getModel, listModel, registerModel)\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch07/fake.go", "content": "package ch07\n\nfunc init() {\n\t// This file is included so that Go tools (like `go list`) will find Go code in this directory and not error\n}\n" }, { "path": "ch08/01_config_injection/01_long_constructor.go", "content": "package config_injection\n\nimport (\n\t\"time\"\n)\n\n// NewLongConstructor is the constructor for MyStruct\nfunc NewLongConstructor(logger Logger, stats Instrumentation, limiter RateLimiter, cache Cache, timeout time.Duration, workers int) *MyStruct {\n\treturn &MyStruct{\n\t\t// code removed\n\t}\n}\n\n// MyStruct does something fantastic\ntype MyStruct struct {\n}\n\n// Logger logs stuff\ntype Logger interface {\n\tError(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tDebug(message string, args ...interface{})\n}\n\n// Instrumentation records the performances and events\ntype Instrumentation interface {\n\tCount(key string, value int)\n\tDuration(key string, start time.Time)\n}\n\n// RateLimiter limits how many concurrent requests we can make or process\ntype RateLimiter interface {\n\tAcquire()\n\tRelease()\n}\n\n// Cache will store/retrieve data in a fast way\ntype Cache interface {\n\tStore(key string, data []byte)\n\tGet(key string) ([]byte, error)\n}\n" }, { "path": "ch08/01_config_injection/02_by_config_example.go", "content": "package config_injection\n\nimport (\n\t\"time\"\n)\n\n// NewByConfigConstructor is the constructor for MyStruct\nfunc NewByConfigConstructor(cfg MyConfig, limiter RateLimiter, cache Cache) *MyStruct {\n\treturn &MyStruct{\n\t\t// code removed\n\t}\n}\n\n// MyConfig defines the config for MyStruct\ntype MyConfig interface {\n\tLogger() Logger\n\tInstrumentation() Instrumentation\n\tTimeout() time.Duration\n\tWorkers() int\n}\n" }, { "path": "ch08/01_config_injection/03_shared_params.go", "content": "package config_injection\n\nimport (\n\t\"fmt\"\n\t\"time\"\n)\n\nfunc Usage() {\n\tcfg := &fakeConfig{}\n\n\tmyFetcher := NewFetcher(cfg, cfg.URL(), cfg.Timeout())\n\n\t// do something with the object so the compiler does not complain\n\tfmt.Printf(\"%#v\", myFetcher)\n}\n\ntype FetcherConfig interface {\n\tLogger() Logger\n\tInstrumentation() Instrumentation\n}\n\nfunc NewFetcher(cfg FetcherConfig, url string, timeout time.Duration) *MyObject {\n\treturn nil\n}\n\ntype MyObject struct{}\n\n// fake implementation of the FetcherConfig interface\ntype fakeConfig struct{}\n\n// Logger implements FetcherConfig\nfunc (f *fakeConfig) Logger() Logger {\n\treturn nil\n}\n\n// Instrumentation implements FetcherConfig\nfunc (f *fakeConfig) Instrumentation() Instrumentation {\n\treturn nil\n}\n\nfunc (f *fakeConfig) URL() string {\n\treturn \"\"\n}\n\nfunc (f *fakeConfig) Timeout() time.Duration {\n\treturn time.Duration(0)\n}\n" }, { "path": "ch08/02_advantages/01_injected_config/01.go", "content": "package injected_config\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/02_advantages/config\"\n)\n\nfunc NewMyObject(cfg *config.Config) *MyObject {\n\treturn &MyObject{\n\t\tcfg: cfg,\n\t}\n}\n\ntype MyObject struct {\n\tcfg *config.Config\n}\n\nfunc (m *MyObject) Do() (interface{}, error) {\n\tm.cfg.Logger().Error(\"not implemented\")\n\treturn struct{}{}, nil\n}\n" }, { "path": "ch08/02_advantages/01_injected_config/01_test.go", "content": "package injected_config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/02_advantages/config\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nconst (\n\ttestConfigLocation = \"\"\n)\n\nfunc TestInjectedConfig(t *testing.T) {\n\t// load test config\n\tcfg, err := config.LoadFromFile(testConfigLocation)\n\trequire.NoError(t, err)\n\n\t// build and use object\n\tobj := NewMyObject(cfg)\n\tresult, resultErr := obj.Do()\n\n\t// validate\n\tassert.NotNil(t, result)\n\tassert.NoError(t, resultErr)\n}\n" }, { "path": "ch08/02_advantages/02_config_injection/02.go", "content": "package config_injection\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/02_advantages/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/02_advantages/stats\"\n)\n\nfunc NewMyObject(cfg Config) *MyObject {\n\treturn &MyObject{\n\t\tcfg: cfg,\n\t}\n}\n\ntype Config interface {\n\tLogger() *logging.Logger\n\tStats() *stats.Collector\n}\n\ntype MyObject struct {\n\tcfg Config\n}\n\nfunc (m *MyObject) Do() (interface{}, error) {\n\tm.cfg.Logger().Error(\"not implemented\")\n\treturn struct{}{}, nil\n}\n" }, { "path": "ch08/02_advantages/02_config_injection/02_test.go", "content": "package config_injection\n\nimport (\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/02_advantages/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/02_advantages/stats\"\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestConfigInjection(t *testing.T) {\n\t// build test config\n\tcfg := &TestConfig{}\n\n\t// build and use object\n\tobj := NewMyObject(cfg)\n\tresult, resultErr := obj.Do()\n\n\t// validate\n\tassert.NotNil(t, result)\n\tassert.NoError(t, resultErr)\n}\n\n// Simple implementation of the Config interface\ntype TestConfig struct {\n\tlogger *logging.Logger\n\tstats *stats.Collector\n}\n\nfunc (t *TestConfig) Logger() *logging.Logger {\n\treturn t.logger\n}\n\nfunc (t *TestConfig) Stats() *stats.Collector {\n\treturn t.stats\n}\n" }, { "path": "ch08/02_advantages/03_long_constructor.go", "content": "package config_injection\n\nimport (\n\t\"time\"\n)\n\n// NewLongConstructor is the constructor for MyStruct\nfunc NewLongConstructor(logger Logger, stats Instrumentation, limiter RateLimiter, cache Cache, url string, credentials string) *MyStruct {\n\treturn &MyStruct{\n\t\t// code removed\n\t}\n}\n\n// MyStruct does something fantastic\ntype MyStruct struct {\n}\n\n// Logger logs stuff\ntype Logger interface {\n\tError(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tDebug(message string, args ...interface{})\n}\n\n// Instrumentation records the performances and events\ntype Instrumentation interface {\n\tCount(key string, value int)\n\tDuration(key string, start time.Time)\n}\n\n// RateLimiter limits how many concurrent requests we can make or process\ntype RateLimiter interface {\n\tAcquire()\n\tRelease()\n}\n\n// Cache will store/retrieve data in a fast way\ntype Cache interface {\n\tStore(key string, data []byte)\n\tGet(key string) ([]byte, error)\n}\n" }, { "path": "ch08/02_advantages/04_by_config_example.go", "content": "package config_injection\n\n// NewByConfigConstructor is the constructor for MyStruct\nfunc NewByConfigConstructor(cfg MyConfig, url string, credentials string) *MyStruct {\n\treturn &MyStruct{\n\t\t// code removed\n\t}\n}\n\n// MyConfig defines the config for MyStruct\ntype MyConfig interface {\n\tLogger() Logger\n\tInstrumentation() Instrumentation\n\tRateLimiter() RateLimiter\n\tCache() Cache\n}\n" }, { "path": "ch08/02_advantages/config/config.go", "content": "package config\n\nimport (\n\t\"sync\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/02_advantages/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/02_advantages/stats\"\n)\n\n// LoadFromFile loads the config from the supplied path\nfunc LoadFromFile(path string) (*Config, error) {\n\t// TODO: implement\n\treturn &Config{}, nil\n}\n\n// Config is the result of loading config from a file\ntype Config struct {\n\t// Log config\n\tLogLevel int `json:\"log_level\"`\n\tlogger *logging.Logger\n\tloggerInitOnce sync.Once\n\n\t// Instrumentation config\n\tStatsDHostAndPort string `json:\"stats_d_host_and_port\"`\n\tstats *stats.Collector\n\tstatsInitOnce sync.Once\n\n\t// Rate Limiter config\n\tRateLimiterMaxConcurrent int `json:\"rate_limiter_max_concurrent\"`\n}\n\nfunc (c *Config) Logger() *logging.Logger {\n\tc.loggerInitOnce.Do(func() {\n\t\t// use log level to create new logger\n\t\tc.logger = &logging.Logger{\n\t\t\tLevel: c.LogLevel,\n\t\t}\n\t})\n\n\treturn c.logger\n}\n\nfunc (c *Config) Stats() *stats.Collector {\n\tc.statsInitOnce.Do(func() {\n\t\tc.stats = &stats.Collector{\n\t\t\tHostAndPort: c.StatsDHostAndPort,\n\t\t}\n\t})\n\n\treturn c.stats\n}\n" }, { "path": "ch08/02_advantages/logging/logger.go", "content": "package logging\n\n// Logger logs stuff\ntype Logger struct {\n\tLevel int\n}\n\n// Error outputs a log at level ERROR\nfunc (l *Logger) Error(message string, args ...interface{}) {\n\t// TODO: implement\n}\n\n// Warn outputs a log at level ERROR\nfunc (l *Logger) Warn(message string, args ...interface{}) {\n\t// TODO: implement\n}\n\n// Info outputs a log at level ERROR\nfunc (l *Logger) Info(message string, args ...interface{}) {\n\t// TODO: implement\n}\n\n// Debug outputs a log at level ERROR\nfunc (l *Logger) Debug(message string, args ...interface{}) {\n\t// TODO: implement\n}\n" }, { "path": "ch08/02_advantages/stats/stats.go", "content": "package stats\n\nimport (\n\t\"time\"\n)\n\n// Collector collects and forwards stats\ntype Collector struct {\n\tHostAndPort string\n}\n\n// Count will record an event\nfunc (c *Collector) Count(key string, value int) {\n\t// TODO: implement\n}\n\n// Count will record the duration of an event\nfunc (c *Collector) Duration(key string, start time.Time) {\n\t// TODO: implement\n}\n" }, { "path": "ch08/03_applying/01_define_register_config.go", "content": "// +build do-not-build\n\npackage applying\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n)\n\n// Config is the configuration for the Registerer\ntype Config interface {\n\tLogger() *logging.LoggerStdOut\n\tBasePrice() float64\n}\n" }, { "path": "ch08/03_applying/02_register_with_config_injection.go", "content": "// +build do-not-build\n\npackage applying\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/exchange\"\n)\n\n// NewRegisterer creates and initializes a Registerer\nfunc NewRegisterer(cfg Config) *Registerer {\n\treturn &Registerer{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the configuration for the Registerer\ntype Config interface {\n\tLogger() logging.Logger\n\tRegistrationBasePrice() float64\n}\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n\tcfg Config\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(ctx context.Context, currency string) (float64, error) {\n\tconverter := &exchange.Converter{}\n\tprice, err := converter.Do(ctx, r.cfg.RegistrationBasePrice(), currency)\n\tif err != nil {\n\t\tr.logger().Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\nfunc (r *Registerer) logger() logging.Logger {\n\treturn r.cfg.Logger()\n}\n" }, { "path": "ch08/03_applying/03_model_before_data_changes.go", "content": "// +build do-not-build\n\npackage applying\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n)\n\n// GetterConfig is the configuration for Getter\ntype GetterConfig interface {\n\tLogger() logging.Logger\n}\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n\tcfg GetterConfig\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\t// load person from the data layer\n\tperson, err := loader(context.TODO(), ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are hiding the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn person, err\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.Load\n" }, { "path": "ch08/03_applying/04_test_config_link_to_config_package.go", "content": "// +build do-not-build\n\npackage applying\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n)\n\ntype testConfig struct{}\n\n// Logger implement Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// RegistrationBasePrice implement Config\nfunc (t *testConfig) RegistrationBasePrice() float64 {\n\treturn 12.34\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n\n// ExchangeBaseURL implements Config\nfunc (t *testConfig) ExchangeBaseURL() string {\n\treturn config.App.ExchangeRateBaseURL\n}\n\n// ExchangeAPIKey implements Config\nfunc (t *testConfig) ExchangeAPIKey() string {\n\treturn config.App.ExchangeRateAPIKey\n}\n" }, { "path": "ch08/03_applying/05_result_payload.json", "content": "{\n \"success\":true,\n \"historical\":true,\n \"date\":\"2010-11-09\",\n \"timestamp\":1289347199,\n \"source\":\"USD\",\n \"quotes\":{\n \"USDAUD\":0.989981\n }\n}" }, { "path": "ch08/03_applying/06_simple_test_server.go", "content": "// +build do-not-build\n\npackage applying\n\nimport (\n\t\"net/http\"\n)\n\ntype happyExchangeRateService struct{}\n\n// ServeHTTP implements http.Handler\nfunc (*happyExchangeRateService) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\tpayload := []byte(`\n{\n \"success\":true,\n \"historical\":true,\n \"date\":\"2010-11-09\",\n \"timestamp\":1289347199,\n \"source\":\"USD\",\n \"quotes\":{\n \"USDAUD\":0.989981\n }\n}`)\n\tresponse.Write(payload)\n}\n" }, { "path": "ch08/04_disadvantages/01_leaking_details.go", "content": "package disadvantages\n\nimport (\n\t\"errors\"\n\t\"strings\"\n)\n\ntype PeopleFilterConfig interface {\n\tDSN() string\n}\n\nfunc PeopleFilter(cfg PeopleFilterConfig, filter string) ([]Person, error) {\n\t// load people\n\tloader := &PersonLoader{}\n\tpeople, err := loader.LoadAll(cfg)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// filter people\n\tout := []Person{}\n\tfor _, person := range people {\n\t\tif strings.Contains(person.Name, filter) {\n\t\t\tout = append(out, person)\n\t\t}\n\t}\n\n\treturn out, nil\n}\n\ntype PersonLoaderConfig interface {\n\tDSN() string\n}\n\ntype PersonLoader struct{}\n\nfunc (p *PersonLoader) LoadAll(cfg PersonLoaderConfig) ([]Person, error) {\n\treturn nil, errors.New(\"not implemented\")\n}\n\n// Some data\ntype Person struct {\n\tName string\n}\n" }, { "path": "ch08/04_disadvantages/02_hiding_details.go", "content": "package disadvantages\n\nimport (\n\t\"strings\"\n)\n\ntype Loader interface {\n\tLoadAll() ([]Person, error)\n}\n\nfunc PeopleFilterV2(loader Loader, filter string) ([]Person, error) {\n\t// load people\n\tpeople, err := loader.LoadAll()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// filter people\n\tout := []Person{}\n\tfor _, person := range people {\n\t\tif strings.Contains(person.Name, filter) {\n\t\t\tout = append(out, person)\n\t\t}\n\t}\n\n\treturn out, nil\n}\n" }, { "path": "ch08/04_disadvantages/03_unclear_lifecycle.go", "content": "package disadvantages\n\nimport (\n\t\"errors\"\n\t\"time\"\n)\n\nfunc DoJob(pool WorkerPool, job Job) error {\n\t// wait for pool\n\tready := pool.IsReady()\n\n\tselect {\n\tcase <-ready:\n\t\t// happy path\n\n\tcase <-time.After(1 * time.Second):\n\t\treturn errors.New(\"timeout waiting for worker pool\")\n\t}\n\n\tworker := pool.GetWorker()\n\treturn worker.Do(job)\n}\n\n// Pool of workers\ntype WorkerPool interface {\n\tGetWorker() Worker\n\tIsReady() chan struct{}\n}\n\n// Executes/processes a unit of work and returns\ntype Worker interface {\n\tDo(job Job) error\n}\n\n// A unit of work to be executed against the pool\ntype Job interface {\n\t// implementation omitted\n}\n" }, { "path": "ch08/04_disadvantages/04_clear_lifecycle.go", "content": "package disadvantages\n\nfunc DoJobUpdated(pool WorkerPool, job Job) error {\n\tworker := pool.GetWorker()\n\treturn worker.Do(job)\n}\n" }, { "path": "ch08/04_disadvantages/05_layers.go", "content": "package disadvantages\n\nfunc NewLayer1Object(config Layer1Config) *Layer1Object {\n\treturn &Layer1Object{\n\t\tMyConfig: config,\n\t\tMyDependency: NewLayer2Object(config),\n\t}\n}\n\n// Configuration for the Layer 1 Object\ntype Layer1Config interface {\n\tLogger() Logger\n}\n\n// Layer 1 Object\ntype Layer1Object struct {\n\tMyConfig Layer1Config\n\tMyDependency *Layer2Object\n}\n\n// Configuration for the Layer 2 Object\ntype Layer2Config interface {\n\tLogger() Logger\n}\n\n// Layer 2 Object\ntype Layer2Object struct {\n\tMyConfig Layer2Config\n}\n\nfunc NewLayer2Object(config Layer2Config) *Layer2Object {\n\treturn &Layer2Object{\n\t\tMyConfig: config,\n\t}\n}\n\n// Stub implementation to make the compiler happy\ntype Logger interface {\n}\n" }, { "path": "ch08/acme/internal/config/config.go", "content": "package config\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// App is the application config\nvar App *Config\n\n// Config defines the JSON format for the config file\ntype Config struct {\n\t// DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n\tDSN string\n\n\t// Address is the IP address and port to bind this rest to\n\tAddress string\n\n\t// BasePrice is the price of registration\n\tBasePrice float64\n\n\t// ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n\tExchangeRateBaseURL string\n\n\t// ExchangeRateAPIKey is the API for the exchange rate API\n\tExchangeRateAPIKey string\n\n\t// environmental dependencies\n\tlogger logging.Logger\n}\n\n// Logger returns a reference to the singleton logger\nfunc (c *Config) Logger() logging.Logger {\n\tif c.logger == nil {\n\t\tc.logger = &logging.LoggerStdOut{}\n\t}\n\n\treturn c.logger\n}\n\n// RegistrationBasePrice returns the base price for registrations\nfunc (c *Config) RegistrationBasePrice() float64 {\n\treturn c.BasePrice\n}\n\n// DataDSN returns the DSN\nfunc (c *Config) DataDSN() string {\n\treturn c.DSN\n}\n\n// ExchangeBaseURL returns the Base URL from which we can load exchange rates\nfunc (c *Config) ExchangeBaseURL() string {\n\treturn c.ExchangeRateBaseURL\n}\n\n// ExchangeAPIKey returns the DSN\nfunc (c *Config) ExchangeAPIKey() string {\n\treturn c.ExchangeRateAPIKey\n}\n\n// BindAddress returns the host and port this service should bind to\nfunc (c *Config) BindAddress() string {\n\treturn c.Address\n}\n\n// Load returns the config loaded from environment\nfunc init() {\n\tfilename, found := os.LookupEnv(DefaultEnvVar)\n\tif !found {\n\t\tlogging.L.Error(\"failed to locate file specified by %s\", DefaultEnvVar)\n\t\treturn\n\t}\n\n\t_ = load(filename)\n}\n\nfunc load(filename string) error {\n\tApp = &Config{}\n\tbytes, err := ioutil.ReadFile(filename)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to read config file. err: %s\", err)\n\t\treturn err\n\t}\n\n\terr = json.Unmarshal(bytes, App)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to parse config file. err : %s\", err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n" }, { "path": "ch08/acme/internal/config/config_test.go", "content": "package config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoad(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin string\n\t\texpectedConfig *Config\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tin: \"../../../../default-config.json\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tDSN: \"[insert your db config here]\",\n\t\t\t\tAddress: \"0.0.0.0:8080\",\n\t\t\t\tBasePrice: 100.00,\n\t\t\t\tExchangeRateBaseURL: \"http://apilayer.net\",\n\t\t\t\tExchangeRateAPIKey: \"[insert your API key here]\",\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"invalid path\",\n\t\t\tin: \"invalid.json\",\n\t\t\texpectedConfig: &Config{},\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\tresultErr := load(scenario.in)\n\t\t\trequire.Equal(t, scenario.expectError, resultErr != nil, \"err: %s\", resultErr)\n\t\t\tassert.Equal(t, scenario.expectedConfig, App, scenario.desc)\n\t\t})\n\t}\n\n}\n" }, { "path": "ch08/acme/internal/logging/logging.go", "content": "package logging\n\nimport (\n\t\"fmt\"\n)\n\n// Logger is our standard interface\ntype Logger interface {\n\tDebug(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tError(message string, args ...interface{})\n}\n\n// L is the global instance of the logger\nvar L = &LoggerStdOut{}\n\n// LoggerStdOut logs to std out\ntype LoggerStdOut struct{}\n\n// Debug logs messages at DEBUG level\nfunc (l LoggerStdOut) Debug(message string, args ...interface{}) {\n\tfmt.Printf(\"[DEBUG] \"+message, args...)\n}\n\n// Info logs messages at INFO level\nfunc (l LoggerStdOut) Info(message string, args ...interface{}) {\n\tfmt.Printf(\"[INFO] \"+message, args...)\n}\n\n// Warn logs messages at WARN level\nfunc (l LoggerStdOut) Warn(message string, args ...interface{}) {\n\tfmt.Printf(\"[WARN] \"+message, args...)\n}\n\n// Error logs messages at ERROR level\nfunc (l LoggerStdOut) Error(message string, args ...interface{}) {\n\tfmt.Printf(\"[ERROR] \"+message, args...)\n}\n" }, { "path": "ch08/acme/internal/modules/data/data.go", "content": "package data\n\nimport (\n\t// import the MySQL Driver\n\t\"context\"\n\t\"database/sql\"\n\t\"errors\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tsqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\n// Config is the configuration for the data package\ntype Config interface {\n\t// Logger returns a reference to the logger\n\tLogger() logging.Logger\n\n\t// DataDSN returns the data source name\n\tDataDSN() string\n}\n\nvar getDB = func(cfg Config) (*sql.DB, error) {\n\tif db == nil {\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", cfg.DataDSN())\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc Save(ctx context.Context, cfg Config, in *Person) (int, error) {\n\tdb, err := getDB(cfg)\n\tif err != nil {\n\t\tcfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB insert\n\tresult, err := db.ExecContext(subCtx, sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\tcfg.Logger().Error(\"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\tcfg.Logger().Error(\"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn int(id), nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc LoadAll(ctx context.Context, cfg Config) ([]*Person, error) {\n\tdb, err := getDB(cfg)\n\tif err != nil {\n\t\tcfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trows, err := db.QueryContext(subCtx, sqlLoadAll)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\tcfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\tcfg.Logger().Warn(\"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc Load(ctx context.Context, cfg Config, ID int) (*Person, error) {\n\tdb, err := getDB(cfg)\n\tif err != nil {\n\t\tcfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trow := db.QueryRowContext(subCtx, sqlLoadByID, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\tcfg.Logger().Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\tcfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n" }, { "path": "ch08/acme/internal/modules/data/data_test.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(ctx, &testConfig{}, in)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_insertError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnError(errors.New(\"failed to insert\"))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(ctx, &testConfig{}, in)\n\n\t// validate result\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_getDBError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patching starts here\n\tdefer func(original func(_ Config) (*sql.DB, error)) {\n\t\t// restore original DB (after test)\n\t\tgetDB = original\n\t}(getDB)\n\n\t// replace getDB() function for this test\n\tgetDB = func(_ Config) (*sql.DB, error) {\n\t\treturn nil, errors.New(\"getDB() failed\")\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tresultID, err := Save(ctx, &testConfig{}, in)\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n}\n\nfunc TestLoadAll_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResults []*Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(1, \"John\", \"0123456789\", \"AUD\", 12.34))\n\t\t\t},\n\t\t\texpectedResults: []*Person{\n\t\t\t\t{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"AUD\",\n\t\t\t\t\tPrice: 12.34,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResults: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey patch the db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tresults, err := LoadAll(ctx, &testConfig{})\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResults, results, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\nfunc TestLoad_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResult *Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\t\t\t},\n\t\t\texpectedResult: &Person{\n\t\t\t\tID: 2,\n\t\t\t\tFullName: \"Paul\",\n\t\t\t\tPhone: \"0123456789\",\n\t\t\t\tCurrency: \"CAD\",\n\t\t\t\tPrice: 23.45,\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResult: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tresult, err := Load(ctx, &testConfig{}, 2)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResult, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n\ntype testConfig struct{}\n\n// Logger implements Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn logging.LoggerStdOut{}\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n" }, { "path": "ch08/acme/internal/modules/exchange/converter.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// NewConverter creates and initializes the converter\nfunc NewConverter(cfg Config) *Converter {\n\treturn &Converter{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the config for Converter\ntype Config interface {\n\tLogger() logging.Logger\n\tExchangeBaseURL() string\n\tExchangeAPIKey() string\n}\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct {\n\tcfg Config\n}\n\n// Exchange will perform the conversion\nfunc (c *Converter) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(ctx, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(ctx context.Context, currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tc.cfg.ExchangeBaseURL(),\n\t\tc.cfg.ExchangeAPIKey(),\n\t\tcurrency)\n\n\t// perform request\n\treq, err := http.NewRequest(\"GET\", url, nil)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to create request. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the upstream call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// replace the default context with our custom one\n\treq = req.WithContext(subCtx)\n\n\t// perform the HTTP request\n\tresponse, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tc.logger().Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tc.logger().Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\nfunc (c *Converter) logger() logging.Logger {\n\treturn c.cfg.Logger()\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n" }, { "path": "ch08/acme/internal/modules/exchange/converter_ext_bounday_test.go", "content": "// +build external\n\npackage exchange\n\nimport (\n\t\"context\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/config\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestExternalBoundaryTest(t *testing.T) {\n\t// define the config\n\tcfg := &testConfig{\n\t\tbaseURL: config.App.ExchangeRateBaseURL,\n\t\tapiKey: config.App.ExchangeRateAPIKey,\n\t}\n\n\t// create a converter to test\n\tconverter := NewConverter(cfg)\n\n\t// fetch from the server\n\tresponse, err := converter.loadRateFromServer(context.Background(), \"AUD\")\n\trequire.NotNil(t, response)\n\trequire.NoError(t, err)\n\n\t// parse the response\n\tresultRate, err := converter.extractRate(response, \"AUD\")\n\trequire.NoError(t, err)\n\n\t// validate the result\n\tassert.True(t, resultRate > 0)\n}\n" }, { "path": "ch08/acme/internal/modules/exchange/converter_int_bounday_test.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestInternalBoundaryTest(t *testing.T) {\n\t// start our test server\n\tserver := httptest.NewServer(&happyExchangeRateService{})\n\tdefer server.Close()\n\n\t// define the config\n\tcfg := &testConfig{\n\t\tbaseURL: server.URL,\n\t\tapiKey: \"\",\n\t}\n\n\t// create a converter to test\n\tconverter := NewConverter(cfg)\n\tresultRate, resultErr := converter.Exchange(context.Background(), 100.00, \"AUD\")\n\n\t// validate the result\n\tassert.Equal(t, 101.01, resultRate)\n\tassert.NoError(t, resultErr)\n}\n\ntype happyExchangeRateService struct{}\n\n// ServeHTTP implements http.Handler\nfunc (*happyExchangeRateService) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\tpayload := []byte(`\n{\n \"success\":true,\n \"historical\":true,\n \"date\":\"2010-11-09\",\n \"timestamp\":1289347199,\n \"source\":\"USD\",\n \"quotes\":{\n \"USDAUD\":0.989981\n }\n}`)\n\tresponse.Write(payload)\n}\n\n// test implementation of Config\ntype testConfig struct {\n\tbaseURL string\n\tapiKey string\n}\n\n// Logger implements Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// ExchangeBaseURL implements Config\nfunc (t *testConfig) ExchangeBaseURL() string {\n\treturn t.baseURL\n}\n\n// ExchangeAPIKey implements Config\nfunc (t *testConfig) ExchangeAPIKey() string {\n\treturn t.apiKey\n}\n" }, { "path": "ch08/acme/internal/modules/get/get.go", "content": "package get\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when the requested person is not in the database\n\terrPersonNotFound = errors.New(\"person not found\")\n)\n\n// NewGetter creates and initializes a Getter\nfunc NewGetter(cfg Config) *Getter {\n\treturn &Getter{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the configuration for Getter\ntype Config interface {\n\tLogger() logging.Logger\n\tDataDSN() string\n}\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n\tcfg Config\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\t// load person from the data layer\n\tperson, err := loader(context.TODO(), g.cfg, ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are hiding the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn person, err\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.Load\n" }, { "path": "ch08/acme/internal/modules/get/go_test.go", "content": "package get\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetter_Do_happyPath(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, _ data.Config, _ int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, _ data.Config, _ int) (*data.Person, error) {\n\t\tresult := &data.Person{\n\t\t\tID: 1234,\n\t\t\tFullName: \"Doug\",\n\t\t}\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, ID, person.ID)\n\tassert.Equal(t, \"Doug\", person.FullName)\n}\n\nfunc TestGetter_Do_noSuchPerson(t *testing.T) {\n\t// inputs\n\tID := 5678\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, _ data.Config, _ int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, _ data.Config, _ int) (*data.Person, error) {\n\t\tvar result *data.Person\n\t\tresultErr := data.ErrNotFound\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Equal(t, errPersonNotFound, err)\n\tassert.Nil(t, person)\n}\n\nfunc TestGetter_Do_error(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, _ data.Config, _ int) (*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, _ data.Config, _ int) (*data.Person, error) {\n\t\tvar result *data.Person\n\t\tresultErr := errors.New(\"failed to load person\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tgetter := &Getter{}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Nil(t, person)\n}\n" }, { "path": "ch08/acme/internal/modules/list/list.go", "content": "package list\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when there are no people in the database\n\terrPeopleNotFound = errors.New(\"no people found\")\n)\n\n// NewLister creates and initializes a Lister\nfunc NewLister(cfg Config) *Lister {\n\treturn &Lister{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the config for Lister\ntype Config interface {\n\tLogger() logging.Logger\n\tDataDSN() string\n}\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n\tcfg Config\n}\n\n// Exchange will load the people from the data layer\nfunc (l *Lister) Do() ([]*data.Person, error) {\n\t// load all people\n\tpeople, err := l.load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(people) == 0 {\n\t\t// special processing for 0 people returned\n\t\treturn nil, errPeopleNotFound\n\t}\n\n\treturn people, nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n\tpeople, err := loader(context.TODO(), l.cfg)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPeopleNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn people, nil\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar loader = data.LoadAll\n" }, { "path": "ch08/acme/internal/modules/list/list_test.go", "content": "package list\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLister_Do_happyPath(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, _ data.Config) ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, _ data.Config) ([]*data.Person, error) {\n\t\tresult := []*data.Person{\n\t\t\t{\n\t\t\t\tID: 1234,\n\t\t\t\tFullName: \"Sally\",\n\t\t\t},\n\t\t\t{\n\t\t\t\tID: 5678,\n\t\t\t\tFullName: \"Jane\",\n\t\t\t},\n\t\t}\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, len(persons))\n}\n\nfunc TestLister_Do_noResults(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, _ data.Config) ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, _ data.Config) ([]*data.Person, error) {\n\t\tvar result []*data.Person\n\t\tresultErr := data.ErrNotFound\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Equal(t, errPeopleNotFound, err)\n\tassert.Equal(t, 0, len(persons))\n}\n\nfunc TestLister_Do_error(t *testing.T) {\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, _ data.Config) ([]*data.Person, error)) {\n\t\t// restore original\n\t\tloader = original\n\t}(loader)\n\n\t// replace method\n\tloader = func(_ context.Context, _ data.Config) ([]*data.Person, error) {\n\t\tvar result []*data.Person\n\t\tresultErr := errors.New(\"failed to load people\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// call method\n\tlister := &Lister{}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, len(persons))\n}\n" }, { "path": "ch08/acme/internal/modules/register/register.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\t// validation errors\n\terrNameMissing = errors.New(\"name is missing\")\n\terrPhoneMissing = errors.New(\"phone is missing\")\n\terrCurrencyMissing = errors.New(\"currency is missing\")\n\terrInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n\t// a little trick to make checking for supported currencies easier\n\tsupportedCurrencies = map[string]struct{}{\n\t\t\"AUD\": {},\n\t\t\"CNY\": {},\n\t\t\"EUR\": {},\n\t\t\"GBP\": {},\n\t\t\"JPY\": {},\n\t\t\"MYR\": {},\n\t\t\"SGD\": {},\n\t\t\"USD\": {},\n\t}\n)\n\n// NewRegisterer creates and initializes a Registerer\nfunc NewRegisterer(cfg Config, exchanger Exchanger) *Registerer {\n\treturn &Registerer{\n\t\tcfg: cfg,\n\t\texchanger: exchanger,\n\t}\n}\n\n// Exchanger will convert from one currency to another\ntype Exchanger interface {\n\t// Exchange will perform the conversion\n\tExchange(ctx context.Context, basePrice float64, currency string) (float64, error)\n}\n\n// Config is the configuration for the Registerer\ntype Config interface {\n\tLogger() logging.Logger\n\tRegistrationBasePrice() float64\n\tDataDSN() string\n}\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n\tcfg Config\n\texchanger Exchanger\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(ctx context.Context, in *data.Person) (int, error) {\n\t// validate the request\n\terr := r.validateInput(in)\n\tif err != nil {\n\t\tr.logger().Warn(\"input validation failed with err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// get price in the requested currency\n\tprice, err := r.getPrice(ctx, in.Currency)\n\tif err != nil {\n\t\treturn defaultPersonID, err\n\t}\n\n\t// save registration\n\tid, err := r.save(ctx, in, price)\n\tif err != nil {\n\t\t// no need to log here as we expect the data layer to do so\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *data.Person) error {\n\tif in.FullName == \"\" {\n\t\treturn errNameMissing\n\t}\n\tif in.Phone == \"\" {\n\t\treturn errPhoneMissing\n\t}\n\tif in.Currency == \"\" {\n\t\treturn errCurrencyMissing\n\t}\n\n\tif _, found := supportedCurrencies[in.Currency]; !found {\n\t\treturn errInvalidCurrency\n\t}\n\n\t// happy path\n\treturn nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(ctx context.Context, currency string) (float64, error) {\n\tprice, err := r.exchanger.Exchange(ctx, r.cfg.RegistrationBasePrice(), currency)\n\tif err != nil {\n\t\tr.logger().Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(ctx context.Context, in *data.Person, price float64) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tCurrency: in.Currency,\n\t\tPrice: price,\n\t}\n\treturn saver(ctx, r.cfg, person)\n}\n\nfunc (r *Registerer) logger() logging.Logger {\n\treturn r.cfg.Logger()\n}\n\n// this function as a variable allows us to Monkey Patch during testing\nvar saver = data.Save\n" }, { "path": "ch08/acme/internal/modules/register/register_test.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterer_Do_happyPath(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, _ data.Config, _ *data.Person) (int, error)) {\n\t\t// restore original\n\t\tsaver = original\n\t}(saver)\n\n\t// replace method\n\tsaver = func(_ context.Context, _ data.Config, _ *data.Person) (int, error) {\n\t\tresult := 888\n\t\tvar resultErr error\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: &stubExchanger{},\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 888, ID)\n}\n\nfunc TestRegisterer_Do_error(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patch calls to the data package\n\tdefer func(original func(_ context.Context, _ data.Config, _ *data.Person) (int, error)) {\n\t\t// restore original\n\t\tsaver = original\n\t}(saver)\n\n\t// replace method\n\tsaver = func(_ context.Context, _ data.Config, _ *data.Person) (int, error) {\n\t\tvar result int\n\t\tresultErr := errors.New(\"failed to save\")\n\n\t\treturn result, resultErr\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: &stubExchanger{},\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, ID)\n}\n\n// Stub implementation of Config\ntype testConfig struct{}\n\n// Logger implement Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// RegistrationBasePrice implement Config\nfunc (t *testConfig) RegistrationBasePrice() float64 {\n\treturn 12.34\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n\ntype stubExchanger struct{}\n\n// Exchange implements Exchanger\nfunc (s stubExchanger) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\treturn 12.34, nil\n}\n" }, { "path": "ch08/acme/internal/rest/get.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// key in the mux where the ID is stored\n\tmuxVarID = \"id\"\n)\n\n// GetModel will load a registration\n//go:generate mockery -name=GetModel -case underscore -testonly -inpkg -note @generated\ntype GetModel interface {\n\tDo(ID int) (*data.Person, error)\n}\n\n// GetConfig is the config for the Get Handler\ntype GetConfig interface {\n\tLogger() logging.Logger\n}\n\n// NewGetHandler is the constructor for GetHandler\nfunc NewGetHandler(cfg GetConfig, model GetModel) *GetHandler {\n\treturn &GetHandler{\n\t\tcfg: cfg,\n\t\tgetter: model,\n\t}\n}\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n\tcfg GetConfig\n\tgetter GetModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tperson, err := h.getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[muxVarID]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\th.cfg.Logger().Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\th.cfg.Logger().Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *data.Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n" }, { "path": "ch08/acme/internal/rest/get_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockGetModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\toutput := &data.Person{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"USD\",\n\t\t\t\t\tPrice: 100,\n\t\t\t\t}\n\n\t\t\t\tmockGetModel := &MockGetModel{}\n\t\t\t\tmockGetModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockGetModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\",\"currency\":\"USD\",\"price\":100}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is invalid)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/x/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"x\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is missing)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person//\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency fail\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"requested registration does not exist\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"person not found\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockGetModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewGetHandler(&testConfig{}, mockGetModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\t\t})\n\t}\n}\n\ntype testConfig struct {\n}\n\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\nfunc (*testConfig) BindAddress() string {\n\treturn \"0.0.0.0:0\"\n}\n" }, { "path": "ch08/acme/internal/rest/list.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n)\n\n// ListModel will load all registrations\n//go:generate mockery -name=ListModel -case underscore -testonly -inpkg -note @generated\ntype ListModel interface {\n\tDo() ([]*data.Person, error)\n}\n\n// NewLister is the constructor for ListHandler\nfunc NewListHandler(model ListModel) *ListHandler {\n\treturn &ListHandler{\n\t\tlister: model,\n\t}\n}\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n\tlister ListModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// attempt loadAll\n\tpeople, err := h.lister.Do()\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, people)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*data.Person) error {\n\toutput := &listResponseFormat{\n\t\tPeople: make([]*listResponseItemFormat, len(people)),\n\t}\n\n\tfor index, record := range people {\n\t\toutput.People[index] = &listResponseItemFormat{\n\t\t\tID: record.ID,\n\t\t\tFullName: record.FullName,\n\t\t\tPhone: record.Phone,\n\t\t}\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n\tPeople []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n}\n" }, { "path": "ch08/acme/internal/rest/list_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestListHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockListModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\toutput := []*data.Person{\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 2,\n\t\t\t\t\t\tFullName: \"Paul\",\n\t\t\t\t\t\tPhone: \"0123456781\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 3,\n\t\t\t\t\t\tFullName: \"George\",\n\t\t\t\t\t\tPhone: \"0123456782\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"Ringo\",\n\t\t\t\t\t\tPhone: \"0123456783\",\n\t\t\t\t\t},\n\t\t\t\t}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\"},{\"id\":2,\"name\":\"Paul\",\"phone\":\"0123456781\"},{\"id\":3,\"name\":\"George\",\"phone\":\"0123456782\"},{\"id\":1,\"name\":\"Ringo\",\"phone\":\"0123456783\"}]}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"no data\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\t// no data\n\t\t\t\toutput := []*data.Person{}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[]}` + \"\\n\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockListModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewListHandler(mockListModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\n\t\t})\n\t}\n}\n" }, { "path": "ch08/acme/internal/rest/mock_get_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockGetModel is an autogenerated mock type for the GetModel type\ntype MockGetModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ID\nfunc (_m *MockGetModel) Do(ID int) (*data.Person, error) {\n\tret := _m.Called(ID)\n\n\tvar r0 *data.Person\n\tif rf, ok := ret.Get(0).(func(int) *data.Person); ok {\n\t\tr0 = rf(ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(int) error); ok {\n\t\tr1 = rf(ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch08/acme/internal/rest/mock_list_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockListModel is an autogenerated mock type for the ListModel type\ntype MockListModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields:\nfunc (_m *MockListModel) Do() ([]*data.Person, error) {\n\tret := _m.Called()\n\n\tvar r0 []*data.Person\n\tif rf, ok := ret.Get(0).(func() []*data.Person); ok {\n\t\tr0 = rf()\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func() error); ok {\n\t\tr1 = rf()\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch08/acme/internal/rest/mock_register_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockRegisterModel is an autogenerated mock type for the RegisterModel type\ntype MockRegisterModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ctx, in\nfunc (_m *MockRegisterModel) Do(ctx context.Context, in *data.Person) (int, error) {\n\tret := _m.Called(ctx, in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(context.Context, *data.Person) int); ok {\n\t\tr0 = rf(ctx, in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, *data.Person) error); ok {\n\t\tr1 = rf(ctx, in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch08/acme/internal/rest/not_found.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n" }, { "path": "ch08/acme/internal/rest/not_found_test.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNotFoundHandler_ServeHTTP(t *testing.T) {\n\t// build inputs\n\tresponse := httptest.NewRecorder()\n\trequest := &http.Request{}\n\n\t// call handler\n\tnotFoundHandler(response, request)\n\n\t// validate outputs\n\trequire.Equal(t, http.StatusNotFound, response.Code)\n}\n" }, { "path": "ch08/acme/internal/rest/register.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/data\"\n)\n\n// RegisterModel will validate and save a registration\n//go:generate mockery -name=RegisterModel -case underscore -testonly -inpkg -note @generated\ntype RegisterModel interface {\n\tDo(ctx context.Context, in *data.Person) (int, error)\n}\n\n// NewRegisterHandler is the constructor for RegisterHandler\nfunc NewRegisterHandler(model RegisterModel) *RegisterHandler {\n\treturn &RegisterHandler{\n\t\tregisterer: model,\n\t}\n}\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n\tregisterer RegisterModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// set latency budget for this API\n\tsubCtx, cancel := context.WithTimeout(request.Context(), 1500*time.Millisecond)\n\tdefer cancel()\n\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// call the business logic using the request data and context\n\tid, err := h.register(subCtx, requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(ctx context.Context, requestPayload *registerRequest) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\treturn h.registerer.Do(ctx, person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch08/acme/internal/rest/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockRegisterModel\n\t\texpectedStatus int\n\t\texpectedHeader string\n\t}{\n\t\t{\n\t\t\tdesc: \"Happy Path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// valid downstream configuration\n\t\t\t\tresultID := 1234\n\t\t\t\tvar resultErr error\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(resultID, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusCreated,\n\t\t\texpectedHeader: \"/person/1234/\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Bad Input / User Error\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tinvalidRequest := bytes.NewBufferString(`this is not valid JSON`)\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", invalidRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// Dependency should not be called\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Dependency Failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// call to the dependency failed\n\t\t\t\tresultErr := errors.New(\"something failed\")\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(0, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockRegisterModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewRegisterHandler(mockRegisterModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code)\n\n\t\t\t// call should output the location to the new person\n\t\t\tresultHeader := response.Header().Get(\"Location\")\n\t\t\tassert.Equal(t, scenario.expectedHeader, resultHeader)\n\n\t\t\t// validate the mock was used as we expected\n\t\t\tassert.True(t, mockRegisterModel.AssertExpectations(t))\n\t\t})\n\t}\n}\n\nfunc buildValidRegisterRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch08/acme/internal/rest/server.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/logging\"\n\t\"github.com/gorilla/mux\"\n)\n\n// Config is the config for the REST package\ntype Config interface {\n\tLogger() logging.Logger\n\tBindAddress() string\n}\n\n// New will create and initialize the server\nfunc New(cfg Config,\n\tgetModel GetModel,\n\tlistModel ListModel,\n\tregisterModel RegisterModel) *Server {\n\n\treturn &Server{\n\t\taddress: cfg.BindAddress(),\n\t\thandlerGet: NewGetHandler(cfg, getModel),\n\t\thandlerList: NewListHandler(listModel),\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: NewRegisterHandler(registerModel),\n\t}\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n\taddress string\n\tserver *http.Server\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n\trouter := s.buildRouter()\n\n\t// create the HTTP server\n\ts.server = &http.Server{\n\t\tHandler: router,\n\t\tAddr: s.address,\n\t}\n\n\t// listen for shutdown\n\tgo func() {\n\t\t// wait for shutdown signal\n\t\t<-stop\n\n\t\t_ = s.server.Close()\n\t}()\n\n\t// start the HTTP server\n\t_ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n\trouter := mux.NewRouter()\n\n\t// map URL endpoints to HTTP handlers\n\trouter.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n\trouter.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n\trouter.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n\t// convert a \"catch all\" not found handler\n\trouter.NotFoundHandler = s.handlerNotFound\n\n\treturn router\n}\n" }, { "path": "ch08/acme/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/acme/internal/rest\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// build the exchanger\n\texchanger := exchange.NewConverter(config.App)\n\n\t// build model layer\n\tgetModel := get.NewGetter(config.App)\n\tlistModel := list.NewLister(config.App)\n\tregisterModel := register.NewRegisterer(config.App, exchanger)\n\n\t// start REST server\n\tserver := rest.New(config.App, getModel, listModel, registerModel)\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch08/fake.go", "content": "package ch08\n\nfunc init() {\n\t// This file is included so that Go tools (like `go list`) will find Go code in this directory and not error\n}\n" }, { "path": "ch09/01_jit_injection/01_injecting_db.go", "content": "package jit_injection\n\nfunc NewMyLoadPersonLogic(ds DataSource) *MyLoadPersonLogic {\n\treturn &MyLoadPersonLogic{\n\t\tdataSource: ds,\n\t}\n}\n\ntype MyLoadPersonLogic struct {\n\tdataSource DataSource\n}\n\n// Load person by supplied ID\nfunc (m *MyLoadPersonLogic) Load(ID int) (Person, error) {\n\treturn m.dataSource.Load(ID)\n}\n\ntype DataSource interface {\n\t// Load person by ID\n\tLoad(ID int) (Person, error)\n}\n\ntype Person struct {\n\tName string\n}\n" }, { "path": "ch09/01_jit_injection/01_injecting_db_test.go", "content": "package jit_injection\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestMyLoadPersonLogic(t *testing.T) {\n\t// setup the mock db\n\tmockDB := &mockDB{\n\t\tout: Person{Name: \"Fred\"},\n\t}\n\n\t// call the object we are testing\n\ttestObj := NewMyLoadPersonLogic(mockDB)\n\tresult, resultErr := testObj.Load(123)\n\n\t// validate expectations\n\tassert.Equal(t, Person{Name: \"Fred\"}, result)\n\tassert.Nil(t, resultErr)\n}\n\n// mock implementation of DataSource\ntype mockDB struct {\n\tout Person\n\toutErr error\n}\n\n// Load implements DataSource\nfunc (m *mockDB) Load(ID int) (Person, error) {\n\treturn m.out, m.outErr\n}\n" }, { "path": "ch09/01_jit_injection/02_injecting_business_logic.go", "content": "package jit_injection\n\nimport (\n\t\"errors\"\n\t\"net/http\"\n)\n\nfunc NewLoadPersonHandler(logic LoadPersonLogic) *LoadPersonHandler {\n\treturn &LoadPersonHandler{\n\t\tbusinessLogic: logic,\n\t}\n}\n\ntype LoadPersonHandler struct {\n\tbusinessLogic LoadPersonLogic\n}\n\nfunc (h *LoadPersonHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\trequestedID, err := h.extractInputFromRequest(request)\n\n\toutput, err := h.businessLogic.Load(requestedID)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\th.writeOutput(response, output)\n}\n\n// extract the person ID from the request\nfunc (h *LoadPersonHandler) extractInputFromRequest(request *http.Request) (int, error) {\n\treturn 0, errors.New(\"not implemented yet\")\n}\n\n// convert person to JSON and write to the HTTP response\nfunc (h *LoadPersonHandler) writeOutput(writer http.ResponseWriter, person Person) {\n\t// not implemented yet\n}\n\ntype LoadPersonLogic interface {\n\t// Load person by supplied ID\n\tLoad(ID int) (Person, error)\n}\n" }, { "path": "ch09/01_jit_injection/03_injecting_db_jit.go", "content": "package jit_injection\n\nimport (\n\t\"errors\"\n)\n\ntype MyLoadPersonLogicJIT struct {\n\tdataSource DataSourceJIT\n}\n\n// Load person by supplied ID\nfunc (m *MyLoadPersonLogicJIT) Load(ID int) (Person, error) {\n\treturn m.getDataSource().Load(ID)\n}\n\nfunc (m *MyLoadPersonLogicJIT) getDataSource() DataSourceJIT {\n\tif m.dataSource == nil {\n\t\tm.dataSource = NewMyDataSourceJIT()\n\t}\n\n\treturn m.dataSource\n}\n\ntype DataSourceJIT interface {\n\t// Load person by ID\n\tLoad(ID int) (Person, error)\n}\n\nfunc NewMyDataSourceJIT() *MyDataSourceJIT {\n\treturn &MyDataSourceJIT{}\n}\n\n// Default implementation of DataSourceJIT\ntype MyDataSourceJIT struct {\n}\n\nfunc (m *MyDataSourceJIT) Load(ID int) (Person, error) {\n\treturn Person{}, errors.New(\"not implemented yet\")\n}\n" }, { "path": "ch09/01_jit_injection/03_injecting_db_jit_test.go", "content": "package jit_injection\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestMyLoadPersonLogicJIT(t *testing.T) {\n\t// setup the mock db\n\tmockDB := &mockDB{\n\t\tout: Person{Name: \"Fred\"},\n\t}\n\n\t// call the object we are testing\n\ttestObj := MyLoadPersonLogicJIT{\n\t\tdataSource: mockDB,\n\t}\n\tresult, resultErr := testObj.Load(123)\n\n\t// validate expectations\n\tassert.Equal(t, Person{Name: \"Fred\"}, result)\n\tassert.Nil(t, resultErr)\n}\n" }, { "path": "ch09/01_jit_injection/04_noop_debugger.go", "content": "package jit_injection\n\nimport (\n\t\"errors\"\n)\n\ntype ObjectWithDebugger struct {\n\tDebugger Debugger\n}\n\nfunc (o *ObjectWithDebugger) DoSomethingAmazing(input int) error {\n\to.getDebugger().Log(\"input was: %d\", input)\n\n\terr := o.doSomething()\n\n\to.getDebugger().Log(\"result was: %v\", err)\n\treturn err\n}\n\nfunc (o *ObjectWithDebugger) getDebugger() Debugger {\n\tif o.Debugger == nil {\n\t\to.Debugger = &noopDebugger{}\n\t}\n\n\treturn o.Debugger\n}\n\nfunc (o *ObjectWithDebugger) doSomething() error {\n\treturn errors.New(\"not implemented yet\")\n}\n\ntype Debugger interface {\n\tLog(msg string, args ...interface{})\n}\n\n// NO-OP implementation of the Debugger interface\ntype noopDebugger struct {\n\t// intentionally left blank\n}\n\n// Log implements Debugger\nfunc (n *noopDebugger) Log(_ string, args ...interface{}) {\n\t// intentionally does nothing\n}\n" }, { "path": "ch09/02_advantages/01_long_constructor.go", "content": "package advantages\n\nimport (\n\t\"io\"\n)\n\nfunc NewGenerator(storage Storage, renderer Renderer, template io.Reader) *Generator {\n\treturn &Generator{\n\t\tstorage: storage,\n\t\trenderer: renderer,\n\t\ttemplate: template,\n\t}\n}\n\ntype Generator struct {\n\tstorage Storage\n\trenderer Renderer\n\ttemplate io.Reader\n}\n\nfunc (g *Generator) Generate(destination io.Writer, params ...interface{}) {\n\n}\n\ntype Storage interface {\n\tLoad() []interface{}\n}\n\ntype Renderer interface {\n\tRender(template io.Reader, params ...interface{}) []byte\n}\n" }, { "path": "ch09/02_advantages/02_short_constructor.go", "content": "package advantages\n\nimport (\n\t\"io\"\n)\n\nfunc NewGeneratorV2(template io.Reader) *Generator {\n\treturn &Generator{\n\t\ttemplate: template,\n\t}\n}\n\nfunc (g *Generator) getStorage() Storage {\n\tif g.storage == nil {\n\t\tg.storage = &DefaultStorage{}\n\t}\n\treturn g.storage\n}\n\nfunc (g *Generator) getRenderer() Renderer {\n\tif g.renderer == nil {\n\t\tg.renderer = &DefaultRenderer{}\n\t}\n\treturn g.renderer\n}\n\n// Default implementation of Storage\ntype DefaultStorage struct{}\n\n// Load implements Storage\nfunc (d *DefaultStorage) Load() []interface{} {\n\treturn nil\n}\n\n// Default implementation of Storage\ntype DefaultRenderer struct{}\n\n// Load implements Renderer\nfunc (d *DefaultRenderer) Render(template io.Reader, params ...interface{}) []byte {\n\treturn nil\n}\n" }, { "path": "ch09/02_advantages/03_optional_dep_without_jitdi.go", "content": "package advantages\n\nfunc NewLoaderWithoutJIT(ds Datastore) *LoaderWithoutJIT {\n\treturn &LoaderWithoutJIT{\n\t\tdatastore: ds,\n\t}\n}\n\ntype LoaderWithoutJIT struct {\n\t// required private dependency\n\tdatastore Datastore\n\n\t// optional cache\n\tOptionalCache Cache\n}\n\nfunc (l *LoaderWithoutJIT) Load(ID int) (*Animal, error) {\n\tvar output *Animal\n\tvar err error\n\n\t// attempt to load from cache\n\tif l.OptionalCache != nil {\n\t\toutput = l.OptionalCache.Get(ID)\n\t\tif output != nil {\n\t\t\t// return cached value\n\t\t\treturn output, nil\n\t\t}\n\t}\n\n\t// load from data store\n\toutput, err = l.datastore.Load(ID)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// cache the loaded value\n\tif l.OptionalCache != nil {\n\t\tl.OptionalCache.Put(ID, output)\n\t}\n\n\t// output the result\n\treturn output, nil\n}\n\ntype Cache interface {\n\tGet(ID int) *Animal\n\tPut(ID int, value *Animal)\n}\n\ntype Datastore interface {\n\tLoad(ID int) (*Animal, error)\n\tSave(ID int, value *Animal) error\n}\n\ntype Animal struct {\n\t// some data fields go here\n}\n" }, { "path": "ch09/02_advantages/04_optional_dep_with_jitdi.go", "content": "package advantages\n\nfunc NewLoaderWithJIT(ds Datastore) *LoaderWithJIT {\n\treturn &LoaderWithJIT{\n\t\tdatastore: ds,\n\t}\n}\n\ntype LoaderWithJIT struct {\n\t// required private dependency\n\tdatastore Datastore\n\n\t// optional cache\n\tOptionalCache Cache\n}\n\nfunc (l *LoaderWithJIT) Load(ID int) (*Animal, error) {\n\t// attempt to load from cache\n\toutput := l.cache().Get(ID)\n\tif output != nil {\n\t\t// return cached value\n\t\treturn output, nil\n\t}\n\n\t// load from data store\n\toutput, err := l.datastore.Load(ID)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// cache the loaded value\n\tl.cache().Put(ID, output)\n\n\t// output the result\n\treturn output, nil\n}\n\nfunc (l *LoaderWithJIT) cache() Cache {\n\tif l.OptionalCache == nil {\n\t\tl.OptionalCache = &noopCache{}\n\t}\n\n\treturn l.OptionalCache\n}\n\n// NO-OP implementation of the cache\ntype noopCache struct {\n\t// intentionally blank\n}\n\nfunc (n *noopCache) Get(ID int) *Animal {\n\t// intentionally does nothing\n\treturn nil\n}\n\nfunc (n *noopCache) Put(ID int, value *Animal) {\n\t// intentionally does nothing\n}\n" }, { "path": "ch09/02_advantages/05_loader.go", "content": "package advantages\n\nimport (\n\t\"errors\"\n)\n\nfunc NewLoader(ds Datastore, cache Cache) *MyLoader {\n\treturn &MyLoader{\n\t\tds: ds,\n\t\tcache: cache,\n\t}\n}\n\ntype MyLoader struct {\n\tds Datastore\n\tcache Cache\n}\n\nfunc (l *MyLoader) LoadAll() ([]interface{}, error) {\n\treturn nil, errors.New(\"not implemented\")\n}\n" }, { "path": "ch09/02_advantages/06_global_variable/06_global_variable.go", "content": "package global_variable\n\n// Global singleton of connections to our data store\nvar storage UserStorage\n\ntype Saver struct {\n}\n\nfunc (s *Saver) Do(in *User) error {\n\terr := s.validate(in)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn storage.Save(in)\n}\n\nfunc (s *Saver) validate(in *User) error {\n\t// validate user and return error when there is a problem\n\treturn nil\n}\n\ntype UserStorage interface {\n\tSave(in *User) error\n}\n\ntype User struct {\n\tName string\n\tPassword string\n}\n" }, { "path": "ch09/02_advantages/07_global_variable_jit/07_global_variable_jit.go", "content": "package global_variable_jit\n\n// Global singleton of connections to our data store\nvar storage UserStorage\n\ntype Saver struct {\n\tstorage UserStorage\n}\n\nfunc (s *Saver) Do(in *User) error {\n\terr := s.validate(in)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn s.getStorage().Save(in)\n}\n\n// Just-in-time DI\nfunc (s *Saver) getStorage() UserStorage {\n\tif s.storage == nil {\n\t\ts.storage = storage\n\t}\n\n\treturn s.storage\n}\n\nfunc (s *Saver) validate(in *User) error {\n\t// validate user and return error when there is a problem\n\treturn nil\n}\n\ntype UserStorage interface {\n\tSave(in *User) error\n}\n\ntype User struct {\n\tName string\n\tPassword string\n}\n" }, { "path": "ch09/02_advantages/07_global_variable_jit/07_global_variable_jit_test.go", "content": "package global_variable_jit\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestSaver_Do(t *testing.T) {\n\t// input\n\tcarol := &User{\n\t\tName: \"Carol\",\n\t\tPassword: \"IamKing\",\n\t}\n\n\t// mocks/stubs\n\tstubStorage := &StubUserStorage{}\n\n\t// do call\n\tsaver := &Saver{\n\t\tstorage: stubStorage,\n\t}\n\tresultErr := saver.Do(carol)\n\n\t// validate\n\tassert.NotEqual(t, resultErr, \"unexpected error\")\n}\n\n// Stub implementation of UserStorage\ntype StubUserStorage struct{}\n\nfunc (s *StubUserStorage) Save(_ *User) error {\n\t// return \"happy path\"\n\treturn nil\n}\n" }, { "path": "ch09/02_advantages/08_car_v1.go", "content": "package advantages\n\ntype CarV1 struct {\n\tengine Engine\n}\n\nfunc (c *CarV1) Drive() {\n\tc.engine.Start()\n\tdefer c.engine.Stop()\n\n\tc.engine.Drive()\n}\n\ntype Engine interface {\n\tStart()\n\tDrive()\n\tStop()\n}\n" }, { "path": "ch09/02_advantages/09_car_v2.go", "content": "package advantages\n\ntype CarV2 struct {\n\tengine Engine\n}\n\nfunc (c *CarV2) Drive() {\n\tengine := c.getEngine()\n\n\tengine.Start()\n\tdefer engine.Stop()\n\n\tengine.Drive()\n}\n\nfunc (c *CarV2) getEngine() Engine {\n\tif c.engine == nil {\n\t\tc.engine = newEngine()\n\t}\n\n\treturn c.engine\n}\n\nfunc newEngine() Engine {\n\t// not implemented\n\treturn nil\n}\n" }, { "path": "ch09/03_applying/01_commands.sh", "content": "#!/usr/bin/env bash\n\ncd $GOPATH/src/github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch08/\n\npackage-coverage -a -prefix $(go list)/ ./acme/\n" }, { "path": "ch09/03_applying/02_coverage.txt", "content": "-------------------------------------------------------------------------\n| Branch | Dir | |\n| Cov% | Stmts | Cov% | Stmts | Package |\n-------------------------------------------------------------------------\n| 65.66 | 265 | 0.00 | 7 | acme/ |\n| 47.83 | 23 | 47.83 | 23 | acme/internal/config/ |\n| 0.00 | 4 | 0.00 | 4 | acme/internal/logging/ |\n| 73.77 | 61 | 73.77 | 61 | acme/internal/modules/data/ |\n| 61.70 | 47 | 61.70 | 47 | acme/internal/modules/exchange/ |\n| 85.71 | 7 | 85.71 | 7 | acme/internal/modules/get/ |\n| 46.15 | 13 | 46.15 | 13 | acme/internal/modules/list/ |\n| 62.07 | 29 | 62.07 | 29 | acme/internal/modules/register/ |\n| 79.73 | 74 | 79.73 | 74 | acme/internal/rest/ |\n-------------------------------------------------------------------------\n" }, { "path": "ch09/03_applying/03_initial_dao.go", "content": "//+build willNotCompile\n\npackage applying\n\nimport (\n\t\"context\"\n)\n\n// NewDAO will initialize the database connection pool (if not already done) and return a data access object which\n// can be used to interact with the database\nfunc NewDAO(cfg Config) *DAO {\n\t// initialize the db connection pool\n\t_, _ = getDB(cfg)\n\n\treturn &DAO{\n\t\tcfg: cfg,\n\t}\n}\n\n// DAO is a data access object that provides an abstraction over our database interactions.\ntype DAO struct {\n\tcfg Config\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Load(ctx context.Context, ID int) (*Person, error) {\n\treturn Load(ctx, d.cfg, ID)\n}\n" }, { "path": "ch09/04_disadvantages/01_uncertain_init_state.go", "content": "package disadvantages\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"net\"\n\t\"sync\"\n)\n\ntype ConnectionPool interface {\n\tIsReady() <-chan struct{}\n\tGet() net.Conn\n\tRelease(conn net.Conn)\n}\n\ntype Sender struct {\n\tconnectionPool ConnectionPool\n\n\tinitPoolOnce sync.Once\n}\n\nfunc (l *Sender) Send(ctx context.Context, payload []byte) error {\n\tpool := l.getConnectionPool()\n\n\t// ensure pool is ready\n\tselect {\n\tcase <-pool.IsReady():\n\t\t// happy path\n\n\tcase <-ctx.Done():\n\t\t// context timed out or was cancelled\n\t\treturn errors.New(\"failed to get connection\")\n\t}\n\n\t// get connection from pool and return afterwards\n\tconn := pool.Get()\n\tdefer l.connectionPool.Release(conn)\n\n\t// send and return\n\t_, err := conn.Write(payload)\n\n\treturn err\n}\n\nfunc (l *Sender) getConnectionPool() ConnectionPool {\n\t// Inject the connection pool with JIT DI\n\tif l.connectionPool == nil {\n\t\tmyPool := &myConnectionPool{}\n\t\tgo myPool.init()\n\n\t\tl.connectionPool = myPool\n\t}\n\n\treturn l.connectionPool\n}\n\n// default implementation of the connection pool\ntype myConnectionPool struct {\n}\n\n// IsReady implements ConnectionPool\nfunc (m *myConnectionPool) IsReady() <-chan struct{} {\n\t// not implemented yet\n\treturn make(chan struct{})\n}\n\n// IsReady implements ConnectionPool\nfunc (m *myConnectionPool) Get() net.Conn {\n\t// not implemented yet\n\treturn nil\n}\n\n// IsReady implements ConnectionPool\nfunc (m *myConnectionPool) Release(_ net.Conn) {\n\t// not implemented yet\n}\n\nfunc (m *myConnectionPool) init() {\n\t// create connection and populate the pool\n}\n" }, { "path": "ch09/04_disadvantages/02_certain_init_state.go", "content": "package disadvantages\n\nfunc (l *Sender) SendWithoutReadyCheck(payload []byte) error {\n\tpool := l.getConnectionPool()\n\n\t// get connection from pool and return afterwards\n\tconn := pool.Get()\n\tdefer l.connectionPool.Release(conn)\n\n\t// send and return\n\t_, err := conn.Write(payload)\n\n\treturn err\n}\n" }, { "path": "ch09/04_disadvantages/03_cpool_slow_constructor.go", "content": "package disadvantages\n\nfunc newConnectionPool() ConnectionPool {\n\tpool := &myConnectionPool{}\n\n\t// initialize the pool\n\tpool.init()\n\n\t// return a \"ready to use pool\"\n\treturn pool\n}\n" }, { "path": "ch09/04_disadvantages/04_get_pool_with_once.go", "content": "package disadvantages\n\nfunc (l *Sender) getConnectionPoolOnce() ConnectionPool {\n\tl.initPoolOnce.Do(func() {\n\t\tl.connectionPool = newConnectionPool()\n\t})\n\n\treturn l.connectionPool\n}\n" }, { "path": "ch09/acme/internal/config/config.go", "content": "package config\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// App is the application config\nvar App *Config\n\n// Config defines the JSON format for the config file\ntype Config struct {\n\t// DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n\tDSN string\n\n\t// Address is the IP address and port to bind this rest to\n\tAddress string\n\n\t// BasePrice is the price of registration\n\tBasePrice float64\n\n\t// ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n\tExchangeRateBaseURL string\n\n\t// ExchangeRateAPIKey is the API for the exchange rate API\n\tExchangeRateAPIKey string\n\n\t// environmental dependencies\n\tlogger logging.Logger\n}\n\n// Logger returns a reference to the singleton logger\nfunc (c *Config) Logger() logging.Logger {\n\tif c.logger == nil {\n\t\tc.logger = &logging.LoggerStdOut{}\n\t}\n\n\treturn c.logger\n}\n\n// RegistrationBasePrice returns the base price for registrations\nfunc (c *Config) RegistrationBasePrice() float64 {\n\treturn c.BasePrice\n}\n\n// DataDSN returns the DSN\nfunc (c *Config) DataDSN() string {\n\treturn c.DSN\n}\n\n// ExchangeBaseURL returns the Base URL from which we can load exchange rates\nfunc (c *Config) ExchangeBaseURL() string {\n\treturn c.ExchangeRateBaseURL\n}\n\n// ExchangeAPIKey returns the DSN\nfunc (c *Config) ExchangeAPIKey() string {\n\treturn c.ExchangeRateAPIKey\n}\n\n// BindAddress returns the host and port this service should bind to\nfunc (c *Config) BindAddress() string {\n\treturn c.Address\n}\n\n// Load returns the config loaded from environment\nfunc init() {\n\tfilename, found := os.LookupEnv(DefaultEnvVar)\n\tif !found {\n\t\tlogging.L.Error(\"failed to locate file specified by %s\", DefaultEnvVar)\n\t\treturn\n\t}\n\n\t_ = load(filename)\n}\n\nfunc load(filename string) error {\n\tApp = &Config{}\n\tbytes, err := ioutil.ReadFile(filename)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to read config file. err: %s\", err)\n\t\treturn err\n\t}\n\n\terr = json.Unmarshal(bytes, App)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to parse config file. err : %s\", err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n" }, { "path": "ch09/acme/internal/config/config_test.go", "content": "package config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoad(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin string\n\t\texpectedConfig *Config\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tin: \"../../../../default-config.json\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tDSN: \"[insert your db config here]\",\n\t\t\t\tAddress: \"0.0.0.0:8080\",\n\t\t\t\tBasePrice: 100.00,\n\t\t\t\tExchangeRateBaseURL: \"http://apilayer.net\",\n\t\t\t\tExchangeRateAPIKey: \"[insert your API key here]\",\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"invalid path\",\n\t\t\tin: \"invalid.json\",\n\t\t\texpectedConfig: &Config{},\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\tresultErr := load(scenario.in)\n\t\t\trequire.Equal(t, scenario.expectError, resultErr != nil, \"err: %s\", resultErr)\n\t\t\tassert.Equal(t, scenario.expectedConfig, App, scenario.desc)\n\t\t})\n\t}\n\n}\n" }, { "path": "ch09/acme/internal/logging/logging.go", "content": "package logging\n\nimport (\n\t\"fmt\"\n)\n\n// Logger is our standard interface\ntype Logger interface {\n\tDebug(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tError(message string, args ...interface{})\n}\n\n// L is the global instance of the logger\nvar L = &LoggerStdOut{}\n\n// LoggerStdOut logs to std out\ntype LoggerStdOut struct{}\n\n// Debug logs messages at DEBUG level\nfunc (l LoggerStdOut) Debug(message string, args ...interface{}) {\n\tfmt.Printf(\"[DEBUG] \"+message, args...)\n}\n\n// Info logs messages at INFO level\nfunc (l LoggerStdOut) Info(message string, args ...interface{}) {\n\tfmt.Printf(\"[INFO] \"+message, args...)\n}\n\n// Warn logs messages at WARN level\nfunc (l LoggerStdOut) Warn(message string, args ...interface{}) {\n\tfmt.Printf(\"[WARN] \"+message, args...)\n}\n\n// Error logs messages at ERROR level\nfunc (l LoggerStdOut) Error(message string, args ...interface{}) {\n\tfmt.Printf(\"[ERROR] \"+message, args...)\n}\n" }, { "path": "ch09/acme/internal/modules/data/dao.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"time\"\n)\n\n// NewDAO will initialize the database connection pool (if not already done) and return a data access object which\n// can be used to interact with the database\nfunc NewDAO(cfg Config) *DAO {\n\t// initialize the db connection pool\n\t_, _ = getDB(cfg)\n\n\treturn &DAO{\n\t\tcfg: cfg,\n\t}\n}\n\n// DAO is a data access object that provides an abstraction over our database interactions.\ntype DAO struct {\n\tcfg Config\n\n\t// Tracker is an optional query timer\n\tTracker QueryTracker\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Load(ctx context.Context, ID int) (*Person, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"Load\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trow := db.QueryRowContext(subCtx, sqlLoadByID, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\td.cfg.Logger().Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\td.cfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) LoadAll(ctx context.Context) ([]*Person, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"LoadAll\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trows, err := db.QueryContext(subCtx, sqlLoadAll)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\td.cfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\td.cfg.Logger().Warn(\"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Save(ctx context.Context, in *Person) (int, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"Save\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB insert\n\tresult, err := db.ExecContext(subCtx, sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn int(id), nil\n}\n\nfunc (d *DAO) getTracker() QueryTracker {\n\tif d.Tracker == nil {\n\t\td.Tracker = &noopTracker{}\n\t}\n\n\treturn d.Tracker\n}\n" }, { "path": "ch09/acme/internal/modules/data/data.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tsqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\n// Config is the configuration for the data package\ntype Config interface {\n\t// Logger returns a reference to the logger\n\tLogger() logging.Logger\n\n\t// DataDSN returns the data source name\n\tDataDSN() string\n}\n\nvar getDB = func(cfg Config) (*sql.DB, error) {\n\tif db == nil {\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", cfg.DataDSN())\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n" }, { "path": "ch09/acme/internal/modules/data/data_test.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_insertError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnError(errors.New(\"failed to insert\"))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\n\t// validate result\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_getDBError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patching starts here\n\tdefer func(original func(_ Config) (*sql.DB, error)) {\n\t\t// restore original DB (after test)\n\t\tgetDB = original\n\t}(getDB)\n\n\t// replace getDB() function for this test\n\tgetDB = func(_ Config) (*sql.DB, error) {\n\t\treturn nil, errors.New(\"getDB() failed\")\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n}\n\nfunc TestLoadAll_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResults []*Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(1, \"John\", \"0123456789\", \"AUD\", 12.34))\n\t\t\t},\n\t\t\texpectedResults: []*Person{\n\t\t\t\t{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"AUD\",\n\t\t\t\t\tPrice: 12.34,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResults: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey patch the db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tdao := NewDAO(&testConfig{})\n\t\tresults, err := dao.LoadAll(ctx)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResults, results, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\nfunc TestLoad_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResult *Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\t\t\t},\n\t\t\texpectedResult: &Person{\n\t\t\t\tID: 2,\n\t\t\t\tFullName: \"Paul\",\n\t\t\t\tPhone: \"0123456789\",\n\t\t\t\tCurrency: \"CAD\",\n\t\t\t\tPrice: 23.45,\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResult: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tdao := NewDAO(&testConfig{})\n\t\tresult, err := dao.Load(ctx, 2)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResult, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n\ntype testConfig struct{}\n\n// Logger implements Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn logging.LoggerStdOut{}\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n" }, { "path": "ch09/acme/internal/modules/data/tracker.go", "content": "package data\n\nimport (\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n)\n\n// QueryTracker is an interface to track query timing\ntype QueryTracker interface {\n\t// Track will record/out the time a query took by calculating time.Now().Sub(start)\n\tTrack(key string, start time.Time)\n}\n\n// NO-OP implementation of QueryTracker\ntype noopTracker struct{}\n\n// Track implements QueryTracker\nfunc (_ *noopTracker) Track(_ string, _ time.Time) {\n\t// intentionally does nothing\n}\n\n// NewLogTracker returns a Tracker that outputs tracking data to log\nfunc NewLogTracker(logger logging.Logger) *LogTracker {\n\treturn &LogTracker{\n\t\tlogger: logger,\n\t}\n}\n\n// LogTracker implements QueryTracker and outputs to the supplied logger\ntype LogTracker struct {\n\tlogger logging.Logger\n}\n\n// Track implements QueryTracker\nfunc (l *LogTracker) Track(key string, start time.Time) {\n\tl.logger.Info(\"[%s] Timing: %s\\n\", key, time.Now().Sub(start).String())\n}\n" }, { "path": "ch09/acme/internal/modules/exchange/converter.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// NewConverter creates and initializes the converter\nfunc NewConverter(cfg Config) *Converter {\n\treturn &Converter{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the config for Converter\ntype Config interface {\n\tLogger() logging.Logger\n\tExchangeBaseURL() string\n\tExchangeAPIKey() string\n}\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct {\n\tcfg Config\n}\n\n// Exchange will perform the conversion\nfunc (c *Converter) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(ctx, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(ctx context.Context, currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tc.cfg.ExchangeBaseURL(),\n\t\tc.cfg.ExchangeAPIKey(),\n\t\tcurrency)\n\n\t// perform request\n\treq, err := http.NewRequest(\"GET\", url, nil)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to create request. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the upstream call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// replace the default context with our custom one\n\treq = req.WithContext(subCtx)\n\n\t// perform the HTTP request\n\tresponse, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tc.logger().Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tc.logger().Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\nfunc (c *Converter) logger() logging.Logger {\n\treturn c.cfg.Logger()\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n" }, { "path": "ch09/acme/internal/modules/exchange/converter_ext_bounday_test.go", "content": "// +build external\n\npackage exchange\n\nimport (\n\t\"context\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/config\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestExternalBoundaryTest(t *testing.T) {\n\t// define the config\n\tcfg := &testConfig{\n\t\tbaseURL: config.App.ExchangeRateBaseURL,\n\t\tapiKey: config.App.ExchangeRateAPIKey,\n\t}\n\n\t// create a converter to test\n\tconverter := NewConverter(cfg)\n\n\t// fetch from the server\n\tresponse, err := converter.loadRateFromServer(context.Background(), \"AUD\")\n\trequire.NotNil(t, response)\n\trequire.NoError(t, err)\n\n\t// parse the response\n\tresultRate, err := converter.extractRate(response, \"AUD\")\n\trequire.NoError(t, err)\n\n\t// validate the result\n\tassert.True(t, resultRate > 0)\n}\n" }, { "path": "ch09/acme/internal/modules/exchange/converter_int_bounday_test.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestInternalBoundaryTest(t *testing.T) {\n\t// start our test server\n\tserver := httptest.NewServer(&happyExchangeRateService{})\n\tdefer server.Close()\n\n\t// define the config\n\tcfg := &testConfig{\n\t\tbaseURL: server.URL,\n\t\tapiKey: \"\",\n\t}\n\n\t// create a converter to test\n\tconverter := NewConverter(cfg)\n\tresultRate, resultErr := converter.Exchange(context.Background(), 100.00, \"AUD\")\n\n\t// validate the result\n\tassert.Equal(t, 101.01, resultRate)\n\tassert.NoError(t, resultErr)\n}\n\ntype happyExchangeRateService struct{}\n\n// ServeHTTP implements http.Handler\nfunc (*happyExchangeRateService) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\tpayload := []byte(`\n{\n \"success\":true,\n \"historical\":true,\n \"date\":\"2010-11-09\",\n \"timestamp\":1289347199,\n \"source\":\"USD\",\n \"quotes\":{\n \"USDAUD\":0.989981\n }\n}`)\n\tresponse.Write(payload)\n}\n\n// test implementation of Config\ntype testConfig struct {\n\tbaseURL string\n\tapiKey string\n}\n\n// Logger implements Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// ExchangeBaseURL implements Config\nfunc (t *testConfig) ExchangeBaseURL() string {\n\treturn t.baseURL\n}\n\n// ExchangeAPIKey implements Config\nfunc (t *testConfig) ExchangeAPIKey() string {\n\treturn t.apiKey\n}\n" }, { "path": "ch09/acme/internal/modules/get/get.go", "content": "package get\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when the requested person is not in the database\n\terrPersonNotFound = errors.New(\"person not found\")\n)\n\n// NewGetter creates and initializes a Getter\nfunc NewGetter(cfg Config) *Getter {\n\treturn &Getter{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the configuration for Getter\ntype Config interface {\n\tLogger() logging.Logger\n\tDataDSN() string\n}\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n\tcfg Config\n\tdata myLoader\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\t// load person from the data layer\n\tperson, err := g.getLoader().Load(context.TODO(), ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are hiding the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn person, err\n}\n\nfunc (g *Getter) getLoader() myLoader {\n\tif g.data == nil {\n\t\tg.data = data.NewDAO(g.cfg)\n\t}\n\n\treturn g.data\n}\n\n//go:generate mockery -name=myLoader -case underscore -testonly -inpkg -note @generated\ntype myLoader interface {\n\tLoad(ctx context.Context, ID int) (*data.Person, error)\n}\n" }, { "path": "ch09/acme/internal/modules/get/go_test.go", "content": "package get\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetter_Do_happyPath(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// configure the mock loader\n\tmockResult := &data.Person{\n\t\tID: 1234,\n\t\tFullName: \"Doug\",\n\t}\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(mockResult, nil).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, ID, person.ID)\n\tassert.Equal(t, \"Doug\", person.FullName)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestGetter_Do_noSuchPerson(t *testing.T) {\n\t// inputs\n\tID := 5678\n\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(nil, data.ErrNotFound).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Equal(t, errPersonNotFound, err)\n\tassert.Nil(t, person)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestGetter_Do_error(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(nil, errors.New(\"something failed\")).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Nil(t, person)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n" }, { "path": "ch09/acme/internal/modules/get/mock_my_loader_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage get\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMyLoader is an autogenerated mock type for the myLoader type\ntype mockMyLoader struct {\n\tmock.Mock\n}\n\n// Load provides a mock function with given fields: ctx, ID\nfunc (_m *mockMyLoader) Load(ctx context.Context, ID int) (*data.Person, error) {\n\tret := _m.Called(ctx, ID)\n\n\tvar r0 *data.Person\n\tif rf, ok := ret.Get(0).(func(context.Context, int) *data.Person); ok {\n\t\tr0 = rf(ctx, ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, int) error); ok {\n\t\tr1 = rf(ctx, ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch09/acme/internal/modules/list/list.go", "content": "package list\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when there are no people in the database\n\terrPeopleNotFound = errors.New(\"no people found\")\n)\n\n// NewLister creates and initializes a Lister\nfunc NewLister(cfg Config) *Lister {\n\treturn &Lister{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the config for Lister\ntype Config interface {\n\tLogger() logging.Logger\n\tDataDSN() string\n}\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n\tcfg Config\n\tdata myLoader\n}\n\n// Exchange will load the people from the data layer\nfunc (l *Lister) Do() ([]*data.Person, error) {\n\t// load all people\n\tpeople, err := l.load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(people) == 0 {\n\t\t// special processing for 0 people returned\n\t\treturn nil, errPeopleNotFound\n\t}\n\n\treturn people, nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n\tpeople, err := l.getLoader().LoadAll(context.TODO())\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPeopleNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn people, nil\n}\n\nfunc (l *Lister) getLoader() myLoader {\n\tif l.data == nil {\n\t\tl.data = data.NewDAO(l.cfg)\n\n\t\t// temporarily add a log tracker\n\t\tl.data.(*data.DAO).Tracker = data.NewLogTracker(l.cfg.Logger())\n\t}\n\n\treturn l.data\n}\n\n//go:generate mockery -name=myLoader -case underscore -testonly -inpkg -note @generated\ntype myLoader interface {\n\tLoadAll(ctx context.Context) ([]*data.Person, error)\n}\n" }, { "path": "ch09/acme/internal/modules/list/list_test.go", "content": "package list\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLister_Do_happyPath(t *testing.T) {\n\t// configure the mock loader\n\tmockResult := []*data.Person{\n\t\t{\n\t\t\tID: 1234,\n\t\t\tFullName: \"Sally\",\n\t\t},\n\t\t{\n\t\t\tID: 5678,\n\t\t\tFullName: \"Jane\",\n\t\t},\n\t}\n\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(mockResult, nil).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestLister_Do_noResults(t *testing.T) {\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(nil, data.ErrNotFound).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Equal(t, errPeopleNotFound, err)\n\tassert.Equal(t, 0, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestLister_Do_error(t *testing.T) {\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n" }, { "path": "ch09/acme/internal/modules/list/mock_my_loader_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage list\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMyLoader is an autogenerated mock type for the myLoader type\ntype mockMyLoader struct {\n\tmock.Mock\n}\n\n// LoadAll provides a mock function with given fields: ctx\nfunc (_m *mockMyLoader) LoadAll(ctx context.Context) ([]*data.Person, error) {\n\tret := _m.Called(ctx)\n\n\tvar r0 []*data.Person\n\tif rf, ok := ret.Get(0).(func(context.Context) []*data.Person); ok {\n\t\tr0 = rf(ctx)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context) error); ok {\n\t\tr1 = rf(ctx)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch09/acme/internal/modules/register/mock_my_saver_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage register\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMySaver is an autogenerated mock type for the mySaver type\ntype mockMySaver struct {\n\tmock.Mock\n}\n\n// Save provides a mock function with given fields: ctx, in\nfunc (_m *mockMySaver) Save(ctx context.Context, in *data.Person) (int, error) {\n\tret := _m.Called(ctx, in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(context.Context, *data.Person) int); ok {\n\t\tr0 = rf(ctx, in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, *data.Person) error); ok {\n\t\tr1 = rf(ctx, in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch09/acme/internal/modules/register/register.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\t// validation errors\n\terrNameMissing = errors.New(\"name is missing\")\n\terrPhoneMissing = errors.New(\"phone is missing\")\n\terrCurrencyMissing = errors.New(\"currency is missing\")\n\terrInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n\t// a little trick to make checking for supported currencies easier\n\tsupportedCurrencies = map[string]struct{}{\n\t\t\"AUD\": {},\n\t\t\"CNY\": {},\n\t\t\"EUR\": {},\n\t\t\"GBP\": {},\n\t\t\"JPY\": {},\n\t\t\"MYR\": {},\n\t\t\"SGD\": {},\n\t\t\"USD\": {},\n\t}\n)\n\n// NewRegisterer creates and initializes a Registerer\nfunc NewRegisterer(cfg Config, exchanger Exchanger) *Registerer {\n\treturn &Registerer{\n\t\tcfg: cfg,\n\t\texchanger: exchanger,\n\t}\n}\n\n// Exchanger will convert from one currency to another\ntype Exchanger interface {\n\t// Exchange will perform the conversion\n\tExchange(ctx context.Context, basePrice float64, currency string) (float64, error)\n}\n\n// Config is the configuration for the Registerer\ntype Config interface {\n\tLogger() logging.Logger\n\tRegistrationBasePrice() float64\n\tDataDSN() string\n}\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n\tcfg Config\n\texchanger Exchanger\n\tdata mySaver\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(ctx context.Context, in *data.Person) (int, error) {\n\t// validate the request\n\terr := r.validateInput(in)\n\tif err != nil {\n\t\tr.logger().Warn(\"input validation failed with err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// get price in the requested currency\n\tprice, err := r.getPrice(ctx, in.Currency)\n\tif err != nil {\n\t\treturn defaultPersonID, err\n\t}\n\n\t// save registration\n\tid, err := r.save(ctx, in, price)\n\tif err != nil {\n\t\t// no need to log here as we expect the data layer to do so\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *data.Person) error {\n\tif in.FullName == \"\" {\n\t\treturn errNameMissing\n\t}\n\tif in.Phone == \"\" {\n\t\treturn errPhoneMissing\n\t}\n\tif in.Currency == \"\" {\n\t\treturn errCurrencyMissing\n\t}\n\n\tif _, found := supportedCurrencies[in.Currency]; !found {\n\t\treturn errInvalidCurrency\n\t}\n\n\t// happy path\n\treturn nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(ctx context.Context, currency string) (float64, error) {\n\tprice, err := r.exchanger.Exchange(ctx, r.cfg.RegistrationBasePrice(), currency)\n\tif err != nil {\n\t\tr.logger().Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(ctx context.Context, in *data.Person, price float64) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tCurrency: in.Currency,\n\t\tPrice: price,\n\t}\n\treturn r.getSaver().Save(ctx, person)\n}\n\nfunc (r *Registerer) getSaver() mySaver {\n\tif r.data == nil {\n\t\tr.data = data.NewDAO(r.cfg)\n\t}\n\n\treturn r.data\n}\n\nfunc (r *Registerer) logger() logging.Logger {\n\treturn r.cfg.Logger()\n}\n\n//go:generate mockery -name=mySaver -case underscore -testonly -inpkg -note @generated\ntype mySaver interface {\n\tSave(ctx context.Context, in *data.Person) (int, error)\n}\n" }, { "path": "ch09/acme/internal/modules/register/register_test.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterer_Do_happyPath(t *testing.T) {\n\t// configure the mock saver\n\tmockResult := 888\n\n\tmockSaver := &mockMySaver{}\n\tmockSaver.On(\"Save\", mock.Anything, mock.Anything).Return(mockResult, nil).Once()\n\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: &stubExchanger{},\n\t\tdata: mockSaver,\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 888, ID)\n\tassert.True(t, mockSaver.AssertExpectations(t))\n}\n\nfunc TestRegisterer_Do_error(t *testing.T) {\n\t// configure the mock saver\n\tmockSaver := &mockMySaver{}\n\tmockSaver.On(\"Save\", mock.Anything, mock.Anything).Return(0, errors.New(\"something failed\")).Once()\n\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: &stubExchanger{},\n\t\tdata: mockSaver,\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, ID)\n\tassert.True(t, mockSaver.AssertExpectations(t))\n}\n\n// Stub implementation of Config\ntype testConfig struct{}\n\n// Logger implement Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// RegistrationBasePrice implement Config\nfunc (t *testConfig) RegistrationBasePrice() float64 {\n\treturn 12.34\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n\ntype stubExchanger struct{}\n\n// Exchange implements Exchanger\nfunc (s stubExchanger) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\treturn 12.34, nil\n}\n" }, { "path": "ch09/acme/internal/rest/get.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// key in the mux where the ID is stored\n\tmuxVarID = \"id\"\n)\n\n// GetModel will load a registration\n//go:generate mockery -name=GetModel -case underscore -testonly -inpkg -note @generated\ntype GetModel interface {\n\tDo(ID int) (*data.Person, error)\n}\n\n// GetConfig is the config for the Get Handler\ntype GetConfig interface {\n\tLogger() logging.Logger\n}\n\n// NewGetHandler is the constructor for GetHandler\nfunc NewGetHandler(cfg GetConfig, model GetModel) *GetHandler {\n\treturn &GetHandler{\n\t\tcfg: cfg,\n\t\tgetter: model,\n\t}\n}\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n\tcfg GetConfig\n\tgetter GetModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tperson, err := h.getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[muxVarID]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\th.cfg.Logger().Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\th.cfg.Logger().Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *data.Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n" }, { "path": "ch09/acme/internal/rest/get_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockGetModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\toutput := &data.Person{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"USD\",\n\t\t\t\t\tPrice: 100,\n\t\t\t\t}\n\n\t\t\t\tmockGetModel := &MockGetModel{}\n\t\t\t\tmockGetModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockGetModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\",\"currency\":\"USD\",\"price\":100}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is invalid)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/x/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"x\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is missing)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person//\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency fail\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"requested registration does not exist\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"person not found\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockGetModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewGetHandler(&testConfig{}, mockGetModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\t\t})\n\t}\n}\n\ntype testConfig struct {\n}\n\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\nfunc (*testConfig) BindAddress() string {\n\treturn \"0.0.0.0:0\"\n}\n" }, { "path": "ch09/acme/internal/rest/list.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n)\n\n// ListModel will load all registrations\n//go:generate mockery -name=ListModel -case underscore -testonly -inpkg -note @generated\ntype ListModel interface {\n\tDo() ([]*data.Person, error)\n}\n\n// NewLister is the constructor for ListHandler\nfunc NewListHandler(model ListModel) *ListHandler {\n\treturn &ListHandler{\n\t\tlister: model,\n\t}\n}\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n\tlister ListModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// attempt loadAll\n\tpeople, err := h.lister.Do()\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, people)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*data.Person) error {\n\toutput := &listResponseFormat{\n\t\tPeople: make([]*listResponseItemFormat, len(people)),\n\t}\n\n\tfor index, record := range people {\n\t\toutput.People[index] = &listResponseItemFormat{\n\t\t\tID: record.ID,\n\t\t\tFullName: record.FullName,\n\t\t\tPhone: record.Phone,\n\t\t}\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n\tPeople []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n}\n" }, { "path": "ch09/acme/internal/rest/list_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestListHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockListModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\toutput := []*data.Person{\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 2,\n\t\t\t\t\t\tFullName: \"Paul\",\n\t\t\t\t\t\tPhone: \"0123456781\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 3,\n\t\t\t\t\t\tFullName: \"George\",\n\t\t\t\t\t\tPhone: \"0123456782\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"Ringo\",\n\t\t\t\t\t\tPhone: \"0123456783\",\n\t\t\t\t\t},\n\t\t\t\t}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\"},{\"id\":2,\"name\":\"Paul\",\"phone\":\"0123456781\"},{\"id\":3,\"name\":\"George\",\"phone\":\"0123456782\"},{\"id\":1,\"name\":\"Ringo\",\"phone\":\"0123456783\"}]}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"no data\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\t// no data\n\t\t\t\toutput := []*data.Person{}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[]}` + \"\\n\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockListModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewListHandler(mockListModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\n\t\t})\n\t}\n}\n" }, { "path": "ch09/acme/internal/rest/mock_get_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockGetModel is an autogenerated mock type for the GetModel type\ntype MockGetModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ID\nfunc (_m *MockGetModel) Do(ID int) (*data.Person, error) {\n\tret := _m.Called(ID)\n\n\tvar r0 *data.Person\n\tif rf, ok := ret.Get(0).(func(int) *data.Person); ok {\n\t\tr0 = rf(ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(int) error); ok {\n\t\tr1 = rf(ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch09/acme/internal/rest/mock_list_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockListModel is an autogenerated mock type for the ListModel type\ntype MockListModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields:\nfunc (_m *MockListModel) Do() ([]*data.Person, error) {\n\tret := _m.Called()\n\n\tvar r0 []*data.Person\n\tif rf, ok := ret.Get(0).(func() []*data.Person); ok {\n\t\tr0 = rf()\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func() error); ok {\n\t\tr1 = rf()\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch09/acme/internal/rest/mock_register_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockRegisterModel is an autogenerated mock type for the RegisterModel type\ntype MockRegisterModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ctx, in\nfunc (_m *MockRegisterModel) Do(ctx context.Context, in *data.Person) (int, error) {\n\tret := _m.Called(ctx, in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(context.Context, *data.Person) int); ok {\n\t\tr0 = rf(ctx, in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, *data.Person) error); ok {\n\t\tr1 = rf(ctx, in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch09/acme/internal/rest/not_found.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n" }, { "path": "ch09/acme/internal/rest/not_found_test.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNotFoundHandler_ServeHTTP(t *testing.T) {\n\t// build inputs\n\tresponse := httptest.NewRecorder()\n\trequest := &http.Request{}\n\n\t// call handler\n\tnotFoundHandler(response, request)\n\n\t// validate outputs\n\trequire.Equal(t, http.StatusNotFound, response.Code)\n}\n" }, { "path": "ch09/acme/internal/rest/register.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/data\"\n)\n\n// RegisterModel will validate and save a registration\n//go:generate mockery -name=RegisterModel -case underscore -testonly -inpkg -note @generated\ntype RegisterModel interface {\n\tDo(ctx context.Context, in *data.Person) (int, error)\n}\n\n// NewRegisterHandler is the constructor for RegisterHandler\nfunc NewRegisterHandler(model RegisterModel) *RegisterHandler {\n\treturn &RegisterHandler{\n\t\tregisterer: model,\n\t}\n}\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n\tregisterer RegisterModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// set latency budget for this API\n\tsubCtx, cancel := context.WithTimeout(request.Context(), 1500*time.Millisecond)\n\tdefer cancel()\n\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// call the business logic using the request data and context\n\tid, err := h.register(subCtx, requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(ctx context.Context, requestPayload *registerRequest) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\treturn h.registerer.Do(ctx, person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch09/acme/internal/rest/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockRegisterModel\n\t\texpectedStatus int\n\t\texpectedHeader string\n\t}{\n\t\t{\n\t\t\tdesc: \"Happy Path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// valid downstream configuration\n\t\t\t\tresultID := 1234\n\t\t\t\tvar resultErr error\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(resultID, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusCreated,\n\t\t\texpectedHeader: \"/person/1234/\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Bad Input / User Error\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tinvalidRequest := bytes.NewBufferString(`this is not valid JSON`)\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", invalidRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// Dependency should not be called\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Dependency Failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// call to the dependency failed\n\t\t\t\tresultErr := errors.New(\"something failed\")\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(0, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockRegisterModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewRegisterHandler(mockRegisterModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code)\n\n\t\t\t// call should output the location to the new person\n\t\t\tresultHeader := response.Header().Get(\"Location\")\n\t\t\tassert.Equal(t, scenario.expectedHeader, resultHeader)\n\n\t\t\t// validate the mock was used as we expected\n\t\t\tassert.True(t, mockRegisterModel.AssertExpectations(t))\n\t\t})\n\t}\n}\n\nfunc buildValidRegisterRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch09/acme/internal/rest/server.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/logging\"\n\t\"github.com/gorilla/mux\"\n)\n\n// Config is the config for the REST package\ntype Config interface {\n\tLogger() logging.Logger\n\tBindAddress() string\n}\n\n// New will create and initialize the server\nfunc New(cfg Config,\n\tgetModel GetModel,\n\tlistModel ListModel,\n\tregisterModel RegisterModel) *Server {\n\n\treturn &Server{\n\t\taddress: cfg.BindAddress(),\n\t\thandlerGet: NewGetHandler(cfg, getModel),\n\t\thandlerList: NewListHandler(listModel),\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: NewRegisterHandler(registerModel),\n\t}\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n\taddress string\n\tserver *http.Server\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n\trouter := s.buildRouter()\n\n\t// create the HTTP server\n\ts.server = &http.Server{\n\t\tHandler: router,\n\t\tAddr: s.address,\n\t}\n\n\t// listen for shutdown\n\tgo func() {\n\t\t// wait for shutdown signal\n\t\t<-stop\n\n\t\t_ = s.server.Close()\n\t}()\n\n\t// start the HTTP server\n\t_ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n\trouter := mux.NewRouter()\n\n\t// map URL endpoints to HTTP handlers\n\trouter.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n\trouter.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n\trouter.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n\t// convert a \"catch all\" not found handler\n\trouter.NotFoundHandler = s.handlerNotFound\n\n\treturn router\n}\n" }, { "path": "ch09/acme/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch09/acme/internal/rest\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// build the exchanger\n\texchanger := exchange.NewConverter(config.App)\n\n\t// build model layer\n\tgetModel := get.NewGetter(config.App)\n\tlistModel := list.NewLister(config.App)\n\tregisterModel := register.NewRegisterer(config.App, exchanger)\n\n\t// start REST server\n\tserver := rest.New(config.App, getModel, listModel, registerModel)\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch09/fake.go", "content": "package ch09\n\nfunc init() {\n\t// This file is included so that Go tools (like `go list`) will find Go code in this directory and not error\n}\n" }, { "path": "ch10/01_intro_to_wire/01_simple/main.go", "content": "package main\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/google/wire\"\n)\n\nfunc main() {\n\tf := initializeDeps()\n\n\tresult, err := f.GoFetch()\n\tfmt.Printf(\"Result: %s / %s\", result, err)\n}\n\n// list of wire enabled dependencies\nvar wireSet = wire.NewSet(ProvideFetcher)\n\n// Provider\nfunc ProvideFetcher() *Fetcher {\n\treturn &Fetcher{}\n}\n\n// Object being \"provided\"\ntype Fetcher struct {\n}\n\nfunc (f *Fetcher) GoFetch() (string, error) {\n\treturn \"\", errors.New(\"not implemented yet\")\n}\n" }, { "path": "ch10/01_intro_to_wire/01_simple/wire.go", "content": "//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeDeps() *Fetcher {\n\twire.Build(wireSet)\n\treturn nil\n}\n" }, { "path": "ch10/01_intro_to_wire/01_simple/wire_gen.go", "content": "// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\n// Injectors from wire.go:\n\nfunc initializeDeps() *Fetcher {\n\tfetcher := ProvideFetcher()\n\treturn fetcher\n}\n" }, { "path": "ch10/01_intro_to_wire/02_params/main.go", "content": "package main\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/google/wire\"\n)\n\nfunc main() {\n\tf := initializeDeps()\n\n\tresult, err := f.GoFetch()\n\tfmt.Printf(\"Result: %s / %s\", result, err)\n}\n\n// list of wire enabled dependencies\nvar wireSet = wire.NewSet(ProvideFetcher, ProvideCache)\n\n// Providers\nfunc ProvideFetcher(cache *Cache) *Fetcher {\n\treturn &Fetcher{\n\t\tcache: cache,\n\t}\n}\n\nfunc ProvideCache() *Cache {\n\treturn &Cache{}\n}\n\ntype Cache struct{}\n\nfunc (c *Cache) Get(key string) (string, error) {\n\treturn \"\", errors.New(\"not implemented yet\")\n}\n\nfunc (c *Cache) Set(key string, value string) error {\n\treturn errors.New(\"not implemented\")\n}\n\ntype Fetcher struct {\n\tcache *Cache\n}\n\nfunc (f *Fetcher) GoFetch() (string, error) {\n\treturn \"\", errors.New(\"not implemented yet\")\n}\n" }, { "path": "ch10/01_intro_to_wire/02_params/wire.go", "content": "//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeDeps() *Fetcher {\n\twire.Build(wireSet)\n\treturn nil\n}\n" }, { "path": "ch10/01_intro_to_wire/02_params/wire_gen.go", "content": "// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\n// Injectors from wire.go:\n\nfunc initializeDeps() *Fetcher {\n\tcache := ProvideCache()\n\tfetcher := ProvideFetcher(cache)\n\treturn fetcher\n}\n" }, { "path": "ch10/01_intro_to_wire/03_error/main.go", "content": "package main\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/google/wire\"\n)\n\nfunc main() {\n\tf, err := initializeDeps()\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\n\tresult, err := f.GoFetch()\n\tfmt.Printf(\"Result: %s / %s\", result, err)\n}\n\n// list of wire enabled dependencies\nvar wireSet = wire.NewSet(ProvideFetcher, ProvideCache)\n\n// Providers\nfunc ProvideFetcher(cache *Cache) *Fetcher {\n\treturn &Fetcher{\n\t\tcache: cache,\n\t}\n}\n\nfunc ProvideCache() (*Cache, error) {\n\tcache := &Cache{}\n\n\terr := cache.Start()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn cache, nil\n}\n\ntype Cache struct{}\n\nfunc (c *Cache) Start() error {\n\treturn errors.New(\"not implemented yet\")\n}\n\nfunc (c *Cache) Get(key string) (string, error) {\n\treturn \"\", errors.New(\"not implemented yet\")\n}\n\nfunc (c *Cache) Set(key string, value string) error {\n\treturn errors.New(\"not implemented\")\n}\n\ntype Fetcher struct {\n\tcache *Cache\n}\n\nfunc (f *Fetcher) GoFetch() (string, error) {\n\treturn \"\", errors.New(\"not implemented yet\")\n}\n" }, { "path": "ch10/01_intro_to_wire/03_error/wire.go", "content": "//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeDeps() (*Fetcher, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n" }, { "path": "ch10/01_intro_to_wire/03_error/wire_gen.go", "content": "// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\n// Injectors from wire.go:\n\nfunc initializeDeps() (*Fetcher, error) {\n\tcache, err := ProvideCache()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tfetcher := ProvideFetcher(cache)\n\treturn fetcher, nil\n}\n" }, { "path": "ch10/01_intro_to_wire/04_without_pset/main.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// start REST server\n\tserver, err := initializeServer()\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch10/01_intro_to_wire/04_without_pset/wire.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\n//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeServer() (*rest.Server, error) {\n\twire.Build(\n\t\t// *config.Config\n\t\tconfig.Load,\n\n\t\t// *exchange.Converter\n\t\twire.Bind(new(exchange.Config), &config.Config{}),\n\t\texchange.NewConverter,\n\n\t\t// *get.Getter\n\t\twire.Bind(new(get.Config), &config.Config{}),\n\t\tget.NewGetter,\n\n\t\t// *list.Lister\n\t\twire.Bind(new(list.Config), &config.Config{}),\n\t\tlist.NewLister,\n\n\t\t// *register.Registerer\n\t\twire.Bind(new(register.Config), &config.Config{}),\n\t\twire.Bind(new(register.Exchanger), &exchange.Converter{}),\n\t\tregister.NewRegisterer,\n\n\t\t// *rest.Server\n\t\twire.Bind(new(rest.Config), &config.Config{}),\n\t\twire.Bind(new(rest.GetModel), &get.Getter{}),\n\t\twire.Bind(new(rest.ListModel), &list.Lister{}),\n\t\twire.Bind(new(rest.RegisterModel), ®ister.Registerer{}),\n\t\trest.New,\n\t)\n\n\treturn nil, nil\n}\n" }, { "path": "ch10/01_intro_to_wire/04_without_pset/wire_gen.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\n// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n)\n\n// Injectors from wire.go:\n\nfunc initializeServer() (*rest.Server, error) {\n\tconfigConfig, err := config.Load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tgetter := get.NewGetter(configConfig)\n\tlister := list.NewLister(configConfig)\n\tconverter := exchange.NewConverter(configConfig)\n\tregisterer := register.NewRegisterer(configConfig, converter)\n\tserver := rest.New(configConfig, getter, lister, registerer)\n\treturn server, nil\n}\n" }, { "path": "ch10/02_advantages/01_dig/main.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n\t\"go.uber.org/dig\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// build DIG container\n\tcontainer := BuildContainer()\n\n\t// start REST server\n\terr := container.Invoke(func(server *rest.Server) {\n\t\tserver.Listen(ctx.Done())\n\t})\n\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n}\n\nfunc BuildContainer() *dig.Container {\n\tcontainer := dig.New()\n\n\tcontainer.Provide(config.Load)\n\tcontainer.Provide(exchange.NewConverter)\n\tcontainer.Provide(get.NewGetter)\n\tcontainer.Provide(list.NewLister)\n\tcontainer.Provide(register.NewRegisterer)\n\tcontainer.Provide(rest.New)\n\n\treturn container\n}\n" }, { "path": "ch10/02_advantages/02_instantiation_order/handler.go", "content": "package main\n\nimport (\n\t\"net/http\"\n)\n\nfunc NewGetPersonHandler(model *GetPersonModel) *GetPersonHandler {\n\treturn &GetPersonHandler{\n\t\tmodel: model,\n\t}\n}\n\ntype GetPersonHandler struct {\n\tmodel *GetPersonModel\n}\n\nfunc (g *GetPersonHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\tresponse.WriteHeader(http.StatusInternalServerError)\n\tresponse.Write([]byte(`not implemented yet`))\n}\n" }, { "path": "ch10/02_advantages/02_instantiation_order/injectors.go", "content": "//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeDeps() *GetPersonHandler {\n\twire.Build(wireSet)\n\treturn nil\n}\n" }, { "path": "ch10/02_advantages/02_instantiation_order/main.go", "content": "package main\n\nfunc main() {\n\t// something fantastic goes here!\n}\n" }, { "path": "ch10/02_advantages/02_instantiation_order/model.go", "content": "package main\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n)\n\nfunc NewGetPersonModel(db *sql.DB) *GetPersonModel {\n\treturn &GetPersonModel{\n\t\tdb: db,\n\t}\n}\n\ntype GetPersonModel struct {\n\tdb *sql.DB\n}\n\nfunc (g *GetPersonModel) LoadByID(ID int) (*Person, error) {\n\treturn nil, errors.New(\"not implemented yet\")\n}\n\ntype Person struct {\n\tName string\n}\n" }, { "path": "ch10/02_advantages/02_instantiation_order/providers.go", "content": "package main\n\nimport (\n\t\"database/sql\"\n\n\t\"github.com/google/wire\"\n)\n\nfunc ProvideHandler(model *GetPersonModel) *GetPersonHandler {\n\treturn &GetPersonHandler{\n\t\tmodel: model,\n\t}\n}\n\nfunc ProvideModel(db *sql.DB) *GetPersonModel {\n\treturn &GetPersonModel{\n\t\tdb: db,\n\t}\n}\n\nfunc ProvideDatabase() *sql.DB {\n\treturn &sql.DB{}\n}\n\nvar wireSet = wire.NewSet(\n\tProvideHandler,\n\tProvideModel,\n\tProvideDatabase,\n)\n" }, { "path": "ch10/02_advantages/02_instantiation_order/wire_gen.go", "content": "// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\n// Injectors from injectors.go:\n\nfunc initializeDeps() *GetPersonHandler {\n\tdb := ProvideDatabase()\n\tgetPersonModel := ProvideModel(db)\n\tgetPersonHandler := ProvideHandler(getPersonModel)\n\treturn getPersonHandler\n}\n" }, { "path": "ch10/03_applying/01_before_config/main.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// load config\n\tcfg, err := config.Load(config.DefaultEnvVar)\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\t// build the exchanger\n\texchanger := exchange.NewConverter(cfg)\n\n\t// build model layer\n\tgetModel := get.NewGetter(cfg)\n\tlistModel := list.NewLister(cfg)\n\tregisterModel := register.NewRegisterer(cfg, exchanger)\n\n\t// start REST server\n\tserver := rest.New(cfg, getModel, listModel, registerModel)\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch10/03_applying/02_after_config/main.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// load config\n\tcfg, err := initializeConfig()\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\t// build the exchanger\n\texchanger := exchange.NewConverter(cfg)\n\n\t// build model layer\n\tgetModel := get.NewGetter(cfg)\n\tlistModel := list.NewLister(cfg)\n\tregisterModel := register.NewRegisterer(cfg, exchanger)\n\n\t// start REST server\n\tserver := rest.New(cfg, getModel, listModel, registerModel)\n\tserver.Listen(ctx.Done())\n}\n" }, { "path": "ch10/03_applying/02_after_config/wire.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\n//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeConfig() (*config.Config, error) {\n\twire.Build(config.Load)\n\treturn nil, nil\n}\n" }, { "path": "ch10/03_applying/02_after_config/wire_gen.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\n// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n)\n\n// Injectors from wire.go:\n\nfunc initializeConfig() (*config.Config, error) {\n\tconfigConfig, err := config.Load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn configConfig, nil\n}\n" }, { "path": "ch10/03_applying/03_after_exchange/main.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// load config\n\tcfg, err := initializeConfig()\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\t// build the exchanger\n\texchanger, err := initializeExchanger()\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\t// build model layer\n\tgetModel := get.NewGetter(cfg)\n\tlistModel := list.NewLister(cfg)\n\tregisterModel := register.NewRegisterer(cfg, exchanger)\n\n\t// start REST server\n\tserver := rest.New(cfg, getModel, listModel, registerModel)\n\tserver.Listen(ctx.Done())\n}\n\n// List of wire enabled objects\nvar wireSet = wire.NewSet(\n\t// *config.Config\n\tconfig.Load,\n\n\t// *exchange.Converter\n\twire.Bind(new(exchange.Config), &config.Config{}),\n\texchange.NewConverter,\n)\n" }, { "path": "ch10/03_applying/03_after_exchange/wire.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\n//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeConfig() (*config.Config, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n\nfunc initializeExchanger() (*exchange.Converter, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n" }, { "path": "ch10/03_applying/04_after_model/main.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// load config\n\tcfg, err := initializeConfig()\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\t// build model layer\n\tgetModel, _ := initializeGetter()\n\tlistModel, _ := initializeLister()\n\tregisterModel, _ := initializeRegisterer()\n\n\t// start REST server\n\tserver := rest.New(cfg, getModel, listModel, registerModel)\n\tserver.Listen(ctx.Done())\n}\n\n// List of wire enabled objects\nvar wireSet = wire.NewSet(\n\t// *config.Config\n\tconfig.Load,\n\n\t// *exchange.Converter\n\twire.Bind(new(exchange.Config), &config.Config{}),\n\texchange.NewConverter,\n\n\t// *get.Getter\n\twire.Bind(new(get.Config), &config.Config{}),\n\tget.NewGetter,\n\n\t// *list.Lister\n\twire.Bind(new(list.Config), &config.Config{}),\n\tlist.NewLister,\n\n\t// *register.Registerer\n\twire.Bind(new(register.Config), &config.Config{}),\n\twire.Bind(new(register.Exchanger), &exchange.Converter{}),\n\tregister.NewRegisterer,\n)\n" }, { "path": "ch10/03_applying/04_after_model/wire.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\n//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeConfig() (*config.Config, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n\nfunc initializeGetter() (*get.Getter, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n\nfunc initializeLister() (*list.Lister, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n\nfunc initializeRegisterer() (*register.Registerer, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n" }, { "path": "ch10/03_applying/05_after_rest/main.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// start REST server\n\tserver, err := initializeServer()\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\tserver.Listen(ctx.Done())\n}\n\n// List of wire enabled objects\nvar wireSet = wire.NewSet(\n\t// *config.Config\n\tconfig.Load,\n\n\t// *exchange.Converter\n\twire.Bind(new(exchange.Config), &config.Config{}),\n\texchange.NewConverter,\n\n\t// *get.Getter\n\twire.Bind(new(get.Config), &config.Config{}),\n\tget.NewGetter,\n\n\t// *list.Lister\n\twire.Bind(new(list.Config), &config.Config{}),\n\tlist.NewLister,\n\n\t// *register.Registerer\n\twire.Bind(new(register.Config), &config.Config{}),\n\twire.Bind(new(register.Exchanger), &exchange.Converter{}),\n\tregister.NewRegisterer,\n\n\t// *rest.Server\n\twire.Bind(new(rest.Config), &config.Config{}),\n\twire.Bind(new(rest.GetModel), &get.Getter{}),\n\twire.Bind(new(rest.ListModel), &list.Lister{}),\n\twire.Bind(new(rest.RegisterModel), ®ister.Registerer{}),\n\trest.New,\n)\n" }, { "path": "ch10/03_applying/05_after_rest/wire.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\n//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeServer() (*rest.Server, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n" }, { "path": "ch10/03_applying/05_after_rest/wire_gen.go", "content": "//+build ignore\n// Code above this line should be ignored as it's not part of the example\n\n// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n)\n\n// Injectors from wire.go:\n\nfunc initializeServer() (*rest.Server, error) {\n\tconfigConfig, err := config.Load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tgetter := get.NewGetter(configConfig)\n\tlister := list.NewLister(configConfig)\n\tconverter := exchange.NewConverter(configConfig)\n\tregisterer := register.NewRegisterer(configConfig, converter)\n\tserver := rest.New(configConfig, getter, lister, registerer)\n\treturn server, nil\n}\n" }, { "path": "ch10/03_applying/06_build_tag.go", "content": "//+build myTag\n\npackage main\n\nimport (\n\t\"fmt\"\n)\n\nfunc sayHello() {\n\tfmt.Println(\"Hello World!\")\n}\n" }, { "path": "ch10/03_applying/06_build_tag_inverse.go", "content": "//+build !myTag\n\npackage main\n\nimport (\n\t\"fmt\"\n)\n\nfunc sayHello() {\n\tfmt.Println(\"Hello Universe!\")\n}\n" }, { "path": "ch10/03_applying/06_main.go", "content": "package main\n\nfunc main() {\n\tsayHello()\n}\n" }, { "path": "ch10/04_disadvantages/01_complexity/main.go", "content": "package main\n\nimport (\n\t\"encoding/json\"\n\t\"io/ioutil\"\n\n\t\"go.uber.org/dig\"\n)\n\nconst (\n\tconfigFile = \"config.json\"\n)\n\nfunc main() {\n\tc := dig.New()\n\n\terr := c.Provide(func() (*Config, error) {\n\t\tout := &Config{}\n\t\tbytes, err := ioutil.ReadFile(configFile)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\terr = json.Unmarshal(bytes, out)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\treturn out, nil\n\t})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\terr = c.Provide(func(cfg *Config) *Logger {\n\t\treturn &Logger{level: cfg.Level}\n\t})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\terr = c.Provide(func(logger *Logger) *Server {\n\t\treturn &Server{logger: logger}\n\t})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\terr = c.Invoke(func(server *Server) {\n\t\tserver.Listen()\n\t})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n}\n\ntype Config struct {\n\tLevel string\n}\n\ntype Logger struct {\n\tlevel string\n}\n\nfunc (l *Logger) Debug(msg string, args ...interface{}) {\n\t// not implemented\n}\n\nfunc (l *Logger) Warn(msg string, args ...interface{}) {\n\t// not implemented\n}\n\nfunc (l *Logger) Error(msg string, args ...interface{}) {\n\t// not implemented\n}\n\ntype Server struct {\n\tlogger *Logger\n}\n\nfunc (s *Server) Listen() {\n\t// not implemented\n}\n" }, { "path": "ch10/acme/internal/config/config.go", "content": "package config\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// Config defines the JSON format for the config file\ntype Config struct {\n\t// DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n\tDSN string\n\n\t// Address is the IP address and port to bind this rest to\n\tAddress string\n\n\t// BasePrice is the price of registration\n\tBasePrice float64\n\n\t// ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n\tExchangeRateBaseURL string\n\n\t// ExchangeRateAPIKey is the API for the exchange rate API\n\tExchangeRateAPIKey string\n\n\t// environmental dependencies\n\tlogger logging.Logger\n}\n\n// Logger returns a reference to the singleton logger\nfunc (c *Config) Logger() logging.Logger {\n\tif c.logger == nil {\n\t\tc.logger = &logging.LoggerStdOut{}\n\t}\n\n\treturn c.logger\n}\n\n// RegistrationBasePrice returns the base price for registrations\nfunc (c *Config) RegistrationBasePrice() float64 {\n\treturn c.BasePrice\n}\n\n// DataDSN returns the DSN\nfunc (c *Config) DataDSN() string {\n\treturn c.DSN\n}\n\n// ExchangeBaseURL returns the Base URL from which we can load exchange rates\nfunc (c *Config) ExchangeBaseURL() string {\n\treturn c.ExchangeRateBaseURL\n}\n\n// ExchangeAPIKey returns the DSN\nfunc (c *Config) ExchangeAPIKey() string {\n\treturn c.ExchangeRateAPIKey\n}\n\n// BindAddress returns the host and port this service should bind to\nfunc (c *Config) BindAddress() string {\n\treturn c.Address\n}\n\n// Load returns the config loaded from environment\nfunc Load() (*Config, error) {\n\tfilename, found := os.LookupEnv(DefaultEnvVar)\n\tif !found {\n\t\terr := fmt.Errorf(\"failed to locate file specified by %s\", DefaultEnvVar)\n\t\tlogging.L.Error(err.Error())\n\t\treturn nil, err\n\t}\n\n\tcfg, err := load(filename)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to load config with err %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn cfg, nil\n}\n\nfunc load(filename string) (*Config, error) {\n\tout := &Config{}\n\tbytes, err := ioutil.ReadFile(filename)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to read config file. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\terr = json.Unmarshal(bytes, out)\n\tif err != nil {\n\t\tlogging.L.Error(\"failed to parse config file. err : %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn out, nil\n}\n" }, { "path": "ch10/acme/internal/config/config_test.go", "content": "package config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoad(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin string\n\t\texpectedConfig *Config\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tin: \"../../../../default-config.json\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tDSN: \"[insert your db config here]\",\n\t\t\t\tAddress: \"0.0.0.0:8080\",\n\t\t\t\tBasePrice: 100.00,\n\t\t\t\tExchangeRateBaseURL: \"http://apilayer.net\",\n\t\t\t\tExchangeRateAPIKey: \"[insert your API key here]\",\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"invalid path\",\n\t\t\tin: \"invalid.json\",\n\t\t\texpectedConfig: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\tresult, resultErr := load(scenario.in)\n\t\t\trequire.Equal(t, scenario.expectError, resultErr != nil, \"err: %s\", resultErr)\n\t\t\tassert.Equal(t, scenario.expectedConfig, result, scenario.desc)\n\t\t})\n\t}\n\n}\n" }, { "path": "ch10/acme/internal/logging/logging.go", "content": "package logging\n\nimport (\n\t\"fmt\"\n)\n\n// Logger is our standard interface\ntype Logger interface {\n\tDebug(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tError(message string, args ...interface{})\n}\n\n// L is the global instance of the logger\nvar L = &LoggerStdOut{}\n\n// LoggerStdOut logs to std out\ntype LoggerStdOut struct{}\n\n// Debug logs messages at DEBUG level\nfunc (l LoggerStdOut) Debug(message string, args ...interface{}) {\n\tfmt.Printf(\"[DEBUG] \"+message, args...)\n}\n\n// Info logs messages at INFO level\nfunc (l LoggerStdOut) Info(message string, args ...interface{}) {\n\tfmt.Printf(\"[INFO] \"+message, args...)\n}\n\n// Warn logs messages at WARN level\nfunc (l LoggerStdOut) Warn(message string, args ...interface{}) {\n\tfmt.Printf(\"[WARN] \"+message, args...)\n}\n\n// Error logs messages at ERROR level\nfunc (l LoggerStdOut) Error(message string, args ...interface{}) {\n\tfmt.Printf(\"[ERROR] \"+message, args...)\n}\n" }, { "path": "ch10/acme/internal/modules/data/dao.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"time\"\n)\n\n// NewDAO will initialize the database connection pool (if not already done) and return a data access object which\n// can be used to interact with the database\nfunc NewDAO(cfg Config) *DAO {\n\t// initialize the db connection pool\n\t_, _ = getDB(cfg)\n\n\treturn &DAO{\n\t\tcfg: cfg,\n\t}\n}\n\n// DAO is a data access object that provides an abstraction over our database interactions.\ntype DAO struct {\n\tcfg Config\n\n\t// Tracker is an optional query timer\n\tTracker QueryTracker\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Load(ctx context.Context, ID int) (*Person, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"Load\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trow := db.QueryRowContext(subCtx, sqlLoadByID, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\td.cfg.Logger().Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\td.cfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) LoadAll(ctx context.Context) ([]*Person, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"LoadAll\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trows, err := db.QueryContext(subCtx, sqlLoadAll)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\td.cfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\td.cfg.Logger().Warn(\"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Save(ctx context.Context, in *Person) (int, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"Save\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB insert\n\tresult, err := db.ExecContext(subCtx, sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn int(id), nil\n}\n\nfunc (d *DAO) getTracker() QueryTracker {\n\tif d.Tracker == nil {\n\t\td.Tracker = &noopTracker{}\n\t}\n\n\treturn d.Tracker\n}\n" }, { "path": "ch10/acme/internal/modules/data/data.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tsqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\n// Config is the configuration for the data package\ntype Config interface {\n\t// Logger returns a reference to the logger\n\tLogger() logging.Logger\n\n\t// DataDSN returns the data source name\n\tDataDSN() string\n}\n\nvar getDB = func(cfg Config) (*sql.DB, error) {\n\tif db == nil {\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", cfg.DataDSN())\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n" }, { "path": "ch10/acme/internal/modules/data/data_test.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_insertError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnError(errors.New(\"failed to insert\"))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\n\t// validate result\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_getDBError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patching starts here\n\tdefer func(original func(_ Config) (*sql.DB, error)) {\n\t\t// restore original DB (after test)\n\t\tgetDB = original\n\t}(getDB)\n\n\t// replace getDB() function for this test\n\tgetDB = func(_ Config) (*sql.DB, error) {\n\t\treturn nil, errors.New(\"getDB() failed\")\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n}\n\nfunc TestLoadAll_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResults []*Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(1, \"John\", \"0123456789\", \"AUD\", 12.34))\n\t\t\t},\n\t\t\texpectedResults: []*Person{\n\t\t\t\t{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"AUD\",\n\t\t\t\t\tPrice: 12.34,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResults: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey patch the db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tdao := NewDAO(&testConfig{})\n\t\tresults, err := dao.LoadAll(ctx)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResults, results, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\nfunc TestLoad_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResult *Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\t\t\t},\n\t\t\texpectedResult: &Person{\n\t\t\t\tID: 2,\n\t\t\t\tFullName: \"Paul\",\n\t\t\t\tPhone: \"0123456789\",\n\t\t\t\tCurrency: \"CAD\",\n\t\t\t\tPrice: 23.45,\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResult: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tdao := NewDAO(&testConfig{})\n\t\tresult, err := dao.Load(ctx, 2)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResult, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n\ntype testConfig struct{}\n\n// Logger implements Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn logging.LoggerStdOut{}\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n" }, { "path": "ch10/acme/internal/modules/data/tracker.go", "content": "package data\n\nimport (\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n)\n\n// QueryTracker is an interface to track query timing\ntype QueryTracker interface {\n\t// Track will record/out the time a query took by calculating time.Now().Sub(start)\n\tTrack(key string, start time.Time)\n}\n\n// NO-OP implementation of QueryTracker\ntype noopTracker struct{}\n\n// Track implements QueryTracker\nfunc (_ *noopTracker) Track(_ string, _ time.Time) {\n\t// intentionally does nothing\n}\n\n// NewLogTracker returns a Tracker that outputs tracking data to log\nfunc NewLogTracker(logger logging.Logger) *LogTracker {\n\treturn &LogTracker{\n\t\tlogger: logger,\n\t}\n}\n\n// LogTracker implements QueryTracker and outputs to the supplied logger\ntype LogTracker struct {\n\tlogger logging.Logger\n}\n\n// Track implements QueryTracker\nfunc (l *LogTracker) Track(key string, start time.Time) {\n\tl.logger.Info(\"[%s] Timing: %s\\n\", key, time.Now().Sub(start).String())\n}\n" }, { "path": "ch10/acme/internal/modules/exchange/converter.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// NewConverter creates and initializes the converter\nfunc NewConverter(cfg Config) *Converter {\n\treturn &Converter{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the config for Converter\ntype Config interface {\n\tLogger() logging.Logger\n\tExchangeBaseURL() string\n\tExchangeAPIKey() string\n}\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct {\n\tcfg Config\n}\n\n// Exchange will perform the conversion\nfunc (c *Converter) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(ctx, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(ctx context.Context, currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tc.cfg.ExchangeBaseURL(),\n\t\tc.cfg.ExchangeAPIKey(),\n\t\tcurrency)\n\n\t// perform request\n\treq, err := http.NewRequest(\"GET\", url, nil)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to create request. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the upstream call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// replace the default context with our custom one\n\treq = req.WithContext(subCtx)\n\n\t// perform the HTTP request\n\tresponse, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tc.logger().Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tc.logger().Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\nfunc (c *Converter) logger() logging.Logger {\n\treturn c.cfg.Logger()\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n" }, { "path": "ch10/acme/internal/modules/exchange/converter_ext_bounday_test.go", "content": "// +build external\n\npackage exchange\n\nimport (\n\t\"context\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestExternalBoundaryTest(t *testing.T) {\n\t// define the config\n\tcfg, err := config.Load()\n\trequire.NoError(t, err)\n\n\t// create a converter to test\n\tconverter := NewConverter(cfg)\n\n\t// fetch from the server\n\tresponse, err := converter.loadRateFromServer(context.Background(), \"AUD\")\n\trequire.NotNil(t, response)\n\trequire.NoError(t, err)\n\n\t// parse the response\n\tresultRate, err := converter.extractRate(response, \"AUD\")\n\trequire.NoError(t, err)\n\n\t// validate the result\n\tassert.True(t, resultRate > 0)\n}\n" }, { "path": "ch10/acme/internal/modules/exchange/converter_int_bounday_test.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestInternalBoundaryTest(t *testing.T) {\n\t// start our test server\n\tserver := httptest.NewServer(&happyExchangeRateService{})\n\tdefer server.Close()\n\n\t// define the config\n\tcfg := &testConfig{\n\t\tbaseURL: server.URL,\n\t\tapiKey: \"\",\n\t}\n\n\t// create a converter to test\n\tconverter := NewConverter(cfg)\n\tresultRate, resultErr := converter.Exchange(context.Background(), 100.00, \"AUD\")\n\n\t// validate the result\n\tassert.Equal(t, 101.01, resultRate)\n\tassert.NoError(t, resultErr)\n}\n\ntype happyExchangeRateService struct{}\n\n// ServeHTTP implements http.Handler\nfunc (*happyExchangeRateService) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\tpayload := []byte(`\n{\n \"success\":true,\n \"historical\":true,\n \"date\":\"2010-11-09\",\n \"timestamp\":1289347199,\n \"source\":\"USD\",\n \"quotes\":{\n \"USDAUD\":0.989981\n }\n}`)\n\tresponse.Write(payload)\n}\n\n// test implementation of Config\ntype testConfig struct {\n\tbaseURL string\n\tapiKey string\n}\n\n// Logger implements Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// ExchangeBaseURL implements Config\nfunc (t *testConfig) ExchangeBaseURL() string {\n\treturn t.baseURL\n}\n\n// ExchangeAPIKey implements Config\nfunc (t *testConfig) ExchangeAPIKey() string {\n\treturn t.apiKey\n}\n" }, { "path": "ch10/acme/internal/modules/get/get.go", "content": "package get\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when the requested person is not in the database\n\terrPersonNotFound = errors.New(\"person not found\")\n)\n\n// NewGetter creates and initializes a Getter\nfunc NewGetter(cfg Config) *Getter {\n\treturn &Getter{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the configuration for Getter\ntype Config interface {\n\tLogger() logging.Logger\n\tDataDSN() string\n}\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n\tcfg Config\n\tdata myLoader\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*data.Person, error) {\n\t// load person from the data layer\n\tperson, err := g.getLoader().Load(context.TODO(), ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are hiding the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn person, err\n}\n\nfunc (g *Getter) getLoader() myLoader {\n\tif g.data == nil {\n\t\tg.data = data.NewDAO(g.cfg)\n\t}\n\n\treturn g.data\n}\n\n//go:generate mockery -name=myLoader -case underscore -testonly -inpkg -note @generated\ntype myLoader interface {\n\tLoad(ctx context.Context, ID int) (*data.Person, error)\n}\n" }, { "path": "ch10/acme/internal/modules/get/go_test.go", "content": "package get\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetter_Do_happyPath(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// configure the mock loader\n\tmockResult := &data.Person{\n\t\tID: 1234,\n\t\tFullName: \"Doug\",\n\t}\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(mockResult, nil).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, ID, person.ID)\n\tassert.Equal(t, \"Doug\", person.FullName)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestGetter_Do_noSuchPerson(t *testing.T) {\n\t// inputs\n\tID := 5678\n\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(nil, data.ErrNotFound).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Equal(t, errPersonNotFound, err)\n\tassert.Nil(t, person)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestGetter_Do_error(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(nil, errors.New(\"something failed\")).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Nil(t, person)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n" }, { "path": "ch10/acme/internal/modules/get/mock_my_loader_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage get\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMyLoader is an autogenerated mock type for the myLoader type\ntype mockMyLoader struct {\n\tmock.Mock\n}\n\n// Load provides a mock function with given fields: ctx, ID\nfunc (_m *mockMyLoader) Load(ctx context.Context, ID int) (*data.Person, error) {\n\tret := _m.Called(ctx, ID)\n\n\tvar r0 *data.Person\n\tif rf, ok := ret.Get(0).(func(context.Context, int) *data.Person); ok {\n\t\tr0 = rf(ctx, ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, int) error); ok {\n\t\tr1 = rf(ctx, ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch10/acme/internal/modules/list/list.go", "content": "package list\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when there are no people in the database\n\terrPeopleNotFound = errors.New(\"no people found\")\n)\n\n// NewLister creates and initializes a Lister\nfunc NewLister(cfg Config) *Lister {\n\treturn &Lister{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the config for Lister\ntype Config interface {\n\tLogger() logging.Logger\n\tDataDSN() string\n}\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n\tcfg Config\n\tdata myLoader\n}\n\n// Exchange will load the people from the data layer\nfunc (l *Lister) Do() ([]*data.Person, error) {\n\t// load all people\n\tpeople, err := l.load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(people) == 0 {\n\t\t// special processing for 0 people returned\n\t\treturn nil, errPeopleNotFound\n\t}\n\n\treturn people, nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n\tpeople, err := l.getLoader().LoadAll(context.TODO())\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPeopleNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn people, nil\n}\n\nfunc (l *Lister) getLoader() myLoader {\n\tif l.data == nil {\n\t\tl.data = data.NewDAO(l.cfg)\n\n\t\t// temporarily add a log tracker\n\t\tl.data.(*data.DAO).Tracker = data.NewLogTracker(l.cfg.Logger())\n\t}\n\n\treturn l.data\n}\n\n//go:generate mockery -name=myLoader -case underscore -testonly -inpkg -note @generated\ntype myLoader interface {\n\tLoadAll(ctx context.Context) ([]*data.Person, error)\n}\n" }, { "path": "ch10/acme/internal/modules/list/list_test.go", "content": "package list\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLister_Do_happyPath(t *testing.T) {\n\t// configure the mock loader\n\tmockResult := []*data.Person{\n\t\t{\n\t\t\tID: 1234,\n\t\t\tFullName: \"Sally\",\n\t\t},\n\t\t{\n\t\t\tID: 5678,\n\t\t\tFullName: \"Jane\",\n\t\t},\n\t}\n\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(mockResult, nil).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestLister_Do_noResults(t *testing.T) {\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(nil, data.ErrNotFound).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Equal(t, errPeopleNotFound, err)\n\tassert.Equal(t, 0, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestLister_Do_error(t *testing.T) {\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n" }, { "path": "ch10/acme/internal/modules/list/mock_my_loader_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage list\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMyLoader is an autogenerated mock type for the myLoader type\ntype mockMyLoader struct {\n\tmock.Mock\n}\n\n// LoadAll provides a mock function with given fields: ctx\nfunc (_m *mockMyLoader) LoadAll(ctx context.Context) ([]*data.Person, error) {\n\tret := _m.Called(ctx)\n\n\tvar r0 []*data.Person\n\tif rf, ok := ret.Get(0).(func(context.Context) []*data.Person); ok {\n\t\tr0 = rf(ctx)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context) error); ok {\n\t\tr1 = rf(ctx)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch10/acme/internal/modules/register/mock_my_saver_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage register\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMySaver is an autogenerated mock type for the mySaver type\ntype mockMySaver struct {\n\tmock.Mock\n}\n\n// Save provides a mock function with given fields: ctx, in\nfunc (_m *mockMySaver) Save(ctx context.Context, in *data.Person) (int, error) {\n\tret := _m.Called(ctx, in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(context.Context, *data.Person) int); ok {\n\t\tr0 = rf(ctx, in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, *data.Person) error); ok {\n\t\tr1 = rf(ctx, in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch10/acme/internal/modules/register/register.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\t// validation errors\n\terrNameMissing = errors.New(\"name is missing\")\n\terrPhoneMissing = errors.New(\"phone is missing\")\n\terrCurrencyMissing = errors.New(\"currency is missing\")\n\terrInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n\t// a little trick to make checking for supported currencies easier\n\tsupportedCurrencies = map[string]struct{}{\n\t\t\"AUD\": {},\n\t\t\"CNY\": {},\n\t\t\"EUR\": {},\n\t\t\"GBP\": {},\n\t\t\"JPY\": {},\n\t\t\"MYR\": {},\n\t\t\"SGD\": {},\n\t\t\"USD\": {},\n\t}\n)\n\n// NewRegisterer creates and initializes a Registerer\nfunc NewRegisterer(cfg Config, exchanger Exchanger) *Registerer {\n\treturn &Registerer{\n\t\tcfg: cfg,\n\t\texchanger: exchanger,\n\t}\n}\n\n// Exchanger will convert from one currency to another\ntype Exchanger interface {\n\t// Exchange will perform the conversion\n\tExchange(ctx context.Context, basePrice float64, currency string) (float64, error)\n}\n\n// Config is the configuration for the Registerer\ntype Config interface {\n\tLogger() logging.Logger\n\tRegistrationBasePrice() float64\n\tDataDSN() string\n}\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n\tcfg Config\n\texchanger Exchanger\n\tdata mySaver\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(ctx context.Context, in *data.Person) (int, error) {\n\t// validate the request\n\terr := r.validateInput(in)\n\tif err != nil {\n\t\tr.logger().Warn(\"input validation failed with err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// get price in the requested currency\n\tprice, err := r.getPrice(ctx, in.Currency)\n\tif err != nil {\n\t\treturn defaultPersonID, err\n\t}\n\n\t// save registration\n\tid, err := r.save(ctx, in, price)\n\tif err != nil {\n\t\t// no need to log here as we expect the data layer to do so\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *data.Person) error {\n\tif in.FullName == \"\" {\n\t\treturn errNameMissing\n\t}\n\tif in.Phone == \"\" {\n\t\treturn errPhoneMissing\n\t}\n\tif in.Currency == \"\" {\n\t\treturn errCurrencyMissing\n\t}\n\n\tif _, found := supportedCurrencies[in.Currency]; !found {\n\t\treturn errInvalidCurrency\n\t}\n\n\t// happy path\n\treturn nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(ctx context.Context, currency string) (float64, error) {\n\tprice, err := r.exchanger.Exchange(ctx, r.cfg.RegistrationBasePrice(), currency)\n\tif err != nil {\n\t\tr.logger().Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(ctx context.Context, in *data.Person, price float64) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tCurrency: in.Currency,\n\t\tPrice: price,\n\t}\n\treturn r.getSaver().Save(ctx, person)\n}\n\nfunc (r *Registerer) getSaver() mySaver {\n\tif r.data == nil {\n\t\tr.data = data.NewDAO(r.cfg)\n\t}\n\n\treturn r.data\n}\n\nfunc (r *Registerer) logger() logging.Logger {\n\treturn r.cfg.Logger()\n}\n\n//go:generate mockery -name=mySaver -case underscore -testonly -inpkg -note @generated\ntype mySaver interface {\n\tSave(ctx context.Context, in *data.Person) (int, error)\n}\n" }, { "path": "ch10/acme/internal/modules/register/register_test.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterer_Do_happyPath(t *testing.T) {\n\t// configure the mock saver\n\tmockResult := 888\n\n\tmockSaver := &mockMySaver{}\n\tmockSaver.On(\"Save\", mock.Anything, mock.Anything).Return(mockResult, nil).Once()\n\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: &stubExchanger{},\n\t\tdata: mockSaver,\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 888, ID)\n\tassert.True(t, mockSaver.AssertExpectations(t))\n}\n\nfunc TestRegisterer_Do_error(t *testing.T) {\n\t// configure the mock saver\n\tmockSaver := &mockMySaver{}\n\tmockSaver.On(\"Save\", mock.Anything, mock.Anything).Return(0, errors.New(\"something failed\")).Once()\n\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// inputs\n\tin := &data.Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: &stubExchanger{},\n\t\tdata: mockSaver,\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, ID)\n\tassert.True(t, mockSaver.AssertExpectations(t))\n}\n\n// Stub implementation of Config\ntype testConfig struct{}\n\n// Logger implement Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// RegistrationBasePrice implement Config\nfunc (t *testConfig) RegistrationBasePrice() float64 {\n\treturn 12.34\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n\ntype stubExchanger struct{}\n\n// Exchange implements Exchanger\nfunc (s stubExchanger) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\treturn 12.34, nil\n}\n" }, { "path": "ch10/acme/internal/rest/get.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// key in the mux where the ID is stored\n\tmuxVarID = \"id\"\n)\n\n// GetModel will load a registration\n//go:generate mockery -name=GetModel -case underscore -testonly -inpkg -note @generated\ntype GetModel interface {\n\tDo(ID int) (*data.Person, error)\n}\n\n// GetConfig is the config for the Get Handler\ntype GetConfig interface {\n\tLogger() logging.Logger\n}\n\n// NewGetHandler is the constructor for GetHandler\nfunc NewGetHandler(cfg GetConfig, model GetModel) *GetHandler {\n\treturn &GetHandler{\n\t\tcfg: cfg,\n\t\tgetter: model,\n\t}\n}\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n\tcfg GetConfig\n\tgetter GetModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tperson, err := h.getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[muxVarID]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\th.cfg.Logger().Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\th.cfg.Logger().Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *data.Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n" }, { "path": "ch10/acme/internal/rest/get_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/gorilla/mux\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockGetModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\toutput := &data.Person{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"USD\",\n\t\t\t\t\tPrice: 100,\n\t\t\t\t}\n\n\t\t\t\tmockGetModel := &MockGetModel{}\n\t\t\t\tmockGetModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockGetModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\",\"currency\":\"USD\",\"price\":100}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is invalid)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/x/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"x\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is missing)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person//\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency fail\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"requested registration does not exist\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"person not found\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockGetModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewGetHandler(&testConfig{}, mockGetModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\t\t})\n\t}\n}\n\ntype testConfig struct {\n}\n\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\nfunc (*testConfig) BindAddress() string {\n\treturn \"0.0.0.0:0\"\n}\n" }, { "path": "ch10/acme/internal/rest/list.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n)\n\n// ListModel will load all registrations\n//go:generate mockery -name=ListModel -case underscore -testonly -inpkg -note @generated\ntype ListModel interface {\n\tDo() ([]*data.Person, error)\n}\n\n// NewLister is the constructor for ListHandler\nfunc NewListHandler(model ListModel) *ListHandler {\n\treturn &ListHandler{\n\t\tlister: model,\n\t}\n}\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n\tlister ListModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// attempt loadAll\n\tpeople, err := h.lister.Do()\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, people)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*data.Person) error {\n\toutput := &listResponseFormat{\n\t\tPeople: make([]*listResponseItemFormat, len(people)),\n\t}\n\n\tfor index, record := range people {\n\t\toutput.People[index] = &listResponseItemFormat{\n\t\t\tID: record.ID,\n\t\t\tFullName: record.FullName,\n\t\t\tPhone: record.Phone,\n\t\t}\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n\tPeople []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n}\n" }, { "path": "ch10/acme/internal/rest/list_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestListHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockListModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\toutput := []*data.Person{\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 2,\n\t\t\t\t\t\tFullName: \"Paul\",\n\t\t\t\t\t\tPhone: \"0123456781\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 3,\n\t\t\t\t\t\tFullName: \"George\",\n\t\t\t\t\t\tPhone: \"0123456782\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"Ringo\",\n\t\t\t\t\t\tPhone: \"0123456783\",\n\t\t\t\t\t},\n\t\t\t\t}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\"},{\"id\":2,\"name\":\"Paul\",\"phone\":\"0123456781\"},{\"id\":3,\"name\":\"George\",\"phone\":\"0123456782\"},{\"id\":1,\"name\":\"Ringo\",\"phone\":\"0123456783\"}]}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"no data\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\t// no data\n\t\t\t\toutput := []*data.Person{}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[]}` + \"\\n\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockListModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewListHandler(mockListModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\n\t\t})\n\t}\n}\n" }, { "path": "ch10/acme/internal/rest/mock_get_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockGetModel is an autogenerated mock type for the GetModel type\ntype MockGetModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ID\nfunc (_m *MockGetModel) Do(ID int) (*data.Person, error) {\n\tret := _m.Called(ID)\n\n\tvar r0 *data.Person\n\tif rf, ok := ret.Get(0).(func(int) *data.Person); ok {\n\t\tr0 = rf(ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(int) error); ok {\n\t\tr1 = rf(ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch10/acme/internal/rest/mock_list_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockListModel is an autogenerated mock type for the ListModel type\ntype MockListModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields:\nfunc (_m *MockListModel) Do() ([]*data.Person, error) {\n\tret := _m.Called()\n\n\tvar r0 []*data.Person\n\tif rf, ok := ret.Get(0).(func() []*data.Person); ok {\n\t\tr0 = rf()\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func() error); ok {\n\t\tr1 = rf()\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch10/acme/internal/rest/mock_register_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockRegisterModel is an autogenerated mock type for the RegisterModel type\ntype MockRegisterModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ctx, in\nfunc (_m *MockRegisterModel) Do(ctx context.Context, in *data.Person) (int, error) {\n\tret := _m.Called(ctx, in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(context.Context, *data.Person) int); ok {\n\t\tr0 = rf(ctx, in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, *data.Person) error); ok {\n\t\tr1 = rf(ctx, in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch10/acme/internal/rest/not_found.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n" }, { "path": "ch10/acme/internal/rest/not_found_test.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNotFoundHandler_ServeHTTP(t *testing.T) {\n\t// build inputs\n\tresponse := httptest.NewRecorder()\n\trequest := &http.Request{}\n\n\t// call handler\n\tnotFoundHandler(response, request)\n\n\t// validate outputs\n\trequire.Equal(t, http.StatusNotFound, response.Code)\n}\n" }, { "path": "ch10/acme/internal/rest/register.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/data\"\n)\n\n// RegisterModel will validate and save a registration\n//go:generate mockery -name=RegisterModel -case underscore -testonly -inpkg -note @generated\ntype RegisterModel interface {\n\tDo(ctx context.Context, in *data.Person) (int, error)\n}\n\n// NewRegisterHandler is the constructor for RegisterHandler\nfunc NewRegisterHandler(model RegisterModel) *RegisterHandler {\n\treturn &RegisterHandler{\n\t\tregisterer: model,\n\t}\n}\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n\tregisterer RegisterModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// set latency budget for this API\n\tsubCtx, cancel := context.WithTimeout(request.Context(), 1500*time.Millisecond)\n\tdefer cancel()\n\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// call the business logic using the request data and context\n\tid, err := h.register(subCtx, requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(ctx context.Context, requestPayload *registerRequest) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\treturn h.registerer.Do(ctx, person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch10/acme/internal/rest/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockRegisterModel\n\t\texpectedStatus int\n\t\texpectedHeader string\n\t}{\n\t\t{\n\t\t\tdesc: \"Happy Path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// valid downstream configuration\n\t\t\t\tresultID := 1234\n\t\t\t\tvar resultErr error\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(resultID, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusCreated,\n\t\t\texpectedHeader: \"/person/1234/\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Bad Input / User Error\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tinvalidRequest := bytes.NewBufferString(`this is not valid JSON`)\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", invalidRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// Dependency should not be called\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Dependency Failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// call to the dependency failed\n\t\t\t\tresultErr := errors.New(\"something failed\")\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(0, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockRegisterModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewRegisterHandler(mockRegisterModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code)\n\n\t\t\t// call should output the location to the new person\n\t\t\tresultHeader := response.Header().Get(\"Location\")\n\t\t\tassert.Equal(t, scenario.expectedHeader, resultHeader)\n\n\t\t\t// validate the mock was used as we expected\n\t\t\tassert.True(t, mockRegisterModel.AssertExpectations(t))\n\t\t})\n\t}\n}\n\nfunc buildValidRegisterRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch10/acme/internal/rest/server.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/logging\"\n\t\"github.com/gorilla/mux\"\n)\n\n// Config is the config for the REST package\ntype Config interface {\n\tLogger() logging.Logger\n\tBindAddress() string\n}\n\n// New will create and initialize the server\nfunc New(cfg Config,\n\tgetModel GetModel,\n\tlistModel ListModel,\n\tregisterModel RegisterModel) *Server {\n\n\treturn &Server{\n\t\taddress: cfg.BindAddress(),\n\t\thandlerGet: NewGetHandler(cfg, getModel),\n\t\thandlerList: NewListHandler(listModel),\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: NewRegisterHandler(registerModel),\n\t}\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n\taddress string\n\tserver *http.Server\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n\trouter := s.buildRouter()\n\n\t// create the HTTP server\n\ts.server = &http.Server{\n\t\tHandler: router,\n\t\tAddr: s.address,\n\t}\n\n\t// listen for shutdown\n\tgo func() {\n\t\t// wait for shutdown signal\n\t\t<-stop\n\n\t\t_ = s.server.Close()\n\t}()\n\n\t// start the HTTP server\n\t_ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n\trouter := mux.NewRouter()\n\n\t// map URL endpoints to HTTP handlers\n\trouter.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n\trouter.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n\trouter.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n\t// convert a \"catch all\" not found handler\n\trouter.NotFoundHandler = s.handlerNotFound\n\n\treturn router\n}\n" }, { "path": "ch10/acme/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// start REST server\n\tserver, err := initializeServer()\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\tserver.Listen(ctx.Done())\n}\n\n// List of wire enabled objects\nvar wireSetWithoutConfig = wire.NewSet(\n\t// *exchange.Converter\n\texchange.NewConverter,\n\n\t// *get.Getter\n\tget.NewGetter,\n\n\t// *list.Lister\n\tlist.NewLister,\n\n\t// *register.Registerer\n\twire.Bind(new(register.Exchanger), &exchange.Converter{}),\n\tregister.NewRegisterer,\n\n\t// *rest.Server\n\twire.Bind(new(rest.GetModel), &get.Getter{}),\n\twire.Bind(new(rest.ListModel), &list.Lister{}),\n\twire.Bind(new(rest.RegisterModel), ®ister.Registerer{}),\n\trest.New,\n)\n\nvar wireSet = wire.NewSet(\n\twireSetWithoutConfig,\n\n\t// *config.Config\n\tconfig.Load,\n\n\t// *exchange.Converter\n\twire.Bind(new(exchange.Config), &config.Config{}),\n\n\t// *get.Getter\n\twire.Bind(new(get.Config), &config.Config{}),\n\n\t// *list.Lister\n\twire.Bind(new(list.Config), &config.Config{}),\n\n\t// *register.Registerer\n\twire.Bind(new(register.Config), &config.Config{}),\n\n\t// *rest.Server\n\twire.Bind(new(rest.Config), &config.Config{}),\n)\n" }, { "path": "ch10/acme/main_test.go", "content": "package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"net\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegister(t *testing.T) {\n\t// start a context with a max execution time\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// start test server\n\tserverAddress := startTestServer(t, ctx)\n\n\t// build and send request\n\tpayload := bytes.NewBufferString(`\n{\n\t\"fullName\": \"Bob\",\n\t\"phone\": \"0123456789\",\n\t\"currency\": \"AUD\"\n}\n`)\n\n\treq, err := http.NewRequest(\"POST\", serverAddress+\"/person/register\", payload)\n\trequire.NoError(t, err)\n\n\tresp, err := http.DefaultClient.Do(req)\n\trequire.NoError(t, err)\n\n\t// validate expectations\n\tassert.Equal(t, http.StatusCreated, resp.StatusCode)\n\tassert.NotEmpty(t, resp.Header.Get(\"Location\"))\n}\n\nfunc TestGet(t *testing.T) {\n\t// start a context with a max execution time\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// start test server\n\tserverAddress := startTestServer(t, ctx)\n\n\t// build and send request\n\treq, err := http.NewRequest(\"GET\", serverAddress+\"/person/1/\", nil)\n\trequire.NoError(t, err)\n\n\tresp, err := http.DefaultClient.Do(req)\n\trequire.NoError(t, err)\n\n\t// validate expectations\n\tassert.Equal(t, http.StatusOK, resp.StatusCode)\n}\n\nfunc TestList(t *testing.T) {\n\t// start a context with a max execution time\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// start test server\n\tserverAddress := startTestServer(t, ctx)\n\n\t// build and send request\n\treq, err := http.NewRequest(\"GET\", serverAddress+\"/person/list\", nil)\n\trequire.NoError(t, err)\n\n\tresp, err := http.DefaultClient.Do(req)\n\trequire.NoError(t, err)\n\n\t// validate expectations\n\tassert.Equal(t, http.StatusOK, resp.StatusCode)\n}\n\nfunc startTestServer(t *testing.T, ctx context.Context) string {\n\t// load the standard config (from the ENV)\n\tcfg, err := config.Load()\n\trequire.NoError(t, err)\n\n\t// get a free port (so tests can run concurrently)\n\tport, err := getFreePort()\n\trequire.NoError(t, err)\n\n\t// override config port with free one\n\tcfg.Address = net.JoinHostPort(\"0.0.0.0\", port)\n\n\t// start the test server on a random port\n\tgo func() {\n\t\t// start REST server\n\t\tserver := initializeServerCustomConfig(cfg, cfg, cfg, cfg, cfg)\n\t\tserver.Listen(ctx.Done())\n\t}()\n\n\t// give the server a chance to start\n\t<-time.After(100 * time.Millisecond)\n\n\t// return the address of the test server\n\treturn \"http://\" + cfg.Address\n}\n\nfunc getFreePort() (string, error) {\n\tfor attempt := 0; attempt <= 10; attempt++ {\n\t\taddr := net.JoinHostPort(\"\", \"0\")\n\t\tlistener, err := net.Listen(\"tcp\", addr)\n\t\tif err != nil {\n\t\t\tcontinue\n\t\t}\n\n\t\tport, err := getPort(listener.Addr())\n\t\tif err != nil {\n\t\t\tcontinue\n\t\t}\n\n\t\t// close/free the port\n\t\ttcpListener := listener.(*net.TCPListener)\n\t\tcErr := tcpListener.Close()\n\t\tif cErr == nil {\n\t\t\tfile, fErr := tcpListener.File()\n\t\t\tif fErr == nil {\n\t\t\t\t// ignore any errors cleaning up the file\n\t\t\t\t_ = file.Close()\n\t\t\t}\n\t\t\treturn port, nil\n\t\t}\n\t}\n\n\treturn \"\", errors.New(\"no free ports\")\n}\n\nfunc getPort(addr fmt.Stringer) (string, error) {\n\tactualAddress := addr.String()\n\t_, port, err := net.SplitHostPort(actualAddress)\n\treturn port, err\n}\n" }, { "path": "ch10/acme/wire.go", "content": "//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeServer() (*rest.Server, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n\nfunc initializeServerCustomConfig(_ exchange.Config, _ get.Config, _ list.Config, _ register.Config, _ rest.Config) *rest.Server {\n\twire.Build(wireSetWithoutConfig)\n\treturn nil\n}\n" }, { "path": "ch10/acme/wire_gen.go", "content": "// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch10/acme/internal/rest\"\n)\n\n// Injectors from wire.go:\n\nfunc initializeServer() (*rest.Server, error) {\n\tconfigConfig, err := config.Load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tgetter := get.NewGetter(configConfig)\n\tlister := list.NewLister(configConfig)\n\tconverter := exchange.NewConverter(configConfig)\n\tregisterer := register.NewRegisterer(configConfig, converter)\n\tserver := rest.New(configConfig, getter, lister, registerer)\n\treturn server, nil\n}\n\nfunc initializeServerCustomConfig(exchangeConfig exchange.Config, getConfig get.Config, listConfig list.Config, registerConfig register.Config, restConfig rest.Config) *rest.Server {\n\tgetter := get.NewGetter(getConfig)\n\tlister := list.NewLister(listConfig)\n\tconverter := exchange.NewConverter(exchangeConfig)\n\tregisterer := register.NewRegisterer(registerConfig, converter)\n\tserver := rest.New(restConfig, getter, lister, registerer)\n\treturn server\n}\n" }, { "path": "ch10/fake.go", "content": "package ch10\n\nfunc init() {\n\t// This file is included so that Go tools (like `go list`) will find Go code in this directory and not error\n}\n" }, { "path": "ch11/01_di_induced_damage/01_long_param/01_long_param.go", "content": "package long_param\n\nimport (\n\t\"net/http\"\n\t\"time\"\n)\n\nfunc NewMyHandler(logger Logger, stats Instrumentation,\n\tparser Parser, formatter Formatter,\n\tlimiter RateLimiter,\n\tcache Cache, db Datastore) *MyHandler {\n\n\treturn &MyHandler{\n\t\t// code removed\n\t}\n}\n\n// MyHandler does something fantastic\ntype MyHandler struct {\n\t// code removed\n}\n\nfunc (m *MyHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// code removed\n}\n\n// Logger logs stuff\ntype Logger interface {\n\tError(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tDebug(message string, args ...interface{})\n}\n\n// Instrumentation records the performances and events\ntype Instrumentation interface {\n\tCount(key string, value int)\n\tDuration(key string, start time.Time)\n}\n\n// Parse will extract details from the request\ntype Parser interface {\n\tExtract(req *http.Request) (int, error)\n}\n\n// Formatter will build the output\ntype Formatter interface {\n\tFormat(resp http.ResponseWriter, data []byte) error\n}\n\n// RateLimiter limits how many concurrent requests we can make or process\ntype RateLimiter interface {\n\tAcquire()\n\tRelease()\n}\n\n// Datastore will store/retrieve data in a permanent\ntype Datastore interface {\n\tLoad(ID int) ([]byte, error)\n}\n\n// Cache will store/retrieve data in a fast way\ntype Cache interface {\n\tStore(key string, data []byte)\n\tGet(key string) ([]byte, error)\n}\n" }, { "path": "ch11/01_di_induced_damage/02_long_param/01_long_param.go", "content": "package long_param\n\nimport (\n\t\"net/http\"\n\t\"time\"\n)\n\nfunc NewMyHandler(logger Logger, stats Instrumentation,\n\tparser Parser, formatter Formatter,\n\tlimiter RateLimiter,\n\tloader Loader) *MyHandler {\n\n\treturn &MyHandler{\n\t\t// code removed\n\t}\n}\n\n// MyHandler does something fantastic\ntype MyHandler struct {\n\t// code removed\n}\n\nfunc (m *MyHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// code removed\n}\n\n// Logger logs stuff\ntype Logger interface {\n\tError(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tDebug(message string, args ...interface{})\n}\n\n// Instrumentation records the performances and events\ntype Instrumentation interface {\n\tCount(key string, value int)\n\tDuration(key string, start time.Time)\n}\n\n// Parse will extract details from the request\ntype Parser interface {\n\tExtract(req *http.Request) (int, error)\n}\n\n// Formatter will build the output\ntype Formatter interface {\n\tFormat(resp http.ResponseWriter, data []byte) error\n}\n\n// RateLimiter limits how many concurrent requests we can make or process\ntype RateLimiter interface {\n\tAcquire()\n\tRelease()\n}\n\n// Loader is responsible for loading the data\ntype Loader interface {\n\tLoad(ID int) ([]byte, error)\n}\n" }, { "path": "ch11/01_di_induced_damage/03_long_param/01_long_param.go", "content": "package long_param\n\nimport (\n\t\"net/http\"\n\t\"time\"\n)\n\nfunc NewMyHandler(config Config,\n\tparser Parser, formatter Formatter,\n\tlimiter RateLimiter,\n\tloader Loader) *MyHandler {\n\n\treturn &MyHandler{\n\t\tconfig: config,\n\t\tparser: parser,\n\t\tformatter: formatter,\n\t\tlimiter: limiter,\n\t\tloader: loader,\n\t}\n}\n\n// MyHandler does something fantastic\ntype MyHandler struct {\n\tconfig Config\n\tparser Parser\n\tformatter Formatter\n\tlimiter RateLimiter\n\tloader Loader\n}\n\nfunc (m *MyHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\tID, err := m.parser.Extract(request)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tdata, err := m.loader.Load(ID)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\terr = m.formatter.Format(response, data)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n}\n\n// Config combines environmental concerns like logging and instrumentation with any other config\ntype Config interface {\n\tLogger() Logger\n\tInstrumentation() Instrumentation\n}\n\n// Logger logs stuff\ntype Logger interface {\n\tError(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tDebug(message string, args ...interface{})\n}\n\n// Instrumentation records the performances and events\ntype Instrumentation interface {\n\tCount(key string, value int)\n\tDuration(key string, start time.Time)\n}\n\n// Parse will extract details from the request\ntype Parser interface {\n\tExtract(req *http.Request) (int, error)\n}\n\n// Formatter will build the output\ntype Formatter interface {\n\tFormat(resp http.ResponseWriter, data []byte) error\n}\n\n// RateLimiter limits how many concurrent requests we can make or process\ntype RateLimiter interface {\n\tAcquire()\n\tRelease()\n}\n\n// Loader is responsible for loading the data\ntype Loader interface {\n\tLoad(ID int) ([]byte, error)\n}\n" }, { "path": "ch11/01_di_induced_damage/04_long_param/01_long_param.go", "content": "package long_param\n\nimport (\n\t\"net/http\"\n\t\"time\"\n)\n\nfunc NewFancyFormatHandler(config Config,\n\tparser Parser,\n\tlimiter RateLimiter,\n\tloader Loader) *FancyFormatHandler {\n\n\treturn &FancyFormatHandler{\n\t\t&MyHandler{\n\t\t\tconfig: config,\n\t\t\tformatter: &FancyFormatter{},\n\t\t\tparser: parser,\n\t\t\tlimiter: limiter,\n\t\t\tloader: loader,\n\t\t},\n\t}\n}\n\n// FancyFormatHandler does something fancy\ntype FancyFormatHandler struct {\n\t*MyHandler\n}\n\n// MyHandler does something fantastic\ntype MyHandler struct {\n\tconfig Config\n\tparser Parser\n\tformatter Formatter\n\tlimiter RateLimiter\n\tloader Loader\n}\n\nfunc (m *MyHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\tID, err := m.parser.Extract(request)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\tdata, err := m.loader.Load(ID)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\n\terr = m.formatter.Format(response, data)\n\tif err != nil {\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n}\n\n// Config combines environmental concerns like logging and instrumentation with any other config\ntype Config interface {\n\tLogger() Logger\n\tInstrumentation() Instrumentation\n}\n\n// Logger logs stuff\ntype Logger interface {\n\tError(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tDebug(message string, args ...interface{})\n}\n\n// Instrumentation records the performances and events\ntype Instrumentation interface {\n\tCount(key string, value int)\n\tDuration(key string, start time.Time)\n}\n\n// Parse will extract details from the request\ntype Parser interface {\n\tExtract(req *http.Request) (int, error)\n}\n\n// Formatter will build the output\ntype Formatter interface {\n\tFormat(resp http.ResponseWriter, data []byte) error\n}\n\n// FancyFormatter Implements Formatter\ntype FancyFormatter struct{}\n\nfunc (f *FancyFormatter) Format(response http.ResponseWriter, data []byte) error {\n\t// does something fancy with the data\n\t_, err := response.Write([]byte(`something fancy!`))\n\treturn err\n}\n\n// RateLimiter limits how many concurrent requests we can make or process\ntype RateLimiter interface {\n\tAcquire()\n\tRelease()\n}\n\n// Loader is responsible for loading the data\ntype Loader interface {\n\tLoad(ID int) ([]byte, error)\n}\n" }, { "path": "ch11/01_di_induced_damage/04_long_param/01_long_param_test.go", "content": "package long_param\n\nimport (\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestNewFancyFormatHandler(t *testing.T) {\n\t// inputs\n\tconfig := &stubConfig{}\n\tparser := &stubParser{}\n\tlimiter := &stubRateLimiter{}\n\tloader := &stubLoader{}\n\n\t// create the handler\n\tfancyHandler := NewFancyFormatHandler(config, parser, limiter, loader)\n\n\t// call with fake HTTP request\n\tresponse := httptest.NewRecorder()\n\trequest := &http.Request{}\n\tfancyHandler.ServeHTTP(response, request)\n\n\t// validate result\n\tassert.Equal(t, http.StatusOK, response.Code)\n\tassert.Equal(t, \"something fancy!\", response.Body.String())\n}\n\n// define some mock implementations so that our test can run\ntype stubConfig struct{}\n\nfunc (s *stubConfig) Logger() Logger {\n\treturn &stubLogger{}\n}\n\nfunc (s *stubConfig) Instrumentation() Instrumentation {\n\treturn &stubInstrumentation{}\n}\n\ntype stubLogger struct{}\n\nfunc (s *stubLogger) Error(message string, args ...interface{}) {\n\t// do nothing\n}\n\nfunc (s *stubLogger) Warn(message string, args ...interface{}) {\n\t// do nothing\n}\n\nfunc (s *stubLogger) Info(message string, args ...interface{}) {\n\t// do nothing\n}\n\nfunc (s *stubLogger) Debug(message string, args ...interface{}) {\n\t// do nothing\n}\n\ntype stubInstrumentation struct{}\n\nfunc (s *stubInstrumentation) Count(key string, value int) {\n\t// do nothing\n}\n\nfunc (s *stubInstrumentation) Duration(key string, start time.Time) {\n\t// do nothing\n}\n\ntype stubParser struct{}\n\nfunc (s *stubParser) Extract(req *http.Request) (int, error) {\n\treturn 1, nil\n}\n\ntype stubRateLimiter struct{}\n\nfunc (s *stubRateLimiter) Acquire() {\n\t// do nothing\n}\n\nfunc (s *stubRateLimiter) Release() {\n\t// do nothing\n}\n\ntype stubLoader struct{}\n\nfunc (s *stubLoader) Load(ID int) ([]byte, error) {\n\treturn []byte(`some data`), nil\n}\n" }, { "path": "ch11/01_di_induced_damage/05_inject_sql/01_interface.go", "content": "package inject_vs_config\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n)\n\ntype Connection interface {\n\tQueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row\n\tQueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)\n\tExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)\n}\n" }, { "path": "ch11/01_di_induced_damage/06_inject_sql/01_interface.go", "content": "package data\n\nimport (\n\t\"context\"\n)\n\ntype Database interface {\n\tQueryRowContext(ctx context.Context, query string, args ...interface{}) Row\n\tQueryContext(ctx context.Context, query string, args ...interface{}) (Rows, error)\n\tExecContext(ctx context.Context, query string, args ...interface{}) (Result, error)\n}\n\ntype Row interface {\n\tScan(dest ...interface{}) error\n}\n\ntype Rows interface {\n\tScan(dest ...interface{}) error\n\tClose() error\n\tNext() bool\n}\n\ntype Result interface {\n\tLastInsertId() (int64, error)\n\tRowsAffected() (int64, error)\n}\n" }, { "path": "ch11/01_di_induced_damage/06_inject_sql/02_implementation.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n)\n\ntype DatabaseImpl struct {\n\tdb *sql.DB\n}\n\nfunc (c *DatabaseImpl) QueryRowContext(ctx context.Context, query string, args ...interface{}) Row {\n\treturn c.db.QueryRowContext(ctx, query, args...)\n}\n\nfunc (c *DatabaseImpl) QueryContext(ctx context.Context, query string, args ...interface{}) (Rows, error) {\n\treturn c.db.QueryContext(ctx, query, args...)\n}\n\nfunc (c *DatabaseImpl) ExecContext(ctx context.Context, query string, args ...interface{}) (Result, error) {\n\treturn c.db.ExecContext(ctx, query, args...)\n}\n\ntype RowImpl struct {\n\trow *sql.Row\n}\n\nfunc (r *RowImpl) Scan(dest ...interface{}) error {\n\treturn r.row.Scan(dest...)\n}\n\ntype RowsImpl struct {\n\trows *sql.Rows\n}\n\nfunc (r RowsImpl) Scan(dest ...interface{}) error {\n\treturn r.rows.Scan(dest...)\n}\n\nfunc (r RowsImpl) Close() error {\n\treturn r.rows.Close()\n}\n\nfunc (r RowsImpl) Next() bool {\n\treturn r.rows.Next()\n}\n\ntype ResultImpl struct {\n\tresult sql.Result\n}\n\nfunc (r *ResultImpl) LastInsertId() (int64, error) {\n\treturn r.result.LastInsertId()\n}\n\nfunc (r *ResultImpl) RowsAffected() (int64, error) {\n\treturn r.result.RowsAffected()\n}\n" }, { "path": "ch11/01_di_induced_damage/06_inject_sql/02_implementation_test.go", "content": "package data\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestImplements(t *testing.T) {\n\tassert.Implements(t, (*Database)(nil), &DatabaseImpl{})\n\tassert.Implements(t, (*Row)(nil), &RowImpl{})\n\tassert.Implements(t, (*Rows)(nil), &RowsImpl{})\n\tassert.Implements(t, (*Result)(nil), &ResultImpl{})\n}\n" }, { "path": "ch11/01_di_induced_damage/06_inject_sql/dao.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"fmt\"\n\t\"os\"\n\t\"time\"\n)\n\n// NewDAO will initialize the database connection pool (if not already done) and return a data access object which\n// can be used to interact with the database\nfunc NewDAO(cfg Config) *DAO {\n\t// initialize the db connection pool\n\t_, _ = getDB(cfg)\n\n\treturn &DAO{\n\t\tcfg: cfg,\n\t}\n}\n\n// DAO is a data access object that provides an abstraction over our database interactions.\ntype DAO struct {\n\tcfg Config\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Load(ctx context.Context, ID int) (*Person, error) {\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trow := db.QueryRowContext(subCtx, sqlLoadByID, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\tfmt.Fprintf(os.Stderr, \"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\tfmt.Fprintf(os.Stderr, \"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) LoadAll(ctx context.Context) ([]*Person, error) {\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trows, err := db.QueryContext(subCtx, sqlLoadAll)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\tfmt.Fprintf(os.Stderr, \"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\tfmt.Fprintf(os.Stderr, \"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Save(ctx context.Context, in *Person) (int, error) {\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB insert\n\tresult, err := db.ExecContext(subCtx, sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn int(id), nil\n}\n" }, { "path": "ch11/01_di_induced_damage/06_inject_sql/data.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tsqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\n// Config is the configuration for the data package\ntype Config interface {\n\t// DataDSN returns the data source name\n\tDataDSN() string\n}\n\nvar getDB = func(cfg Config) (Database, error) {\n\tif db == nil {\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", cfg.DataDSN())\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn &DatabaseImpl{db: db}, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n" }, { "path": "ch11/01_di_induced_damage/06_inject_sql/data_test.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_insertError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnError(errors.New(\"failed to insert\"))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\n\t// validate result\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_getDBError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patching starts here\n\tdefer func(original func(_ Config) (Database, error)) {\n\t\t// restore original DB (after test)\n\t\tgetDB = original\n\t}(getDB)\n\n\t// replace getDB() function for this test\n\tgetDB = func(_ Config) (Database, error) {\n\t\treturn nil, errors.New(\"getDB() failed\")\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n}\n\nfunc TestLoadAll_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResults []*Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(1, \"John\", \"0123456789\", \"AUD\", 12.34))\n\t\t\t},\n\t\t\texpectedResults: []*Person{\n\t\t\t\t{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"AUD\",\n\t\t\t\t\tPrice: 12.34,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResults: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey patch the db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tdao := NewDAO(&testConfig{})\n\t\tresults, err := dao.LoadAll(ctx)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResults, results, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\nfunc TestLoad_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResult *Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\t\t\t},\n\t\t\texpectedResult: &Person{\n\t\t\t\tID: 2,\n\t\t\t\tFullName: \"Paul\",\n\t\t\t\tPhone: \"0123456789\",\n\t\t\t\tCurrency: \"CAD\",\n\t\t\t\tPrice: 23.45,\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResult: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tdao := NewDAO(&testConfig{})\n\t\tresult, err := dao.Load(ctx, 2)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResult, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n\ntype testConfig struct{}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n" }, { "path": "ch11/01_di_induced_damage/07_needless_indirection/example_test.go", "content": "package needless_indirection\n\nimport (\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestExample(t *testing.T) {\n\trouter := http.NewServeMux()\n\trouter.HandleFunc(\"/health\", func(resp http.ResponseWriter, req *http.Request) {\n\t\t_, _ = resp.Write([]byte(`OK`))\n\t})\n\n\t// start a server\n\taddress := \":8080\"\n\tgo func() {\n\t\t_ = http.ListenAndServe(address, router)\n\t}()\n\n\t// call the server\n\tresp, err := http.Get(\"http://:8080/health\")\n\trequire.NoError(t, err)\n\n\t// validate the response\n\tresponseBody, err := ioutil.ReadAll(resp.Body)\n\tassert.Equal(t, []byte(`OK`), responseBody)\n}\n" }, { "path": "ch11/01_di_induced_damage/08_needless_indirection/01_mux.go", "content": "package needless_indirection\n\nimport (\n\t\"net/http\"\n)\n\n//go:generate mockery -name=MyMux -case underscore -testonly -inpkg -note @generated\ntype MyMux interface {\n\tHandle(pattern string, handler http.Handler)\n\tHandler(req *http.Request) (handler http.Handler, pattern string)\n\tServeHTTP(resp http.ResponseWriter, req *http.Request)\n}\n\n// build HTTP handler routing\nfunc buildRouter(mux MyMux) {\n\tmux.Handle(\"/get\", &getEndpoint{})\n\tmux.Handle(\"/list\", &listEndpoint{})\n\tmux.Handle(\"/save\", &saveEndpoint{})\n}\n\ntype getEndpoint struct{}\n\nfunc (*getEndpoint) ServeHTTP(_ http.ResponseWriter, _ *http.Request) {\n\t// not implemented\n}\n\ntype listEndpoint struct{}\n\nfunc (*listEndpoint) ServeHTTP(_ http.ResponseWriter, _ *http.Request) {\n\t// not implemented\n}\n\ntype saveEndpoint struct{}\n\nfunc (*saveEndpoint) ServeHTTP(_ http.ResponseWriter, _ *http.Request) {\n\t// not implemented\n}\n" }, { "path": "ch11/01_di_induced_damage/08_needless_indirection/01_mux_test.go", "content": "package needless_indirection\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestBuildRouter(t *testing.T) {\n\t// build mock\n\tmockRouter := &MockMyMux{}\n\tmockRouter.On(\"Handle\", \"/get\", &getEndpoint{}).Once()\n\tmockRouter.On(\"Handle\", \"/list\", &listEndpoint{}).Once()\n\tmockRouter.On(\"Handle\", \"/save\", &saveEndpoint{}).Once()\n\n\t// call function\n\tbuildRouter(mockRouter)\n\n\t// assert expectations\n\tassert.True(t, mockRouter.AssertExpectations(t))\n}\n" }, { "path": "ch11/01_di_induced_damage/08_needless_indirection/mock_my_mux_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage needless_indirection\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockMyMux is an autogenerated mock type for the MyMux type\ntype MockMyMux struct {\n\tmock.Mock\n}\n\n// Handle provides a mock function with given fields: pattern, handler\nfunc (_m *MockMyMux) Handle(pattern string, handler http.Handler) {\n\t_m.Called(pattern, handler)\n}\n\n// Handler provides a mock function with given fields: req\nfunc (_m *MockMyMux) Handler(req *http.Request) (http.Handler, string) {\n\tret := _m.Called(req)\n\n\tvar r0 http.Handler\n\tif rf, ok := ret.Get(0).(func(*http.Request) http.Handler); ok {\n\t\tr0 = rf(req)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(http.Handler)\n\t\t}\n\t}\n\n\tvar r1 string\n\tif rf, ok := ret.Get(1).(func(*http.Request) string); ok {\n\t\tr1 = rf(req)\n\t} else {\n\t\tr1 = ret.Get(1).(string)\n\t}\n\n\treturn r0, r1\n}\n\n// ServeHTTP provides a mock function with given fields: resp, req\nfunc (_m *MockMyMux) ServeHTTP(resp http.ResponseWriter, req *http.Request) {\n\t_m.Called(resp, req)\n}\n" }, { "path": "ch11/01_di_induced_damage/09_needless_indirection/01_mux.go", "content": "package needless_indirection\n\nimport (\n\t\"net/http\"\n)\n\n// build HTTP handler routing\nfunc buildRouter(mux *http.ServeMux) {\n\tmux.Handle(\"/get\", &getEndpoint{})\n\tmux.Handle(\"/list\", &listEndpoint{})\n\tmux.Handle(\"/save\", &saveEndpoint{})\n}\n\ntype getEndpoint struct{}\n\nfunc (*getEndpoint) ServeHTTP(_ http.ResponseWriter, _ *http.Request) {\n\t// not implemented\n}\n\ntype listEndpoint struct{}\n\nfunc (*listEndpoint) ServeHTTP(_ http.ResponseWriter, _ *http.Request) {\n\t// not implemented\n}\n\ntype saveEndpoint struct{}\n\nfunc (*saveEndpoint) ServeHTTP(_ http.ResponseWriter, _ *http.Request) {\n\t// not implemented\n}\n" }, { "path": "ch11/01_di_induced_damage/09_needless_indirection/01_mux_test.go", "content": "package needless_indirection\n\nimport (\n\t\"net/http\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestBuildRouter(t *testing.T) {\n\trouter := http.NewServeMux()\n\n\t// call function\n\tbuildRouter(router)\n\n\t// assertions\n\tassert.IsType(t, &getEndpoint{}, extractHandler(router, \"/get\"))\n\tassert.IsType(t, &listEndpoint{}, extractHandler(router, \"/list\"))\n\tassert.IsType(t, &saveEndpoint{}, extractHandler(router, \"/save\"))\n}\n\nfunc extractHandler(router *http.ServeMux, path string) http.Handler {\n\treq, _ := http.NewRequest(\"GET\", path, nil)\n\thandler, _ := router.Handler(req)\n\treturn handler\n}\n" }, { "path": "ch11/01_di_induced_damage/10_needless_indirection/01_mux_e2e.go", "content": "package needless_indirection\n\nimport (\n\t\"net/http\"\n)\n\n// build HTTP handler routing\nfunc buildRouter(mux *http.ServeMux) {\n\tmux.Handle(\"/get\", &getEndpoint{})\n\tmux.Handle(\"/list\", &listEndpoint{})\n\tmux.Handle(\"/save\", &saveEndpoint{})\n}\n\ntype getEndpoint struct{}\n\nfunc (*getEndpoint) ServeHTTP(resp http.ResponseWriter, _ *http.Request) {\n\t_, _ = resp.Write([]byte(`Hi from Get!`))\n}\n\ntype listEndpoint struct{}\n\nfunc (*listEndpoint) ServeHTTP(resp http.ResponseWriter, _ *http.Request) {\n\t_, _ = resp.Write([]byte(`Hi from List!`))\n}\n\ntype saveEndpoint struct{}\n\nfunc (*saveEndpoint) ServeHTTP(resp http.ResponseWriter, _ *http.Request) {\n\t_, _ = resp.Write([]byte(`Hi from Save!`))\n}\n" }, { "path": "ch11/01_di_induced_damage/10_needless_indirection/01_mux_e2e_test.go", "content": "package needless_indirection\n\nimport (\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestBuildRouter(t *testing.T) {\n\trouter := http.NewServeMux()\n\n\t// call function\n\tbuildRouter(router)\n\n\t// start a server\n\taddress := \":8080\"\n\tgo func() {\n\t\t_ = http.ListenAndServe(address, router)\n\t}()\n\n\t// call endpoints\n\tresponseBody := doGet(t, address+\"/get\")\n\tassert.Equal(t, `Hi from Get!`, responseBody)\n\n\tresponseBody = doGet(t, address+\"/list\")\n\tassert.Equal(t, `Hi from List!`, responseBody)\n\n\tresponseBody = doGet(t, address+\"/save\")\n\tassert.Equal(t, `Hi from Save!`, responseBody)\n\n}\n\nfunc doGet(t *testing.T, address string) string {\n\tresp, err := http.Get(\"http://\" + address)\n\trequire.NoError(t, err)\n\n\tbody, err := ioutil.ReadAll(resp.Body)\n\trequire.NoError(t, err)\n\n\tdefer resp.Body.Close()\n\treturn string(body)\n}\n" }, { "path": "ch11/01_di_induced_damage/11_service_locator/01_service_locator.go", "content": "package service_locator\n\nfunc NewServiceLocator() *ServiceLocator {\n\treturn &ServiceLocator{\n\t\tdeps: map[string]interface{}{},\n\t}\n}\n\ntype ServiceLocator struct {\n\tdeps map[string]interface{}\n}\n\n// Store or map a dependency to a key\nfunc (s *ServiceLocator) Store(key string, dep interface{}) {\n\ts.deps[key] = dep\n}\n\n// Retrieve a dependency by key\nfunc (s *ServiceLocator) Get(key string) interface{} {\n\treturn s.deps[key]\n}\n" }, { "path": "ch11/01_di_induced_damage/11_service_locator/02_usage.go", "content": "package service_locator\n\nfunc Example() {\n\tlocator := buildServiceLocator()\n\tuseServiceLocator(locator)\n}\n\nfunc buildServiceLocator() *ServiceLocator {\n\t// build a service locator\n\tlocator := NewServiceLocator()\n\n\t// load the dependency mappings\n\tlocator.Store(\"logger\", &myLogger{})\n\tlocator.Store(\"converter\", &myConverter{})\n\n\treturn locator\n}\n\nfunc useServiceLocator(locator *ServiceLocator) {\n\t// use the locators to get the logger\n\tlogger := locator.Get(\"logger\").(Logger)\n\n\t// use the logger\n\tlogger.Info(\"Hello World!\")\n}\n\nfunc useServiceLocatorExtended(locator *ServiceLocator) {\n\t// use the locators to get the logger\n\tloggerRetrieved := locator.Get(\"logger\")\n\tif loggerRetrieved == nil {\n\t\treturn\n\t}\n\tlogger, ok := loggerRetrieved.(Logger)\n\tif !ok {\n\t\treturn\n\t}\n\n\t// use the logger\n\tlogger.Info(\"Hello World!\")\n}\n\ntype Logger interface {\n\tInfo(message string, args ...interface{})\n}\n\ntype myLogger struct{}\n\nfunc (m *myLogger) Info(message string, args ...interface{}) {\n\t// not implemented\n}\n\ntype Converter interface {\n\tConvert(int float64) (float64, error)\n}\n\ntype myConverter struct{}\n\nfunc (m *myConverter) Convert(in float64) (float64, error) {\n\t// not implemented\n\treturn 0, nil\n}\n" }, { "path": "ch11/02_premature_future/get.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// key in the mux where the ID is stored\n\tmuxVarID = \"id\"\n)\n\n// GetModel will load a registration\ntype GetModel interface {\n\tDo(ID int) (*Person, error)\n}\n\n// GetConfig is the config for the Get Handler\ntype GetConfig interface {\n\tLogger() Logger\n}\n\n// Formatter will convert the supplied object to bytes\ntype Formatter interface {\n\tMarshal(interface{}) ([]byte, error)\n}\n\n// NewGetHandler is the constructor for GetHandler\nfunc NewGetHandler(cfg GetConfig, model GetModel, formatter Formatter) *GetHandler {\n\treturn &GetHandler{\n\t\tcfg: cfg,\n\t\tgetter: model,\n\t\tformatter: formatter,\n\t}\n}\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\ntype GetHandler struct {\n\tcfg GetConfig\n\tgetter GetModel\n\tformatter Formatter\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tperson, err := h.getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.buildOutput(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[muxVarID]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\th.cfg.Logger().Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\th.cfg.Logger().Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person\nfunc (h *GetHandler) buildOutput(writer io.Writer, person *Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// build output payload\n\tpayload, err := h.formatter.Marshal(output)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// write payload to response and return\n\t_, err = writer.Write(payload)\n\treturn err\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n\ntype Person struct {\n\tID int\n\tFullName string\n\tPhone string\n\tCurrency string\n\tPrice float64\n}\n\ntype Logger interface {\n\tDebug(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tError(message string, args ...interface{})\n}\n" }, { "path": "ch11/03_mocking_http_requests/converter.go", "content": "package mocking_http_reques\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\t\"time\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// Config is the config for Converter\ntype Config interface {\n\tLogger() Logger\n\tExchangeBaseURL() string\n\tExchangeAPIKey() string\n}\n\n// NewConverter creates and initializes the converter\nfunc NewConverter(cfg Config, requester Requester) *Converter {\n\treturn &Converter{\n\t\tcfg: cfg,\n\t\trequester: requester,\n\t}\n}\n\n// Converter will convert the base price to the currency supplied\ntype Converter struct {\n\tcfg Config\n\trequester Requester\n}\n\n// Exchange will perform the conversion\nfunc (c *Converter) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(ctx, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(ctx context.Context, currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tc.cfg.ExchangeBaseURL(),\n\t\tc.cfg.ExchangeAPIKey(),\n\t\tcurrency)\n\n\t// perform request\n\tresponse, err := c.requester.doRequest(ctx, url)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tc.logger().Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tc.logger().Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\nfunc (c *Converter) logger() Logger {\n\treturn c.cfg.Logger()\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n\n// Requester builds and sending HTTP requests\n//go:generate mockery -name=Requester -case underscore -testonly -inpkg -note @generated\ntype Requester interface {\n\tdoRequest(ctx context.Context, url string) (*http.Response, error)\n}\n\n// Requesterer is the default implementation of Requester\ntype Requesterer struct {\n}\n\nfunc (r *Requesterer) doRequest(ctx context.Context, url string) (*http.Response, error) {\n\treq, err := http.NewRequest(\"GET\", url, nil)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the upstream call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// replace the default context with our custom one\n\treq = req.WithContext(subCtx)\n\n\t// perform the HTTP request\n\treturn http.DefaultClient.Do(req)\n}\n\ntype Logger interface {\n\tWarn(message string, args ...interface{})\n\tError(message string, args ...interface{})\n}\n\ntype stubLogger struct{}\n\nfunc (l *stubLogger) Warn(message string, args ...interface{}) {\n\t// do nothing\n}\n\nfunc (l *stubLogger) Error(message string, args ...interface{}) {\n\t// do nothing\n}\n" }, { "path": "ch11/03_mocking_http_requests/converter_test.go", "content": "package mocking_http_reques\n\nimport (\n\t\"context\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestExchange_invalidResponse(t *testing.T) {\n\t// build response\n\tresponse := httptest.NewRecorder()\n\t_, err := response.WriteString(`invalid payload`)\n\trequire.NoError(t, err)\n\n\t// configure mock\n\tmockRequester := &mockRequester{}\n\tmockRequester.On(\"doRequest\", mock.Anything, mock.Anything).Return(response.Result(), nil).Once()\n\n\t// inputs\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\tbasePrice := 12.34\n\tcurrency := \"AUD\"\n\n\t// perform call\n\tconverter := &Converter{\n\t\trequester: mockRequester,\n\t\tcfg: &testConfig{},\n\t}\n\tresult, resultErr := converter.Exchange(ctx, basePrice, currency)\n\n\t// validate response\n\tassert.Equal(t, float64(0), result)\n\tassert.Error(t, resultErr)\n\tassert.True(t, mockRequester.AssertExpectations(t))\n}\n\n// stub config that returns known values\ntype testConfig struct {\n}\n\nfunc (t *testConfig) Logger() Logger {\n\treturn &stubLogger{}\n}\n\nfunc (t *testConfig) ExchangeBaseURL() string {\n\treturn \"http://www.example.com\"\n}\n\nfunc (t *testConfig) ExchangeAPIKey() string {\n\treturn \"foo\"\n}\n" }, { "path": "ch11/03_mocking_http_requests/mock_requester_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage mocking_http_reques\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockRequester is an autogenerated mock type for the requester type\ntype mockRequester struct {\n\tmock.Mock\n}\n\n// doRequest provides a mock function with given fields: ctx, url\nfunc (_m *mockRequester) doRequest(ctx context.Context, url string) (*http.Response, error) {\n\tret := _m.Called(ctx, url)\n\n\tvar r0 *http.Response\n\tif rf, ok := ret.Get(0).(func(context.Context, string) *http.Response); ok {\n\t\tr0 = rf(ctx, url)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*http.Response)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, string) error); ok {\n\t\tr1 = rf(ctx, url)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch11/acme/internal/config/config.go", "content": "package config\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// Config defines the JSON format for the config file\ntype Config struct {\n\t// DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n\tDSN string\n\n\t// Address is the IP address and port to bind this rest to\n\tAddress string\n\n\t// BasePrice is the price of registration\n\tBasePrice float64\n\n\t// ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n\tExchangeRateBaseURL string\n\n\t// ExchangeRateAPIKey is the API for the exchange rate API\n\tExchangeRateAPIKey string\n\n\t// environmental dependencies\n\tlogger logging.Logger\n}\n\n// Logger returns a reference to the singleton logger\nfunc (c *Config) Logger() logging.Logger {\n\tif c.logger == nil {\n\t\tc.logger = &logging.LoggerStdOut{}\n\t}\n\n\treturn c.logger\n}\n\n// RegistrationBasePrice returns the base price for registrations\nfunc (c *Config) RegistrationBasePrice() float64 {\n\treturn c.BasePrice\n}\n\n// DataDSN returns the DSN\nfunc (c *Config) DataDSN() string {\n\treturn c.DSN\n}\n\n// ExchangeBaseURL returns the Base URL from which we can load exchange rates\nfunc (c *Config) ExchangeBaseURL() string {\n\treturn c.ExchangeRateBaseURL\n}\n\n// ExchangeAPIKey returns the DSN\nfunc (c *Config) ExchangeAPIKey() string {\n\treturn c.ExchangeRateAPIKey\n}\n\n// BindAddress returns the host and port this service should bind to\nfunc (c *Config) BindAddress() string {\n\treturn c.Address\n}\n\n// Load returns the config loaded from environment\nfunc Load() (*Config, error) {\n\tfilename, found := os.LookupEnv(DefaultEnvVar)\n\tif !found {\n\t\terr := fmt.Errorf(\"failed to locate file specified by %s\", DefaultEnvVar)\n\t\tfmt.Fprintf(os.Stderr, err.Error())\n\t\treturn nil, err\n\t}\n\n\tcfg, err := load(filename)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"failed to load config with err %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn cfg, nil\n}\n\nfunc load(filename string) (*Config, error) {\n\tout := &Config{}\n\tbytes, err := ioutil.ReadFile(filename)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"failed to read config file. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\terr = json.Unmarshal(bytes, out)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"failed to parse config file. err : %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn out, nil\n}\n" }, { "path": "ch11/acme/internal/config/config_test.go", "content": "package config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoad(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tin string\n\t\texpectedConfig *Config\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tin: \"../../../../default-config.json\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tDSN: \"[insert your db config here]\",\n\t\t\t\tAddress: \"0.0.0.0:8080\",\n\t\t\t\tBasePrice: 100.00,\n\t\t\t\tExchangeRateBaseURL: \"http://apilayer.net\",\n\t\t\t\tExchangeRateAPIKey: \"[insert your API key here]\",\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"invalid path\",\n\t\t\tin: \"invalid.json\",\n\t\t\texpectedConfig: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\tresult, resultErr := load(scenario.in)\n\t\t\trequire.Equal(t, scenario.expectError, resultErr != nil, \"err: %s\", resultErr)\n\t\t\tassert.Equal(t, scenario.expectedConfig, result, scenario.desc)\n\t\t})\n\t}\n\n}\n" }, { "path": "ch11/acme/internal/logging/logging.go", "content": "package logging\n\nimport (\n\t\"fmt\"\n)\n\n// Logger is our standard interface\ntype Logger interface {\n\tDebug(message string, args ...interface{})\n\tInfo(message string, args ...interface{})\n\tWarn(message string, args ...interface{})\n\tError(message string, args ...interface{})\n}\n\n// LoggerStdOut logs to std out\ntype LoggerStdOut struct{}\n\n// Debug logs messages at DEBUG level\nfunc (l LoggerStdOut) Debug(message string, args ...interface{}) {\n\tfmt.Printf(\"[DEBUG] \"+message, args...)\n}\n\n// Info logs messages at INFO level\nfunc (l LoggerStdOut) Info(message string, args ...interface{}) {\n\tfmt.Printf(\"[INFO] \"+message, args...)\n}\n\n// Warn logs messages at WARN level\nfunc (l LoggerStdOut) Warn(message string, args ...interface{}) {\n\tfmt.Printf(\"[WARN] \"+message, args...)\n}\n\n// Error logs messages at ERROR level\nfunc (l LoggerStdOut) Error(message string, args ...interface{}) {\n\tfmt.Printf(\"[ERROR] \"+message, args...)\n}\n" }, { "path": "ch11/acme/internal/modules/data/dao.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"time\"\n)\n\n// NewDAO will initialize the database connection pool (if not already done) and return a data access object which\n// can be used to interact with the database\nfunc NewDAO(cfg Config) *DAO {\n\t// initialize the db connection pool\n\t_, _ = getDB(cfg)\n\n\treturn &DAO{\n\t\tcfg: cfg,\n\t}\n}\n\n// DAO is a data access object that provides an abstraction over our database interactions.\ntype DAO struct {\n\tcfg Config\n\n\t// Tracker is an optional query timer\n\tTracker QueryTracker\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Load(ctx context.Context, ID int) (*Person, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"Load\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trow := db.QueryRowContext(subCtx, sqlLoadByID, ID)\n\n\t// retrieve columns and populate the person object\n\tout, err := populatePerson(row.Scan)\n\tif err != nil {\n\t\tif err == sql.ErrNoRows {\n\t\t\td.cfg.Logger().Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n\t\t\treturn nil, ErrNotFound\n\t\t}\n\n\t\td.cfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n\t\treturn nil, err\n\t}\n\treturn out, nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) LoadAll(ctx context.Context) ([]*Person, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"LoadAll\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB select\n\trows, err := db.QueryContext(subCtx, sqlLoadAll)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer func() {\n\t\t_ = rows.Close()\n\t}()\n\n\tvar out []*Person\n\n\tfor rows.Next() {\n\t\t// retrieve columns and populate the person object\n\t\trecord, err := populatePerson(rows.Scan)\n\t\tif err != nil {\n\t\t\td.cfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n\t\t\treturn nil, err\n\t\t}\n\n\t\tout = append(out, record)\n\t}\n\n\tif len(out) == 0 {\n\t\td.cfg.Logger().Warn(\"no people found in the database.\")\n\t\treturn nil, ErrNotFound\n\t}\n\n\treturn out, nil\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Save(ctx context.Context, in *Person) (int, error) {\n\t// track processing time\n\tdefer d.getTracker().Track(\"Save\", time.Now())\n\n\tdb, err := getDB(d.cfg)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// set latency budget for the database call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// perform DB insert\n\tresult, err := db.ExecContext(subCtx, sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to save person into DB. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// retrieve and return the ID of the person created\n\tid, err := result.LastInsertId()\n\tif err != nil {\n\t\td.cfg.Logger().Error(\"failed to retrieve id of last saved person. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn int(id), nil\n}\n\nfunc (d *DAO) getTracker() QueryTracker {\n\tif d.Tracker == nil {\n\t\td.Tracker = &noopTracker{}\n\t}\n\n\treturn d.Tracker\n}\n" }, { "path": "ch11/acme/internal/modules/data/data.go", "content": "package data\n\nimport (\n\t\"database/sql\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t_ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// SQL statements as constants (to reduce duplication and maintenance in tests)\n\tsqlAllColumns = \"id, fullname, phone, currency, price\"\n\tsqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n\tsqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n\tsqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n\tdb *sql.DB\n\n\t// ErrNotFound is returned when the no records where matched by the query\n\tErrNotFound = errors.New(\"not found\")\n)\n\n// Config is the configuration for the data package\ntype Config interface {\n\t// Logger returns a reference to the logger\n\tLogger() logging.Logger\n\n\t// DataDSN returns the data source name\n\tDataDSN() string\n}\n\nvar getDB = func(cfg Config) (*sql.DB, error) {\n\tif db == nil {\n\t\tvar err error\n\t\tdb, err = sql.Open(\"mysql\", cfg.DataDSN())\n\t\tif err != nil {\n\t\t\t// if the DB cannot be accessed we are dead\n\t\t\tpanic(err.Error())\n\t\t}\n\t}\n\n\treturn db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n\t// ID is the unique ID for this person\n\tID int\n\t// FullName is the name of this person\n\tFullName string\n\t// Phone is the phone for this person\n\tPhone string\n\t// Currency is the currency this person has paid in\n\tCurrency string\n\t// Price is the amount (in the above currency) paid by this person\n\tPrice float64\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n\tout := &Person{}\n\terr := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n\treturn out, err\n}\n" }, { "path": "ch11/acme/internal/modules/data/data_test.go", "content": "package data\n\nimport (\n\t\"context\"\n\t\"database/sql\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/DATA-DOG/go-sqlmock\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSave_happyPath(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnResult(sqlmock.NewResult(2, 1))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\n\t// validate result\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_insertError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// define a mock db\n\ttestDb, dbMock, err := sqlmock.New()\n\tdefer testDb.Close()\n\n\trequire.NoError(t, err)\n\n\t// configure the mock db\n\tqueryRegex := convertSQLToRegex(sqlInsert)\n\tdbMock.ExpectExec(queryRegex).WillReturnError(errors.New(\"failed to insert\"))\n\n\t// monkey patching starts here\n\tdb = testDb\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\n\t// validate result\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n\tassert.NoError(t, dbMock.ExpectationsWereMet())\n}\n\nfunc TestSave_getDBError(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// monkey patching starts here\n\tdefer func(original func(_ Config) (*sql.DB, error)) {\n\t\t// restore original DB (after test)\n\t\tgetDB = original\n\t}(getDB)\n\n\t// replace getDB() function for this test\n\tgetDB = func(_ Config) (*sql.DB, error) {\n\t\treturn nil, errors.New(\"getDB() failed\")\n\t}\n\t// end of monkey patch\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Jake Blues\",\n\t\tPhone: \"01234567890\",\n\t\tCurrency: \"AUD\",\n\t\tPrice: 123.45,\n\t}\n\n\t// call function\n\tdao := NewDAO(&testConfig{})\n\tresultID, err := dao.Save(ctx, in)\n\trequire.Error(t, err)\n\tassert.Equal(t, defaultPersonID, resultID)\n}\n\nfunc TestLoadAll_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResults []*Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(1, \"John\", \"0123456789\", \"AUD\", 12.34))\n\t\t\t},\n\t\t\texpectedResults: []*Person{\n\t\t\t\t{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"AUD\",\n\t\t\t\t\tPrice: 12.34,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResults: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey patch the db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tdao := NewDAO(&testConfig{})\n\t\tresults, err := dao.LoadAll(ctx)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResults, results, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\nfunc TestLoad_tableDrivenTest(t *testing.T) {\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)\n\tdefer cancel()\n\n\tscenarios := []struct {\n\t\tdesc string\n\t\tconfigureMockDB func(sqlmock.Sqlmock)\n\t\texpectedResult *Person\n\t\texpectError bool\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnRows(\n\t\t\t\t\tsqlmock.NewRows(strings.Split(sqlAllColumns, \", \")).\n\t\t\t\t\t\tAddRow(2, \"Paul\", \"0123456789\", \"CAD\", 23.45))\n\t\t\t},\n\t\t\texpectedResult: &Person{\n\t\t\t\tID: 2,\n\t\t\t\tFullName: \"Paul\",\n\t\t\t\tPhone: \"0123456789\",\n\t\t\t\tCurrency: \"CAD\",\n\t\t\t\tPrice: 23.45,\n\t\t\t},\n\t\t\texpectError: false,\n\t\t},\n\t\t{\n\t\t\tdesc: \"load error\",\n\t\t\tconfigureMockDB: func(dbMock sqlmock.Sqlmock) {\n\t\t\t\tqueryRegex := convertSQLToRegex(sqlLoadAll)\n\t\t\t\tdbMock.ExpectQuery(queryRegex).WillReturnError(errors.New(\"something failed\"))\n\t\t\t},\n\t\t\texpectedResult: nil,\n\t\t\texpectError: true,\n\t\t},\n\t}\n\n\tfor _, scenario := range scenarios {\n\t\t// define a mock db\n\t\ttestDb, dbMock, err := sqlmock.New()\n\t\trequire.NoError(t, err)\n\n\t\t// configure the mock db\n\t\tscenario.configureMockDB(dbMock)\n\n\t\t// monkey db for this test\n\t\toriginal := *db\n\t\tdb = testDb\n\n\t\t// call function\n\t\tdao := NewDAO(&testConfig{})\n\t\tresult, err := dao.Load(ctx, 2)\n\n\t\t// validate results\n\t\tassert.Equal(t, scenario.expectedResult, result, scenario.desc)\n\t\tassert.Equal(t, scenario.expectError, err != nil, scenario.desc)\n\t\tassert.NoError(t, dbMock.ExpectationsWereMet())\n\n\t\t// restore original DB (after test)\n\t\tdb = &original\n\t\ttestDb.Close()\n\t}\n}\n\n// convert SQL string to regex by treating the entire query as a literal\nfunc convertSQLToRegex(in string) string {\n\treturn `\\Q` + in + `\\E`\n}\n\ntype testConfig struct{}\n\n// Logger implements Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn logging.LoggerStdOut{}\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n" }, { "path": "ch11/acme/internal/modules/data/tracker.go", "content": "package data\n\nimport (\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n)\n\n// QueryTracker is an interface to track query timing\ntype QueryTracker interface {\n\t// Track will record/out the time a query took by calculating time.Now().Sub(start)\n\tTrack(key string, start time.Time)\n}\n\n// NO-OP implementation of QueryTracker\ntype noopTracker struct{}\n\n// Track implements QueryTracker\nfunc (_ *noopTracker) Track(_ string, _ time.Time) {\n\t// intentionally does nothing\n}\n\n// NewLogTracker returns a Tracker that outputs tracking data to log\nfunc NewLogTracker(logger logging.Logger) *LogTracker {\n\treturn &LogTracker{\n\t\tlogger: logger,\n\t}\n}\n\n// LogTracker implements QueryTracker and outputs to the supplied logger\ntype LogTracker struct {\n\tlogger logging.Logger\n}\n\n// Track implements QueryTracker\nfunc (l *LogTracker) Track(key string, start time.Time) {\n\tl.logger.Info(\"[%s] Timing: %s\\n\", key, time.Now().Sub(start).String())\n}\n" }, { "path": "ch11/acme/internal/modules/exchange/converter.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"math\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n)\n\nconst (\n\t// request URL for the exchange rate API\n\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n\t// default price that is sent when an error occurs\n\tdefaultPrice = 0.0\n)\n\n// NewConverter creates and initializes the converter\nfunc NewConverter(cfg Config) *Converter {\n\treturn &Converter{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the config for Converter\ntype Config interface {\n\tLogger() logging.Logger\n\tExchangeBaseURL() string\n\tExchangeAPIKey() string\n}\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct {\n\tcfg Config\n}\n\n// Exchange will perform the conversion\nfunc (c *Converter) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\t// load rate from the external API\n\tresponse, err := c.loadRateFromServer(ctx, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// extract rate from response\n\trate, err := c.extractRate(response, currency)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// apply rate and round to 2 decimal places\n\treturn math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(ctx context.Context, currency string) (*http.Response, error) {\n\t// build the request\n\turl := fmt.Sprintf(urlFormat,\n\t\tc.cfg.ExchangeBaseURL(),\n\t\tc.cfg.ExchangeAPIKey(),\n\t\tcurrency)\n\n\t// perform request\n\treq, err := http.NewRequest(\"GET\", url, nil)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to create request. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// set latency budget for the upstream call\n\tsubCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n\tdefer cancel()\n\n\t// replace the default context with our custom one\n\treq = req.WithContext(subCtx)\n\n\t// perform the HTTP request\n\tresponse, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tc.logger().Warn(\"[exchange] failed to load. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tif response.StatusCode != http.StatusOK {\n\t\terr = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n\t\tc.logger().Warn(\"[exchange] %s\", err)\n\t\treturn nil, err\n\t}\n\n\treturn response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n\tdefer func() {\n\t\t_ = response.Body.Close()\n\t}()\n\n\t// extract data from response\n\tdata, err := c.extractResponse(response)\n\tif err != nil {\n\t\treturn defaultPrice, err\n\t}\n\n\t// pull rate from response data\n\trate, found := data.Quotes[\"USD\"+currency]\n\tif !found {\n\t\terr = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n\t\tc.logger().Error(\"[exchange] %s\", err)\n\t\treturn defaultPrice, err\n\t}\n\n\t// happy path\n\treturn rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n\tpayload, err := ioutil.ReadAll(response.Body)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] failed to ready response body. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\tdata := &apiResponseFormat{}\n\terr = json.Unmarshal(payload, data)\n\tif err != nil {\n\t\tc.logger().Error(\"[exchange] error converting response. err: %s\", err)\n\t\treturn nil, err\n\t}\n\n\t// happy path\n\treturn data, nil\n}\n\nfunc (c *Converter) logger() logging.Logger {\n\treturn c.cfg.Logger()\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n\tQuotes map[string]float64 `json:\"quotes\"`\n}\n" }, { "path": "ch11/acme/internal/modules/exchange/converter_ext_bounday_test.go", "content": "// +build external\n\npackage exchange\n\nimport (\n\t\"context\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/config\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestExternalBoundaryTest(t *testing.T) {\n\t// define the config\n\tcfg, err := config.Load()\n\trequire.NoError(t, err)\n\n\t// create a converter to test\n\tconverter := NewConverter(cfg)\n\n\t// fetch from the server\n\tresponse, err := converter.loadRateFromServer(context.Background(), \"AUD\")\n\trequire.NotNil(t, response)\n\trequire.NoError(t, err)\n\n\t// parse the response\n\tresultRate, err := converter.extractRate(response, \"AUD\")\n\trequire.NoError(t, err)\n\n\t// validate the result\n\tassert.True(t, resultRate > 0)\n}\n" }, { "path": "ch11/acme/internal/modules/exchange/converter_int_bounday_test.go", "content": "package exchange\n\nimport (\n\t\"context\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestInternalBoundaryTest(t *testing.T) {\n\t// start our test server\n\tserver := httptest.NewServer(&happyExchangeRateService{})\n\tdefer server.Close()\n\n\t// define the config\n\tcfg := &testConfig{\n\t\tbaseURL: server.URL,\n\t\tapiKey: \"\",\n\t}\n\n\t// create a converter to test\n\tconverter := NewConverter(cfg)\n\tresultRate, resultErr := converter.Exchange(context.Background(), 100.00, \"AUD\")\n\n\t// validate the result\n\tassert.Equal(t, 101.01, resultRate)\n\tassert.NoError(t, resultErr)\n}\n\ntype happyExchangeRateService struct{}\n\n// ServeHTTP implements http.Handler\nfunc (*happyExchangeRateService) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\tpayload := []byte(`\n{\n \"success\":true,\n \"historical\":true,\n \"date\":\"2010-11-09\",\n \"timestamp\":1289347199,\n \"source\":\"USD\",\n \"quotes\":{\n \"USDAUD\":0.989981\n }\n}`)\n\tresponse.Write(payload)\n}\n\nfunc TestExchange_invalidResponseFromServer(t *testing.T) {\n\t// start our test server\n\tserver := httptest.NewServer(http.HandlerFunc(func(response http.ResponseWriter, request *http.Request) {\n\t\tpayload := []byte(`invalid payload`)\n\t\tresponse.Write(payload)\n\t}))\n\tdefer server.Close()\n\n\t// inputs\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\tbasePrice := 12.34\n\tcurrency := \"AUD\"\n\n\tcfg := &testConfig{\n\t\tbaseURL: server.URL,\n\t\tapiKey: \"\",\n\t}\n\n\tconverter := NewConverter(cfg)\n\tresult, resultErr := converter.Exchange(ctx, basePrice, currency)\n\n\t// validate response\n\tassert.Equal(t, float64(0), result)\n\tassert.Error(t, resultErr)\n}\n\n// test implementation of Config\ntype testConfig struct {\n\tbaseURL string\n\tapiKey string\n}\n\n// Logger implements Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// ExchangeBaseURL implements Config\nfunc (t *testConfig) ExchangeBaseURL() string {\n\treturn t.baseURL\n}\n\n// ExchangeAPIKey implements Config\nfunc (t *testConfig) ExchangeAPIKey() string {\n\treturn t.apiKey\n}\n" }, { "path": "ch11/acme/internal/modules/get/get.go", "content": "package get\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when the requested person is not in the database\n\terrPersonNotFound = errors.New(\"person not found\")\n)\n\n// NewGetter creates and initializes a Getter\nfunc NewGetter(cfg Config) *Getter {\n\treturn &Getter{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the configuration for Getter\ntype Config interface {\n\tLogger() logging.Logger\n\tDataDSN() string\n}\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n\tcfg Config\n\tdata myLoader\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*Person, error) {\n\t// load person from the data layer\n\tperson, err := g.getLoader().Load(context.TODO(), ID)\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are hiding the implementation details from our users.\n\t\t\treturn nil, errPersonNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn g.convert(person), err\n}\n\nfunc (g *Getter) getLoader() myLoader {\n\tif g.data == nil {\n\t\tg.data = data.NewDAO(g.cfg)\n\t}\n\n\treturn g.data\n}\n\nfunc (g *Getter) convert(in *data.Person) *Person {\n\treturn &Person{\n\t\tID: in.ID,\n\t\tCurrency: in.Currency,\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tPrice: in.Price,\n\t}\n}\n\n//go:generate mockery -name=myLoader -case underscore -testonly -inpkg -note @generated\ntype myLoader interface {\n\tLoad(ctx context.Context, ID int) (*data.Person, error)\n}\n\n// Person is a copy/sub-set of data.Person so that the relationship does not leak.\n// It also allows us to remove/hide and internal fields\ntype Person struct {\n\tID int\n\tFullName string\n\tPhone string\n\tCurrency string\n\tPrice float64\n}\n" }, { "path": "ch11/acme/internal/modules/get/go_test.go", "content": "package get\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetter_Do_happyPath(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// configure the mock loader\n\tmockResult := &data.Person{\n\t\tID: 1234,\n\t\tFullName: \"Doug\",\n\t}\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(mockResult, nil).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, ID, person.ID)\n\tassert.Equal(t, \"Doug\", person.FullName)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestGetter_Do_noSuchPerson(t *testing.T) {\n\t// inputs\n\tID := 5678\n\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(nil, data.ErrNotFound).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Equal(t, errPersonNotFound, err)\n\tassert.Nil(t, person)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestGetter_Do_error(t *testing.T) {\n\t// inputs\n\tID := 1234\n\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"Load\", mock.Anything, ID).Return(nil, errors.New(\"something failed\")).Once()\n\n\t// call method\n\tgetter := &Getter{\n\t\tdata: mockLoader,\n\t}\n\tperson, err := getter.Do(ID)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Nil(t, person)\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n" }, { "path": "ch11/acme/internal/modules/get/mock_my_loader_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage get\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMyLoader is an autogenerated mock type for the myLoader type\ntype mockMyLoader struct {\n\tmock.Mock\n}\n\n// Load provides a mock function with given fields: ctx, ID\nfunc (_m *mockMyLoader) Load(ctx context.Context, ID int) (*data.Person, error) {\n\tret := _m.Called(ctx, ID)\n\n\tvar r0 *data.Person\n\tif rf, ok := ret.Get(0).(func(context.Context, int) *data.Person); ok {\n\t\tr0 = rf(ctx, ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, int) error); ok {\n\t\tr1 = rf(ctx, ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch11/acme/internal/modules/list/list.go", "content": "package list\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/data\"\n)\n\nvar (\n\t// error thrown when there are no people in the database\n\terrPeopleNotFound = errors.New(\"no people found\")\n)\n\n// NewLister creates and initializes a Lister\nfunc NewLister(cfg Config) *Lister {\n\treturn &Lister{\n\t\tcfg: cfg,\n\t}\n}\n\n// Config is the config for Lister\ntype Config interface {\n\tLogger() logging.Logger\n\tDataDSN() string\n}\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n\tcfg Config\n\tdata myLoader\n}\n\n// Exchange will load the people from the data layer\nfunc (l *Lister) Do() ([]*Person, error) {\n\t// load all people\n\tpeople, err := l.load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(people) == 0 {\n\t\t// special processing for 0 people returned\n\t\treturn nil, errPeopleNotFound\n\t}\n\n\treturn l.convert(people), nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n\tpeople, err := l.getLoader().LoadAll(context.TODO())\n\tif err != nil {\n\t\tif err == data.ErrNotFound {\n\t\t\t// By converting the error we are encapsulating the implementation details from our users.\n\t\t\treturn nil, errPeopleNotFound\n\t\t}\n\t\treturn nil, err\n\t}\n\n\treturn people, nil\n}\n\nfunc (l *Lister) getLoader() myLoader {\n\tif l.data == nil {\n\t\tl.data = data.NewDAO(l.cfg)\n\n\t\t// temporarily add a log tracker\n\t\tl.data.(*data.DAO).Tracker = data.NewLogTracker(l.cfg.Logger())\n\t}\n\n\treturn l.data\n}\n\nfunc (l *Lister) convert(in []*data.Person) []*Person {\n\tout := make([]*Person, len(in))\n\n\tfor index, thisRecord := range in {\n\t\tout[index] = &Person{\n\t\t\tID: thisRecord.ID,\n\t\t\tFullName: thisRecord.FullName,\n\t\t\tPhone: thisRecord.Phone,\n\t\t}\n\t}\n\n\treturn out\n}\n\n//go:generate mockery -name=myLoader -case underscore -testonly -inpkg -note @generated\ntype myLoader interface {\n\tLoadAll(ctx context.Context) ([]*data.Person, error)\n}\n\n// Person is a copy/sub-set of data.Person so that the relationship does not leak.\n// It also allows us to remove/hide and internal fields\ntype Person struct {\n\tID int\n\tFullName string\n\tPhone string\n}\n" }, { "path": "ch11/acme/internal/modules/list/list_test.go", "content": "package list\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLister_Do_happyPath(t *testing.T) {\n\t// configure the mock loader\n\tmockResult := []*data.Person{\n\t\t{\n\t\t\tID: 1234,\n\t\t\tFullName: \"Sally\",\n\t\t},\n\t\t{\n\t\t\tID: 5678,\n\t\t\tFullName: \"Jane\",\n\t\t},\n\t}\n\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(mockResult, nil).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 2, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestLister_Do_noResults(t *testing.T) {\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(nil, data.ErrNotFound).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Equal(t, errPeopleNotFound, err)\n\tassert.Equal(t, 0, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n\nfunc TestLister_Do_error(t *testing.T) {\n\t// configure the mock loader\n\tmockLoader := &mockMyLoader{}\n\tmockLoader.On(\"LoadAll\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t// call method\n\tlister := &Lister{\n\t\tdata: mockLoader,\n\t}\n\tpersons, err := lister.load()\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, len(persons))\n\tassert.True(t, mockLoader.AssertExpectations(t))\n}\n" }, { "path": "ch11/acme/internal/modules/list/mock_my_loader_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage list\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMyLoader is an autogenerated mock type for the myLoader type\ntype mockMyLoader struct {\n\tmock.Mock\n}\n\n// LoadAll provides a mock function with given fields: ctx\nfunc (_m *mockMyLoader) LoadAll(ctx context.Context) ([]*data.Person, error) {\n\tret := _m.Called(ctx)\n\n\tvar r0 []*data.Person\n\tif rf, ok := ret.Get(0).(func(context.Context) []*data.Person); ok {\n\t\tr0 = rf(ctx)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*data.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context) error); ok {\n\t\tr1 = rf(ctx)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch11/acme/internal/modules/register/mock_exchanger_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage register\n\nimport (\n\t\"context\"\n\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockExchanger is an autogenerated mock type for the Exchanger type\ntype MockExchanger struct {\n\tmock.Mock\n}\n\n// Exchange provides a mock function with given fields: ctx, basePrice, currency\nfunc (_m *MockExchanger) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\tret := _m.Called(ctx, basePrice, currency)\n\n\tvar r0 float64\n\tif rf, ok := ret.Get(0).(func(context.Context, float64, string) float64); ok {\n\t\tr0 = rf(ctx, basePrice, currency)\n\t} else {\n\t\tr0 = ret.Get(0).(float64)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, float64, string) error); ok {\n\t\tr1 = rf(ctx, basePrice, currency)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch11/acme/internal/modules/register/mock_my_saver_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage register\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/data\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// mockMySaver is an autogenerated mock type for the mySaver type\ntype mockMySaver struct {\n\tmock.Mock\n}\n\n// Save provides a mock function with given fields: ctx, in\nfunc (_m *mockMySaver) Save(ctx context.Context, in *data.Person) (int, error) {\n\tret := _m.Called(ctx, in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(context.Context, *data.Person) int); ok {\n\t\tr0 = rf(ctx, in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, *data.Person) error); ok {\n\t\tr1 = rf(ctx, in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch11/acme/internal/modules/register/register.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/data\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n)\n\nvar (\n\t// validation errors\n\terrNameMissing = errors.New(\"name is missing\")\n\terrPhoneMissing = errors.New(\"phone is missing\")\n\terrCurrencyMissing = errors.New(\"currency is missing\")\n\terrInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n\t// a little trick to make checking for supported currencies easier\n\tsupportedCurrencies = map[string]struct{}{\n\t\t\"AUD\": {},\n\t\t\"CNY\": {},\n\t\t\"EUR\": {},\n\t\t\"GBP\": {},\n\t\t\"JPY\": {},\n\t\t\"MYR\": {},\n\t\t\"SGD\": {},\n\t\t\"USD\": {},\n\t}\n)\n\n// NewRegisterer creates and initializes a Registerer\nfunc NewRegisterer(cfg Config, exchanger Exchanger) *Registerer {\n\treturn &Registerer{\n\t\tcfg: cfg,\n\t\texchanger: exchanger,\n\t}\n}\n\n// Exchanger will convert from one currency to another\n//go:generate mockery -name=Exchanger -case underscore -testonly -inpkg -note @generated\ntype Exchanger interface {\n\t// Exchange will perform the conversion\n\tExchange(ctx context.Context, basePrice float64, currency string) (float64, error)\n}\n\n// Config is the configuration for the Registerer\ntype Config interface {\n\tLogger() logging.Logger\n\tRegistrationBasePrice() float64\n\tDataDSN() string\n}\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n\tcfg Config\n\texchanger Exchanger\n\tdata mySaver\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(ctx context.Context, in *Person) (int, error) {\n\t// validate the request\n\terr := r.validateInput(in)\n\tif err != nil {\n\t\tr.logger().Warn(\"input validation failed with err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\t// get price in the requested currency\n\tprice, err := r.getPrice(ctx, in.Currency)\n\tif err != nil {\n\t\treturn defaultPersonID, err\n\t}\n\n\t// save registration\n\tid, err := r.save(ctx, r.convert(in), price)\n\tif err != nil {\n\t\t// no need to log here as we expect the data layer to do so\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *Person) error {\n\tif in.FullName == \"\" {\n\t\treturn errNameMissing\n\t}\n\tif in.Phone == \"\" {\n\t\treturn errPhoneMissing\n\t}\n\tif in.Currency == \"\" {\n\t\treturn errCurrencyMissing\n\t}\n\n\tif _, found := supportedCurrencies[in.Currency]; !found {\n\t\treturn errInvalidCurrency\n\t}\n\n\t// happy path\n\treturn nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(ctx context.Context, currency string) (float64, error) {\n\tprice, err := r.exchanger.Exchange(ctx, r.cfg.RegistrationBasePrice(), currency)\n\tif err != nil {\n\t\tr.logger().Warn(\"failed to convert the price. err: %s\", err)\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(ctx context.Context, in *data.Person, price float64) (int, error) {\n\tperson := &data.Person{\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tCurrency: in.Currency,\n\t\tPrice: price,\n\t}\n\treturn r.getSaver().Save(ctx, person)\n}\n\nfunc (r *Registerer) getSaver() mySaver {\n\tif r.data == nil {\n\t\tr.data = data.NewDAO(r.cfg)\n\t}\n\n\treturn r.data\n}\n\nfunc (r *Registerer) logger() logging.Logger {\n\treturn r.cfg.Logger()\n}\n\nfunc (r *Registerer) convert(in *Person) *data.Person {\n\treturn &data.Person{\n\t\tID: in.ID,\n\t\tCurrency: in.Currency,\n\t\tFullName: in.FullName,\n\t\tPhone: in.Phone,\n\t\tPrice: in.Price,\n\t}\n}\n\n//go:generate mockery -name=mySaver -case underscore -testonly -inpkg -note @generated\ntype mySaver interface {\n\tSave(ctx context.Context, in *data.Person) (int, error)\n}\n\n// Person is a copy/sub-set of data.Person so that the relationship does not leak.\n// It also allows us to remove/hide and internal fields\ntype Person struct {\n\tID int\n\tFullName string\n\tPhone string\n\tCurrency string\n\tPrice float64\n}\n" }, { "path": "ch11/acme/internal/modules/register/register_test.go", "content": "package register\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterer_Do_happyPath(t *testing.T) {\n\t// configure the mock saver\n\tmockResult := 888\n\n\tmockSaver := &mockMySaver{}\n\tmockSaver.On(\"Save\", mock.Anything, mock.Anything).Return(mockResult, nil).Once()\n\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: &stubExchanger{},\n\t\tdata: mockSaver,\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.NoError(t, err)\n\tassert.Equal(t, 888, ID)\n\tassert.True(t, mockSaver.AssertExpectations(t))\n}\n\nfunc TestRegisterer_Do_error(t *testing.T) {\n\t// configure the mock saver\n\tmockSaver := &mockMySaver{}\n\tmockSaver.On(\"Save\", mock.Anything, mock.Anything).Return(0, errors.New(\"something failed\")).Once()\n\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: &stubExchanger{},\n\t\tdata: mockSaver,\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, ID)\n\tassert.True(t, mockSaver.AssertExpectations(t))\n}\n\nfunc TestRegisterer_Do_exchangeError(t *testing.T) {\n\t// configure the mocks\n\tmockSaver := &mockMySaver{}\n\tmockExchanger := &MockExchanger{}\n\tmockExchanger.\n\t\tOn(\"Exchange\", mock.Anything, mock.Anything, mock.Anything).\n\t\tReturn(0.0, errors.New(\"failed to load conversion\")).\n\t\tOnce()\n\n\t// define context and therefore test timeout\n\tctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)\n\tdefer cancel()\n\n\t// inputs\n\tin := &Person{\n\t\tFullName: \"Chang\",\n\t\tPhone: \"11122233355\",\n\t\tCurrency: \"CNY\",\n\t}\n\n\t// call method\n\tregisterer := &Registerer{\n\t\tcfg: &testConfig{},\n\t\texchanger: mockExchanger,\n\t\tdata: mockSaver,\n\t}\n\tID, err := registerer.Do(ctx, in)\n\n\t// validate expectations\n\trequire.Error(t, err)\n\tassert.Equal(t, 0, ID)\n\tassert.True(t, mockSaver.AssertExpectations(t))\n\tassert.True(t, mockExchanger.AssertExpectations(t))\n}\n\n// Stub implementation of Config\ntype testConfig struct{}\n\n// Logger implement Config\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\n// RegistrationBasePrice implement Config\nfunc (t *testConfig) RegistrationBasePrice() float64 {\n\treturn 12.34\n}\n\n// DataDSN implements Config\nfunc (t *testConfig) DataDSN() string {\n\treturn \"\"\n}\n\ntype stubExchanger struct{}\n\n// Exchange implements Exchanger\nfunc (s stubExchanger) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n\treturn 12.34, nil\n}\n" }, { "path": "ch11/acme/internal/rest/get.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/get\"\n\t\"github.com/gorilla/mux\"\n)\n\nconst (\n\t// default person id (returned on error)\n\tdefaultPersonID = 0\n\n\t// key in the mux where the ID is stored\n\tmuxVarID = \"id\"\n)\n\n// GetModel will load a registration\n//go:generate mockery -name=GetModel -case underscore -testonly -inpkg -note @generated\ntype GetModel interface {\n\tDo(ID int) (*get.Person, error)\n}\n\n// GetConfig is the config for the Get Handler\ntype GetConfig interface {\n\tLogger() logging.Logger\n}\n\n// NewGetHandler is the constructor for GetHandler\nfunc NewGetHandler(cfg GetConfig, model GetModel) *GetHandler {\n\treturn &GetHandler{\n\t\tcfg: cfg,\n\t\tgetter: model,\n\t}\n}\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n\tcfg GetConfig\n\tgetter GetModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// extract person id from request\n\tid, err := h.extractID(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// attempt get\n\tperson, err := h.getter.Do(id)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, person)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n\t// ID is part of the URL, so we extract it from there\n\tvars := mux.Vars(request)\n\tidAsString, exists := vars[muxVarID]\n\tif !exists {\n\t\t// log and return error\n\t\terr := errors.New(\"[get] person id missing from request\")\n\t\th.cfg.Logger().Warn(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\t// convert ID to int\n\tid, err := strconv.Atoi(idAsString)\n\tif err != nil {\n\t\t// log and return error\n\t\terr = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n\t\th.cfg.Logger().Error(err.Error())\n\t\treturn defaultPersonID, err\n\t}\n\n\treturn id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *get.Person) error {\n\toutput := &getResponseFormat{\n\t\tID: person.ID,\n\t\tFullName: person.FullName,\n\t\tPhone: person.Phone,\n\t\tCurrency: person.Currency,\n\t\tPrice: person.Price,\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n\tCurrency string `json:\"currency\"`\n\tPrice float64 `json:\"price\"`\n}\n" }, { "path": "ch11/acme/internal/rest/get_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/get\"\n\t\"github.com/gorilla/mux\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockGetModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\toutput := &get.Person{\n\t\t\t\t\tID: 1,\n\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\tCurrency: \"USD\",\n\t\t\t\t\tPrice: 100,\n\t\t\t\t}\n\n\t\t\t\tmockGetModel := &MockGetModel{}\n\t\t\t\tmockGetModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockGetModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\",\"currency\":\"USD\",\"price\":100}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is invalid)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/x/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"x\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"bad input (ID is missing)\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person//\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\t// expect the model not to be called\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency fail\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"requested registration does not exist\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/1/\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// set values into request (required by the mux)\n\t\t\t\treturn mux.SetURLVars(req, map[string]string{muxVarID: \"1\"})\n\t\t\t},\n\t\t\tinModelMock: func() *MockGetModel {\n\t\t\t\tmockRegisterModel := &MockGetModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"person not found\")).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockGetModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewGetHandler(&testConfig{}, mockGetModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\t\t})\n\t}\n}\n\ntype testConfig struct {\n}\n\nfunc (t *testConfig) Logger() logging.Logger {\n\treturn &logging.LoggerStdOut{}\n}\n\nfunc (*testConfig) BindAddress() string {\n\treturn \"0.0.0.0:0\"\n}\n" }, { "path": "ch11/acme/internal/rest/list.go", "content": "package rest\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/list\"\n)\n\n// ListModel will load all registrations\n//go:generate mockery -name=ListModel -case underscore -testonly -inpkg -note @generated\ntype ListModel interface {\n\tDo() ([]*list.Person, error)\n}\n\n// NewLister is the constructor for ListHandler\nfunc NewListHandler(model ListModel) *ListHandler {\n\treturn &ListHandler{\n\t\tlister: model,\n\t}\n}\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n\tlister ListModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// attempt loadAll\n\tpeople, err := h.lister.Do()\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusNotFound)\n\t\treturn\n\t}\n\n\t// happy path\n\terr = h.writeJSON(response, people)\n\tif err != nil {\n\t\t// this error should not happen but if it does there is nothing we can do to recover\n\t\tresponse.WriteHeader(http.StatusInternalServerError)\n\t}\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*list.Person) error {\n\toutput := &listResponseFormat{\n\t\tPeople: make([]*listResponseItemFormat, len(people)),\n\t}\n\n\tfor index, record := range people {\n\t\toutput.People[index] = &listResponseItemFormat{\n\t\t\tID: record.ID,\n\t\t\tFullName: record.FullName,\n\t\t\tPhone: record.Phone,\n\t\t}\n\t}\n\n\t// call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n\treturn json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n\tPeople []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n\tID int `json:\"id\"`\n\tFullName string `json:\"name\"`\n\tPhone string `json:\"phone\"`\n}\n" }, { "path": "ch11/acme/internal/rest/list_test.go", "content": "package rest\n\nimport (\n\t\"errors\"\n\t\"io/ioutil\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/list\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestListHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockListModel\n\t\texpectedStatus int\n\t\texpectedPayload string\n\t}{\n\t\t{\n\t\t\tdesc: \"happy path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\toutput := []*list.Person{\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"John\",\n\t\t\t\t\t\tPhone: \"0123456789\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 2,\n\t\t\t\t\t\tFullName: \"Paul\",\n\t\t\t\t\t\tPhone: \"0123456781\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 3,\n\t\t\t\t\t\tFullName: \"George\",\n\t\t\t\t\t\tPhone: \"0123456782\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tID: 1,\n\t\t\t\t\t\tFullName: \"Ringo\",\n\t\t\t\t\t\tPhone: \"0123456783\",\n\t\t\t\t\t},\n\t\t\t\t}\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[{\"id\":1,\"name\":\"John\",\"phone\":\"0123456789\"},{\"id\":2,\"name\":\"Paul\",\"phone\":\"0123456781\"},{\"id\":3,\"name\":\"George\",\"phone\":\"0123456782\"},{\"id\":1,\"name\":\"Ringo\",\"phone\":\"0123456783\"}]}` + \"\\n\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"dependency failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(nil, errors.New(\"something failed\")).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusNotFound,\n\t\t\texpectedPayload: ``,\n\t\t},\n\t\t{\n\t\t\tdesc: \"no data\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\treq, err := http.NewRequest(\"GET\", \"/person/list\", nil)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn req\n\t\t\t},\n\t\t\tinModelMock: func() *MockListModel {\n\t\t\t\t// no data\n\t\t\t\tvar output []*list.Person\n\n\t\t\t\tmockListModel := &MockListModel{}\n\t\t\t\tmockListModel.On(\"Do\", mock.Anything).Return(output, nil).Once()\n\n\t\t\t\treturn mockListModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusOK,\n\t\t\texpectedPayload: `{\"people\":[]}` + \"\\n\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockListModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewListHandler(mockListModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code, scenario.desc)\n\n\t\t\tpayload, _ := ioutil.ReadAll(response.Body)\n\t\t\tassert.Equal(t, scenario.expectedPayload, string(payload), scenario.desc)\n\n\t\t})\n\t}\n}\n" }, { "path": "ch11/acme/internal/rest/mock_get_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/get\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockGetModel is an autogenerated mock type for the GetModel type\ntype MockGetModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ID\nfunc (_m *MockGetModel) Do(ID int) (*get.Person, error) {\n\tret := _m.Called(ID)\n\n\tvar r0 *get.Person\n\tif rf, ok := ret.Get(0).(func(int) *get.Person); ok {\n\t\tr0 = rf(ID)\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).(*get.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(int) error); ok {\n\t\tr1 = rf(ID)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch11/acme/internal/rest/mock_list_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/list\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockListModel is an autogenerated mock type for the ListModel type\ntype MockListModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields:\nfunc (_m *MockListModel) Do() ([]*list.Person, error) {\n\tret := _m.Called()\n\n\tvar r0 []*list.Person\n\tif rf, ok := ret.Get(0).(func() []*list.Person); ok {\n\t\tr0 = rf()\n\t} else {\n\t\tif ret.Get(0) != nil {\n\t\t\tr0 = ret.Get(0).([]*list.Person)\n\t\t}\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func() error); ok {\n\t\tr1 = rf()\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch11/acme/internal/rest/mock_register_model_test.go", "content": "// Code generated by mockery v1.0.0\n\n// @generated\n\npackage rest\n\nimport (\n\t\"context\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/register\"\n\t\"github.com/stretchr/testify/mock\"\n)\n\n// MockRegisterModel is an autogenerated mock type for the RegisterModel type\ntype MockRegisterModel struct {\n\tmock.Mock\n}\n\n// Do provides a mock function with given fields: ctx, in\nfunc (_m *MockRegisterModel) Do(ctx context.Context, in *register.Person) (int, error) {\n\tret := _m.Called(ctx, in)\n\n\tvar r0 int\n\tif rf, ok := ret.Get(0).(func(context.Context, *register.Person) int); ok {\n\t\tr0 = rf(ctx, in)\n\t} else {\n\t\tr0 = ret.Get(0).(int)\n\t}\n\n\tvar r1 error\n\tif rf, ok := ret.Get(1).(func(context.Context, *register.Person) error); ok {\n\t\tr1 = rf(ctx, in)\n\t} else {\n\t\tr1 = ret.Error(1)\n\t}\n\n\treturn r0, r1\n}\n" }, { "path": "ch11/acme/internal/rest/not_found.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n\tresponse.WriteHeader(http.StatusNotFound)\n\t_, _ = response.Write([]byte(`Not found`))\n}\n" }, { "path": "ch11/acme/internal/rest/not_found_test.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNotFoundHandler_ServeHTTP(t *testing.T) {\n\t// build inputs\n\tresponse := httptest.NewRecorder()\n\trequest := &http.Request{}\n\n\t// call handler\n\tnotFoundHandler(response, request)\n\n\t// validate outputs\n\trequire.Equal(t, http.StatusNotFound, response.Code)\n}\n" }, { "path": "ch11/acme/internal/rest/register.go", "content": "package rest\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/register\"\n)\n\n// RegisterModel will validate and save a registration\n//go:generate mockery -name=RegisterModel -case underscore -testonly -inpkg -note @generated\ntype RegisterModel interface {\n\tDo(ctx context.Context, in *register.Person) (int, error)\n}\n\n// NewRegisterHandler is the constructor for RegisterHandler\nfunc NewRegisterHandler(model RegisterModel) *RegisterHandler {\n\treturn &RegisterHandler{\n\t\tregisterer: model,\n\t}\n}\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n\tregisterer RegisterModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n\t// set latency budget for this API\n\tsubCtx, cancel := context.WithTimeout(request.Context(), 1500*time.Millisecond)\n\tdefer cancel()\n\n\t// extract payload from request\n\trequestPayload, err := h.extractPayload(request)\n\tif err != nil {\n\t\t// output error\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// call the business logic using the request data and context\n\tid, err := h.register(subCtx, requestPayload)\n\tif err != nil {\n\t\t// not need to log here as we can expect other layers to do so\n\t\tresponse.WriteHeader(http.StatusBadRequest)\n\t\treturn\n\t}\n\n\t// happy path\n\tresponse.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n\tresponse.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n\trequestPayload := ®isterRequest{}\n\n\tdecoder := json.NewDecoder(request.Body)\n\terr := decoder.Decode(requestPayload)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(ctx context.Context, requestPayload *registerRequest) (int, error) {\n\tperson := ®ister.Person{\n\t\tFullName: requestPayload.FullName,\n\t\tPhone: requestPayload.Phone,\n\t\tCurrency: requestPayload.Currency,\n\t}\n\n\treturn h.registerer.Do(ctx, person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n\t// FullName of the person\n\tFullName string `json:\"fullName\"`\n\t// Phone of the person\n\tPhone string `json:\"phone\"`\n\t// Currency the wish to register in\n\tCurrency string `json:\"currency\"`\n}\n" }, { "path": "ch11/acme/internal/rest/register_test.go", "content": "package rest\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegisterHandler_ServeHTTP(t *testing.T) {\n\tscenarios := []struct {\n\t\tdesc string\n\t\tinRequest func() *http.Request\n\t\tinModelMock func() *MockRegisterModel\n\t\texpectedStatus int\n\t\texpectedHeader string\n\t}{\n\t\t{\n\t\t\tdesc: \"Happy Path\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// valid downstream configuration\n\t\t\t\tresultID := 1234\n\t\t\t\tvar resultErr error\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(resultID, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusCreated,\n\t\t\texpectedHeader: \"/person/1234/\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Bad Input / User Error\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tinvalidRequest := bytes.NewBufferString(`this is not valid JSON`)\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", invalidRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// Dependency should not be called\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t\t{\n\t\t\tdesc: \"Dependency Failure\",\n\t\t\tinRequest: func() *http.Request {\n\t\t\t\tvalidRequest := buildValidRegisterRequest()\n\t\t\t\trequest, err := http.NewRequest(\"POST\", \"/person/register\", validRequest)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn request\n\t\t\t},\n\t\t\tinModelMock: func() *MockRegisterModel {\n\t\t\t\t// call to the dependency failed\n\t\t\t\tresultErr := errors.New(\"something failed\")\n\n\t\t\t\tmockRegisterModel := &MockRegisterModel{}\n\t\t\t\tmockRegisterModel.On(\"Do\", mock.Anything, mock.Anything).Return(0, resultErr).Once()\n\n\t\t\t\treturn mockRegisterModel\n\t\t\t},\n\t\t\texpectedStatus: http.StatusBadRequest,\n\t\t\texpectedHeader: \"\",\n\t\t},\n\t}\n\n\tfor _, s := range scenarios {\n\t\tscenario := s\n\t\tt.Run(scenario.desc, func(t *testing.T) {\n\t\t\t// define model layer mock\n\t\t\tmockRegisterModel := scenario.inModelMock()\n\n\t\t\t// build handler\n\t\t\thandler := NewRegisterHandler(mockRegisterModel)\n\n\t\t\t// perform request\n\t\t\tresponse := httptest.NewRecorder()\n\t\t\thandler.ServeHTTP(response, scenario.inRequest())\n\n\t\t\t// validate outputs\n\t\t\trequire.Equal(t, scenario.expectedStatus, response.Code)\n\n\t\t\t// call should output the location to the new person\n\t\t\tresultHeader := response.Header().Get(\"Location\")\n\t\t\tassert.Equal(t, scenario.expectedHeader, resultHeader)\n\n\t\t\t// validate the mock was used as we expected\n\t\t\tassert.True(t, mockRegisterModel.AssertExpectations(t))\n\t\t})\n\t}\n}\n\nfunc buildValidRegisterRequest() io.Reader {\n\trequestData := ®isterRequest{\n\t\tFullName: \"Joan Smith\",\n\t\tCurrency: \"AUD\",\n\t\tPhone: \"01234567890\",\n\t}\n\n\tdata, _ := json.Marshal(requestData)\n\treturn bytes.NewBuffer(data)\n}\n" }, { "path": "ch11/acme/internal/rest/server.go", "content": "package rest\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/logging\"\n\t\"github.com/gorilla/mux\"\n)\n\n// Config is the config for the REST package\ntype Config interface {\n\tLogger() logging.Logger\n\tBindAddress() string\n}\n\n// New will create and initialize the server\nfunc New(cfg Config,\n\tgetModel GetModel,\n\tlistModel ListModel,\n\tregisterModel RegisterModel) *Server {\n\n\treturn &Server{\n\t\taddress: cfg.BindAddress(),\n\t\thandlerGet: NewGetHandler(cfg, getModel),\n\t\thandlerList: NewListHandler(listModel),\n\t\thandlerNotFound: notFoundHandler,\n\t\thandlerRegister: NewRegisterHandler(registerModel),\n\t}\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n\taddress string\n\tserver *http.Server\n\n\thandlerGet http.Handler\n\thandlerList http.Handler\n\thandlerNotFound http.HandlerFunc\n\thandlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n\trouter := s.buildRouter()\n\n\t// create the HTTP server\n\ts.server = &http.Server{\n\t\tHandler: router,\n\t\tAddr: s.address,\n\t}\n\n\t// listen for shutdown\n\tgo func() {\n\t\t// wait for shutdown signal\n\t\t<-stop\n\n\t\t_ = s.server.Close()\n\t}()\n\n\t// start the HTTP server\n\t_ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n\trouter := mux.NewRouter()\n\n\t// map URL endpoints to HTTP handlers\n\trouter.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n\trouter.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n\trouter.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n\t// convert a \"catch all\" not found handler\n\trouter.NotFoundHandler = s.handlerNotFound\n\n\treturn router\n}\n" }, { "path": "ch11/acme/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\nfunc main() {\n\t// bind stop channel to context\n\tctx := context.Background()\n\n\t// start REST server\n\tserver, err := initializeServer()\n\tif err != nil {\n\t\tos.Exit(-1)\n\t}\n\n\tserver.Listen(ctx.Done())\n}\n\n// List of wire enabled objects\nvar wireSetWithoutConfig = wire.NewSet(\n\t// *exchange.Converter\n\texchange.NewConverter,\n\n\t// *get.Getter\n\tget.NewGetter,\n\n\t// *list.Lister\n\tlist.NewLister,\n\n\t// *register.Registerer\n\twire.Bind(new(register.Exchanger), &exchange.Converter{}),\n\tregister.NewRegisterer,\n\n\t// *rest.Server\n\twire.Bind(new(rest.GetModel), &get.Getter{}),\n\twire.Bind(new(rest.ListModel), &list.Lister{}),\n\twire.Bind(new(rest.RegisterModel), ®ister.Registerer{}),\n\trest.New,\n)\n\nvar wireSet = wire.NewSet(\n\twireSetWithoutConfig,\n\n\t// *config.Config\n\tconfig.Load,\n\n\t// *exchange.Converter\n\twire.Bind(new(exchange.Config), &config.Config{}),\n\n\t// *get.Getter\n\twire.Bind(new(get.Config), &config.Config{}),\n\n\t// *list.Lister\n\twire.Bind(new(list.Config), &config.Config{}),\n\n\t// *register.Registerer\n\twire.Bind(new(register.Config), &config.Config{}),\n\n\t// *rest.Server\n\twire.Bind(new(rest.Config), &config.Config{}),\n)\n" }, { "path": "ch11/acme/main_test.go", "content": "package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"net\"\n\t\"net/http\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/config\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRegister(t *testing.T) {\n\t// start a context with a max execution time\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// start test server\n\tserverAddress := startTestServer(t, ctx)\n\n\t// build and send request\n\tpayload := bytes.NewBufferString(`\n{\n\t\"fullName\": \"Bob\",\n\t\"phone\": \"0123456789\",\n\t\"currency\": \"AUD\"\n}\n`)\n\n\treq, err := http.NewRequest(\"POST\", serverAddress+\"/person/register\", payload)\n\trequire.NoError(t, err)\n\n\tresp, err := http.DefaultClient.Do(req)\n\trequire.NoError(t, err)\n\n\t// validate expectations\n\tassert.Equal(t, http.StatusCreated, resp.StatusCode)\n\tassert.NotEmpty(t, resp.Header.Get(\"Location\"))\n}\n\nfunc TestGet(t *testing.T) {\n\t// start a context with a max execution time\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// start test server\n\tserverAddress := startTestServer(t, ctx)\n\n\t// build and send request\n\treq, err := http.NewRequest(\"GET\", serverAddress+\"/person/1/\", nil)\n\trequire.NoError(t, err)\n\n\tresp, err := http.DefaultClient.Do(req)\n\trequire.NoError(t, err)\n\n\t// validate expectations\n\tassert.Equal(t, http.StatusOK, resp.StatusCode)\n}\n\nfunc TestList(t *testing.T) {\n\t// start a context with a max execution time\n\tctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)\n\tdefer cancel()\n\n\t// start test server\n\tserverAddress := startTestServer(t, ctx)\n\n\t// build and send request\n\treq, err := http.NewRequest(\"GET\", serverAddress+\"/person/list\", nil)\n\trequire.NoError(t, err)\n\n\tresp, err := http.DefaultClient.Do(req)\n\trequire.NoError(t, err)\n\n\t// validate expectations\n\tassert.Equal(t, http.StatusOK, resp.StatusCode)\n}\n\nfunc startTestServer(t *testing.T, ctx context.Context) string {\n\t// load the standard config (from the ENV)\n\tcfg, err := config.Load()\n\trequire.NoError(t, err)\n\n\t// get a free port (so tests can run concurrently)\n\tport, err := getFreePort()\n\trequire.NoError(t, err)\n\n\t// override config port with free one\n\tcfg.Address = net.JoinHostPort(\"0.0.0.0\", port)\n\n\t// start the test server on a random port\n\tgo func() {\n\t\t// start REST server\n\t\tserver := initializeServerCustomConfig(cfg, cfg, cfg, cfg, cfg)\n\t\tserver.Listen(ctx.Done())\n\t}()\n\n\t// give the server a chance to start\n\t<-time.After(100 * time.Millisecond)\n\n\t// return the address of the test server\n\treturn \"http://\" + cfg.Address\n}\n\nfunc getFreePort() (string, error) {\n\tfor attempt := 0; attempt <= 10; attempt++ {\n\t\taddr := net.JoinHostPort(\"\", \"0\")\n\t\tlistener, err := net.Listen(\"tcp\", addr)\n\t\tif err != nil {\n\t\t\tcontinue\n\t\t}\n\n\t\tport, err := getPort(listener.Addr())\n\t\tif err != nil {\n\t\t\tcontinue\n\t\t}\n\n\t\t// close/free the port\n\t\ttcpListener := listener.(*net.TCPListener)\n\t\tcErr := tcpListener.Close()\n\t\tif cErr == nil {\n\t\t\tfile, fErr := tcpListener.File()\n\t\t\tif fErr == nil {\n\t\t\t\t// ignore any errors cleaning up the file\n\t\t\t\t_ = file.Close()\n\t\t\t}\n\t\t\treturn port, nil\n\t\t}\n\t}\n\n\treturn \"\", errors.New(\"no free ports\")\n}\n\nfunc getPort(addr fmt.Stringer) (string, error) {\n\tactualAddress := addr.String()\n\t_, port, err := net.SplitHostPort(actualAddress)\n\treturn port, err\n}\n" }, { "path": "ch11/acme/wire.go", "content": "//+build wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/rest\"\n\t\"github.com/google/wire\"\n)\n\n// The build tag makes sure the stub is not built in the final build.\n\nfunc initializeServer() (*rest.Server, error) {\n\twire.Build(wireSet)\n\treturn nil, nil\n}\n\nfunc initializeServerCustomConfig(_ exchange.Config, _ get.Config, _ list.Config, _ register.Config, _ rest.Config) *rest.Server {\n\twire.Build(wireSetWithoutConfig)\n\treturn nil\n}\n" }, { "path": "ch11/acme/wire_gen.go", "content": "// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\nimport (\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/config\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/exchange\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/get\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/list\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/modules/register\"\n\t\"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch11/acme/internal/rest\"\n)\n\n// Injectors from wire.go:\n\nfunc initializeServer() (*rest.Server, error) {\n\tconfigConfig, err := config.Load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tgetter := get.NewGetter(configConfig)\n\tlister := list.NewLister(configConfig)\n\tconverter := exchange.NewConverter(configConfig)\n\tregisterer := register.NewRegisterer(configConfig, converter)\n\tserver := rest.New(configConfig, getter, lister, registerer)\n\treturn server, nil\n}\n\nfunc initializeServerCustomConfig(exchangeConfig exchange.Config, getConfig get.Config, listConfig list.Config, registerConfig register.Config, restConfig rest.Config) *rest.Server {\n\tgetter := get.NewGetter(getConfig)\n\tlister := list.NewLister(listConfig)\n\tconverter := exchange.NewConverter(exchangeConfig)\n\tregisterer := register.NewRegisterer(registerConfig, converter)\n\tserver := rest.New(restConfig, getter, lister, registerer)\n\treturn server\n}\n" }, { "path": "ch12/01_improvements/01_test_logging_test.go", "content": "package improvements\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLogging(t *testing.T) {\n\t// build log recorder\n\trecorder := &LogRecorder{}\n\n\t// Call struct that uses a logger\n\tcalculator := &Calculator{\n\t\tlogger: recorder,\n\t}\n\tresult := calculator.divide(10, 0)\n\n\t// validate expectations, including that the logger was called\n\tassert.Equal(t, 0, result)\n\trequire.Equal(t, 1, len(recorder.Logs))\n\tassert.Equal(t, \"cannot divide by 0\", recorder.Logs[0])\n}\n\ntype Calculator struct {\n\tlogger Logger\n}\n\nfunc (c *Calculator) divide(dividend int, divisor int) int {\n\tif divisor == 0 {\n\t\tc.logger.Error(\"cannot divide by 0\")\n\t\treturn 0\n\t}\n\n\treturn dividend / divisor\n}\n\n// Logger is our standard interface\ntype Logger interface {\n\tError(message string, args ...interface{})\n}\n\n// LogRecorder implements Logger interface\ntype LogRecorder struct {\n\tLogs []string\n}\n\nfunc (l *LogRecorder) Error(message string, args ...interface{}) {\n\t// build log message\n\tlogMessage := fmt.Sprintf(message, args...)\n\n\t// record log message\n\tl.Logs = append(l.Logs, logMessage)\n}\n" }, { "path": "ch12/03_testing/01_mock_get_model.go", "content": "package testing\n\nimport (\n\t\"github.com/stretchr/testify/mock\"\n)\n\ntype MockGetModel struct {\n\tmock.Mock\n}\n\nfunc (_m *MockGetModel) Do(ID int) (*Person, error) {\n\toutputs := _m.Called(ID)\n\n\tif outputs.Get(0) != nil {\n\t\treturn outputs.Get(0).(*Person), outputs.Error(1)\n\t}\n\n\treturn nil, outputs.Error(1)\n}\n\ntype Person struct {\n\tID int\n\tFullName string\n\tPhone string\n\tCurrency string\n\tPrice float64\n}\n" }, { "path": "ch12/03_testing/02_coverage_ch04.txt", "content": "----------------------------------------------------------------------------\n| Branch | Dir | |\n| Cov% | Stmts | Cov% | Stmts | Package |\n----------------------------------------------------------------------------\n| 52.94 | 238 | 0.00 | 3 | acme/ |\n| 73.33 | 15 | 73.33 | 15 | acme/internal/config/ |\n| 0.00 | 4 | 0.00 | 4 | acme/internal/logging/ |\n| 63.33 | 60 | 63.33 | 60 | acme/internal/modules/data/ |\n| 0.00 | 38 | 0.00 | 38 | acme/internal/modules/exchange/ |\n| 50.00 | 6 | 50.00 | 6 | acme/internal/modules/get/ |\n| 25.00 | 12 | 25.00 | 12 | acme/internal/modules/list/ |\n| 64.29 | 28 | 64.29 | 28 | acme/internal/modules/register/ |\n| 73.61 | 72 | 73.61 | 72 | acme/internal/rest/ |\n----------------------------------------------------------------------------" }, { "path": "ch12/03_testing/03_coverage_ch11.txt", "content": "----------------------------------------------------------------------------\n| Branch | Dir | |\n| Cov% | Stmts | Cov% | Stmts | Package |\n----------------------------------------------------------------------------\n| 63.11 | 309 | 30.00 | 20 | acme/ |\n| 28.57 | 28 | 28.57 | 28 | acme/internal/config/ |\n| 0.00 | 4 | 0.00 | 4 | acme/internal/logging/ |\n| 74.65 | 71 | 74.65 | 71 | acme/internal/modules/data/ |\n| 61.70 | 47 | 61.70 | 47 | acme/internal/modules/exchange/ |\n| 81.82 | 11 | 81.82 | 11 | acme/internal/modules/get/ |\n| 38.10 | 21 | 38.10 | 21 | acme/internal/modules/list/ |\n| 75.76 | 33 | 75.76 | 33 | acme/internal/modules/register/ |\n| 77.03 | 74 | 77.03 | 74 | acme/internal/rest/ |\n----------------------------------------------------------------------------\n" }, { "path": "ch12/03_testing/04_coverage_config.htm", "content": "\n\n\n\t\t\n\t\t\n\t\n\t\n\t\tpackage config\n\nimport (\n \"encoding/json\"\n \"fmt\"\n \"io/ioutil\"\n \"os\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n)\n\n// DefaultEnvVar is the default environment variable the points to the config file\nconst DefaultEnvVar = \"ACME_CONFIG\"\n\n// Config defines the JSON format for the config file\ntype Config struct {\n // DSN is the data source name (format: https://github.com/go-sql-driver/mysql/#dsn-data-source-name)\n DSN string\n\n // Address is the IP address and port to bind this rest to\n Address string\n\n // BasePrice is the price of registration\n BasePrice float64\n\n // ExchangeRateBaseURL is the server and protocol part of the URL from which to load the exchange rate\n ExchangeRateBaseURL string\n\n // ExchangeRateAPIKey is the API for the exchange rate API\n ExchangeRateAPIKey string\n\n // environmental dependencies\n logger logging.Logger\n}\n\n// Logger returns a reference to the singleton logger\nfunc (c *Config) Logger() logging.Logger {\n if c.logger == nil {\n c.logger = &logging.LoggerStdOut{}\n }\n\n return c.logger\n}\n\n// RegistrationBasePrice returns the base price for registrations\nfunc (c *Config) RegistrationBasePrice() float64 {\n return c.BasePrice\n}\n\n// DataDSN returns the DSN\nfunc (c *Config) DataDSN() string {\n return c.DSN\n}\n\n// ExchangeBaseURL returns the Base URL from which we can load exchange rates\nfunc (c *Config) ExchangeBaseURL() string {\n return c.ExchangeRateBaseURL\n}\n\n// ExchangeAPIKey returns the DSN\nfunc (c *Config) ExchangeAPIKey() string {\n return c.ExchangeRateAPIKey\n}\n\n// BindAddress returns the host and port this service should bind to\nfunc (c *Config) BindAddress() string {\n return c.Address\n}\n\n// Load returns the config loaded from environment\nfunc Load() (*Config, error) {\n filename, found := os.LookupEnv(DefaultEnvVar)\n if !found {\n err := fmt.Errorf(\"failed to locate file specified by %s\", DefaultEnvVar)\n fmt.Fprintf(os.Stderr, err.Error())\n return nil, err\n }\n\n cfg, err := load(filename)\n if err != nil {\n fmt.Fprintf(os.Stderr, \"failed to load config with err %s\", err)\n return nil, err\n }\n\n return cfg, nil\n}\n\nfunc load(filename string) (*Config, error) {\n out := &Config{}\n bytes, err := ioutil.ReadFile(filename)\n if err != nil {\n fmt.Fprintf(os.Stderr, \"failed to read config file. err: %s\", err)\n return nil, err\n }\n\n err = json.Unmarshal(bytes, out)\n if err != nil {\n fmt.Fprintf(os.Stderr, \"failed to parse config file. err : %s\", err)\n return nil, err\n }\n\n return out, nil\n}\n\n\t\t\n\t\tpackage data\n\nimport (\n \"context\"\n \"database/sql\"\n \"time\"\n)\n\n// NewDAO will initialize the database connection pool (if not already done) and return a data access object which\n// can be used to interact with the database\nfunc NewDAO(cfg Config) *DAO {\n // initialize the db connection pool\n _, _ = getDB(cfg)\n\n return &DAO{\n cfg: cfg,\n }\n}\n\n// DAO is a data access object that provides an abstraction over our database interactions.\ntype DAO struct {\n cfg Config\n\n // Tracker is an optional query timer\n Tracker QueryTracker\n}\n\n// Load will attempt to load and return a person.\n// It will return ErrNotFound when the requested person does not exist.\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Load(ctx context.Context, ID int) (*Person, error) {\n // track processing time\n defer d.getTracker().Track(\"Load\", time.Now())\n\n db, err := getDB(d.cfg)\n if err != nil {\n d.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n return nil, err\n }\n\n // set latency budget for the database call\n subCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n defer cancel()\n\n // perform DB select\n row := db.QueryRowContext(subCtx, sqlLoadByID, ID)\n\n // retrieve columns and populate the person object\n out, err := populatePerson(row.Scan)\n if err != nil {\n if err == sql.ErrNoRows {\n d.cfg.Logger().Warn(\"failed to load requested person '%d'. err: %s\", ID, err)\n return nil, ErrNotFound\n }\n\n d.cfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n return nil, err\n }\n return out, nil\n}\n\n// LoadAll will attempt to load all people in the database\n// It will return ErrNotFound when there are not people in the database\n// Any other errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) LoadAll(ctx context.Context) ([]*Person, error) {\n // track processing time\n defer d.getTracker().Track(\"LoadAll\", time.Now())\n\n db, err := getDB(d.cfg)\n if err != nil {\n d.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n return nil, err\n }\n\n // set latency budget for the database call\n subCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n defer cancel()\n\n // perform DB select\n rows, err := db.QueryContext(subCtx, sqlLoadAll)\n if err != nil {\n return nil, err\n }\n defer func() {\n _ = rows.Close()\n }()\n\n var out []*Person\n\n for rows.Next() {\n // retrieve columns and populate the person object\n record, err := populatePerson(rows.Scan)\n if err != nil {\n d.cfg.Logger().Error(\"failed to convert query result. err: %s\", err)\n return nil, err\n }\n\n out = append(out, record)\n }\n\n if len(out) == 0 {\n d.cfg.Logger().Warn(\"no people found in the database.\")\n return nil, ErrNotFound\n }\n\n return out, nil\n}\n\n// Save will save the supplied person and return the ID of the newly created person or an error.\n// Errors returned are caused by the underlying database or our connection to it.\nfunc (d *DAO) Save(ctx context.Context, in *Person) (int, error) {\n // track processing time\n defer d.getTracker().Track(\"Save\", time.Now())\n\n db, err := getDB(d.cfg)\n if err != nil {\n d.cfg.Logger().Error(\"failed to get DB connection. err: %s\", err)\n return defaultPersonID, err\n }\n\n // set latency budget for the database call\n subCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n defer cancel()\n\n // perform DB insert\n result, err := db.ExecContext(subCtx, sqlInsert, in.FullName, in.Phone, in.Currency, in.Price)\n if err != nil {\n d.cfg.Logger().Error(\"failed to save person into DB. err: %s\", err)\n return defaultPersonID, err\n }\n\n // retrieve and return the ID of the person created\n id, err := result.LastInsertId()\n if err != nil {\n d.cfg.Logger().Error(\"failed to retrieve id of last saved person. err: %s\", err)\n return defaultPersonID, err\n }\n\n return int(id), nil\n}\n\nfunc (d *DAO) getTracker() QueryTracker {\n if d.Tracker == nil {\n d.Tracker = &noopTracker{}\n }\n\n return d.Tracker\n}\n\n\t\t\n\t\t
package data\n\nimport (\n \"database/sql\"\n \"errors\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n _ \"github.com/go-sql-driver/mysql\"\n)\n\nconst (\n // default person id (returned on error)\n defaultPersonID = 0\n\n // SQL statements as constants (to reduce duplication and maintenance in tests)\n sqlAllColumns = \"id, fullname, phone, currency, price\"\n sqlInsert = \"INSERT INTO person (fullname, phone, currency, price) VALUES (?, ?, ?, ?)\"\n sqlLoadAll = \"SELECT \" + sqlAllColumns + \" FROM person\"\n sqlLoadByID = \"SELECT \" + sqlAllColumns + \" FROM person WHERE id = ? LIMIT 1\"\n)\n\nvar (\n db *sql.DB\n\n // ErrNotFound is returned when the no records where matched by the query\n ErrNotFound = errors.New(\"not found\")\n)\n\n// Config is the configuration for the data package\ntype Config interface {\n // Logger returns a reference to the logger\n Logger() logging.Logger\n\n // DataDSN returns the data source name\n DataDSN() string\n}\n\nvar getDB = func(cfg Config) (*sql.DB, error) {\n if db == nil {\n var err error\n db, err = sql.Open(\"mysql\", cfg.DataDSN())\n if err != nil {\n // if the DB cannot be accessed we are dead\n panic(err.Error())\n }\n }\n\n return db, nil\n}\n\n// Person is the data transfer object (DTO) for this package\ntype Person struct {\n // ID is the unique ID for this person\n ID int\n // FullName is the name of this person\n FullName string\n // Phone is the phone for this person\n Phone string\n // Currency is the currency this person has paid in\n Currency string\n // Price is the amount (in the above currency) paid by this person\n Price float64\n}\n\n// custom type so we can convert sql results to easily\ntype scanner func(dest ...interface{}) error\n\n// reduce the duplication (and maintenance) between sql.Row and sql.Rows usage\nfunc populatePerson(scanner scanner) (*Person, error) {\n out := &Person{}\n err := scanner(&out.ID, &out.FullName, &out.Phone, &out.Currency, &out.Price)\n return out, err\n}\n\n\t\t\n\t\tpackage data\n\nimport (\n \"time\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n)\n\n// QueryTracker is an interface to track query timing\ntype QueryTracker interface {\n // Track will record/out the time a query took by calculating time.Now().Sub(start)\n Track(key string, start time.Time)\n}\n\n// NO-OP implementation of QueryTracker\ntype noopTracker struct{}\n\n// Track implements QueryTracker\nfunc (_ *noopTracker) Track(_ string, _ time.Time) {\n // intentionally does nothing\n}\n\n// NewLogTracker returns a Tracker that outputs tracking data to log\nfunc NewLogTracker(logger logging.Logger) *LogTracker {\n return &LogTracker{\n logger: logger,\n }\n}\n\n// LogTracker implements QueryTracker and outputs to the supplied logger\ntype LogTracker struct {\n logger logging.Logger\n}\n\n// Track implements QueryTracker\nfunc (l *LogTracker) Track(key string, start time.Time) {\n l.logger.Info(\"[%s] Timing: %s\\n\", key, time.Now().Sub(start).String())\n}\n\n\t\t\n\t\tpackage exchange\n\nimport (\n \"context\"\n \"encoding/json\"\n \"fmt\"\n \"io/ioutil\"\n \"math\"\n \"net/http\"\n \"time\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n)\n\nconst (\n // request URL for the exchange rate API\n\t\turlFormat = \"%s/api/historical?access_key=%s&date=2018-06-20¤cies=%s\"\n\n // default price that is sent when an error occurs\n defaultPrice = 0.0\n)\n\n// NewConverter creates and initializes the converter\nfunc NewConverter(cfg Config) *Converter {\n return &Converter{\n cfg: cfg,\n }\n}\n\n// Config is the config for Converter\ntype Config interface {\n Logger() logging.Logger\n ExchangeBaseURL() string\n ExchangeAPIKey() string\n}\n\n// Converter will convert the base price to the currency supplied\n// Note: we are expecting sane inputs and therefore skipping input validation\ntype Converter struct {\n cfg Config\n}\n\n// Exchange will perform the conversion\nfunc (c *Converter) Exchange(ctx context.Context, basePrice float64, currency string) (float64, error) {\n // load rate from the external API\n response, err := c.loadRateFromServer(ctx, currency)\n if err != nil {\n return defaultPrice, err\n }\n\n // extract rate from response\n rate, err := c.extractRate(response, currency)\n if err != nil {\n return defaultPrice, err\n }\n\n // apply rate and round to 2 decimal places\n return math.Floor((basePrice/rate)*100) / 100, nil\n}\n\n// load rate from the external API\nfunc (c *Converter) loadRateFromServer(ctx context.Context, currency string) (*http.Response, error) {\n // build the request\n url := fmt.Sprintf(urlFormat,\n c.cfg.ExchangeBaseURL(),\n c.cfg.ExchangeAPIKey(),\n currency)\n\n // perform request\n req, err := http.NewRequest(\"GET\", url, nil)\n if err != nil {\n c.logger().Warn(\"[exchange] failed to create request. err: %s\", err)\n return nil, err\n }\n\n // set latency budget for the upstream call\n subCtx, cancel := context.WithTimeout(ctx, 1*time.Second)\n defer cancel()\n\n // replace the default context with our custom one\n req = req.WithContext(subCtx)\n\n // perform the HTTP request\n response, err := http.DefaultClient.Do(req)\n if err != nil {\n c.logger().Warn(\"[exchange] failed to load. err: %s\", err)\n return nil, err\n }\n\n if response.StatusCode != http.StatusOK {\n err = fmt.Errorf(\"request failed with code %d\", response.StatusCode)\n c.logger().Warn(\"[exchange] %s\", err)\n return nil, err\n }\n\n return response, nil\n}\n\nfunc (c *Converter) extractRate(response *http.Response, currency string) (float64, error) {\n defer func() {\n _ = response.Body.Close()\n }()\n\n // extract data from response\n data, err := c.extractResponse(response)\n if err != nil {\n return defaultPrice, err\n }\n\n // pull rate from response data\n rate, found := data.Quotes[\"USD\" + currency]\n if !found {\n err = fmt.Errorf(\"response did not include expected currency '%s'\", currency)\n c.logger().Error(\"[exchange] %s\", err)\n return defaultPrice, err\n }\n\n // happy path\n return rate, nil\n}\n\nfunc (c *Converter) extractResponse(response *http.Response) (*apiResponseFormat, error) {\n payload, err := ioutil.ReadAll(response.Body)\n if err != nil {\n c.logger().Error(\"[exchange] failed to ready response body. err: %s\", err)\n return nil, err\n }\n\n data := &apiResponseFormat{}\n err = json.Unmarshal(payload, data)\n if err != nil {\n c.logger().Error(\"[exchange] error converting response. err: %s\", err)\n return nil, err\n }\n\n // happy path\n return data, nil\n}\n\nfunc (c *Converter) logger() logging.Logger {\n return c.cfg.Logger()\n}\n\n// the response format from the exchange rate API\ntype apiResponseFormat struct {\n Quotes map[string]float64 `json:\"quotes\"`\n}\n\n\t\t\n\t\t
package get\n\nimport (\n \"context\"\n \"errors\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/data\"\n)\n\nvar (\n // error thrown when the requested person is not in the database\n errPersonNotFound = errors.New(\"person not found\")\n)\n\n// NewGetter creates and initializes a Getter\nfunc NewGetter(cfg Config) *Getter {\n return &Getter{\n cfg: cfg,\n }\n}\n\n// Config is the configuration for Getter\ntype Config interface {\n Logger() logging.Logger\n DataDSN() string\n}\n\n// Getter will attempt to load a person.\n// It can return an error caused by the data layer or when the requested person is not found\ntype Getter struct {\n cfg Config\n data myLoader\n}\n\n// Do will perform the get\nfunc (g *Getter) Do(ID int) (*Person, error) {\n // load person from the data layer\n person, err := g.getLoader().Load(context.TODO(), ID)\n if err != nil {\n if err == data.ErrNotFound {\n // By converting the error we are hiding the implementation details from our users.\n return nil, errPersonNotFound\n }\n return nil, err\n }\n\n return g.convert(person), err\n}\n\nfunc (g *Getter) getLoader() myLoader {\n if g.data == nil {\n g.data = data.NewDAO(g.cfg)\n }\n\n return g.data\n}\n\nfunc (g *Getter) convert(in *data.Person) *Person {\n return &Person{\n ID: in.ID,\n Currency: in.Currency,\n FullName: in.FullName,\n Phone: in.Phone,\n Price: in.Price,\n }\n}\n\n//go:generate mockery -name=myLoader -case underscore -testonly -inpkg -note @generated\ntype myLoader interface {\n Load(ctx context.Context, ID int) (*data.Person, error)\n}\n\n// Person is a copy/sub-set of data.Person so that the relationship does not leak.\n// It also allows us to remove/hide and internal fields\ntype Person struct {\n ID int\n FullName string\n Phone string\n Currency string\n Price float64\n}\n\n\t\t\n\t\t
package list\n\nimport (\n \"context\"\n \"errors\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/data\"\n)\n\nvar (\n // error thrown when there are no people in the database\n errPeopleNotFound = errors.New(\"no people found\")\n)\n\n// NewLister creates and initializes a Lister\nfunc NewLister(cfg Config) *Lister {\n return &Lister{\n cfg: cfg,\n }\n}\n\n// Config is the config for Lister\ntype Config interface {\n Logger() logging.Logger\n DataDSN() string\n}\n\n// Lister will attempt to load all people in the database.\n// It can return an error caused by the data layer\ntype Lister struct {\n cfg Config\n data myLoader\n}\n\n// Exchange will load the people from the data layer\nfunc (l *Lister) Do() ([]*Person, error) {\n // load all people\n people, err := l.load()\n if err != nil {\n return nil, err\n }\n\n if len(people) == 0 {\n // special processing for 0 people returned\n return nil, errPeopleNotFound\n }\n\n return l.convert(people), nil\n}\n\n// load all people\nfunc (l *Lister) load() ([]*data.Person, error) {\n people, err := l.getLoader().LoadAll(context.TODO())\n if err != nil {\n if err == data.ErrNotFound {\n // By converting the error we are encapsulating the implementation details from our users.\n return nil, errPeopleNotFound\n }\n return nil, err\n }\n\n return people, nil\n}\n\nfunc (l *Lister) getLoader() myLoader {\n if l.data == nil {\n l.data = data.NewDAO(l.cfg)\n\n // temporarily add a log tracker\n l.data.(*data.DAO).Tracker = data.NewLogTracker(l.cfg.Logger())\n }\n\n return l.data\n}\n\nfunc (l *Lister) convert(in []*data.Person) []*Person {\n out := make([]*Person, len(in))\n\n for index, thisRecord := range in {\n out[index] = &Person{\n ID: thisRecord.ID,\n FullName: thisRecord.FullName,\n Phone: thisRecord.Phone,\n }\n }\n\n return out\n}\n\n//go:generate mockery -name=myLoader -case underscore -testonly -inpkg -note @generated\ntype myLoader interface {\n LoadAll(ctx context.Context) ([]*data.Person, error)\n}\n\n// Person is a copy/sub-set of data.Person so that the relationship does not leak.\n// It also allows us to remove/hide and internal fields\ntype Person struct {\n ID int\n FullName string\n Phone string\n}\n\n\t\t\n\t\t
package main\n\nimport (\n \"context\"\n \"os\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/config\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/exchange\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/get\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/list\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/register\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/rest\"\n \"github.com/google/wire\"\n)\n\nfunc main() {\n // bind stop channel to context\n ctx := context.Background()\n\n // start REST server\n server, err := initializeServer()\n if err != nil {\n os.Exit(-1)\n }\n\n server.Listen(ctx.Done())\n}\n\n// List of wire enabled objects\nvar wireSetWithoutConfig = wire.NewSet(\n // *exchange.Converter\n exchange.NewConverter,\n\n // *get.Getter\n get.NewGetter,\n\n // *list.Lister\n list.NewLister,\n\n // *register.Registerer\n wire.Bind(new(register.Exchanger), &exchange.Converter{}),\n register.NewRegisterer,\n\n // *rest.Server\n wire.Bind(new(rest.GetModel), &get.Getter{}),\n wire.Bind(new(rest.ListModel), &list.Lister{}),\n wire.Bind(new(rest.RegisterModel), ®ister.Registerer{}),\n rest.New,\n)\n\nvar wireSet = wire.NewSet(\n wireSetWithoutConfig,\n\n // *config.Config\n config.Load,\n\n // *exchange.Converter\n wire.Bind(new(exchange.Config), &config.Config{}),\n\n // *get.Getter\n wire.Bind(new(get.Config), &config.Config{}),\n\n // *list.Lister\n wire.Bind(new(list.Config), &config.Config{}),\n\n // *register.Registerer\n wire.Bind(new(register.Config), &config.Config{}),\n\n // *rest.Server\n wire.Bind(new(rest.Config), &config.Config{}),\n)\n\n\t\t\n\t\t
// Code generated by Wire. DO NOT EDIT.\n\n//go:generate wire\n//+build !wireinject\n\npackage main\n\nimport (\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/config\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/exchange\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/get\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/list\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/register\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/rest\"\n)\n\n// Injectors from wire.go:\n\nfunc initializeServer() (*rest.Server, error) {\n configConfig, err := config.Load()\n if err != nil {\n return nil, err\n }\n getter := get.NewGetter(configConfig)\n lister := list.NewLister(configConfig)\n converter := exchange.NewConverter(configConfig)\n registerer := register.NewRegisterer(configConfig, converter)\n server := rest.New(configConfig, getter, lister, registerer)\n return server, nil\n}\n\nfunc initializeServerCustomConfig(exchangeConfig exchange.Config, getConfig get.Config, listConfig list.Config, registerConfig register.Config, restConfig rest.Config) *rest.Server {\n getter := get.NewGetter(getConfig)\n lister := list.NewLister(listConfig)\n converter := exchange.NewConverter(exchangeConfig)\n registerer := register.NewRegisterer(registerConfig, converter)\n server := rest.New(restConfig, getter, lister, registerer)\n return server\n}\n\n\t\t\n\t\t
package register\n\nimport (\n \"context\"\n \"errors\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/data\"\n)\n\nconst (\n // default person id (returned on error)\n defaultPersonID = 0\n)\n\nvar (\n // validation errors\n errNameMissing = errors.New(\"name is missing\")\n errPhoneMissing = errors.New(\"phone is missing\")\n errCurrencyMissing = errors.New(\"currency is missing\")\n errInvalidCurrency = errors.New(\"currency is invalid, supported types are AUD, CNY, EUR, GBP, JPY, MYR, SGD, USD\")\n\n // a little trick to make checking for supported currencies easier\n supportedCurrencies = map[string]struct{}{\n \"AUD\": {},\n \"CNY\": {},\n \"EUR\": {},\n \"GBP\": {},\n \"JPY\": {},\n \"MYR\": {},\n \"SGD\": {},\n \"USD\": {},\n }\n)\n\n// NewRegisterer creates and initializes a Registerer\nfunc NewRegisterer(cfg Config, exchanger Exchanger) *Registerer {\n return &Registerer{\n cfg: cfg,\n exchanger: exchanger,\n }\n}\n\n// Exchanger will convert from one currency to another\n//go:generate mockery -name=Exchanger -case underscore -testonly -inpkg -note @generated\ntype Exchanger interface {\n // Exchange will perform the conversion\n Exchange(ctx context.Context, basePrice float64, currency string) (float64, error)\n}\n\n// Config is the configuration for the Registerer\ntype Config interface {\n Logger() logging.Logger\n RegistrationBasePrice() float64\n DataDSN() string\n}\n\n// Registerer validates the supplied person, calculates the price in the requested currency and saves the result.\n// It will return an error when:\n// -the person object does not include all the fields\n// -the currency is invalid\n// -the exchange rate cannot be loaded\n// -the data layer throws an error.\ntype Registerer struct {\n cfg Config\n exchanger Exchanger\n data mySaver\n}\n\n// Do is API for this struct\nfunc (r *Registerer) Do(ctx context.Context, in *Person) (int, error) {\n // validate the request\n err := r.validateInput(in)\n if err != nil {\n r.logger().Warn(\"input validation failed with err: %s\", err)\n return defaultPersonID, err\n }\n\n // get price in the requested currency\n price, err := r.getPrice(ctx, in.Currency)\n if err != nil {\n return defaultPersonID, err\n }\n\n // save registration\n id, err := r.save(ctx, r.convert(in), price)\n if err != nil {\n // no need to log here as we expect the data layer to do so\n return defaultPersonID, err\n }\n\n return id, nil\n}\n\n// validate input and return error on fail\nfunc (r *Registerer) validateInput(in *Person) error {\n if in.FullName == \"\" {\n return errNameMissing\n }\n if in.Phone == \"\" {\n return errPhoneMissing\n }\n if in.Currency == \"\" {\n return errCurrencyMissing\n }\n\n if _, found := supportedCurrencies[in.Currency]; !found {\n return errInvalidCurrency\n }\n\n // happy path\n return nil\n}\n\n// get price in the requested currency\nfunc (r *Registerer) getPrice(ctx context.Context, currency string) (float64, error) {\n price, err := r.exchanger.Exchange(ctx, r.cfg.RegistrationBasePrice(), currency)\n if err != nil {\n r.logger().Warn(\"failed to convert the price. err: %s\", err)\n return defaultPersonID, err\n }\n\n return price, nil\n}\n\n// save the registration\nfunc (r *Registerer) save(ctx context.Context, in *data.Person, price float64) (int, error) {\n person := &data.Person{\n FullName: in.FullName,\n Phone: in.Phone,\n Currency: in.Currency,\n Price: price,\n }\n return r.getSaver().Save(ctx, person)\n}\n\nfunc (r *Registerer) getSaver() mySaver {\n if r.data == nil {\n r.data = data.NewDAO(r.cfg)\n }\n\n return r.data\n}\n\nfunc (r *Registerer) logger() logging.Logger {\n return r.cfg.Logger()\n}\n\nfunc (r *Registerer) convert(in *Person) *data.Person {\n return &data.Person{\n ID: in.ID,\n Currency: in.Currency,\n FullName: in.FullName,\n Phone: in.Phone,\n Price: in.Price,\n }\n}\n\n//go:generate mockery -name=mySaver -case underscore -testonly -inpkg -note @generated\ntype mySaver interface {\n Save(ctx context.Context, in *data.Person) (int, error)\n}\n\n// Person is a copy/sub-set of data.Person so that the relationship does not leak.\n// It also allows us to remove/hide and internal fields\ntype Person struct {\n ID int\n FullName string\n Phone string\n Currency string\n Price float64\n}\n\n\t\t\n\t\tpackage rest\n\nimport (\n \"encoding/json\"\n \"errors\"\n \"fmt\"\n \"io\"\n \"net/http\"\n \"strconv\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/get\"\n \"github.com/gorilla/mux\"\n)\n\nconst (\n // default person id (returned on error)\n defaultPersonID = 0\n\n // key in the mux where the ID is stored\n muxVarID = \"id\"\n)\n\n// GetModel will load a registration\n//go:generate mockery -name=GetModel -case underscore -testonly -inpkg -note @generated\ntype GetModel interface {\n Do(ID int) (*get.Person, error)\n}\n\n// GetConfig is the config for the Get Handler\ntype GetConfig interface {\n Logger() logging.Logger\n}\n\n// NewGetHandler is the constructor for GetHandler\nfunc NewGetHandler(cfg GetConfig, model GetModel) *GetHandler {\n return &GetHandler{\n cfg: cfg,\n getter: model,\n }\n}\n\n// GetHandler is the HTTP handler for the \"Get Person\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400\n// or \"not found\" HTTP 404\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype GetHandler struct {\n cfg GetConfig\n getter GetModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *GetHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n // extract person id from request\n id, err := h.extractID(request)\n if err != nil {\n // output error\n response.WriteHeader(http.StatusBadRequest)\n return\n }\n\n // attempt get\n person, err := h.getter.Do(id)\n if err != nil {\n // not need to log here as we can expect other layers to do so\n response.WriteHeader(http.StatusNotFound)\n return\n }\n\n // happy path\n err = h.writeJSON(response, person)\n if err != nil {\n // this error should not happen but if it does there is nothing we can do to recover\n response.WriteHeader(http.StatusInternalServerError)\n }\n}\n\n// extract the person ID from the request\nfunc (h *GetHandler) extractID(request *http.Request) (int, error) {\n // ID is part of the URL, so we extract it from there\n vars := mux.Vars(request)\n idAsString, exists := vars[muxVarID]\n if !exists {\n // log and return error\n err := errors.New(\"[get] person id missing from request\")\n h.cfg.Logger().Warn(err.Error())\n return defaultPersonID, err\n }\n\n // convert ID to int\n id, err := strconv.Atoi(idAsString)\n if err != nil {\n // log and return error\n err = fmt.Errorf(\"[get] failed to convert person id into a number. err: %s\", err)\n h.cfg.Logger().Error(err.Error())\n return defaultPersonID, err\n }\n\n return id, nil\n}\n\n// output the supplied person as JSON\nfunc (h *GetHandler) writeJSON(writer io.Writer, person *get.Person) error {\n output := &getResponseFormat{\n ID: person.ID,\n FullName: person.FullName,\n Phone: person.Phone,\n Currency: person.Currency,\n Price: person.Price,\n }\n\n // call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n return json.NewEncoder(writer).Encode(output)\n}\n\n// the JSON response format\ntype getResponseFormat struct {\n ID int `json:\"id\"`\n FullName string `json:\"name\"`\n Phone string `json:\"phone\"`\n Currency string `json:\"currency\"`\n Price float64 `json:\"price\"`\n}\n\n\t\t\n\t\tpackage rest\n\nimport (\n \"encoding/json\"\n \"io\"\n \"net/http\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/list\"\n)\n\n// ListModel will load all registrations\n//go:generate mockery -name=ListModel -case underscore -testonly -inpkg -note @generated\ntype ListModel interface {\n Do() ([]*list.Person, error)\n}\n\n// NewLister is the constructor for ListHandler\nfunc NewListHandler(model ListModel) *ListHandler {\n return &ListHandler{\n lister: model,\n }\n}\n\n// ListHandler is the HTTP handler for the \"List Do people\" endpoint\n// In this simplified example we are assuming all possible errors are system errors (HTTP 500)\ntype ListHandler struct {\n lister ListModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *ListHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n // attempt loadAll\n people, err := h.lister.Do()\n if err != nil {\n // not need to log here as we can expect other layers to do so\n response.WriteHeader(http.StatusNotFound)\n return\n }\n\n // happy path\n err = h.writeJSON(response, people)\n if err != nil {\n // this error should not happen but if it does there is nothing we can do to recover\n response.WriteHeader(http.StatusInternalServerError)\n }\n}\n\n// output the result as JSON\nfunc (h *ListHandler) writeJSON(writer io.Writer, people []*list.Person) error {\n output := &listResponseFormat{\n People: make([]*listResponseItemFormat, len(people)),\n }\n\n for index, record := range people {\n output.People[index] = &listResponseItemFormat{\n ID: record.ID,\n FullName: record.FullName,\n Phone: record.Phone,\n }\n }\n\n // call to http.ResponseWriter.Write() will cause HTTP OK (200) to be output as well\n return json.NewEncoder(writer).Encode(output)\n}\n\ntype listResponseFormat struct {\n People []*listResponseItemFormat `json:\"people\"`\n}\n\ntype listResponseItemFormat struct {\n ID int `json:\"id\"`\n FullName string `json:\"name\"`\n Phone string `json:\"phone\"`\n}\n\n\t\t\n\t\tpackage rest\n\nimport (\n \"net/http\"\n)\n\nfunc notFoundHandler(response http.ResponseWriter, _ *http.Request) {\n response.WriteHeader(http.StatusNotFound)\n _, _ = response.Write([]byte(`Not found`))\n}\n\n\t\t\n\t\tpackage rest\n\nimport (\n \"context\"\n \"encoding/json\"\n \"fmt\"\n \"net/http\"\n \"time\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/modules/register\"\n)\n\n// RegisterModel will validate and save a registration\n//go:generate mockery -name=RegisterModel -case underscore -testonly -inpkg -note @generated\ntype RegisterModel interface {\n Do(ctx context.Context, in *register.Person) (int, error)\n}\n\n// NewRegisterHandler is the constructor for RegisterHandler\nfunc NewRegisterHandler(model RegisterModel) *RegisterHandler {\n return &RegisterHandler{\n registerer: model,\n }\n}\n\n// RegisterHandler is the HTTP handler for the \"Register\" endpoint\n// In this simplified example we are assuming all possible errors are user errors and returning \"bad request\" HTTP 400.\n// There are some programmer errors possible but hopefully these will be caught in testing.\ntype RegisterHandler struct {\n registerer RegisterModel\n}\n\n// ServeHTTP implements http.Handler\nfunc (h *RegisterHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {\n // set latency budget for this API\n subCtx, cancel := context.WithTimeout(request.Context(), 1500*time.Millisecond)\n defer cancel()\n\n // extract payload from request\n requestPayload, err := h.extractPayload(request)\n if err != nil {\n // output error\n response.WriteHeader(http.StatusBadRequest)\n return\n }\n\n // call the business logic using the request data and context\n id, err := h.register(subCtx, requestPayload)\n if err != nil {\n // not need to log here as we can expect other layers to do so\n response.WriteHeader(http.StatusBadRequest)\n return\n }\n\n // happy path\n response.Header().Add(\"Location\", fmt.Sprintf(\"/person/%d/\", id))\n response.WriteHeader(http.StatusCreated)\n}\n\n// extract payload from request\nfunc (h *RegisterHandler) extractPayload(request *http.Request) (*registerRequest, error) {\n requestPayload := ®isterRequest{}\n\n decoder := json.NewDecoder(request.Body)\n err := decoder.Decode(requestPayload)\n if err != nil {\n return nil, err\n }\n\n return requestPayload, nil\n}\n\n// call the logic layer\nfunc (h *RegisterHandler) register(ctx context.Context, requestPayload *registerRequest) (int, error) {\n person := ®ister.Person{\n FullName: requestPayload.FullName,\n Phone: requestPayload.Phone,\n Currency: requestPayload.Currency,\n }\n\n return h.registerer.Do(ctx, person)\n}\n\n// register endpoint request format\ntype registerRequest struct {\n // FullName of the person\n FullName string `json:\"fullName\"`\n // Phone of the person\n Phone string `json:\"phone\"`\n // Currency the wish to register in\n Currency string `json:\"currency\"`\n}\n\n\t\t\n\t\tpackage rest\n\nimport (\n \"net/http\"\n\n \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go/ch12/acme/internal/logging\"\n \"github.com/gorilla/mux\"\n)\n\n// Config is the config for the REST package\ntype Config interface {\n Logger() logging.Logger\n BindAddress() string\n}\n\n// New will create and initialize the server\nfunc New(cfg Config,\n getModel GetModel,\n listModel ListModel,\n registerModel RegisterModel) *Server {\n\n return &Server{\n address: cfg.BindAddress(),\n handlerGet: NewGetHandler(cfg, getModel),\n handlerList: NewListHandler(listModel),\n handlerNotFound: notFoundHandler,\n handlerRegister: NewRegisterHandler(registerModel),\n }\n}\n\n// Server is the HTTP REST server\ntype Server struct {\n address string\n server *http.Server\n\n handlerGet http.Handler\n handlerList http.Handler\n handlerNotFound http.HandlerFunc\n handlerRegister http.Handler\n}\n\n// Listen will start a HTTP rest for this service\nfunc (s *Server) Listen(stop <-chan struct{}) {\n router := s.buildRouter()\n\n // create the HTTP server\n s.server = &http.Server{\n Handler: router,\n Addr: s.address,\n }\n\n // listen for shutdown\n go func() {\n // wait for shutdown signal\n <-stop\n\n _ = s.server.Close()\n }()\n\n // start the HTTP server\n _ = s.server.ListenAndServe()\n}\n\n// configure the endpoints to handlers\nfunc (s *Server) buildRouter() http.Handler {\n router := mux.NewRouter()\n\n // map URL endpoints to HTTP handlers\n router.Handle(\"/person/{id}/\", s.handlerGet).Methods(\"GET\")\n router.Handle(\"/person/list\", s.handlerList).Methods(\"GET\")\n router.Handle(\"/person/register\", s.handlerRegister).Methods(\"POST\")\n\n // convert a \"catch all\" not found handler\n router.NotFoundHandler = s.handlerNotFound\n\n return router\n}\n\n\t\t\n\t\t\" lines in HTML files). That may be\n// because this is the only method of the 3 that has a *concept* of\n// \"junk\"
Name: %v>`, r.Type, r.Name)\n\tcase r.Group != \"\":\n\t\treturn fmt.Sprintf(`label=<%v
Group: %v>`, r.Type, r.Group)\n\tdefault:\n\t\treturn fmt.Sprintf(`label=<%v>`, r.Type)\n\t}\n}\n\n// Attributes composes and returns a string of the Group node's attributes.\nfunc (g *Group) Attributes() string {\n\tattr := fmt.Sprintf(`shape=diamond label=<%v
Group: %v>`, g.Type, g.Name)\n\tif g.ErrorType != noError {\n\t\tattr += \" color=\" + g.ErrorType.Color()\n\t}\n\treturn attr\n}\n\n// Color returns the color representation of each ErrorType.\nfunc (s ErrorType) Color() string {\n\tswitch s {\n\tcase rootCause:\n\t\treturn \"red\"\n\tcase transitiveFailure:\n\t\treturn \"orange\"\n\tdefault:\n\t\treturn \"black\"\n\t}\n}\n\nfunc (dg *Graph) addRootCause(r *Result) {\n\tdg.Failed.RootCauses = append(dg.Failed.RootCauses, r)\n}\n\nfunc (dg *Graph) addTransitiveFailure(r *Result) {\n\tdg.Failed.TransitiveFailures = append(dg.Failed.TransitiveFailures, r)\n}\n"
},
{
"path": "vendor/go.uber.org/dig/param.go",
"content": "// Copyright (c) 2018 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\npackage dig\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"go.uber.org/dig/internal/dot\"\n)\n\n// The param interface represents a dependency for a constructor.\n//\n// The following implementations exist:\n// paramList All arguments of the constructor.\n// paramSingle An explicitly requested type.\n// paramObject dig.In struct where each field in the struct can be another\n// param.\n// paramGroupedSlice\n// A slice consuming a value group. This will receive all\n// values produced with a `group:\"..\"` tag with the same name\n// as a slice.\ntype param interface {\n\tfmt.Stringer\n\n\t// Builds this dependency and any of its dependencies from the provided\n\t// Container.\n\t//\n\t// This MAY panic if the param does not produce a single value.\n\tBuild(containerStore) (reflect.Value, error)\n\n\t// DotParam returns a slice of dot.Param(s).\n\tDotParam() []*dot.Param\n}\n\nvar (\n\t_ param = paramSingle{}\n\t_ param = paramObject{}\n\t_ param = paramList{}\n\t_ param = paramGroupedSlice{}\n)\n\n// newParam builds a param from the given type. If the provided type is a\n// dig.In struct, an paramObject will be returned.\nfunc newParam(t reflect.Type) (param, error) {\n\tswitch {\n\tcase IsOut(t) || (t.Kind() == reflect.Ptr && IsOut(t.Elem())) || embedsType(t, _outPtrType):\n\t\treturn nil, fmt.Errorf(\"cannot depend on result objects: %v embeds a dig.Out\", t)\n\tcase IsIn(t):\n\t\treturn newParamObject(t)\n\tcase embedsType(t, _inPtrType):\n\t\treturn nil, fmt.Errorf(\n\t\t\t\"cannot build a parameter object by embedding *dig.In, embed dig.In instead: \"+\n\t\t\t\t\"%v embeds *dig.In\", t)\n\tcase t.Kind() == reflect.Ptr && IsIn(t.Elem()):\n\t\treturn nil, fmt.Errorf(\n\t\t\t\"cannot depend on a pointer to a parameter object, use a value instead: \"+\n\t\t\t\t\"%v is a pointer to a struct that embeds dig.In\", t)\n\tdefault:\n\t\treturn paramSingle{Type: t}, nil\n\t}\n}\n\n// paramVisitor visits every param in a param tree, allowing tracking state at\n// each level.\ntype paramVisitor interface {\n\t// Visit is called on the param being visited.\n\t//\n\t// If Visit returns a non-nil paramVisitor, that paramVisitor visits all\n\t// the child params of this param.\n\tVisit(param) paramVisitor\n\n\t// We can implement AnnotateWithField and AnnotateWithPosition like\n\t// resultVisitor if we need to track that information in the future.\n}\n\n// paramVisitorFunc is a paramVisitor that visits param in a tree with the\n// return value deciding whether the descendants of this param should be\n// recursed into.\ntype paramVisitorFunc func(param) (recurse bool)\n\nfunc (f paramVisitorFunc) Visit(p param) paramVisitor {\n\tif f(p) {\n\t\treturn f\n\t}\n\treturn nil\n}\n\n// walkParam walks the param tree for the given param with the provided\n// visitor.\n//\n// paramVisitor.Visit will be called on the provided param and if a non-nil\n// paramVisitor is received, this param's descendants will be walked with that\n// visitor.\n//\n// This is very similar to how go/ast.Walk works.\nfunc walkParam(p param, v paramVisitor) {\n\tv = v.Visit(p)\n\tif v == nil {\n\t\treturn\n\t}\n\n\tswitch par := p.(type) {\n\tcase paramSingle, paramGroupedSlice:\n\t\t// No sub-results\n\tcase paramObject:\n\t\tfor _, f := range par.Fields {\n\t\t\twalkParam(f.Param, v)\n\t\t}\n\tcase paramList:\n\t\tfor _, p := range par.Params {\n\t\t\twalkParam(p, v)\n\t\t}\n\tdefault:\n\t\tpanic(fmt.Sprintf(\n\t\t\t\"It looks like you have found a bug in dig. \"+\n\t\t\t\t\"Please file an issue at https://github.com/uber-go/dig/issues/ \"+\n\t\t\t\t\"and provide the following message: \"+\n\t\t\t\t\"received unknown param type %T\", p))\n\t}\n}\n\n// paramList holds all arguments of the constructor as params.\n//\n// NOTE: Build() MUST NOT be called on paramList. Instead, BuildList\n// must be called.\ntype paramList struct {\n\tctype reflect.Type // type of the constructor\n\n\tParams []param\n}\n\nfunc (pl paramList) DotParam() []*dot.Param {\n\tvar types []*dot.Param\n\tfor _, param := range pl.Params {\n\t\ttypes = append(types, param.DotParam()...)\n\t}\n\treturn types\n}\n\n// newParamList builds a paramList from the provided constructor type.\n//\n// Variadic arguments of a constructor are ignored and not included as\n// dependencies.\nfunc newParamList(ctype reflect.Type) (paramList, error) {\n\tnumArgs := ctype.NumIn()\n\tif ctype.IsVariadic() {\n\t\t// NOTE: If the function is variadic, we skip the last argument\n\t\t// because we're not filling variadic arguments yet. See #120.\n\t\tnumArgs--\n\t}\n\n\tpl := paramList{\n\t\tctype: ctype,\n\t\tParams: make([]param, 0, numArgs),\n\t}\n\n\tfor i := 0; i < numArgs; i++ {\n\t\tp, err := newParam(ctype.In(i))\n\t\tif err != nil {\n\t\t\treturn pl, errWrapf(err, \"bad argument %d\", i+1)\n\t\t}\n\t\tpl.Params = append(pl.Params, p)\n\t}\n\n\treturn pl, nil\n}\n\nfunc (pl paramList) Build(containerStore) (reflect.Value, error) {\n\tpanic(\"It looks like you have found a bug in dig. \" +\n\t\t\"Please file an issue at https://github.com/uber-go/dig/issues/ \" +\n\t\t\"and provide the following message: \" +\n\t\t\"paramList.Build() must never be called\")\n}\n\n// BuildList returns an ordered list of values which may be passed directly\n// to the underlying constructor.\nfunc (pl paramList) BuildList(c containerStore) ([]reflect.Value, error) {\n\targs := make([]reflect.Value, len(pl.Params))\n\tfor i, p := range pl.Params {\n\t\tvar err error\n\t\targs[i], err = p.Build(c)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\treturn args, nil\n}\n\n// paramSingle is an explicitly requested type, optionally with a name.\n//\n// This object must be present in the graph as-is unless it's specified as\n// optional.\ntype paramSingle struct {\n\tName string\n\tOptional bool\n\tType reflect.Type\n}\n\nfunc (ps paramSingle) DotParam() []*dot.Param {\n\treturn []*dot.Param{\n\t\t{\n\t\t\tNode: &dot.Node{\n\t\t\t\tType: ps.Type,\n\t\t\t\tName: ps.Name,\n\t\t\t},\n\t\t\tOptional: ps.Optional,\n\t\t},\n\t}\n}\n\nfunc (ps paramSingle) Build(c containerStore) (reflect.Value, error) {\n\tif v, ok := c.getValue(ps.Name, ps.Type); ok {\n\t\treturn v, nil\n\t}\n\n\tproviders := c.getValueProviders(ps.Name, ps.Type)\n\tif len(providers) == 0 {\n\t\tif ps.Optional {\n\t\t\treturn reflect.Zero(ps.Type), nil\n\t\t}\n\t\treturn _noValue, newErrMissingType(c, key{name: ps.Name, t: ps.Type})\n\t}\n\n\tfor _, n := range providers {\n\t\terr := n.Call(c)\n\t\tif err == nil {\n\t\t\tcontinue\n\t\t}\n\n\t\t// If we're missing dependencies but the parameter itself is optional,\n\t\t// we can just move on.\n\t\tif _, ok := err.(errMissingDependencies); ok && ps.Optional {\n\t\t\treturn reflect.Zero(ps.Type), nil\n\t\t}\n\n\t\treturn _noValue, errParamSingleFailed{\n\t\t\tCtorID: n.ID(),\n\t\t\tKey: key{t: ps.Type, name: ps.Name},\n\t\t\tReason: err,\n\t\t}\n\t}\n\n\t// If we get here, it's impossible for the value to be absent from the\n\t// container.\n\tv, _ := c.getValue(ps.Name, ps.Type)\n\treturn v, nil\n}\n\n// paramObject is a dig.In struct where each field is another param.\n//\n// This object is not expected in the graph as-is.\ntype paramObject struct {\n\tType reflect.Type\n\tFields []paramObjectField\n}\n\nfunc (po paramObject) DotParam() []*dot.Param {\n\tvar types []*dot.Param\n\tfor _, field := range po.Fields {\n\t\ttypes = append(types, field.DotParam()...)\n\t}\n\treturn types\n}\n\n// newParamObject builds an paramObject from the provided type. The type MUST\n// be a dig.In struct.\nfunc newParamObject(t reflect.Type) (paramObject, error) {\n\tpo := paramObject{Type: t}\n\n\tfor i := 0; i < t.NumField(); i++ {\n\t\tf := t.Field(i)\n\t\tif f.Type == _inType {\n\t\t\t// Skip over the dig.In embed.\n\t\t\tcontinue\n\t\t}\n\n\t\tpof, err := newParamObjectField(i, f)\n\t\tif err != nil {\n\t\t\treturn po, errWrapf(err, \"bad field %q of %v\", f.Name, t)\n\t\t}\n\n\t\tpo.Fields = append(po.Fields, pof)\n\t}\n\n\treturn po, nil\n}\n\nfunc (po paramObject) Build(c containerStore) (reflect.Value, error) {\n\tdest := reflect.New(po.Type).Elem()\n\tfor _, f := range po.Fields {\n\t\tv, err := f.Build(c)\n\t\tif err != nil {\n\t\t\treturn dest, err\n\t\t}\n\t\tdest.Field(f.FieldIndex).Set(v)\n\t}\n\treturn dest, nil\n}\n\n// paramObjectField is a single field of a dig.In struct.\ntype paramObjectField struct {\n\t// Name of the field in the struct.\n\tFieldName string\n\n\t// Index of this field in the target struct.\n\t//\n\t// We need to track this separately because not all fields of the\n\t// struct map to params.\n\tFieldIndex int\n\n\t// The dependency requested by this field.\n\tParam param\n}\n\nfunc (pof paramObjectField) DotParam() []*dot.Param {\n\treturn pof.Param.DotParam()\n}\n\nfunc newParamObjectField(idx int, f reflect.StructField) (paramObjectField, error) {\n\tpof := paramObjectField{\n\t\tFieldName: f.Name,\n\t\tFieldIndex: idx,\n\t}\n\n\tvar p param\n\tswitch {\n\tcase f.PkgPath != \"\":\n\t\treturn pof, fmt.Errorf(\n\t\t\t\"unexported fields not allowed in dig.In, did you mean to export %q (%v)?\",\n\t\t\tf.Name, f.Type)\n\n\tcase f.Tag.Get(_groupTag) != \"\":\n\t\tvar err error\n\t\tp, err = newParamGroupedSlice(f)\n\t\tif err != nil {\n\t\t\treturn pof, err\n\t\t}\n\n\tdefault:\n\t\tvar err error\n\t\tp, err = newParam(f.Type)\n\t\tif err != nil {\n\t\t\treturn pof, err\n\t\t}\n\t}\n\n\tif ps, ok := p.(paramSingle); ok {\n\t\tps.Name = f.Tag.Get(_nameTag)\n\n\t\tvar err error\n\t\tps.Optional, err = isFieldOptional(f)\n\t\tif err != nil {\n\t\t\treturn pof, err\n\t\t}\n\n\t\tp = ps\n\t}\n\n\tpof.Param = p\n\treturn pof, nil\n}\n\nfunc (pof paramObjectField) Build(c containerStore) (reflect.Value, error) {\n\tv, err := pof.Param.Build(c)\n\tif err != nil {\n\t\treturn v, err\n\t}\n\treturn v, nil\n}\n\n// paramGroupedSlice is a param which produces a slice of values with the same\n// group name.\ntype paramGroupedSlice struct {\n\t// Name of the group as specified in the `group:\"..\"` tag.\n\tGroup string\n\n\t// Type of the slice.\n\tType reflect.Type\n}\n\nfunc (pt paramGroupedSlice) DotParam() []*dot.Param {\n\treturn []*dot.Param{\n\t\t{\n\t\t\tNode: &dot.Node{\n\t\t\t\tType: pt.Type,\n\t\t\t\tGroup: pt.Group,\n\t\t\t},\n\t\t},\n\t}\n}\n\n// newParamGroupedSlice builds a paramGroupedSlice from the provided type with\n// the given name.\n//\n// The type MUST be a slice type.\nfunc newParamGroupedSlice(f reflect.StructField) (paramGroupedSlice, error) {\n\tpg := paramGroupedSlice{Group: f.Tag.Get(_groupTag), Type: f.Type}\n\n\tname := f.Tag.Get(_nameTag)\n\toptional, _ := isFieldOptional(f)\n\tswitch {\n\tcase f.Type.Kind() != reflect.Slice:\n\t\treturn pg, fmt.Errorf(\"value groups may be consumed as slices only: \"+\n\t\t\t\"field %q (%v) is not a slice\", f.Name, f.Type)\n\tcase name != \"\":\n\t\treturn pg, fmt.Errorf(\n\t\t\t\"cannot use named values with value groups: name:%q requested with group:%q\", name, pg.Group)\n\n\tcase optional:\n\t\treturn pg, errors.New(\"value groups cannot be optional\")\n\t}\n\n\treturn pg, nil\n}\n\nfunc (pt paramGroupedSlice) Build(c containerStore) (reflect.Value, error) {\n\tfor _, n := range c.getGroupProviders(pt.Group, pt.Type.Elem()) {\n\t\tif err := n.Call(c); err != nil {\n\t\t\treturn _noValue, errParamGroupFailed{\n\t\t\t\tCtorID: n.ID(),\n\t\t\t\tKey: key{group: pt.Group, t: pt.Type.Elem()},\n\t\t\t\tReason: err,\n\t\t\t}\n\t\t}\n\t}\n\n\titems := c.getValueGroup(pt.Group, pt.Type.Elem())\n\n\tresult := reflect.MakeSlice(pt.Type, len(items), len(items))\n\tfor i, v := range items {\n\t\tresult.Index(i).Set(v)\n\t}\n\treturn result, nil\n}\n"
},
{
"path": "vendor/go.uber.org/dig/result.go",
"content": "// Copyright (c) 2018 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\npackage dig\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"go.uber.org/dig/internal/dot\"\n)\n\n// The result interface represents a result produced by a constructor.\n//\n// The following implementations exist:\n// resultList All values returned by the constructor.\n// resultSingle A single value produced by a constructor.\n// resultObject dig.Out struct where each field in the struct can be\n// another result.\n// resultGrouped A value produced by a constructor that is part of a value\n// group.\ntype result interface {\n\t// Extracts the values for this result from the provided value and\n\t// stores them into the provided containerWriter.\n\t//\n\t// This MAY panic if the result does not consume a single value.\n\tExtract(containerWriter, reflect.Value)\n\n\t// DotResult returns a slice of dot.Result(s).\n\tDotResult() []*dot.Result\n}\n\nvar (\n\t_ result = resultSingle{}\n\t_ result = resultObject{}\n\t_ result = resultList{}\n\t_ result = resultGrouped{}\n)\n\ntype resultOptions struct {\n\t// If set, this is the name of the associated result value.\n\t//\n\t// For Result Objects, name:\"..\" tags on fields override this.\n\tName string\n}\n\n// newResult builds a result from the given type.\nfunc newResult(t reflect.Type, opts resultOptions) (result, error) {\n\tswitch {\n\tcase IsIn(t) || (t.Kind() == reflect.Ptr && IsIn(t.Elem())) || embedsType(t, _inPtrType):\n\t\treturn nil, fmt.Errorf(\"cannot provide parameter objects: %v embeds a dig.In\", t)\n\tcase isError(t):\n\t\treturn nil, fmt.Errorf(\"cannot return an error here, return it from the constructor instead\")\n\tcase IsOut(t):\n\t\treturn newResultObject(t, opts)\n\tcase embedsType(t, _outPtrType):\n\t\treturn nil, fmt.Errorf(\n\t\t\t\"cannot build a result object by embedding *dig.Out, embed dig.Out instead: \"+\n\t\t\t\t\"%v embeds *dig.Out\", t)\n\tcase t.Kind() == reflect.Ptr && IsOut(t.Elem()):\n\t\treturn nil, fmt.Errorf(\n\t\t\t\"cannot return a pointer to a result object, use a value instead: \"+\n\t\t\t\t\"%v is a pointer to a struct that embeds dig.Out\", t)\n\tdefault:\n\t\treturn resultSingle{Type: t, Name: opts.Name}, nil\n\t}\n}\n\n// resultVisitor visits every result in a result tree, allowing tracking state\n// at each level.\ntype resultVisitor interface {\n\t// Visit is called on the result being visited.\n\t//\n\t// If Visit returns a non-nil resultVisitor, that resultVisitor visits all\n\t// the child results of this result.\n\tVisit(result) resultVisitor\n\n\t// AnnotateWithField is called on each field of a resultObject after\n\t// visiting it but before walking its descendants.\n\t//\n\t// The same resultVisitor is used for all fields: the one returned upon\n\t// visiting the resultObject.\n\t//\n\t// For each visited field, if AnnotateWithField returns a non-nil\n\t// resultVisitor, it will be used to walk the result of that field.\n\tAnnotateWithField(resultObjectField) resultVisitor\n\n\t// AnnotateWithPosition is called with the index of each result of a\n\t// resultList after vising it but before walking its descendants.\n\t//\n\t// The same resultVisitor is used for all results: the one returned upon\n\t// visiting the resultList.\n\t//\n\t// For each position, if AnnotateWithPosition returns a non-nil\n\t// resultVisitor, it will be used to walk the result at that index.\n\tAnnotateWithPosition(idx int) resultVisitor\n}\n\n// walkResult walks the result tree for the given result with the provided\n// visitor.\n//\n// resultVisitor.Visit will be called on the provided result and if a non-nil\n// resultVisitor is received, it will be used to walk its descendants. If a\n// resultObject or resultList was visited, AnnotateWithField and\n// AnnotateWithPosition respectively will be called before visiting the\n// descendants of that resultObject/resultList.\n//\n// This is very similar to how go/ast.Walk works.\nfunc walkResult(r result, v resultVisitor) {\n\tv = v.Visit(r)\n\tif v == nil {\n\t\treturn\n\t}\n\n\tswitch res := r.(type) {\n\tcase resultSingle, resultGrouped:\n\t\t// No sub-results\n\tcase resultObject:\n\t\tw := v\n\t\tfor _, f := range res.Fields {\n\t\t\tif v := w.AnnotateWithField(f); v != nil {\n\t\t\t\twalkResult(f.Result, v)\n\t\t\t}\n\t\t}\n\tcase resultList:\n\t\tw := v\n\t\tfor i, r := range res.Results {\n\t\t\tif v := w.AnnotateWithPosition(i); v != nil {\n\t\t\t\twalkResult(r, v)\n\t\t\t}\n\t\t}\n\tdefault:\n\t\tpanic(fmt.Sprintf(\n\t\t\t\"It looks like you have found a bug in dig. \"+\n\t\t\t\t\"Please file an issue at https://github.com/uber-go/dig/issues/ \"+\n\t\t\t\t\"and provide the following message: \"+\n\t\t\t\t\"received unknown result type %T\", res))\n\t}\n}\n\n// resultList holds all values returned by the constructor as results.\ntype resultList struct {\n\tctype reflect.Type\n\n\tResults []result\n\n\t// For each item at index i returned by the constructor, resultIndexes[i]\n\t// is the index in .Results for the corresponding result object.\n\t// resultIndexes[i] is -1 for errors returned by constructors.\n\tresultIndexes []int\n}\n\nfunc (rl resultList) DotResult() []*dot.Result {\n\tvar types []*dot.Result\n\tfor _, result := range rl.Results {\n\t\ttypes = append(types, result.DotResult()...)\n\t}\n\treturn types\n}\n\nfunc newResultList(ctype reflect.Type, opts resultOptions) (resultList, error) {\n\trl := resultList{\n\t\tctype: ctype,\n\t\tResults: make([]result, 0, ctype.NumOut()),\n\t\tresultIndexes: make([]int, ctype.NumOut()),\n\t}\n\n\tresultIdx := 0\n\tfor i := 0; i < ctype.NumOut(); i++ {\n\t\tt := ctype.Out(i)\n\t\tif isError(t) {\n\t\t\trl.resultIndexes[i] = -1\n\t\t\tcontinue\n\t\t}\n\n\t\tr, err := newResult(t, opts)\n\t\tif err != nil {\n\t\t\treturn rl, errWrapf(err, \"bad result %d\", i+1)\n\t\t}\n\n\t\trl.Results = append(rl.Results, r)\n\t\trl.resultIndexes[i] = resultIdx\n\t\tresultIdx++\n\t}\n\n\treturn rl, nil\n}\n\nfunc (resultList) Extract(containerWriter, reflect.Value) {\n\tpanic(\"It looks like you have found a bug in dig. \" +\n\t\t\"Please file an issue at https://github.com/uber-go/dig/issues/ \" +\n\t\t\"and provide the following message: \" +\n\t\t\"resultList.Extract() must never be called\")\n}\n\nfunc (rl resultList) ExtractList(cw containerWriter, values []reflect.Value) error {\n\tfor i, v := range values {\n\t\tif resultIdx := rl.resultIndexes[i]; resultIdx >= 0 {\n\t\t\trl.Results[resultIdx].Extract(cw, v)\n\t\t\tcontinue\n\t\t}\n\n\t\tif err, _ := v.Interface().(error); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\treturn nil\n}\n\n// resultSingle is an explicit value produced by a constructor, optionally\n// with a name.\n//\n// This object will be added to the graph as-is.\ntype resultSingle struct {\n\tName string\n\tType reflect.Type\n}\n\nfunc (rs resultSingle) DotResult() []*dot.Result {\n\treturn []*dot.Result{\n\t\t{\n\t\t\tNode: &dot.Node{\n\t\t\t\tType: rs.Type,\n\t\t\t\tName: rs.Name,\n\t\t\t},\n\t\t},\n\t}\n}\n\nfunc (rs resultSingle) Extract(cw containerWriter, v reflect.Value) {\n\tcw.setValue(rs.Name, rs.Type, v)\n}\n\n// resultObject is a dig.Out struct where each field is another result.\n//\n// This object is not added to the graph. Its fields are interpreted as\n// results and added to the graph if needed.\ntype resultObject struct {\n\tType reflect.Type\n\tFields []resultObjectField\n}\n\nfunc (ro resultObject) DotResult() []*dot.Result {\n\tvar types []*dot.Result\n\tfor _, field := range ro.Fields {\n\t\ttypes = append(types, field.DotResult()...)\n\t}\n\treturn types\n}\n\nfunc newResultObject(t reflect.Type, opts resultOptions) (resultObject, error) {\n\tro := resultObject{Type: t}\n\tif len(opts.Name) > 0 {\n\t\treturn ro, fmt.Errorf(\n\t\t\t\"cannot specify a name for result objects: %v embeds dig.Out\", t)\n\t}\n\n\tfor i := 0; i < t.NumField(); i++ {\n\t\tf := t.Field(i)\n\t\tif f.Type == _outType {\n\t\t\t// Skip over the dig.Out embed.\n\t\t\tcontinue\n\t\t}\n\n\t\trof, err := newResultObjectField(i, f, opts)\n\t\tif err != nil {\n\t\t\treturn ro, errWrapf(err, \"bad field %q of %v\", f.Name, t)\n\t\t}\n\n\t\tro.Fields = append(ro.Fields, rof)\n\t}\n\treturn ro, nil\n}\n\nfunc (ro resultObject) Extract(cw containerWriter, v reflect.Value) {\n\tfor _, f := range ro.Fields {\n\t\tf.Result.Extract(cw, v.Field(f.FieldIndex))\n\t}\n}\n\n// resultObjectField is a single field inside a dig.Out struct.\ntype resultObjectField struct {\n\t// Name of the field in the struct.\n\tFieldName string\n\n\t// Index of the field in the struct.\n\t//\n\t// We need to track this separately because not all fields of the struct\n\t// map to results.\n\tFieldIndex int\n\n\t// Result produced by this field.\n\tResult result\n}\n\nfunc (rof resultObjectField) DotResult() []*dot.Result {\n\treturn rof.Result.DotResult()\n}\n\n// newResultObjectField(i, f, opts) builds a resultObjectField from the field\n// f at index i.\nfunc newResultObjectField(idx int, f reflect.StructField, opts resultOptions) (resultObjectField, error) {\n\trof := resultObjectField{\n\t\tFieldName: f.Name,\n\t\tFieldIndex: idx,\n\t}\n\n\tvar r result\n\tswitch {\n\tcase f.PkgPath != \"\":\n\t\treturn rof, fmt.Errorf(\n\t\t\t\"unexported fields not allowed in dig.Out, did you mean to export %q (%v)?\", f.Name, f.Type)\n\n\tcase f.Tag.Get(_groupTag) != \"\":\n\t\tvar err error\n\t\tr, err = newResultGrouped(f)\n\t\tif err != nil {\n\t\t\treturn rof, err\n\t\t}\n\n\tdefault:\n\t\tvar err error\n\t\tif name := f.Tag.Get(_nameTag); len(name) > 0 {\n\t\t\t// can modify in-place because options are passed-by-value.\n\t\t\topts.Name = name\n\t\t}\n\t\tr, err = newResult(f.Type, opts)\n\t\tif err != nil {\n\t\t\treturn rof, err\n\t\t}\n\t}\n\n\trof.Result = r\n\treturn rof, nil\n}\n\n// resultGrouped is a value produced by a constructor that is part of a result\n// group.\n//\n// These will be produced as fields of a dig.Out struct.\ntype resultGrouped struct {\n\t// Name of the group as specified in the `group:\"..\"` tag.\n\tGroup string\n\n\t// Type of value produced.\n\tType reflect.Type\n}\n\nfunc (rt resultGrouped) DotResult() []*dot.Result {\n\treturn []*dot.Result{\n\t\t{\n\t\t\tNode: &dot.Node{\n\t\t\t\tType: rt.Type,\n\t\t\t\tGroup: rt.Group,\n\t\t\t},\n\t\t},\n\t}\n}\n\n// newResultGrouped(f) builds a new resultGrouped from the provided field.\nfunc newResultGrouped(f reflect.StructField) (resultGrouped, error) {\n\trg := resultGrouped{Group: f.Tag.Get(_groupTag), Type: f.Type}\n\n\tname := f.Tag.Get(_nameTag)\n\toptional, _ := isFieldOptional(f)\n\tswitch {\n\tcase name != \"\":\n\t\treturn rg, fmt.Errorf(\n\t\t\t\"cannot use named values with value groups: name:%q provided with group:%q\", name, rg.Group)\n\tcase optional:\n\t\treturn rg, errors.New(\"value groups cannot be optional\")\n\t}\n\n\treturn rg, nil\n}\n\nfunc (rt resultGrouped) Extract(cw containerWriter, v reflect.Value) {\n\tcw.submitGroupedValue(rt.Group, rt.Type, v)\n}\n"
},
{
"path": "vendor/go.uber.org/dig/stringer.go",
"content": "// Copyright (c) 2018 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\npackage dig\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"strings\"\n)\n\n// String representation of the entire Container\nfunc (c *Container) String() string {\n\tb := &bytes.Buffer{}\n\tfmt.Fprintln(b, \"nodes: {\")\n\tfor k, vs := range c.providers {\n\t\tfor _, v := range vs {\n\t\t\tfmt.Fprintln(b, \"\\t\", k, \"->\", v)\n\t\t}\n\t}\n\tfmt.Fprintln(b, \"}\")\n\n\tfmt.Fprintln(b, \"values: {\")\n\tfor k, v := range c.values {\n\t\tfmt.Fprintln(b, \"\\t\", k, \"=>\", v)\n\t}\n\tfor k, vs := range c.groups {\n\t\tfor _, v := range vs {\n\t\t\tfmt.Fprintln(b, \"\\t\", k, \"=>\", v)\n\t\t}\n\t}\n\tfmt.Fprintln(b, \"}\")\n\n\treturn b.String()\n}\n\nfunc (n *node) String() string {\n\treturn fmt.Sprintf(\"deps: %v, ctor: %v\", n.paramList, n.ctype)\n}\n\nfunc (k key) String() string {\n\tif k.name != \"\" {\n\t\treturn fmt.Sprintf(\"%v[name=%q]\", k.t, k.name)\n\t}\n\tif k.group != \"\" {\n\t\treturn fmt.Sprintf(\"%v[group=%q]\", k.t, k.group)\n\t}\n\treturn k.t.String()\n}\n\nfunc (pl paramList) String() string {\n\targs := make([]string, len(pl.Params))\n\tfor i, p := range pl.Params {\n\t\targs[i] = p.String()\n\t}\n\treturn fmt.Sprint(args)\n}\n\nfunc (sp paramSingle) String() string {\n\t// tally.Scope[optional] means optional\n\t// tally.Scope[optional, name=\"foo\"] means named optional\n\n\tvar opts []string\n\tif sp.Optional {\n\t\topts = append(opts, \"optional\")\n\t}\n\tif sp.Name != \"\" {\n\t\topts = append(opts, fmt.Sprintf(\"name=%q\", sp.Name))\n\t}\n\n\tif len(opts) == 0 {\n\t\treturn fmt.Sprint(sp.Type)\n\t}\n\n\treturn fmt.Sprintf(\"%v[%v]\", sp.Type, strings.Join(opts, \", \"))\n}\n\nfunc (op paramObject) String() string {\n\tfields := make([]string, len(op.Fields))\n\tfor i, f := range op.Fields {\n\t\tfields[i] = f.Param.String()\n\t}\n\treturn strings.Join(fields, \" \")\n}\n\nfunc (pt paramGroupedSlice) String() string {\n\t// io.Reader[group=\"foo\"] refers to a group of io.Readers called 'foo'\n\treturn fmt.Sprintf(\"%v[group=%q]\", pt.Type.Elem(), pt.Group)\n}\n"
},
{
"path": "vendor/go.uber.org/dig/types.go",
"content": "// Copyright (c) 2018 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\npackage dig\n\nimport (\n\t\"container/list\"\n\t\"reflect\"\n)\n\nvar (\n\t_noValue reflect.Value\n\t_errType = reflect.TypeOf((*error)(nil)).Elem()\n\t_inPtrType = reflect.TypeOf((*In)(nil))\n\t_inType = reflect.TypeOf(In{})\n\t_outPtrType = reflect.TypeOf((*Out)(nil))\n\t_outType = reflect.TypeOf(Out{})\n)\n\n// Special interface embedded inside dig sentinel values (dig.In, dig.Out) to\n// make their special nature obvious in the godocs. Otherwise they will appear\n// as plain empty structs.\ntype digSentinel interface {\n\tdigSentinel()\n}\n\n// In may be embedded into structs to request dig to treat them as special\n// parameter structs. When a constructor accepts such a struct, instead of the\n// struct becoming a dependency for that constructor, all its fields become\n// dependencies instead. See the section on Parameter Objects in the\n// package-level documentation for more information.\n//\n// Fields of the struct may optionally be tagged to customize the behavior of\n// dig. The following tags are supported,\n//\n// name Requests a value with the same name and type from the\n// container. See Named Values for more information.\n// optional If set to true, indicates that the dependency is optional and\n// the constructor gracefully handles its absence.\n// group Name of the Value Group from which this field will be filled.\n// The field must be a slice type. See Value Groups in the\n// package documentation for more information.\ntype In struct{ digSentinel }\n\n// Out is an embeddable type that signals to dig that the returned\n// struct should be treated differently. Instead of the struct itself\n// becoming part of the container, all members of the struct will.\n\n// Out may be embedded into structs to request dig to treat them as special\n// result structs. When a constructor returns such a struct, instead of the\n// struct becoming a result of the constructor, all its fields become results\n// of the constructor. See the section on Result Objects in the package-level\n// documentation for more information.\n//\n// Fields of the struct may optionally be tagged to customize the behavior of\n// dig. The following tags are supported,\n//\n// name Specifies the name of the value. Only a field on a dig.In\n// struct with the same 'name' annotation can receive this\n// value. See Named Values for more information.\n// group Name of the Value Group to which this field's value is being\n// sent. See Value Groups in the package documentation for more\n// information.\ntype Out struct{ digSentinel }\n\nfunc isError(t reflect.Type) bool {\n\treturn t.Implements(_errType)\n}\n\n// IsIn checks whether the given struct is a dig.In struct. A struct qualifies\n// as a dig.In struct if it embeds the dig.In type or if any struct that it\n// embeds is a dig.In struct. The parameter may be the reflect.Type of the\n// struct rather than the struct itself.\n//\n// A struct MUST qualify as a dig.In struct for its fields to be treated\n// specially by dig.\n//\n// See the documentation for dig.In for a comprehensive list of supported\n// tags.\nfunc IsIn(o interface{}) bool {\n\treturn embedsType(o, _inType)\n}\n\n// IsOut checks whether the given struct is a dig.Out struct. A struct\n// qualifies as a dig.Out struct if it embeds the dig.Out type or if any\n// struct that it embeds is a dig.Out struct. The parameter may be the\n// reflect.Type of the struct rather than the struct itself.\n//\n// A struct MUST qualify as a dig.Out struct for its fields to be treated\n// specially by dig.\n//\n// See the documentation for dig.Out for a comprehensive list of supported\n// tags.\nfunc IsOut(o interface{}) bool {\n\treturn embedsType(o, _outType)\n}\n\n// Returns true if t embeds e or if any of the types embedded by t embed e.\nfunc embedsType(i interface{}, e reflect.Type) bool {\n\t// TODO: this function doesn't consider e being a pointer.\n\t// given `type A foo { *In }`, this function would return false for\n\t// embedding dig.In, which makes for some extra error checking in places\n\t// that call this funciton. Might be worthwhile to consider reflect.Indirect\n\t// usage to clean up the callers.\n\n\tif i == nil {\n\t\treturn false\n\t}\n\n\t// maybe it's already a reflect.Type\n\tt, ok := i.(reflect.Type)\n\tif !ok {\n\t\t// take the type if it's not\n\t\tt = reflect.TypeOf(i)\n\t}\n\n\t// We are going to do a breadth-first search of all embedded fields.\n\ttypes := list.New()\n\ttypes.PushBack(t)\n\tfor types.Len() > 0 {\n\t\tt := types.Remove(types.Front()).(reflect.Type)\n\n\t\tif t == e {\n\t\t\treturn true\n\t\t}\n\n\t\tif t.Kind() != reflect.Struct {\n\t\t\tcontinue\n\t\t}\n\n\t\tfor i := 0; i < t.NumField(); i++ {\n\t\t\tf := t.Field(i)\n\t\t\tif f.Anonymous {\n\t\t\t\ttypes.PushBack(f.Type)\n\t\t\t}\n\t\t}\n\t}\n\n\t// If perf is an issue, we can cache known In objects and Out objects in a\n\t// map[reflect.Type]struct{}.\n\treturn false\n}\n"
},
{
"path": "vendor/go.uber.org/dig/version.go",
"content": "// Copyright (c) 2018 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\npackage dig\n\n// Version of the library\nconst Version = \"1.6.0\"\n"
},
{
"path": "vendor/google.golang.org/appengine/LICENSE",
"content": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n"
},
{
"path": "vendor/google.golang.org/appengine/cloudsql/cloudsql.go",
"content": "// Copyright 2013 Google Inc. All rights reserved.\n// Use of this source code is governed by the Apache 2.0\n// license that can be found in the LICENSE file.\n\n/*\nPackage cloudsql exposes access to Google Cloud SQL databases.\n\nThis package does not work in App Engine \"flexible environment\".\n\nThis package is intended for MySQL drivers to make App Engine-specific\nconnections. Applications should use this package through database/sql:\nSelect a pure Go MySQL driver that supports this package, and use sql.Open\nwith protocol \"cloudsql\" and an address of the Cloud SQL instance.\n\nA Go MySQL driver that has been tested to work well with Cloud SQL\nis the go-sql-driver:\n\timport \"database/sql\"\n\timport _ \"github.com/go-sql-driver/mysql\"\n\n\tdb, err := sql.Open(\"mysql\", \"user@cloudsql(project-id:instance-name)/dbname\")\n\n\nAnother driver that works well with Cloud SQL is the mymysql driver:\n\timport \"database/sql\"\n\timport _ \"github.com/ziutek/mymysql/godrv\"\n\n\tdb, err := sql.Open(\"mymysql\", \"cloudsql:instance-name*dbname/user/password\")\n\n\nUsing either of these drivers, you can perform a standard SQL query.\nThis example assumes there is a table named 'users' with\ncolumns 'first_name' and 'last_name':\n\n\trows, err := db.Query(\"SELECT first_name, last_name FROM users\")\n\tif err != nil {\n\t\tlog.Errorf(ctx, \"db.Query: %v\", err)\n\t}\n\tdefer rows.Close()\n\n\tfor rows.Next() {\n\t\tvar firstName string\n\t\tvar lastName string\n\t\tif err := rows.Scan(&firstName, &lastName); err != nil {\n\t\t\tlog.Errorf(ctx, \"rows.Scan: %v\", err)\n\t\t\tcontinue\n\t\t}\n\t\tlog.Infof(ctx, \"First: %v - Last: %v\", firstName, lastName)\n\t}\n\tif err := rows.Err(); err != nil {\n\t\tlog.Errorf(ctx, \"Row error: %v\", err)\n\t}\n*/\npackage cloudsql\n\nimport (\n\t\"net\"\n)\n\n// Dial connects to the named Cloud SQL instance.\nfunc Dial(instance string) (net.Conn, error) {\n\treturn connect(instance)\n}\n"
},
{
"path": "vendor/google.golang.org/appengine/cloudsql/cloudsql_classic.go",
"content": "// Copyright 2013 Google Inc. All rights reserved.\n// Use of this source code is governed by the Apache 2.0\n// license that can be found in the LICENSE file.\n\n// +build appengine\n\npackage cloudsql\n\nimport (\n\t\"net\"\n\n\t\"appengine/cloudsql\"\n)\n\nfunc connect(instance string) (net.Conn, error) {\n\treturn cloudsql.Dial(instance)\n}\n"
},
{
"path": "vendor/google.golang.org/appengine/cloudsql/cloudsql_vm.go",
"content": "// Copyright 2013 Google Inc. All rights reserved.\n// Use of this source code is governed by the Apache 2.0\n// license that can be found in the LICENSE file.\n\n// +build !appengine\n\npackage cloudsql\n\nimport (\n\t\"errors\"\n\t\"net\"\n)\n\nfunc connect(instance string) (net.Conn, error) {\n\treturn nil, errors.New(`cloudsql: not supported in App Engine \"flexible environment\"`)\n}\n"
},
{
"path": "vendor/vendor.json",
"content": "{\n\t\"comment\": \"\",\n\t\"ignore\": \"test\",\n\t\"package\": [\n\t\t{\n\t\t\t\"path\": \"appengine/cloudsql\",\n\t\t\t\"revision\": \"\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"AIF4lP/6rhhHA4zsdvzfM1uFXi4=\",\n\t\t\t\"path\": \"github.com/DATA-DOG/go-sqlmock\",\n\t\t\t\"revision\": \"b9ca56ce96879f5362120ae10866bbf66f2c5db6\",\n\t\t\t\"revisionTime\": \"2018-03-04T15:30:57Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"OFu4xJEIjiI8Suu+j/gabfp+y6Q=\",\n\t\t\t\"origin\": \"github.com/stretchr/testify/vendor/github.com/davecgh/go-spew/spew\",\n\t\t\t\"path\": \"github.com/davecgh/go-spew/spew\",\n\t\t\t\"revision\": \"2aa2c176b9dab406a6970f6a55f513e8a8c8b18f\",\n\t\t\t\"revisionTime\": \"2017-08-14T20:04:35Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"JXVlDIoOSmyi1QAgDI455Wsr/gY=\",\n\t\t\t\"path\": \"github.com/go-sql-driver/mysql\",\n\t\t\t\"revision\": \"3287d94d4c6a48a63e16fffaabf27ab20203af2a\",\n\t\t\t\"revisionTime\": \"2018-04-13T18:15:57Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"g/V4qrXjUGG9B+e3hB+4NAYJ5Gs=\",\n\t\t\t\"path\": \"github.com/gorilla/context\",\n\t\t\t\"revision\": \"08b5f424b9271eedf6f9f0ce86cb9396ed337a42\",\n\t\t\t\"revisionTime\": \"2016-08-17T18:46:32Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"YuYKzn2jczaM6DQcFDmukvAHUX4=\",\n\t\t\t\"path\": \"github.com/gorilla/mux\",\n\t\t\t\"revision\": \"94231ffd98496cbcb1c15b7bf2a9edfd5f852cd4\",\n\t\t\t\"revisionTime\": \"2018-04-03T18:23:30Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"zKKp5SZ3d3ycKe4EKMNT0BqAWBw=\",\n\t\t\t\"origin\": \"github.com/stretchr/testify/vendor/github.com/pmezard/go-difflib/difflib\",\n\t\t\t\"path\": \"github.com/pmezard/go-difflib/difflib\",\n\t\t\t\"revision\": \"2aa2c176b9dab406a6970f6a55f513e8a8c8b18f\",\n\t\t\t\"revisionTime\": \"2017-08-14T20:04:35Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"EO+jcRet/AJ6IY3lBO8l8BLsZWg=\",\n\t\t\t\"origin\": \"github.com/stretchr/testify/vendor/github.com/stretchr/objx\",\n\t\t\t\"path\": \"github.com/stretchr/objx\",\n\t\t\t\"revision\": \"2aa2c176b9dab406a6970f6a55f513e8a8c8b18f\",\n\t\t\t\"revisionTime\": \"2017-08-14T20:04:35Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"mGbTYZ8dHVTiPTTJu3ktp+84pPI=\",\n\t\t\t\"path\": \"github.com/stretchr/testify/assert\",\n\t\t\t\"revision\": \"2aa2c176b9dab406a6970f6a55f513e8a8c8b18f\",\n\t\t\t\"revisionTime\": \"2017-08-14T20:04:35Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"hs0IfAV4wNExbAXc0aUU9V2SuFc=\",\n\t\t\t\"path\": \"github.com/stretchr/testify/mock\",\n\t\t\t\"revision\": \"2aa2c176b9dab406a6970f6a55f513e8a8c8b18f\",\n\t\t\t\"revisionTime\": \"2017-08-14T20:04:35Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"7vs6dSc1PPGBKyzb/SCIyeMJPLQ=\",\n\t\t\t\"path\": \"github.com/stretchr/testify/require\",\n\t\t\t\"revision\": \"2aa2c176b9dab406a6970f6a55f513e8a8c8b18f\",\n\t\t\t\"revisionTime\": \"2017-08-14T20:04:35Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"4nm6kgOL/4Xj3j+CwKcggRg8Wno=\",\n\t\t\t\"path\": \"go.uber.org/dig\",\n\t\t\t\"revision\": \"007ab720a796b1027b6c289fb4e836c8fc077357\",\n\t\t\t\"revisionTime\": \"2018-09-19T20:28:59Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"ukkiijCfrA/L+yTvOhmUH+5sWyI=\",\n\t\t\t\"path\": \"go.uber.org/dig/internal/digreflect\",\n\t\t\t\"revision\": \"007ab720a796b1027b6c289fb4e836c8fc077357\",\n\t\t\t\"revisionTime\": \"2018-09-19T20:28:59Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"WURKr1FAB8025bzGumOQ/4U0rxI=\",\n\t\t\t\"path\": \"go.uber.org/dig/internal/dot\",\n\t\t\t\"revision\": \"007ab720a796b1027b6c289fb4e836c8fc077357\",\n\t\t\t\"revisionTime\": \"2018-09-19T20:28:59Z\"\n\t\t},\n\t\t{\n\t\t\t\"checksumSHA1\": \"LiyXfqOzaeQ8vgYZH3t2hUEdVTw=\",\n\t\t\t\"path\": \"google.golang.org/appengine/cloudsql\",\n\t\t\t\"revision\": \"0a24098c0ec68416ec050f567f75df563d6b231e\",\n\t\t\t\"revisionTime\": \"2018-04-05T22:03:34Z\"\n\t\t}\n\t],\n\t\"rootPath\": \"github.com/PacktPublishing/Hands-On-Dependency-Injection-in-Go\"\n}\n"
}
]