Parser tests - Revision history

Gsnedders: The documentation now lives in the repo, so this can die.

2013-10-24T16:56:11Z

The documentation now lives in the repo, so this can die.

Jmdyck: /* Tokenizer Tests */ Add section for xmlViolation tests

2013-08-31T19:27:51Z

Tokenizer Tests: Add section for xmlViolation tests

← Older revision		Revision as of 19:27, 31 August 2013
Line 60:		Line 60:

	<tt>test.ignoreErrorOrder</tt> is a boolean value indicating that the order of <tt>ParseError</tt> tokens relative to other tokens in the output stream is unimportant, and implementations should ignore such differences between their output and <tt>expected_output_tokens</tt>. (This is used for errors emitted by the input stream preprocessing stage, since it is useful to test that code but it is undefined when the errors occur). If it is omitted, it defaults to <tt>false</tt>.		<tt>test.ignoreErrorOrder</tt> is a boolean value indicating that the order of <tt>ParseError</tt> tokens relative to other tokens in the output stream is unimportant, and implementations should ignore such differences between their output and <tt>expected_output_tokens</tt>. (This is used for errors emitted by the input stream preprocessing stage, since it is useful to test that code but it is undefined when the errors occur). If it is omitted, it defaults to <tt>false</tt>.

			== xmlViolation tests ==

			<tt>tokenizer/xmlViolation.test</tt> differs from the above in a couple of ways:
			* The name of the single member of the top-level JSON object is "xmlViolationTests" instead of "tests".
			* Each test's expected output assumes that implementation is applying the tweaks given in the spec's "Coercing an HTML DOM into an infoset" section.

	== Open Issues ==		== Open Issues ==

Jmdyck: /* Basic Structure */ describe 'doubleEscaped'

2013-08-31T19:13:00Z

Basic Structure: describe 'doubleEscaped'

← Older revision		Revision as of 19:13, 31 August 2013
Line 27:		Line 27:
	<tt>test.input</tt> is a string containing the characters to pass to the tokenizer.		<tt>test.input</tt> is a string containing the characters to pass to the tokenizer.
	Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.		Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.

			If <tt>test.doubleEscaped</tt> is present and <tt>true</tt>, then <tt>test.input</tt> is not quite as described above.
			Instead, it must first be subjected to another round of unescaping (i.e., in addition to any unescaping involved in the JSON import), and the result of ''that'' represents the characters of the input stream.
			Currently, the only unescaping required by this option is to convert each sequence of the form \uHHHH (where H is a hex digit) into the corresponding Unicode code point.
			(Note that this option also affects the interpretation of <tt>test.output</tt>.)

	<tt>test.initialStates</tt> is a list of strings, each being the name of a tokenizer state.		<tt>test.initialStates</tt> is a list of strings, each being the name of a tokenizer state.
Line 51:		Line 56:

	All adjacent character tokens are coalesced into a single <tt>["Character", data]</tt> token.		All adjacent character tokens are coalesced into a single <tt>["Character", data]</tt> token.

			If <tt>test.doubleEscaped</tt> is present and <tt>true</tt>, then every string within <tt>test.output</tt> must be further unescaped (as described above) before comparing with the tokenizer's output.

	<tt>test.ignoreErrorOrder</tt> is a boolean value indicating that the order of <tt>ParseError</tt> tokens relative to other tokens in the output stream is unimportant, and implementations should ignore such differences between their output and <tt>expected_output_tokens</tt>. (This is used for errors emitted by the input stream preprocessing stage, since it is useful to test that code but it is undefined when the errors occur). If it is omitted, it defaults to <tt>false</tt>.		<tt>test.ignoreErrorOrder</tt> is a boolean value indicating that the order of <tt>ParseError</tt> tokens relative to other tokens in the output stream is unimportant, and implementations should ignore such differences between their output and <tt>expected_output_tokens</tt>. (This is used for errors emitted by the input stream preprocessing stage, since it is useful to test that code but it is undefined when the errors occur). If it is omitted, it defaults to <tt>false</tt>.

Jmdyck: /* Tokenizer Tests */ I think it's confusing to refer to a component of a test using an identifier that isn't the component's actual name, so eliminate that.

2013-08-31T18:53:24Z

Tokenizer Tests: I think it's confusing to refer to a component of a test using an identifier that isn't the component's actual name, so eliminate that.

← Older revision		Revision as of 18:53, 31 August 2013
Line 25:		Line 25:
	===Test set-up===		===Test set-up===

	<tt>~~input_string~~</tt> is a string ~~literal~~ containing the ~~input string~~ to pass to the tokenizer.		<tt>test.input</tt> is a string containing the characters to pass to the tokenizer.
	Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.		Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.

	<tt>~~initial_states~~</tt> is a list of strings, each being the name of a tokenizer state.		<tt>test.initialStates</tt> is a list of strings, each being the name of a tokenizer state.
	The test should be run once for each string, using it to set the tokenizer's initial state for that run.		The test should be run once for each string, using it to set the tokenizer's initial state for that run.
	If <tt>~~initial_states~~</tt> is omitted, it defaults to <tt>["data state"]</tt>.		If <tt>test.initialStates</tt> is omitted, it defaults to <tt>["data state"]</tt>.

	<tt>~~last_start_tag~~</tt> is a lowercase string that should be used as "the tag name of the last start tag to have been emitted from this tokenizer", referenced in the spec's definition of '''appropriate end tag token'''. If it is omitted, it is treated as if "no start tag has been emitted from this tokenizer".		<tt>test.lastStartTag</tt> is a lowercase string that should be used as "the tag name of the last start tag to have been emitted from this tokenizer", referenced in the spec's definition of '''appropriate end tag token'''. If it is omitted, it is treated as if "no start tag has been emitted from this tokenizer".

	===Test results===		===Test results===

	<tt>~~expected_output_tokens~~</tt> is a list of tokens, ordered with the first produced by the tokenizer the first (leftmost) in the list. The list must mach the '''complete''' list of tokens that the tokenizer should produce. Valid tokens are:		<tt>test.output</tt> is a list of tokens, ordered with the first produced by the tokenizer the first (leftmost) in the list. The list must mach the '''complete''' list of tokens that the tokenizer should produce. Valid tokens are:

	["DOCTYPE", name, public_id, system_id, correctness]		["DOCTYPE", name, public_id, system_id, correctness]
Line 52:		Line 52:
	All adjacent character tokens are coalesced into a single <tt>["Character", data]</tt> token.		All adjacent character tokens are coalesced into a single <tt>["Character", data]</tt> token.

	<tt>~~ignore_error_order~~</tt> is a boolean value indicating that the order of <tt>ParseError</tt> tokens relative to other tokens in the output stream is unimportant, and implementations should ignore such differences between their output and <tt>expected_output_tokens</tt>. (This is used for errors emitted by the input stream preprocessing stage, since it is useful to test that code but it is undefined when the errors occur). If it is omitted, it defaults to <tt>false</tt>.		<tt>test.ignoreErrorOrder</tt> is a boolean value indicating that the order of <tt>ParseError</tt> tokens relative to other tokens in the output stream is unimportant, and implementations should ignore such differences between their output and <tt>expected_output_tokens</tt>. (This is used for errors emitted by the input stream preprocessing stage, since it is useful to test that code but it is undefined when the errors occur). If it is omitted, it defaults to <tt>false</tt>.

	== Open Issues ==		== Open Issues ==

Jmdyck: /* Test set-up */ make a stronger association between lastStartTag and the spec

2013-08-31T18:40:47Z

Test set-up: make a stronger association between lastStartTag and the spec

← Older revision		Revision as of 18:40, 31 August 2013
Line 32:		Line 32:
	If <tt>initial_states</tt> is omitted, it defaults to <tt>["data state"]</tt>.		If <tt>initial_states</tt> is omitted, it defaults to <tt>["data state"]</tt>.

	<tt>last_start_tag</tt> is a lowercase string that should be used as "the tag name of the last start tag ~~token~~ emitted" in the ~~tokenizer algorithm~~. If it is omitted, it is treated as if "no start tag ~~token~~ has ~~ever~~ been emitted by this ~~instance of the tokeniser~~".		<tt>last_start_tag</tt> is a lowercase string that should be used as "the tag name of the last start tag to have been emitted from this tokenizer", referenced in the spec's definition of '''appropriate end tag token'''. If it is omitted, it is treated as if "no start tag has been emitted from this tokenizer".

	===Test results===		===Test results===

Jmdyck: /* Basic Structure */ replace 'contentModelFlags' with 'initialStates'

2013-08-31T18:35:07Z

Basic Structure: replace 'contentModelFlags' with 'initialStates'

← Older revision		Revision as of 18:35, 31 August 2013
Line 13:		Line 13:
	"input":"input_string",		"input":"input_string",
	"output":[expected_output_tokens],		"output":[expected_output_tokens],
	"~~contentModelFlags~~":[~~content_model_flags~~],		"initialStates":[initial_states],
	"lastStartTag":last_start_tag,		"lastStartTag":last_start_tag,
	"ignoreErrorOrder":ignore_error_order		"ignoreErrorOrder":ignore_error_order
Line 28:		Line 28:
	Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.		Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.

	<tt>~~content_model_flags~~</tt> is a list of strings ~~from~~ the ~~set:~~		<tt>initial_states</tt> is a list of strings, each being the name of a tokenizer state.
	~~PCDATA~~		The test should be run once for each string, using it to set the tokenizer's initial state for that run.
	~~RCDATA~~		If <tt>initial_states</tt> is omitted, it defaults to <tt>["data state"]</tt>.
	~~RAWTEXT~~
	~~PLAINTEXT~~
	The test ~~case applies when~~ the tokenizer ~~begins with its content model flag set to any of those values~~. If <tt>~~content_model_flags~~</tt> is omitted, it defaults to <tt>["~~PCDATA~~"]</tt>.

	<tt>last_start_tag</tt> is a lowercase string that should be used as "the tag name of the last start tag token emitted" in the tokenizer algorithm. If it is omitted, it is treated as if "no start tag token has ever been emitted by this instance of the tokeniser".		<tt>last_start_tag</tt> is a lowercase string that should be used as "the tag name of the last start tag token emitted" in the tokenizer algorithm. If it is omitted, it is treated as if "no start tag token has ever been emitted by this instance of the tokeniser".

Jmdyck: /* Basic Structure */ fix typo: misplaced right-brace

2013-08-31T18:26:40Z

Basic Structure: fix typo: misplaced right-brace

← Older revision		Revision as of 18:26, 31 August 2013
Line 12:		Line 12:
	{"description":"Test description",		{"description":"Test description",
	"input":"input_string",		"input":"input_string",
	"output":[expected_output_tokens]},		"output":[expected_output_tokens],
	"contentModelFlags":[content_model_flags],		"contentModelFlags":[content_model_flags],
	"lastStartTag":last_start_tag,		"lastStartTag":last_start_tag,
	"ignoreErrorOrder":ignore_error_order		"ignoreErrorOrder":ignore_error_order
			}
	]}		]}

Jmdyck: /* Basic Structure */ Indent the JSON code for readability.

2013-08-31T18:25:35Z

Basic Structure: Indent the JSON code for readability.

← Older revision		Revision as of 18:25, 31 August 2013
Line 10:		Line 10:
	{"tests": [		{"tests": [

	{"description":"Test description",		{"description":"Test description",
	"input":"input_string",		"input":"input_string",
	"output":[expected_output_tokens]},		"output":[expected_output_tokens]},
	"contentModelFlags":[content_model_flags],		"contentModelFlags":[content_model_flags],
	"lastStartTag":last_start_tag,		"lastStartTag":last_start_tag,
	"ignoreErrorOrder":ignore_error_order		"ignoreErrorOrder":ignore_error_order
	]}		]}

Jmdyck: /* Basic Structure */ Rearrange paragraphs more logically. Add headers "Test set-up" and "Test results".

2013-08-30T22:44:12Z

Basic Structure: Rearrange paragraphs more logically. Add headers "Test set-up" and "Test results".

← Older revision		Revision as of 22:44, 30 August 2013
Line 17:		Line 17:
	"ignoreErrorOrder":ignore_error_order		"ignoreErrorOrder":ignore_error_order
	]}		]}

			Multiple tests per file are allowed simply by adding more objects to the "tests" list.

	<tt>description</tt>, <tt>input</tt> and <tt>output</tt> are always present. The other values are optional.		<tt>description</tt>, <tt>input</tt> and <tt>output</tt> are always present. The other values are optional.

			===Test set-up===

	<tt>input_string</tt> is a string literal containing the input string to pass to the tokenizer.		<tt>input_string</tt> is a string literal containing the input string to pass to the tokenizer.
	Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.		Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.

			<tt>content_model_flags</tt> is a list of strings from the set:
			PCDATA
			RCDATA
			RAWTEXT
			PLAINTEXT
			The test case applies when the tokenizer begins with its content model flag set to any of those values. If <tt>content_model_flags</tt> is omitted, it defaults to <tt>["PCDATA"]</tt>.

			<tt>last_start_tag</tt> is a lowercase string that should be used as "the tag name of the last start tag token emitted" in the tokenizer algorithm. If it is omitted, it is treated as if "no start tag token has ever been emitted by this instance of the tokeniser".

			===Test results===

	<tt>expected_output_tokens</tt> is a list of tokens, ordered with the first produced by the tokenizer the first (leftmost) in the list. The list must mach the '''complete''' list of tokens that the tokenizer should produce. Valid tokens are:		<tt>expected_output_tokens</tt> is a list of tokens, ordered with the first produced by the tokenizer the first (leftmost) in the list. The list must mach the '''complete''' list of tokens that the tokenizer should produce. Valid tokens are:
Line 37:		Line 52:
	When the self-closing flag is set, the <tt>StartTag</tt> array has <tt>true</tt> as its fourth entry. When the flag is not set, the array has only three entries for backwards compatibility.		When the self-closing flag is set, the <tt>StartTag</tt> array has <tt>true</tt> as its fourth entry. When the flag is not set, the array has only three entries for backwards compatibility.

	~~<tt>content_model_flags</tt> is~~ a ~~list of strings from the set:~~		All adjacent character tokens are coalesced into a single <tt>["Character", data]</tt> token.
	~~PCDATA~~
	~~RCDATA~~
	~~RAWTEXT~~
	~~PLAINTEXT~~
	~~The test case applies when the tokenizer begins with its content model flag set to any of those values. If <tt>content_model_flags</tt> is omitted, it defaults to~~ <tt>["~~PCDATA~~"]</tt>.

	~~<tt>last_start_tag</tt> is a lowercase string that should be used as "the tag name of the last start tag~~ token ~~emitted" in the tokenizer algorithm. If it is omitted, it is treated as if "no start tag token has ever been emitted by this instance of the tokeniser"~~.

	<tt>ignore_error_order</tt> is a boolean value indicating that the order of <tt>ParseError</tt> tokens relative to other tokens in the output stream is unimportant, and implementations should ignore such differences between their output and <tt>expected_output_tokens</tt>. (This is used for errors emitted by the input stream preprocessing stage, since it is useful to test that code but it is undefined when the errors occur). If it is omitted, it defaults to <tt>false</tt>.		<tt>ignore_error_order</tt> is a boolean value indicating that the order of <tt>ParseError</tt> tokens relative to other tokens in the output stream is unimportant, and implementations should ignore such differences between their output and <tt>expected_output_tokens</tt>. (This is used for errors emitted by the input stream preprocessing stage, since it is useful to test that code but it is undefined when the errors occur). If it is omitted, it defaults to <tt>false</tt>.


	~~Multiple tests per file are allowed simply by adding more objects to the "tests" list.~~

	~~All adjacent character tokens are coalesced into a single <tt>["Character", data]</tt> token.~~

	== Open Issues ==		== Open Issues ==

Jmdyck: /* Basic Structure */ Clarify "input_string".

2013-08-28T23:02:32Z

Basic Structure: Clarify "input_string".

← Older revision		Revision as of 23:02, 28 August 2013
Line 21:		Line 21:

	<tt>input_string</tt> is a string literal containing the input string to pass to the tokenizer.		<tt>input_string</tt> is a string literal containing the input string to pass to the tokenizer.
			Specifically, it represents the characters of the '''input stream''', and so implementations are expected to perform the processing described in the spec's '''Preprocessing the input stream''' section before feeding the result to the tokenizer.

	<tt>expected_output_tokens</tt> is a list of tokens, ordered with the first produced by the tokenizer the first (leftmost) in the list. The list must mach the '''complete''' list of tokens that the tokenizer should produce. Valid tokens are:		<tt>expected_output_tokens</tt> is a list of tokens, ordered with the first produced by the tokenizer the first (leftmost) in the list. The list must mach the '''complete''' list of tokens that the tokenizer should produce. Valid tokens are: