commontest

type Action func(c TestContext) error

type ActualNumber struct {
	IntValue   int
	FloatValue float64
}

type AnyValue struct {
	Kind   ValueKind
	Bool   bool
	Number Number
	String string
	Array  []Action
	Object []PropertyAction
}

type ExampleStruct struct {
	StringField             string      `json:"string"`
	IntField                int64       `json:"int"`
	OptBoolAsInterfaceField interface{} `json:"optBool"`
}

type Number struct {
	Value []byte
	Kind  NumberKind
}

type NumberKind int

type PropertyAction struct {
	Name   string
	Action Action
}

type ReadErrorTestFactory interface {
	ExpectEOFError(err error) error
	ExpectWrongTypeError(err error, expectedType ValueKind, variant ValueVariant, gotType ValueKind) error
	ExpectSyntaxError(err error) error
}

type ReaderTestSuite struct {
	// ContextFactory must be provided by the caller to create an implementation of TestContext for
	// running a parsing test on the specified JSON input. This should include whatever parser
	// object will be used by the Actions that the ValueTestFactory creates.
	ContextFactory func(input []byte) TestContext

	// ValueTestFactory must be provided by the caller to create implementations of Action for
	// various JSON value types.
	ValueTestFactory ValueTestFactory

	// ReadErrorTestFactory must be provided by the caller to define expectations about error
	// reporting for invalid input.
	ReadErrorTestFactory ReadErrorTestFactory
}

type TestContext interface {
	// JSONData returns either (for readers) the input data that was passed in when the TestContext
	// was created, or (for writers) all of the output that has been produced so far.
	JSONData() []byte
}

type ValueKind int

type ValueTestFactory interface {
	EOF() Action
	Value(value AnyValue, variant ValueVariant) Action
	Variants(value AnyValue) []ValueVariant
}

type ValueVariant string

type WriterTestSuite struct {
	// ContextFactory must be provided by the caller to create an implementation of TestContext for
	// running a writing test on some set of JSON data. This should include whatever writer object
	// will be used by the Actions that the ValueTestFactory creates.
	ContextFactory func() TestContext

	// ValueTestFactory must be provided by the caller to create implementations of Action for
	// various JSON value types.
	ValueTestFactory ValueTestFactory

	// EncodeAsHex must be provided by the caller to define expectations about whether this writer
	// will use a \uNNNN escape sequence for the specified Unicode character. There is no single
	// correct answer for all implementations, since JSON allows characters to be escaped in
	// several ways and also allows unescaped multi-byte characters.
	EncodeAsHex func(rune) bool
}