The goal was to write a client library in Go to access fake account API which is provided as a Docker container, implement the Create, Fetch, and Delete operations on the accounts resource with all the testing.
This was my first project in the Go programming language, so I was using different resources to learn Go and write this client library. Resources are listed below in the Useful resources section.
- The HTTP client
- Create, Fetch, and Delete operations
- Unit tests
- Integration tests
.
├── account
│ ├── account_create.go
│ ├── account_create_test.go
│ ├── account_delete.go
│ ├── account_delete_test.go
│ ├── account_fetch.go
│ └── account_fetch_test.go
├── account_data.json
├── client
│ ├── client.go
│ └── client_test.go
├── docker-compose.yml
├── go.mod
├── LICENSE
├── main.go
├── model
│ └── models.go
├── README.md
├── scripts
│ └── db
│ └── 10-init.sql
└── tests
└── integrations
└── account_test.go
To run the project and tests you will need
Example for Create account uses the data in the JSON format in the file located in the same directory as the main package. In this project there is account_data.json
First, use the docker-compose file to run the Form3 API.
docker-compose up
Then modify the main package accordingly.
package main
import (
"accountapi/account"
"encoding/json"
"io/ioutil"
"log"
"os"
)
func FetchData(url string, id string) {
var request account.RequestFetch
request.Host = url
request.AccountID = id
response, err := account.AccountFetch(&request)
if err != nil {
log.Println("Error: ", err)
}
f, _ := json.MarshalIndent(response, "", " ")
log.Println(string(f))
}
func main() {
namespace := "/v1/organisation/accounts"
url := "http://0.0.0.0:8080"
id := "123e4567-e89b-12d3-a456-426614174123"
FetchData(url+namespace, id)
}package main
import (
"accountapi/account"
"encoding/json"
"io/ioutil"
"log"
"os"
)
func CreateData(url string, data *model.AccountData) {
var request account.RequestCreate
request.Host = url
request.Data = data
response, err := account.AccountCreate(&request)
if err != nil {
log.Println("Error: ", err)
}
f, _ := json.MarshalIndent(response, "", " ")
log.Println(string(f))
}
func OpenFile() *model.AccountData {
jsonFile, err := os.Open("account_data.json")
if err != nil {
log.Println(err)
}
log.Println("Successfully Opened users.json")
defer jsonFile.Close()
byteValue, _ := ioutil.ReadAll(jsonFile)
var accountData model.AccountData
er := json.Unmarshal([]byte(byteValue), &accountData)
if er != nil {
log.Println(er)
}
return &accountData
}
func main() {
namespace := "/v1/organisation/accounts"
url := "http://0.0.0.0:8080"
var data = OpenFile()
CreateData(url+namespace, data)
}package main
import (
"accountapi/account"
"encoding/json"
"io/ioutil"
"log"
"os"
)
func DeleteData(url string, id string) {
var request account.RequestDelete
request.Host = url
request.AccountID = id
request.Version = "?version=0"
err := account.AccountDelete(&request)
if err != nil {
log.Println("Error: ", err)
}
}
func main() {
namespace := "/v1/organisation/accounts"
url := "http://0.0.0.0:8080"
id := "123e4567-e89b-12d3-a456-426614174123"
DeleteData(url+namespace, id)
}Unit and integration tests are run when docker-compose up is executed
To run account unit tests
cd account
go test -v
To run HTTP client unit tests
cd client
go test -v
To run integration tests on the host machine change URI variable in tests/integrations/account_test.go from http://accountapi:8080/ to http://localhost:8080/
cd tests/integration
go test -v