Function TestMarshalJSONAPI

marshal_test.go:388–453

(t *testing.T)

}

func TestMarshalJSONAPI(t *testing.T) {
	t.Parallel()

	articleAJSONAPIBody := `{"data":{"id":"1","type":"articles","attributes":{"title":"A"}},"jsonapi":{"version":"1.0"}}`
	articleAJSONAPIMetaBody := `{"data":{"id":"1","type":"articles","attributes":{"title":"A"}},"jsonapi":{"version":"1.0","meta":{"foo":"bar"}}}`
	errorsObjectMetaBody := `{"jsonapi":{"version":"1.0","meta":{"foo":"bar"}},"errors":[{"title":"T"}]}`

	tests := []struct {
		description  string
		given        any
		givenJSONAPI any
		expect       string
		expectError  error
	}{
		{
			description:  "include jsonapi",
			given:        &articleA,
			givenJSONAPI: nil,
			expect:       articleAJSONAPIBody,
			expectError:  nil,
		}, {
			description:  "include jsonapi and meta (map)",
			given:        &articleA,
			givenJSONAPI: map[string]any{"foo": "bar"},
			expect:       articleAJSONAPIMetaBody,
			expectError:  nil,
		}, {
			description: "include jsonapi and meta (struct)",
			given:       &articleA,
			givenJSONAPI: &struct {
				Foo string `json:"foo"`
			}{Foo: "bar"},
			expect:      articleAJSONAPIMetaBody,
			expectError: nil,
		}, {
			description:  "include jsonapi and meta (non-object type)",
			given:        &articleA,
			givenJSONAPI: "foo",
			expect:       "",
			expectError:  &TypeError{Actual: "string", Expected: []string{"struct", "map"}},
		}, {
			description:  "include jsonapi and meta (map) errors object",
			given:        errorsSimpleSliceSinglePtr,
			givenJSONAPI: map[string]any{"foo": "bar"},
			expect:       errorsObjectMetaBody,
			expectError:  nil,
		},
	}

	for i, tc := range tests {
		tc := tc
		t.Run(fmt.Sprintf("%d", i), func(t *testing.T) {
			t.Parallel()
			t.Log(tc.description)

			actual, err := Marshal(tc.given, MarshalJSONAPI(tc.givenJSONAPI))
			if tc.expectError != nil {
				is.EqualError(t, tc.expectError, err)