Page MenuHomePhabricator

Finalize file format for phester test definitions
Closed, InvalidPublic3 Estimate Story Points

Description

The file format drafted in T219883: Draft file format for phester test definitions needs to be finalized and documented, once we have a feature complete (prototype?) implementation of phester.

Event Timeline

daniel renamed this task from Finalize file format for API test definitions to Finalize file format for phester test definitions.Apr 29 2019, 7:48 PM
daniel created this task.
daniel set the point value for this task to 3.

Giving this 3 story points, tending towards 5, because writing a proper spec with good documentation takes time, even after we know exactly what the file format should look like.

Phester's format for specifying requests and responses is quite similar to HAR (see HTTP Archive 1.2), but there are some differences. Maybe we want to change the format to be compatible with HAR?

daniel added a comment.EditedJul 26 2019, 10:45 AM

Accessing values nested deeply in a structure. We could allow a shorthand syntax for that. E.g. instead of

body: 
  query:
     page:
         62323:
             user:
                 id: 23

we could allow:

body:
  .query.page.62323.user.id: 23

The path-like key would be expanded after parsing the YAML. The leading dot would trigger that. The syntax follows the JSONPath standard (though I don't think we should implement full JSONPath here). To allow for the rare case that we literally want a key that starts with a dot, escape it with a backslash (or another dot).

CCicalese_WMF closed this task as Invalid.Aug 12 2019, 6:38 PM
CCicalese_WMF added a subscriber: CCicalese_WMF.

We will not be building Phester.