openapiv2/internal/genopenapi/format_test.go

package genopenapi_test

import (
	"bytes"
	"encoding/json"
	"io"
	"reflect"
	"testing"

	"github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2/internal/genopenapi"
	"gopkg.in/yaml.v3"
)

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

	testCases := [...]struct {
		Format genopenapi.Format
		Valid  bool
	}{{
		Format: genopenapi.FormatJSON,
		Valid:  true,
	}, {
		Format: genopenapi.FormatYAML,
		Valid:  true,
	}, {
		Format: genopenapi.Format("unknown"),
		Valid:  false,
	}, {
		Format: genopenapi.Format(""),
		Valid:  false,
	}}

	for _, tc := range testCases {
		tc := tc

		t.Run(string(tc.Format), func(t *testing.T) {
			t.Parallel()

			err := tc.Format.Validate()
			switch {
			case tc.Valid && err != nil:
				t.Fatalf("expect no validation error, got: %s", err)
			case !tc.Valid && err == nil:
				t.Fatal("expect validation error, got nil")
			}
		})
	}
}

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

	type contentDecoder interface {
		Decode(v interface{}) error
	}

	testCases := [...]struct {
		Format     genopenapi.Format
		NewDecoder func(r io.Reader) contentDecoder
	}{{
		Format: genopenapi.FormatJSON,
		NewDecoder: func(r io.Reader) contentDecoder {
			return json.NewDecoder(r)
		},
	}, {
		Format: genopenapi.FormatYAML,
		NewDecoder: func(r io.Reader) contentDecoder {
			return yaml.NewDecoder(r)
		},
	}}

	for _, tc := range testCases {
		tc := tc

		t.Run(string(tc.Format), func(t *testing.T) {
			t.Parallel()

			expParams := map[string]string{
				"hello": "world",
			}

			var buf bytes.Buffer
			enc, err := tc.Format.NewEncoder(&buf)
			if err != nil {
				t.Fatalf("expect no encoder creating error, got: %s", err)
			}

			err = enc.Encode(expParams)
			if err != nil {
				t.Fatalf("expect no encoding error, got: %s", err)
			}

			gotParams := make(map[string]string)
			err = tc.NewDecoder(&buf).Decode(&gotParams)
			if err != nil {
				t.Fatalf("expect no decoding error, got: %s", err)
			}

			if !reflect.DeepEqual(expParams, gotParams) {
				t.Fatalf("expected: %+v, actual: %+v", expParams, gotParams)
			}
		})
	}
}