TestError() — gin Function Reference

Architecture documentation for the TestError() function in errors_test.go from the gin codebase.

Function go GinCore Middleware

Entity Profile

GinCore→ Middleware→ TestError() — gin Function Reference

Dependency Diagram

graph TD
  73ec626e_6181_43d1_7e23_2a5e0cfeeaa9["TestError()"]
  bd4678df_f6bd_26e2_4f83_00536939b6d9["errors_test.go"]
  73ec626e_6181_43d1_7e23_2a5e0cfeeaa9 -->|defined in| bd4678df_f6bd_26e2_4f83_00536939b6d9
  style 73ec626e_6181_43d1_7e23_2a5e0cfeeaa9 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

errors_test.go lines 17–66

func TestError(t *testing.T) {
	baseError := errors.New("test error")
	err := &Error{
		Err:  baseError,
		Type: ErrorTypePrivate,
	}
	assert.Equal(t, err.Error(), baseError.Error())
	assert.Equal(t, H{"error": baseError.Error()}, err.JSON())

	assert.Equal(t, err.SetType(ErrorTypePublic), err)
	assert.Equal(t, ErrorTypePublic, err.Type)

	assert.Equal(t, err.SetMeta("some data"), err)
	assert.Equal(t, "some data", err.Meta)
	assert.Equal(t, H{
		"error": baseError.Error(),
		"meta":  "some data",
	}, err.JSON())

	jsonBytes, _ := json.API.Marshal(err)
	assert.JSONEq(t, "{\"error\":\"test error\",\"meta\":\"some data\"}", string(jsonBytes))

	err.SetMeta(H{ //nolint: errcheck
		"status": "200",
		"data":   "some data",
	})
	assert.Equal(t, H{
		"error":  baseError.Error(),
		"status": "200",
		"data":   "some data",
	}, err.JSON())

	err.SetMeta(H{ //nolint: errcheck
		"error":  "custom error",
		"status": "200",
		"data":   "some data",
	})
	assert.Equal(t, H{
		"error":  "custom error",
		"status": "200",
		"data":   "some data",
	}, err.JSON())

	type customError struct {
		status string
		data   string
	}
	err.SetMeta(customError{status: "200", data: "other data"}) //nolint: errcheck
	assert.Equal(t, customError{status: "200", data: "other data"}, err.JSON())
}