Function TestNewDoc

common/doc_test.go:91–174

(t *testing.T)

}

func TestNewDoc(t *testing.T) {
	tests := []struct {
		newDoc     func() *Doc
		kind       DocKind
		name       string
		celType    string
		sig        string
		desc       string
		childCount int
	}{
		{
			newDoc: func() *Doc {
				return NewMacroDoc("map", "map converts a list or map of values to a list",
					NewExampleDoc("[1, 2].map(i, i * 2) // [2, 4]"))
			},
			kind:       DocMacro,
			name:       "map",
			desc:       "map converts a list or map of values to a list",
			childCount: 1,
		},
		{
			newDoc: func() *Doc {
				return NewVariableDoc(
					"request",
					"google.rpc.context.AttributeContext.Request",
					"parameters related to an HTTP API request")
			},
			kind:       DocVariable,
			name:       "request",
			celType:    "google.rpc.context.AttributeContext.Request",
			desc:       "parameters related to an HTTP API request",
			childCount: 0,
		},
		{
			newDoc: func() *Doc {
				return NewFunctionDoc("getToken",
					"get the JWT token from a request\nas deserialized JSON",
					NewOverloadDoc("request_getToken", "request.getToken() -> map(string, dyn)",
						NewExampleDoc("has(request.getToken().sub) // false")))
			},
			kind:       DocFunction,
			name:       "getToken",
			desc:       "get the JWT token from a request\nas deserialized JSON",
			childCount: 1,
		},
		{
			newDoc: func() *Doc {
				return NewFieldDoc("google.rpc.context.AttributeContext.Request.token", "string",
					"The HTTP URL scheme, such as `http` and `https`.",
					NewExampleDoc("\"https\""))
			},
			kind:       DocField,
			name:       "google.rpc.context.AttributeContext.Request.token",
			celType:    "string",
			desc:       "The HTTP URL scheme, such as `http` and `https`.",
			childCount: 1,
		},
	}