View source for test-suite

{{DISPLAYTITLE:microformats test suites}}

{{stub}}

Test suites help interoperability and completeness of microformats parsing. This page documents the effort to produce test cases for [[microformats2]] and parsing patterns, so that you can verify the operations of your parser.

==Goals of Test Suite Project==
There's no better way for parser writers to verify the correctness and completeness of their code.

We need to provide a suite to:
* Verify the correctness of [[microformats2-parsing]]
* Indicate the completeness of a [[parser]] implementation
* Ensure that global patterns like [[abbr-design-pattern]] and [[value-class-pattern]] are implemented accurately
* Provide a base set of tests for implementations to build their automated test scripts
* Encourage implementations to put their tests into this combined effort, rather than working alone

== Test Project ==
On github:
* https://github.com/microformats/tests

== FAQ ==
Frequently asked questions about microformats tests / test suites.

* '''How do we create a test suite which can be used for implementations in any langage?'''
** Define the test suites using the [[test-fixture]] microformat (and/or it’s updated mf2 version) so that language-specific test suites can be derived from a single source. See also [[test-suite-brainstorming]]
* '''Should we test the whole parser output against a JSON representation of the original data, or compare individual parsed properties?'''
** Paraphrased from [https://github.com/microformats/tests/issues/1 this issue on github]
** Specifically the difficulty is dates/times, where a single datetime can be specified in many different ways, and only sometimes represented as an object native to the language the parser is working in.  Many microformats / [[HTML5]] &lt;time> dates/times/durations are not represented in any native language objects (e.g. month-day). See [http://wiki.whatwg.org/wiki/Time HTML5 Time element proposals] for more variants/details.
* …

== see also ==
* [[test-suite-brainstorming]]
* [[test-fixture]]
* [[microformats2]]
* [[microformats2-parsing]]

== previously ==
Previous microformats1 test suites: [[test-suite-2009]]