mock

README

GoCryptoTrader package Mock

This mock package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Mock Testing Suite

Current Features for mock

• REST recording service
• REST mock response server

How to enable

• Any exchange with mock testing will be enabled by default. This is done using build tags which are highlighted in the examples below via //+build mock_test_off. To disable and run live endpoint testing parse -tags=mock_test_off as a go test param.

Mock test setup

• Create two additional test files for the exchange. Examples are below:

file one - your_current_exchange_name_live_test.go

//+build mock_test_off

// This will build if build tag mock_test_off is parsed and will do live testing
// using all tests in (exchange)_test.go
package your_current_exchange_name

import (
	"os"
	"testing"
	"log"

	"github.com/thrasher-corp/gocryptotrader/config"
	"github.com/thrasher-corp/gocryptotrader/exchanges/sharedtestvalues"
)

var mockTests = false

func TestMain(m *testing.M) {
	cfg := config.GetConfig()
	cfg.LoadConfig("../../testdata/configtest.json")
	your_current_exchange_nameConfig, err := cfg.GetExchangeConfig("your_current_exchange_name")
	if err != nil {
		log.Fatal("your_current_exchange_name Setup() init error", err)
	}
	your_current_exchange_nameConfig.API.AuthenticatedSupport = true
	your_current_exchange_nameConfig.API.Credentials.Key = apiKey
	your_current_exchange_nameConfig.API.Credentials.Secret = apiSecret
	s.SetDefaults()
	s.Setup(&your_current_exchange_nameConfig)
	log.Printf(sharedtestvalues.LiveTesting, s.Name, s.API.Endpoints.URL)
	os.Exit(m.Run())
}

file two - your_current_exchange_name_mock_test.go

//+build !mock_test_off

// This will build if build tag mock_test_off is not parsed and will try to mock
// all tests in _test.go
package your_current_exchange_name

import (
	"os"
	"testing"
	"log"

	"github.com/thrasher-corp/gocryptotrader/config"
	"github.com/thrasher-corp/gocryptotrader/exchanges/mock"
	"github.com/thrasher-corp/gocryptotrader/exchanges/sharedtestvalues"
)

const mockfile = "../../testdata/http_mock/your_current_exchange_name/your_current_exchange_name.json"

var mockTests = true

func TestMain(m *testing.M) {
	cfg := config.GetConfig()
	cfg.LoadConfig("../../testdata/configtest.json")
	your_current_exchange_nameConfig, err := cfg.GetExchangeConfig("your_current_exchange_name")
	if err != nil {
		log.Fatal("your_current_exchange_name Setup() init error", err)
	}
	your_current_exchange_nameConfig.API.AuthenticatedSupport = true
	your_current_exchange_nameConfig.API.Credentials.Key = apiKey
	your_current_exchange_nameConfig.API.Credentials.Secret = apiSecret
	s.SetDefaults()
	s.Setup(&your_current_exchange_nameConfig)

	serverDetails, newClient, err := mock.NewVCRServer(mockfile)
	if err != nil {
		log.Fatalf("Mock server error %s", err)
	}

	s.HTTPClient = newClient
	s.API.Endpoints.URL = serverDetails

	log.Printf(sharedtestvalues.MockTesting, s.Name, s.API.Endpoints.URL)
	os.Exit(m.Run())
}

Mock test storage

• Under testdata/http_mock create a folder matching the name of your exchange. Then create a JSON file matching the name of your exchange with the following formatting:

{
	"routes": {
	}
}

Recording a test result

• Once the files your_current_exchange_name_mock_test.go and your_current_exchange_name_live_test.go along with the JSON file testdata/http_mock/our_current_exchange_name/our_current_exchange_name.json are created, go through each individual test function and add

var s SomeExchange

func TestDummyTest(t *testing.T) {
	s.Verbose = true // This will show you some fancy debug output
	s.HTTPRecording = true // This will record the request and response payloads
	s.API.Endpoints.URL = apiURL // This will overwrite the current mock url at localhost
	s.API.Endpoints.URLSecondary = secondAPIURL // This is only if your API has multiple endpoints
	s.HTTPClient = http.DefaultClient // This will ensure that a real HTTPClient is used to record
	err := s.SomeExchangeEndpointFunction()
	// check error
}

• This will store the request and results under the freshly created testdata/http_mock/your_current_exchange/your_current_exchange.json

Validating

• To check if the recording was successful, comment out recording and apiurl changes, then re-run test.

var s SomeExchange

func TestDummyTest(t *testing.T) {
	s.Verbose = true // This will show you some fancy debug output
	// s.HTTPRecording = true // This will record the request and response payloads
	// s.API.Endpoints.URL = apiURL // This will overwrite the current mock url at localhost
	// s.API.Endpoints.URLSecondary = secondAPIURL // This is only if your API has multiple endpoints
	// s.HTTPClient = http.DefaultClient // This will ensure that a real HTTPClient is used to record
	err := s.SomeExchangeEndpointFunction()
	// check error
}

• The payload should be the same.

Considerations

• Some functions require timestamps. Mock tests must match the same request structure, so time.Now() will cause problems for mock testing.
  • To address this, use the boolean variable mockTests to create a consistent date. An example is below.

	startTime := time.Now().Add(-time.Hour * 1)
	endTime := time.Now()
	if mockTests {
		startTime = time.Date(2020, 9, 1, 0, 0, 0, 0, time.UTC)
		endTime = time.Date(2020, 9, 2, 0, 0, 0, 0, time.UTC)
	}

• Authenticated endpoints will typically require valid API keys and a signature to run successfully. Authenticated endpoints should be skipped. See an example below

	if mockTests {
		t.Skip("skipping authenticated function for mock testing")
	}

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

• Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
• Code must be documented adhering to the official Go commentary guidelines.
• Code must adhere to our coding style.
• Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc

Documentation

Index

• Constants
• func CheckJSON(data interface{}, excluded *Exclusion) (interface{}, error)
• func CheckResponsePayload(data []byte) ([]byte, error)
• func DeriveURLValsFromJSONMap(payload []byte) (url.Values, error)
• func GetFilteredHeader(res *http.Response) (http.Header, error)
• func GetFilteredURLVals(vals url.Values) (string, error)
• func HTTPRecord(res *http.Response, service string, respContents []byte) error
• func IsExcluded(key string, excludedVars []string) bool
• func MatchAndGetResponse(mockData []HTTPResponse, requestVals url.Values, isQueryData bool) (json.RawMessage, error)
• func MatchURLVals(v1, v2 url.Values) bool
• func MessageWriteJSON(w http.ResponseWriter, status int, data interface{})
• func NewVCRServer(path string) (string, *http.Client, error)
• func RegisterHandler(pattern string, mock map[string][]HTTPResponse, mux *http.ServeMux)
• type Exclusion
  • func GetExcludedItems() (Exclusion, error)
• type HTTPResponse
• type VCRMock

Constants

const (
	Int64   = "int64"
	Float64 = "float64"
	Slice   = "slice"
	String  = "string"
	Bool    = "bool"
	Invalid = "invalid"
)

Reflection consts

const DefaultDirectory = "../../testdata/http_mock/"

DefaultDirectory defines the main mock directory

Functions

func CheckJSON

func CheckJSON(data interface{}, excluded *Exclusion) (interface{}, error)

CheckJSON recursively parses json data to retract keywords, quite intensive.

func CheckResponsePayload

func CheckResponsePayload(data []byte) ([]byte, error)

CheckResponsePayload checks to see if there are any response body variables that should not be there.

func DeriveURLValsFromJSONMap

func DeriveURLValsFromJSONMap(payload []byte) (url.Values, error)

DeriveURLValsFromJSONMap gets url vals from a map[string]string encoded JSON body

func GetFilteredHeader

func GetFilteredHeader(res *http.Response) (http.Header, error)

GetFilteredHeader filters excluded http headers for insertion into a mock test file

func GetFilteredURLVals

func GetFilteredURLVals(vals url.Values) (string, error)

GetFilteredURLVals filters excluded url value variables for insertion into a mock test file

func HTTPRecord

func HTTPRecord(res *http.Response, service string, respContents []byte) error

HTTPRecord will record the request and response to a default JSON file for mocking purposes

func IsExcluded

func IsExcluded(key string, excludedVars []string) bool

IsExcluded cross references the key with the excluded variables

func MatchAndGetResponse

func MatchAndGetResponse(mockData []HTTPResponse, requestVals url.Values, isQueryData bool) (json.RawMessage, error)

MatchAndGetResponse matches incoming request values with mockdata response values and returns the payload

func MatchURLVals

func MatchURLVals(v1, v2 url.Values) bool

MatchURLVals matches url.Value query strings

func MessageWriteJSON

func MessageWriteJSON(w http.ResponseWriter, status int, data interface{})

MessageWriteJSON writes JSON to a connection

func NewVCRServer

func NewVCRServer(path string) (string, *http.Client, error)

NewVCRServer starts a new VCR server for replaying HTTP requests for testing purposes and returns the server connection details

func RegisterHandler

func RegisterHandler(pattern string, mock map[string][]HTTPResponse, mux *http.ServeMux)

RegisterHandler registers a generalised mock response logic for specific routes

Types

type Exclusion

type Exclusion struct {
	Headers   []string `json:"headers"`
	Variables []string `json:"variables"`
}

Exclusion defines a list of items to be excluded from the main mock output this attempts a catch all approach and needs to be updated per exchange basis

func GetExcludedItems

func GetExcludedItems() (Exclusion, error)

GetExcludedItems checks to see if the variable is in the exclusion list as to not display secure items in mock file generator output

type HTTPResponse

type HTTPResponse struct {
	Data        json.RawMessage     `json:"data"`
	QueryString string              `json:"queryString"`
	BodyParams  string              `json:"bodyParams"`
	Headers     map[string][]string `json:"headers"`
}

HTTPResponse defines expected response from the end point including request data for pathing on the VCR server

type VCRMock

type VCRMock struct {
	Routes map[string]map[string][]HTTPResponse `json:"routes"`
}

VCRMock defines the main mock JSON file and attributes