XML Developer's Guide

{ "*": {} } { "from": 0, "size": 2000, "sort": [ { "@timestamp": "desc" } ], "query": { "bool": { "must": [ { "match": { "tag.env": "prod" } }, { "match": { "data.r_code": "500" } }, { "match": { "data.q_client-dns": "m.shop.sosh.fr" } }, { "match": { "@timestamp": { "query": "{{date}}" } } } ] } } } { "encoding1": "\uD834\uDD1E" } "Hello {{Name}}!" { "firstName": "John", "lastName": "Smith", "isAlive": true, "age": 27, "address": { "streetAddress": "21 2nd Street", "city": "New York", "state": "NY", "postalCode": "10021-3100" }, "phoneNumbers": [ { "type": "home", "number": "212 555-1234" }, { "type": "office", "number": "646 555-4567" } ], "children": [], "spouse": null } { "name": "{{name}}", "password": "secret", "age": {{age}}, "strict": {{strict}} } { "description": "JSONPath Compliance Test Suite. This file is autogenerated, do not edit.", "tests": [ { "name": "basic, root", "selector": "$", "document": [ "first", "second" ], "result": [ [ "first", "second" ] ], "result_paths": [ "$" ] }, { "name": "basic, no leading whitespace", "selector": " $", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "basic, no trailing whitespace", "selector": "$ ", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "basic, name shorthand", "selector": "$.a", "document": { "a": "A", "b": "B" }, "result": [ "A" ], "result_paths": [ "$['a']" ] }, { "name": "basic, name shorthand, extended unicode ☺", "selector": "$.☺", "document": { "☺": "A", "b": "B" }, "result": [ "A" ], "result_paths": [ "$['☺']" ] }, { "name": "basic, name shorthand, underscore", "selector": "$._", "document": { "_": "A", "_foo": "B" }, "result": [ "A" ], "result_paths": [ "$['_']" ] }, { "name": "basic, name shorthand, symbol", "selector": "$.&", "invalid_selector": true }, { "name": "basic, name shorthand, number", "selector": "$.1", "invalid_selector": true }, { "name": "basic, name shorthand, absent data", "selector": "$.c", "document": { "a": "A", "b": "B" }, "result": [], "result_paths": [] }, { "name": "basic, name shorthand, array data", "selector": "$.a", "document": [ "first", "second" ], "result": [], "result_paths": [] }, { "name": "basic, name shorthand, object data, nested", "selector": "$.a.b.c", "document": { "a": { "b": { "c": "C" } } }, "result": [ "C" ], "result_paths": [ "$['a']['b']['c']" ] }, { "name": "basic, wildcard shorthand, object data", "selector": "$.*", "document": { "a": "A", "b": "B" }, "results": [ [ "A", "B" ], [ "B", "A" ] ], "results_paths": [ [ "$['a']", "$['b']" ], [ "$['b']", "$['a']" ] ] }, { "name": "basic, wildcard shorthand, array data", "selector": "$.*", "document": [ "first", "second" ], "result": [ "first", "second" ], "result_paths": [ "$[0]", "$[1]" ] }, { "name": "basic, wildcard selector, array data", "selector": "$[*]", "document": [ "first", "second" ], "result": [ "first", "second" ], "result_paths": [ "$[0]", "$[1]" ] }, { "name": "basic, wildcard shorthand, then name shorthand", "selector": "$.*.a", "document": { "x": { "a": "Ax", "b": "Bx" }, "y": { "a": "Ay", "b": "By" } }, "results": [ [ "Ax", "Ay" ], [ "Ay", "Ax" ] ], "results_paths": [ [ "$['x']['a']", "$['y']['a']" ], [ "$['y']['a']", "$['x']['a']" ] ] }, { "name": "basic, multiple selectors", "selector": "$[0,2]", "document": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "result": [ 0, 2 ], "result_paths": [ "$[0]", "$[2]" ] }, { "name": "basic, multiple selectors, space instead of comma", "selector": "$[0 2]", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "basic, selector, leading comma", "selector": "$[,0]", "invalid_selector": true }, { "name": "basic, selector, trailing comma", "selector": "$[0,]", "invalid_selector": true }, { "name": "basic, multiple selectors, name and index, array data", "selector": "$['a',1]", "document": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "result": [ 1 ], "result_paths": [ "$[1]" ] }, { "name": "basic, multiple selectors, name and index, object data", "selector": "$['a',1]", "document": { "a": 1, "b": 2 }, "result": [ 1 ], "result_paths": [ "$['a']" ] }, { "name": "basic, multiple selectors, index and slice", "selector": "$[1,5:7]", "document": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "result": [ 1, 5, 6 ], "result_paths": [ "$[1]", "$[5]", "$[6]" ] }, { "name": "basic, multiple selectors, index and slice, overlapping", "selector": "$[1,0:3]", "document": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "result": [ 1, 0, 1, 2 ], "result_paths": [ "$[1]", "$[0]", "$[1]", "$[2]" ] }, { "name": "basic, multiple selectors, duplicate index", "selector": "$[1,1]", "document": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "result": [ 1, 1 ], "result_paths": [ "$[1]", "$[1]" ] }, { "name": "basic, multiple selectors, wildcard and index", "selector": "$[*,1]", "document": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "result": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 1 ], "result_paths": [ "$[0]", "$[1]", "$[2]", "$[3]", "$[4]", "$[5]", "$[6]", "$[7]", "$[8]", "$[9]", "$[1]" ] }, { "name": "basic, multiple selectors, wildcard and name", "selector": "$[*,'a']", "document": { "a": "A", "b": "B" }, "results": [ [ "A", "B", "A" ], [ "B", "A", "A" ] ], "results_paths": [ [ "$['a']", "$['b']", "$['a']" ], [ "$['b']", "$['a']", "$['a']" ] ] }, { "name": "basic, multiple selectors, wildcard and slice", "selector": "$[*,0:2]", "document": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "result": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1 ], "result_paths": [ "$[0]", "$[1]", "$[2]", "$[3]", "$[4]", "$[5]", "$[6]", "$[7]", "$[8]", "$[9]", "$[0]", "$[1]" ] }, { "name": "basic, multiple selectors, multiple wildcards", "selector": "$[*,*]", "document": [ 0, 1, 2 ], "result": [ 0, 1, 2, 0, 1, 2 ], "result_paths": [ "$[0]", "$[1]", "$[2]", "$[0]", "$[1]", "$[2]" ] }, { "name": "basic, empty segment", "selector": "$[]", "invalid_selector": true }, { "name": "basic, descendant segment, index", "selector": "$..[1]", "document": { "o": [ 0, 1, [ 2, 3 ] ] }, "result": [ 1, 3 ], "result_paths": [ "$['o'][1]", "$['o'][2][1]" ] }, { "name": "basic, descendant segment, name shorthand", "selector": "$..a", "document": { "o": [ { "a": "b" }, { "a": "c" } ] }, "result": [ "b", "c" ], "result_paths": [ "$['o'][0]['a']", "$['o'][1]['a']" ] }, { "name": "basic, name shorthand, true", "selector": "$.true", "document": { "true": "A", "_foo": "B" }, "result": [ "A" ], "result_paths": [ "$['true']" ], "tags": [ "boundary" ] }, { "name": "basic, name shorthand, false", "selector": "$.false", "document": { "false": "A", "_foo": "B" }, "result": [ "A" ], "result_paths": [ "$['false']" ], "tags": [ "boundary" ] }, { "name": "basic, name shorthand, null", "selector": "$.null", "document": { "null": "A", "_foo": "B" }, "result": [ "A" ], "result_paths": [ "$['null']" ], "tags": [ "boundary" ] }, { "name": "basic, descendant segment, wildcard shorthand, array data", "selector": "$..*", "document": [ 0, 1 ], "result": [ 0, 1 ], "result_paths": [ "$[0]", "$[1]" ] }, { "name": "basic, descendant segment, wildcard selector, array data", "selector": "$..[*]", "document": [ 0, 1 ], "result": [ 0, 1 ], "result_paths": [ "$[0]", "$[1]" ] }, { "name": "basic, descendant segment, wildcard selector, nested arrays", "selector": "$..[*]", "document": [ [ [ 1 ] ], [ 2 ] ], "results": [ [ [ [ 1 ] ], [ 2 ], [ 1 ], 1, 2 ], [ [ [ 1 ] ], [ 2 ], [ 1 ], 2, 1 ] ], "results_paths": [ [ "$[0]", "$[1]", "$[0][0]", "$[0][0][0]", "$[1][0]" ], [ "$[0]", "$[1]", "$[0][0]", "$[1][0]", "$[0][0][0]" ] ] }, { "name": "basic, descendant segment, wildcard selector, nested objects", "selector": "$..[*]", "document": { "a": { "c": { "e": 1 } }, "b": { "d": 2 } }, "results": [ [ { "c": { "e": 1 } }, { "d": 2 }, { "e": 1 }, 1, 2 ], [ { "c": { "e": 1 } }, { "d": 2 }, { "e": 1 }, 2, 1 ], [ { "c": { "e": 1 } }, { "d": 2 }, 2, { "e": 1 }, 1 ], [ { "d": 2 }, { "c": { "e": 1 } }, { "e": 1 }, 1, 2 ], [ { "d": 2 }, { "c": { "e": 1 } }, { "e": 1 }, 2, 1 ], [ { "d": 2 }, { "c": { "e": 1 } }, 2, { "e": 1 }, 1 ] ], "results_paths": [ [ "$['a']", "$['b']", "$['a']['c']", "$['a']['c']['e']", "$['b']['d']" ], [ "$['a']", "$['b']", "$['a']['c']", "$['b']['d']", "$['a']['c']['e']" ], [ "$['a']", "$['b']", "$['b']['d']", "$['a']['c']", "$['a']['c']['e']" ], [ "$['b']", "$['a']", "$['a']['c']", "$['a']['c']['e']", "$['b']['d']" ], [ "$['b']", "$['a']", "$['a']['c']", "$['b']['d']", "$['a']['c']['e']" ], [ "$['b']", "$['a']", "$['b']['d']", "$['a']['c']", "$['a']['c']['e']" ] ] }, { "name": "basic, descendant segment, wildcard shorthand, object data", "selector": "$..*", "document": { "a": "b" }, "result": [ "b" ], "result_paths": [ "$['a']" ] }, { "name": "basic, descendant segment, wildcard shorthand, nested data", "selector": "$..*", "document": { "o": [ { "a": "b" } ] }, "result": [ [ { "a": "b" } ], { "a": "b" }, "b" ], "result_paths": [ "$['o']", "$['o'][0]", "$['o'][0]['a']" ] }, { "name": "basic, descendant segment, multiple selectors", "selector": "$..['a','d']", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" } ], "result": [ "b", "e", "c", "f" ], "result_paths": [ "$[0]['a']", "$[0]['d']", "$[1]['a']", "$[1]['d']" ] }, { "name": "basic, descendant segment, object traversal, multiple selectors", "selector": "$..['a','d']", "document": { "x": { "a": "b", "d": "e" }, "y": { "a": "c", "d": "f" } }, "results": [ [ "b", "e", "c", "f" ], [ "c", "f", "b", "e" ] ], "results_paths": [ [ "$['x']['a']", "$['x']['d']", "$['y']['a']", "$['y']['d']" ], [ "$['y']['a']", "$['y']['d']", "$['x']['a']", "$['x']['d']" ] ] }, { "name": "basic, bald descendant segment", "selector": "$..", "invalid_selector": true }, { "name": "basic, current node identifier without filter selector", "selector": "$[@.a]", "invalid_selector": true }, { "name": "basic, root node identifier in brackets without filter selector", "selector": "$[$.a]", "invalid_selector": true }, { "name": "filter, existence, without segments", "selector": "$[?@]", "document": { "a": 1, "b": null }, "results": [ [ 1, null ], [ null, 1 ] ], "results_paths": [ [ "$['a']", "$['b']" ], [ "$['b']", "$['a']" ] ] }, { "name": "filter, existence", "selector": "$[?@.a]", "document": [ { "a": "b", "d": "e" }, { "b": "c", "d": "f" } ], "result": [ { "a": "b", "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, existence, present with null", "selector": "$[?@.a]", "document": [ { "a": null, "d": "e" }, { "b": "c", "d": "f" } ], "result": [ { "a": null, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, absolute existence, without segments", "selector": "$[?$]", "document": { "a": 1, "b": null }, "results": [ [ 1, null ], [ null, 1 ] ], "results_paths": [ [ "$['a']", "$['b']" ], [ "$['b']", "$['a']" ] ] }, { "name": "filter, absolute existence, with segments", "selector": "$[?$.*.a]", "document": [ { "a": "b", "d": "e" }, { "b": "c", "d": "f" } ], "result": [ { "a": "b", "d": "e" }, { "b": "c", "d": "f" } ], "result_paths": [ "$[0]", "$[1]" ] }, { "name": "filter, equals string, single quotes", "selector": "$[?@.a=='b']", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "b", "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, equals numeric string, single quotes", "selector": "$[?@.a=='1']", "document": [ { "a": "1", "d": "e" }, { "a": 1, "d": "f" } ], "result": [ { "a": "1", "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, equals string, double quotes", "selector": "$[?@.a==\"b\"]", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "b", "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, equals numeric string, double quotes", "selector": "$[?@.a==\"1\"]", "document": [ { "a": "1", "d": "e" }, { "a": 1, "d": "f" } ], "result": [ { "a": "1", "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, equals number", "selector": "$[?@.a==1]", "document": [ { "a": 1, "d": "e" }, { "a": "c", "d": "f" }, { "a": 2, "d": "f" }, { "a": "1", "d": "f" } ], "result": [ { "a": 1, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, equals null", "selector": "$[?@.a==null]", "document": [ { "a": null, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": null, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, equals null, absent from data", "selector": "$[?@.a==null]", "document": [ { "d": "e" }, { "a": "c", "d": "f" } ], "result": [], "result_paths": [] }, { "name": "filter, equals true", "selector": "$[?@.a==true]", "document": [ { "a": true, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": true, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, equals false", "selector": "$[?@.a==false]", "document": [ { "a": false, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": false, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, equals self", "selector": "$[?@==@]", "document": [ 1, null, true, { "a": "b" }, [ false ] ], "result": [ 1, null, true, { "a": "b" }, [ false ] ], "result_paths": [ "$[0]", "$[1]", "$[2]", "$[3]", "$[4]" ] }, { "name": "filter, absolute, equals self", "selector": "$[?$==$]", "document": [ 1, null, true, { "a": "b" }, [ false ] ], "result": [ 1, null, true, { "a": "b" }, [ false ] ], "result_paths": [ "$[0]", "$[1]", "$[2]", "$[3]", "$[4]" ] }, { "name": "filter, equals, absent from index selector equals absent from name selector", "selector": "$[?@.absent==@.list[9]]", "document": [ { "list": [ 1 ] } ], "result": [ { "list": [ 1 ] } ], "result_paths": [ "$[0]" ] }, { "name": "filter, deep equality, arrays", "selector": "$[?@.a==@.b]", "document": [ { "a": false, "b": [ 1, 2 ] }, { "a": [ [ 1, [ 2 ] ] ], "b": [ [ 1, [ 2 ] ] ] }, { "a": [ [ 1, [ 2 ] ] ], "b": [ [ [ 2 ], 1 ] ] }, { "a": [ [ 1, [ 2 ] ] ], "b": [ [ 1, 2 ] ] } ], "result": [ { "a": [ [ 1, [ 2 ] ] ], "b": [ [ 1, [ 2 ] ] ] } ], "result_paths": [ "$[1]" ] }, { "name": "filter, deep equality, objects", "selector": "$[?@.a==@.b]", "document": [ { "a": false, "b": { "x": 1, "y": { "z": 1 } } }, { "a": { "x": 1, "y": { "z": 1 } }, "b": { "x": 1, "y": { "z": 1 } } }, { "a": { "x": 1, "y": { "z": 1 } }, "b": { "y": { "z": 1 }, "x": 1 } }, { "a": { "x": 1, "y": { "z": 1 } }, "b": { "x": 1 } }, { "a": { "x": 1, "y": { "z": 1 } }, "b": { "x": 1, "y": { "z": 2 } } } ], "result": [ { "a": { "x": 1, "y": { "z": 1 } }, "b": { "x": 1, "y": { "z": 1 } } }, { "a": { "x": 1, "y": { "z": 1 } }, "b": { "y": { "z": 1 }, "x": 1 } } ], "result_paths": [ "$[1]", "$[2]" ] }, { "name": "filter, not-equals string, single quotes", "selector": "$[?@.a!='b']", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "c", "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals numeric string, single quotes", "selector": "$[?@.a!='1']", "document": [ { "a": "1", "d": "e" }, { "a": 1, "d": "f" } ], "result": [ { "a": 1, "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals string, single quotes, different type", "selector": "$[?@.a!='b']", "document": [ { "a": "b", "d": "e" }, { "a": 1, "d": "f" } ], "result": [ { "a": 1, "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals string, double quotes", "selector": "$[?@.a!=\"b\"]", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "c", "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals numeric string, double quotes", "selector": "$[?@.a!=\"1\"]", "document": [ { "a": "1", "d": "e" }, { "a": 1, "d": "f" } ], "result": [ { "a": 1, "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals string, double quotes, different types", "selector": "$[?@.a!=\"b\"]", "document": [ { "a": "b", "d": "e" }, { "a": 1, "d": "f" } ], "result": [ { "a": 1, "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals number", "selector": "$[?@.a!=1]", "document": [ { "a": 1, "d": "e" }, { "a": 2, "d": "f" }, { "a": "1", "d": "f" } ], "result": [ { "a": 2, "d": "f" }, { "a": "1", "d": "f" } ], "result_paths": [ "$[1]", "$[2]" ] }, { "name": "filter, not-equals number, different types", "selector": "$[?@.a!=1]", "document": [ { "a": 1, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "c", "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals null", "selector": "$[?@.a!=null]", "document": [ { "a": null, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "c", "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals null, absent from data", "selector": "$[?@.a!=null]", "document": [ { "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "d": "e" }, { "a": "c", "d": "f" } ], "result_paths": [ "$[0]", "$[1]" ] }, { "name": "filter, not-equals true", "selector": "$[?@.a!=true]", "document": [ { "a": true, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "c", "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not-equals false", "selector": "$[?@.a!=false]", "document": [ { "a": false, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "c", "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, less than string, single quotes", "selector": "$[?@.a<'c']", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "b", "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, less than string, double quotes", "selector": "$[?@.a<\"c\"]", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "b", "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, less than number", "selector": "$[?@.a<10]", "document": [ { "a": 1, "d": "e" }, { "a": 10, "d": "e" }, { "a": "c", "d": "f" }, { "a": 20, "d": "f" } ], "result": [ { "a": 1, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, less than null", "selector": "$[?@.a'c']", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" }, { "a": "d", "d": "f" } ], "result": [ { "a": "d", "d": "f" } ], "result_paths": [ "$[2]" ] }, { "name": "filter, greater than string, double quotes", "selector": "$[?@.a>\"c\"]", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" }, { "a": "d", "d": "f" } ], "result": [ { "a": "d", "d": "f" } ], "result_paths": [ "$[2]" ] }, { "name": "filter, greater than number", "selector": "$[?@.a>10]", "document": [ { "a": 1, "d": "e" }, { "a": 10, "d": "e" }, { "a": "c", "d": "f" }, { "a": 20, "d": "f" } ], "result": [ { "a": 20, "d": "f" } ], "result_paths": [ "$[3]" ] }, { "name": "filter, greater than null", "selector": "$[?@.a>null]", "document": [ { "a": null, "d": "e" }, { "a": "c", "d": "f" } ], "result": [], "result_paths": [] }, { "name": "filter, greater than true", "selector": "$[?@.a>true]", "document": [ { "a": true, "d": "e" }, { "a": "c", "d": "f" } ], "result": [], "result_paths": [] }, { "name": "filter, greater than false", "selector": "$[?@.a>false]", "document": [ { "a": false, "d": "e" }, { "a": "c", "d": "f" } ], "result": [], "result_paths": [] }, { "name": "filter, greater than or equal to string, single quotes", "selector": "$[?@.a>='c']", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" }, { "a": "d", "d": "f" } ], "result": [ { "a": "c", "d": "f" }, { "a": "d", "d": "f" } ], "result_paths": [ "$[1]", "$[2]" ] }, { "name": "filter, greater than or equal to string, double quotes", "selector": "$[?@.a>=\"c\"]", "document": [ { "a": "b", "d": "e" }, { "a": "c", "d": "f" }, { "a": "d", "d": "f" } ], "result": [ { "a": "c", "d": "f" }, { "a": "d", "d": "f" } ], "result_paths": [ "$[1]", "$[2]" ] }, { "name": "filter, greater than or equal to number", "selector": "$[?@.a>=10]", "document": [ { "a": 1, "d": "e" }, { "a": 10, "d": "e" }, { "a": "c", "d": "f" }, { "a": 20, "d": "f" } ], "result": [ { "a": 10, "d": "e" }, { "a": 20, "d": "f" } ], "result_paths": [ "$[1]", "$[3]" ] }, { "name": "filter, greater than or equal to null", "selector": "$[?@.a>=null]", "document": [ { "a": null, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": null, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, greater than or equal to true", "selector": "$[?@.a>=true]", "document": [ { "a": true, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": true, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, greater than or equal to false", "selector": "$[?@.a>=false]", "document": [ { "a": false, "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": false, "d": "e" } ], "result_paths": [ "$[0]" ] }, { "name": "filter, exists and not-equals null, absent from data", "selector": "$[?@.a&&@.a!=null]", "document": [ { "d": "e" }, { "a": "c", "d": "f" } ], "result": [ { "a": "c", "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, exists and exists, data false", "selector": "$[?@.a&&@.b]", "document": [ { "a": false, "b": false }, { "b": false }, { "c": false } ], "result": [ { "a": false, "b": false } ], "result_paths": [ "$[0]" ] }, { "name": "filter, exists or exists, data false", "selector": "$[?@.a||@.b]", "document": [ { "a": false, "b": false }, { "b": false }, { "c": false } ], "result": [ { "a": false, "b": false }, { "b": false } ], "result_paths": [ "$[0]", "$[1]" ] }, { "name": "filter, and", "selector": "$[?@.a>0&&@.a<10]", "document": [ { "a": -10, "d": "e" }, { "a": 5, "d": "f" }, { "a": 20, "d": "f" } ], "result": [ { "a": 5, "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, or", "selector": "$[?@.a=='b'||@.a=='d']", "document": [ { "a": "a", "d": "e" }, { "a": "b", "d": "f" }, { "a": "c", "d": "f" }, { "a": "d", "d": "f" } ], "result": [ { "a": "b", "d": "f" }, { "a": "d", "d": "f" } ], "result_paths": [ "$[1]", "$[3]" ] }, { "name": "filter, not expression", "selector": "$[?!(@.a=='b')]", "document": [ { "a": "a", "d": "e" }, { "a": "b", "d": "f" }, { "a": "d", "d": "f" } ], "result": [ { "a": "a", "d": "e" }, { "a": "d", "d": "f" } ], "result_paths": [ "$[0]", "$[2]" ] }, { "name": "filter, not exists", "selector": "$[?!@.a]", "document": [ { "a": "a", "d": "e" }, { "d": "f" }, { "a": "d", "d": "f" } ], "result": [ { "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, not exists, data null", "selector": "$[?!@.a]", "document": [ { "a": null, "d": "e" }, { "d": "f" }, { "a": "d", "d": "f" } ], "result": [ { "d": "f" } ], "result_paths": [ "$[1]" ] }, { "name": "filter, non-singular existence, wildcard", "selector": "$[?@.*]", "document": [ 1, [], [ 2 ], {}, { "a": 3 } ], "result": [ [ 2 ], { "a": 3 } ], "result_paths": [ "$[2]", "$[4]" ] }, { "name": "filter, non-singular existence, multiple", "selector": "$[?@[0, 0, 'a']]", "document": [ 1, [], [ 2 ], [ 2, 3 ], { "a": 3 }, { "b": 4 }, { "a": 3, "b": 4 } ], "result": [ [ 2 ], [ 2, 3 ], { "a": 3 }, { "a": 3, "b": 4 } ], "result_paths": [ "$[2]", "$[3]", "$[4]", "$[6]" ] }, { "name": "filter, non-singular existence, slice", "selector": "$[?@[0:2]]", "document": [ 1, [], [ 2 ], [ 2, 3, 4 ], {}, { "a": 3 } ], "result": [ [ 2 ], [ 2, 3, 4 ] ], "result_paths": [ "$[2]", "$[3]" ] }, { "name": "filter, non-singular existence, negated", "selector": "$[?!@.*]", "document": [ 1, [], [ 2 ], {}, { "a": 3 } ], "result": [ 1, [], {} ], "result_paths": [ "$[0]", "$[1]", "$[3]" ] }, { "name": "filter, non-singular query in comparison, slice", "selector": "$[?@[0:0]==0]", "invalid_selector": true }, { "name": "filter, non-singular query in comparison, all children", "selector": "$[?@[*]==0]", "invalid_selector": true }, { "name": "filter, non-singular query in comparison, descendants", "selector": "$[?@..a==0]", "invalid_selector": true }, { "name": "filter, non-singular query in comparison, combined", "selector": "$[?@.a[*].a==0]", "invalid_selector": true }, { "name": "filter, nested", "selector": "$[?@[?@>1]]", "document": [ [ 0 ], [ 0, 1 ], [ 0, 1, 2 ], [ 42 ] ], "result": [ [ 0, 1, 2 ], [ 42 ] ], "result_paths": [ "$[2]", "$[3]" ] }, { "name": "filter, name segment on primitive, selects nothing", "selector": "$[?@.a == 1]", "document": { "a": 1 }, "result": [], "result_paths": [] }, { "name": "filter, name segment on array, selects nothing", "selector": "$[?@['0'] == 5]", "document": [ [ 5, 6 ] ], "result": [], "result_paths": [] }, { "name": "filter, index segment on object, selects nothing", "selector": "$[?@[0] == 5]", "document": [ { "0": 5 } ], "result": [], "result_paths": [] }, { "name": "filter, followed by name selector", "selector": "$[?@.a==1].b.x", "document": [ { "a": 1, "b": { "x": 2 } } ], "result": [ 2 ], "result_paths": [ "$[0]['b']['x']" ] }, { "name": "filter, followed by child segment that selects multiple elements", "selector": "$[?@.z=='_']['x','y']", "document": [ { "x": 1, "y": null, "z": "_" } ], "result": [ 1, null ], "result_paths": [ "$[0]['x']", "$[0]['y']" ] }, { "name": "filter, relative non-singular query, index, equal", "selector": "$[?(@[0, 0]==42)]", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "filter, relative non-singular query, index, not equal", "selector": "$[?(@[0, 0]!=42)]", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "filter, relative non-singular query, index, less-or-equal", "selector": "$[?(@[0, 0]<=42)]", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "filter, relative non-singular query, name, equal", "selector": "$[?(@['a', 'a']==42)]", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "filter, relative non-singular query, name, not equal", "selector": "$[?(@['a', 'a']!=42)]", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "filter, relative non-singular query, name, less-or-equal", "selector": "$[?(@['a', 'a']<=42)]", "invalid_selector": true, "tags": [ "whitespace" ] }, { "name": "filter, relative non-singular quer { "store": { "book": [ { "category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95 }, { "category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99 }, { "category": "fiction", "author": "Herman Melville", "title": "Moby Dick", "isbn": "0-553-21311-3", "price": 8.99 }, { "category": "fiction", "author": "J. R. R. Tolkien", "title": "The Lord of the Rings", "isbn": "0-395-19395-8", "price": 22.99 } ], "bicycle": { "color": "red", "price": 19.95 } } } hurl_core =============== The hurl_core crate provides the common functionalities used by both hurl and hurlfmt.

[![deploy status](https://github.com/Orange-OpenSource/hurl/workflows/test/badge.svg)](https://github.com/Orange-OpenSource/hurl/actions) [![coverage](https://Orange-OpenSource.github.io/hurl/coverage/badges/flat.svg)](https://Orange-OpenSource.github.io/hurl/coverage) [![Crates.io](https://img.shields.io/crates/v/hurl.svg)](https://crates.io/crates/hurl) [![documentation](https://img.shields.io/badge/-documentation-ff0288)](https://hurl.dev) # What's Hurl? Hurl is a command line tool that runs HTTP requests defined in a simple plain text format. It can chain requests, capture values and evaluate queries on headers and body response. Hurl is very versatile: it can be used for both fetching data and testing HTTP sessions. Hurl makes it easy to work with HTML content, REST / SOAP / GraphQL APIs, or any other XML / JSON based APIs. ```hurl # Go home and capture token GET https://example.org HTTP 200 [Captures] csrf_token: xpath "string(//meta[@name='_csrf_token']/@content)" # Do login! POST https://example.org/login [Form] user: toto password: 1234 token: {{csrf_token}} HTTP 302 ``` Chaining multiple requests is easy: ```hurl GET https://example.org/api/health GET https://example.org/api/step1 GET https://example.org/api/step2 GET https://example.org/api/step3 ``` # Also an HTTP Test Tool Hurl can run HTTP requests but can also be used to test HTTP responses. Different types of queries and predicates are supported, from [XPath] and [JSONPath] on body response, to assert on status code and response headers.

It is well adapted for REST / JSON APIs ```hurl POST https://example.org/api/tests { "id": "4568", "evaluate": true } HTTP 200 [Asserts] header "X-Frame-Options" == "SAMEORIGIN" jsonpath "$.status" == "RUNNING" # Check the status code jsonpath "$.tests" count == 25 # Check the number of items jsonpath "$.id" matches /\d{4}/ # Check the format of the id ``` HTML content ```hurl GET https://example.org HTTP 200 [Asserts] xpath "normalize-space(//head/title)" == "Hello world!" ``` GraphQL ~~~hurl POST https://example.org/graphql ```graphql { human(id: "1000") { name height(unit: FOOT) } } ``` HTTP 200 ~~~ and even SOAP APIs ```hurl POST https://example.org/InStock Content-Type: application/soap+xml; charset=utf-8 SOAPAction: "http://www.w3.org/2003/05/soap-envelope" GOOG HTTP 200 ``` Hurl can also be used to test the performance of HTTP endpoints ```hurl GET https://example.org/api/v1/pets HTTP 200 [Asserts] duration < 1000 # Duration in ms ``` And check response bytes ```hurl GET https://example.org/data.tar.gz HTTP 200 [Asserts] sha256 == hex,039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81; ``` Finally, Hurl is easy to integrate in CI/CD, with text, JUnit, TAP and HTML reports

# Why Hurl?

Text Format: for both devops and developers
Fast CLI: a command line for local dev and continuous integration
Single Binary: easy to install, with no runtime required

# Powered by curl Hurl is a lightweight binary written in [Rust]. Under the hood, Hurl HTTP engine is powered by [libcurl], one of the most powerful and reliable file transfer libraries. With its text file format, Hurl adds syntactic sugar to run and test HTTP requests, but it's still the [curl] that we love: __fast__, __efficient__ and __IPv6 / HTTP/3 ready__. # Feedbacks To support its development, [star Hurl on GitHub]! [Feedback, suggestion, bugs or improvements] are welcome. ```hurl POST https://hurl.dev/api/feedback { "name": "John Doe", "feedback": "Hurl is awesome!" } HTTP 200 ``` # Resources [License] [Blog] [Tutorial] [Documentation] (download [HTML], [PDF], [Markdown]) [GitHub] # Table of Contents * [Samples](#samples) * [Getting Data](#getting-data) * [HTTP Headers](#http-headers) * [Query Params](#query-params) * [Basic Authentication](#basic-authentication) * [Passing Data between Requests ](#passing-data-between-requests) * [Sending Data](#sending-data) * [Sending HTML Form Data](#sending-html-form-data) * [Sending Multipart Form Data](#sending-multipart-form-data) * [Posting a JSON Body](#posting-a-json-body) * [Templating a JSON Body](#templating-a-json-body) * [Templating a XML Body](#templating-a-xml-body) * [Using GraphQL Query](#using-graphql-query) * [Using Dynamic Datas](#using-dynamic-datas) * [Testing Response](#testing-response) * [Testing Status Code](#testing-status-code) * [Testing Response Headers](#testing-response-headers) * [Testing REST APIs](#testing-rest-apis) * [Testing HTML Response](#testing-html-response) * [Testing Set-Cookie Attributes](#testing-set-cookie-attributes) * [Testing Bytes Content](#testing-bytes-content) * [SSL Certificate](#ssl-certificate) * [Checking Full Body](#checking-full-body) * [Testing Redirections](#testing-redirections) * [Debug Tips](#debug-tips) * [Verbose Mode](#verbose-mode) * [Error Format](#error-format) * [Output Response Body](#output-response-body) * [Export curl Commands](#export-curl-commands) * [Using Proxy](#using-proxy) * [Reports](#reports) * [HTML Report](#html-report) * [JSON Report](#json-report) * [JUnit Report](#junit-report) * [TAP Report](#tap-report) * [JSON Output](#json-output) * [Others](#others) * [HTTP Version](#http-version) * [IP Address](#ip-address) * [Polling and Retry](#polling-and-retry) * [Delaying Requests](#delaying-requests) * [Skipping Requests](#skipping-requests) * [Testing Endpoint Performance](#testing-endpoint-performance) * [Using SOAP APIs](#using-soap-apis) * [Capturing and Using a CSRF Token](#capturing-and-using-a-csrf-token) * [Redacting Secrets](#redacting-secrets) * [Checking Byte Order Mark (BOM) in Response Body](#checking-byte-order-mark-bom-in-response-body) * [AWS Signature Version 4 Requests](#aws-signature-version-4-requests) * [Using curl Options](#using-curl-options) * [Manual](#manual) * [Name](#name) * [Synopsis](#synopsis) * [Description](#description) * [Hurl File Format](#hurl-file-format) * [Capturing values](#capturing-values) * [Asserts](#asserts) * [Configuration](#configuration) * [All Options](#all-options) * [HTTP options](#http-options) * [Output options](#output-options) * [Run options](#run-options) * [Report options](#report-options) * [Other options](#other-options) * [Exit Codes](#exit-codes) * [WWW](#www) * [See Also](#see-also) * [Installation](#installation) * [Binaries Installation](#binaries-installation) * [Linux](#linux) * [Debian / Ubuntu](#debian--ubuntu) * [Alpine](#alpine) * [Arch Linux / Manjaro](#arch-linux--manjaro) * [NixOS / Nix](#nixos--nix) * [Guix](#guix) * [macOS](#macos) * [Homebrew](#homebrew) * [MacPorts](#macports) * [FreeBSD](#freebsd) * [Windows](#windows) * [Zip File](#zip-file) * [Installer](#installer) * [Chocolatey](#chocolatey) * [Scoop](#scoop) * [Windows Package Manager](#windows-package-manager) * [Cargo](#cargo) * [conda-forge](#conda-forge) * [Docker](#docker) * [npm](#npm) * [Building From Sources](#building-from-sources) * [Build on Linux](#build-on-linux) * [Debian based distributions](#debian-based-distributions) * [Fedora based distributions](#fedora-based-distributions) * [Red Hat based distributions](#red-hat-based-distributions) * [Arch based distributions](#arch-based-distributions) * [Alpine based distributions](#alpine-based-distributions) * [Build on macOS](#build-on-macos) * [Build on Windows](#build-on-windows) # Samples To run a sample, edit a file with the sample content, and run Hurl: ```shell $ vi sample.hurl GET https://example.org $ hurl sample.hurl ``` By default, Hurl behaves like [curl] and outputs the last HTTP response's [entry]. To have a test oriented output, you can use [`--test` option]: ```shell $ hurl --test sample.hurl ``` A particular response can be saved with [`[Options] section`](https://hurl.dev/docs/request.html#options): ```hurl GET https://example.org/cats/123 [Options] output: cat123.txt # use - to output to stdout HTTP 200 GET https://example.org/dogs/567 HTTP 200 ``` Finally, Hurl can take files as input, or directories. In the latter case, Hurl will search files with `.hurl` extension recursively. ```shell $ hurl --test integration/*.hurl $ hurl --test . ``` You can check [Hurl tests suite] for more samples. ## Getting Data A simple GET: ```hurl GET https://example.org ``` Requests can be chained: ```hurl GET https://example.org/a GET https://example.org/b HEAD https://example.org/c GET https://example.org/c ``` [Doc](https://hurl.dev/docs/request.html#method) ### HTTP Headers A simple GET with headers: ```hurl GET https://example.org/news User-Agent: Mozilla/5.0 Accept: */* Accept-Language: en-US,en;q=0.5 Accept-Encoding: gzip, deflate, br Connection: keep-alive ``` [Doc](https://hurl.dev/docs/request.html#headers) ### Query Params ```hurl GET https://example.org/news [Query] order: newest search: something to search count: 100 ``` Or: ```hurl GET https://example.org/news?order=newest&search=something%20to%20search&count=100 ``` > With `[Query]` section, params don't need to be URL escaped. [Doc](https://hurl.dev/docs/request.html#query-parameters) ### Basic Authentication ```hurl GET https://example.org/protected [BasicAuth] bob: secret ``` [Doc](https://hurl.dev/docs/request.html#basic-authentication) This is equivalent to construct the request with a [Authorization] header: ```hurl # Authorization header value can be computed with `echo -n 'bob:secret' | base64` GET https://example.org/protected Authorization: Basic Ym9iOnNlY3JldA== ``` Basic authentication section allows per request authentication. If you want to add basic authentication to all the requests of a Hurl file you could use [`-u/--user` option]: ```shell $ hurl --user bob:secret login.hurl ``` [`--user`] option can also be set per request: ```hurl GET https://example.org/login [Options] user: bob:secret HTTP 200 GET https://example.org/login [Options] user: alice:secret HTTP 200 ``` ### Passing Data between Requests [Captures] can be used to pass data from one request to another: ```hurl POST https://sample.org/orders HTTP 201 [Captures] order_id: jsonpath "$.order.id" GET https://sample.org/orders/{{order_id}} HTTP 200 ``` [Doc](https://hurl.dev/docs/capturing-response.html) ## Sending Data ### Sending HTML Form Data ```hurl POST https://example.org/contact [Form] default: false token: {{token}} email: john.doe@rookie.org number: 33611223344 ``` [Doc](https://hurl.dev/docs/request.html#form-parameters) ### Sending Multipart Form Data ```hurl POST https://example.org/upload [Multipart] field1: value1 field2: file,example.txt; # One can specify the file content type: field3: file,example.zip; application/zip ``` [Doc](https://hurl.dev/docs/request.html#multipart-form-data) Multipart forms can also be sent with a [multiline string body]: ~~~hurl POST https://example.org/upload Content-Type: multipart/form-data; boundary="boundary" ``` --boundary Content-Disposition: form-data; name="key1" value1 --boundary Content-Disposition: form-data; name="upload1"; filename="data.txt" Content-Type: text/plain Hello World! --boundary Content-Disposition: form-data; name="upload2"; filename="data.html" Content-Type: text/html

Hello World!

--boundary-- ``` ~~~ In that case, files have to be inlined in the Hurl file. [Doc](https://hurl.dev/docs/request.html#multiline-string-body) ### Posting a JSON Body With an inline JSON: ```hurl POST https://example.org/api/tests { "id": "456", "evaluate": true } ``` [Doc](https://hurl.dev/docs/request.html#json-body) With a local file: ```hurl POST https://example.org/api/tests Content-Type: application/json file,data.json; ``` [Doc](https://hurl.dev/docs/request.html#file-body) ### Templating a JSON Body ```hurl PUT https://example.org/api/hits Content-Type: application/json { "key0": "{{a_string}}", "key1": {{a_bool}}, "key2": {{a_null}}, "key3": {{a_number}} } ``` Variables can be initialized via command line: ```shell $ hurl --variable a_string=apple \ --variable a_bool=true \ --variable a_null=null \ --variable a_number=42 \ test.hurl ``` Resulting in a PUT request with the following JSON body: ``` { "key0": "apple", "key1": true, "key2": null, "key3": 42 } ``` [Doc](https://hurl.dev/docs/templates.html) ### Templating a XML Body Using templates with [XML body] is not currently supported in Hurl. You can use templates in [XML multiline string body] with variables to send a variable XML body: ~~~hurl POST https://example.org/echo/post/xml ```xml {{login}} {{password}} ``` ~~~ [Doc](https://hurl.dev/docs/request.html#multiline-string-body) ### Using GraphQL Query A simple GraphQL query: ~~~hurl POST https://example.org/starwars/graphql ```graphql { human(id: "1000") { name height(unit: FOOT) } } ``` ~~~ A GraphQL query with variables: ~~~hurl POST https://example.org/starwars/graphql ```graphql query Hero($episode: Episode, $withFriends: Boolean!) { hero(episode: $episode) { name friends @include(if: $withFriends) { name } } } variables { "episode": "JEDI", "withFriends": false } ``` ~~~ GraphQL queries can also use [Hurl templates]. [Doc](https://hurl.dev/docs/request.html#graphql-query) ### Using Dynamic Datas [Functions] like `newUuid` and `newDate` can be used in templates to create dynamic datas: A file that creates a dynamic email (i.e `0531f78f-7f87-44be-a7f2-969a1c4e6d97@test.com`): ```hurl POST https://example.org/api/foo { "name": "foo", "email": "{{newUuid}}@test.com" } ``` A file that creates a dynamic query parameter (i.e `2024-12-02T10:35:44.461731Z`): ```hurl GET https://example.org/api/foo [Query] date: {{newDate}} HTTP 200 ``` [Doc](https://hurl.dev/docs/templates.html#functions) ## Testing Response Responses are optional, everything after `HTTP` is part of the response asserts. ```hurl # A request with (almost) no check: GET https://foo.com # A status code check: GET https://foo.com HTTP 200 # A test on response body GET https://foo.com HTTP 200 [Asserts] jsonpath "$.state" == "running" ``` ### Testing Status Code ```hurl GET https://example.org/order/435 HTTP 200 ``` [Doc](https://hurl.dev/docs/asserting-response.html#version-status) ```hurl GET https://example.org/order/435 # Testing status code is in a 200-300 range HTTP * [Asserts] status >= 200 status < 300 ``` [Doc](https://hurl.dev/docs/asserting-response.html#status-assert) ### Testing Response Headers Use implicit response asserts to test header values: ```hurl GET https://example.org/index.html HTTP 200 Set-Cookie: theme=light Set-Cookie: sessionToken=abc123; Expires=Wed, 09 Jun 2021 10:18:14 GMT ``` [Doc](https://hurl.dev/docs/asserting-response.html#headers) Or use explicit response asserts with [predicates]: ```hurl GET https://example.org HTTP 302 [Asserts] header "Location" contains "www.example.net" ``` [Doc](https://hurl.dev/docs/asserting-response.html#header-assert) Implicit and explicit asserts can be combined: ```hurl GET https://example.org/index.html HTTP 200 Set-Cookie: theme=light Set-Cookie: sessionToken=abc123; Expires=Wed, 09 Jun 2021 10:18:14 GMT [Asserts] header "Location" contains "www.example.net" ``` ### Testing REST APIs Asserting JSON body response (node values, collection count etc...) with [JSONPath]: ```hurl GET https://example.org/order screencapability: low HTTP 200 [Asserts] jsonpath "$.validated" == true jsonpath "$.userInfo" isObject jsonpath "$.userInfo.firstName" == "Franck" jsonpath "$.userInfo.lastName" == "Herbert" jsonpath "$.hasDevice" == false jsonpath "$.links" count == 12 jsonpath "$.state" != null jsonpath "$.order" matches "^order-\\d{8}$" jsonpath "$.order" matches /^order-\d{8}$/ # Alternative syntax with regex literal jsonpath "$.id" matches /(?i)[a-z]*/ # See syntax for flags jsonpath "$.created" isIsoDate ``` [Doc](https://hurl.dev/docs/asserting-response.html#jsonpath-assert) ### Testing HTML Response ```hurl GET https://example.org HTTP 200 Content-Type: text/html; charset=UTF-8 [Asserts] xpath "string(/html/head/title)" contains "Example" # Check title xpath "count(//p)" == 2 # Check the number of p xpath "//p" count == 2 # Similar assert for p xpath "boolean(count(//h2))" == false # Check there is no h2 xpath "//h2" not exists # Similar assert for h2 xpath "string(//div[1])" matches /Hello.*/ ``` [Doc](https://hurl.dev/docs/asserting-response.html#xpath-assert) ### Testing Set-Cookie Attributes ```hurl GET https://example.org/home HTTP 200 [Asserts] cookie "JSESSIONID" == "8400BAFE2F66443613DC38AE3D9D6239" cookie "JSESSIONID[Value]" == "8400BAFE2F66443613DC38AE3D9D6239" cookie "JSESSIONID[Expires]" contains "Wed, 13 Jan 2021" cookie "JSESSIONID[Secure]" exists cookie "JSESSIONID[HttpOnly]" exists cookie "JSESSIONID[SameSite]" == "Lax" ``` [Doc](https://hurl.dev/docs/asserting-response.html#cookie-assert) ### Testing Bytes Content Check the SHA-256 response body hash: ```hurl GET https://example.org/data.tar.gz HTTP 200 [Asserts] sha256 == hex,039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81; ``` [Doc](https://hurl.dev/docs/asserting-response.html#sha-256-assert) ### SSL Certificate Check the properties of a SSL certificate: ```hurl GET https://example.org HTTP 200 [Asserts] certificate "Subject" == "CN=example.org" certificate "Issuer" == "C=US, O=Let's Encrypt, CN=R3" certificate "Expire-Date" daysAfterNow > 15 certificate "Serial-Number" matches /[\da-f]+/ certificate "Subject-Alt-Name" contains "DNS:example.org" certificate "Subject-Alt-Name" split "," count == 2 certificate "Value" startsWith "-----BEGIN CERTIFICATE-----" ``` [Doc](https://hurl.dev/docs/asserting-response.html#ssl-certificate-assert) ### Checking Full Body Use implicit body to test an exact JSON body match: ```hurl GET https://example.org/api/cats/123 HTTP 200 { "name" : "Purrsloud", "species" : "Cat", "favFoods" : ["wet food", "dry food", "any food"], "birthYear" : 2016, "photo" : "https://learnwebcode.github.io/json-example/images/cat-2.jpg" } ``` [Doc](https://hurl.dev/docs/asserting-response.html#json-body) Or an explicit assert file: ```hurl GET https://example.org/index.html HTTP 200 [Asserts] body == file,cat.json; ``` [Doc](https://hurl.dev/docs/asserting-response.html#body-assert) Implicit asserts supports XML body: ```hurl GET https://example.org/api/catalog HTTP 200 Gambardella, Matthew XML Developer's Guide Computer 44.95 2000-10-01 An in-depth look at creating applications with XML. ``` [Doc](https://hurl.dev/docs/asserting-response.html#xml-body) Plain text: ~~~hurl GET https://example.org/models HTTP 200 ``` Year,Make,Model,Description,Price 1997,Ford,E350,"ac, abs, moon",3000.00 1999,Chevy,"Venture ""Extended Edition""","",4900.00 1999,Chevy,"Venture ""Extended Edition, Very Large""",,5000.00 1996,Jeep,Grand Cherokee,"MUST SELL! air, moon roof, loaded",4799.00 ``` ~~~ [Doc](https://hurl.dev/docs/asserting-response.html#multiline-string-body) One line: ```hurl POST https://example.org/helloworld HTTP 200 `Hello world!` ``` [Doc](https://hurl.dev/docs/asserting-response.html#oneline-string-body) File: ```hurl GET https://example.org HTTP 200 file,data.bin; ``` [Doc](https://hurl.dev/docs/asserting-response.html#file-body) ### Testing Redirections By default, Hurl doesn't follow redirection so each step of a redirect must be run manually and can be analysed: ```hurl GET https://example.org/step1 HTTP 301 [Asserts] header "Location" == "https://example.org/step2" GET https://example.org/step2 HTTP 301 [Asserts] header "Location" == "https://example.org/step3" GET https://example.org/step3 HTTP 200 ``` [Doc](https://hurl.dev/docs/asserting-response.html) Using [`--location`] and [`--location-trusted`] (either with command line option or per request), Hurl follows redirection and each step of the redirection can be checked. ```hurl GET https://example.org/step1 [Options] location: true HTTP 200 [Asserts] redirects count == 2 redirects nth 0 location == "https://example.org/step2" redirects nth 1 location == "https://example.org/step3" ``` ```hurl GET https://example.org/step1 [Options] location-trusted: true HTTP 200 [Asserts] redirects last location == "https://example.org/step2" ``` [Doc](https://hurl.dev/docs/asserting-response.html#redirects-assert) ## Debug Tips ### Verbose Mode To get more info on a given request/response, use [`[Options]` section](https://hurl.dev/docs/request.html#options): ```hurl GET https://example.org HTTP 200 GET https://example.org/api/cats/123 [Options] very-verbose: true HTTP 200 ``` `--verbose` and `--very-verbose` can be also used globally as command line options. [Doc](https://hurl.dev/docs/manual.html#very-verbose) ### Error Format ```shell $ hurl --test --error-format long *.hurl ``` [Doc](https://hurl.dev/docs/manual.html#error-format) ### Output Response Body Use `--output` on a specific request to get the response body (`-` can be used as standard output): ```hurl GET https://foo.com/failure [Options] # use - to output on standard output, foo.bin to save on disk output: - HTTP 200 GET https://foo.com/success HTTP 200 ``` [Doc](https://hurl.dev/docs/manual.html#output) ### Export curl Commands ```shell $ hurl ---curl /tmp/curl.txt *.hurl ``` [Doc](https://hurl.dev/docs/manual.html#curl) ### Using Proxy Use `--proxy` on a specific request or globally as command line option: ```hurl GET https://foo.com/a HTTP 200 GET https://foo.com/b [Options] proxy: localhost:8888 HTTP 200 GET https://foo.com/c HTTP 200 ``` ## Reports ### HTML Report ```shell $ hurl --test --report-html build/report/ *.hurl ``` [Doc](https://hurl.dev/docs/running-tests.html#generating-report) ### JSON Report ```shell $ hurl --test --report-json build/report/ *.hurl ``` [Doc](https://hurl.dev/docs/running-tests.html#generating-report) ### JUnit Report ```shell $ hurl --test --report-junit build/report.xml *.hurl ``` [Doc](https://hurl.dev/docs/running-tests.html#generating-report) ### TAP Report ```shell $ hurl --test --report-tap build/report.txt *.hurl ``` [Doc](https://hurl.dev/docs/running-tests.html#generating-report) ### JSON Output A structured output of running Hurl files can be obtained with [`--json` option]. Each file will produce a JSON export of the run. ```shell $ hurl --json *.hurl ``` ## Others ### HTTP Version Testing HTTP version (HTTP/1.0, HTTP/1.1, HTTP/2 or HTTP/3) can be done using implicit asserts: ```hurl GET https://foo.com HTTP/3 200 GET https://bar.com HTTP/2 200 ``` [Doc](https://hurl.dev/docs/asserting-response.html#version-status) Or explicit: ```hurl GET https://foo.com HTTP 200 [Asserts] version == "3" GET https://bar.com HTTP 200 [Asserts] version == "2" version toFloat > 1.1 ``` [Doc](https://hurl.dev/docs/asserting-response.html#version-assert) ### IP Address Testing the IP address of the response, as a string. This string may be IPv6 address: ```hurl GET https://foo.com HTTP 200 [Asserts] ip == "2001:0db8:85a3:0000:0000:8a2e:0370:733" ip startsWith "2001" ip isIpv6 ``` ### Polling and Retry Retry request on any errors (asserts, captures, status code, runtime etc...): ```hurl # Create a new job POST https://api.example.org/jobs HTTP 201 [Captures] job_id: jsonpath "$.id" [Asserts] jsonpath "$.state" == "RUNNING" # Pull job status until it is completed GET https://api.example.org/jobs/{{job_id}} [Options] retry: 10 # maximum number of retry, -1 for unlimited retry-interval: 500ms HTTP 200 [Asserts] jsonpath "$.state" == "COMPLETED" ``` [Doc](https://hurl.dev/docs/entry.html#retry) ### Delaying Requests Add delay for every request, or a particular request: ```hurl # Delaying this request by 5 seconds (aka sleep) GET https://example.org/turtle [Options] delay: 5s HTTP 200 # No delay! GET https://example.org/turtle HTTP 200 ``` [Doc](https://hurl.dev/docs/manual.html#delay) ### Skipping Requests ```hurl # a, c, d are run, b is skipped GET https://example.org/a GET https://example.org/b [Options] skip: true GET https://example.org/c GET https://example.org/d ``` [Doc](https://hurl.dev/docs/manual.html#skip) ### Testing Endpoint Performance ```hurl GET https://sample.org/helloworld HTTP * [Asserts] duration < 1000 # Check that response time is less than one second ``` [Doc](https://hurl.dev/docs/asserting-response.html#duration-assert) ### Using SOAP APIs ```hurl POST https://example.org/InStock Content-Type: application/soap+xml; charset=utf-8 SOAPAction: "http://www.w3.org/2003/05/soap-envelope" GOOG HTTP 200 ``` [Doc](https://hurl.dev/docs/request.html#xml-body) ### Capturing and Using a CSRF Token ```hurl GET https://example.org HTTP 200 [Captures] csrf_token: xpath "string(//meta[@name='_csrf_token']/@content)" POST https://example.org/login?user=toto&password=1234 X-CSRF-TOKEN: {{csrf_token}} HTTP 302 ``` [Doc](https://hurl.dev/docs/capturing-response.html#xpath-capture) ### Redacting Secrets Using command-line for known values: ```shell $ hurl --secret token=1234 file.hurl ``` ```hurl POST https://example.org X-Token: {{token}} { "name": "Alice", "value": 100 } HTTP 200 ``` [Doc](https://hurl.dev/docs/templates.html#secrets) Using `redact` for dynamic values: ```hurl # Get an authorization token: GET https://example.org/token HTTP 200 [Captures] token: header "X-Token" redact # Send an authorized request: POST https://example.org X-Token: {{token}} { "name": "Alice", "value": 100 } HTTP 200 ``` [Doc](https://hurl.dev/docs/capturing-response.html#redacting-secrets) ### Checking Byte Order Mark (BOM) in Response Body ```hurl GET https://example.org/data.bin HTTP 200 [Asserts] bytes startsWith hex,efbbbf; ``` [Doc](https://hurl.dev/docs/asserting-response.html#bytes-assert) ### AWS Signature Version 4 Requests Generate signed API requests with [AWS Signature Version 4], as used by several cloud providers. ```hurl POST https://sts.eu-central-1.amazonaws.com/ [Options] aws-sigv4: aws:amz:eu-central-1:sts [Form] Action: GetCallerIdentity Version: 2011-06-15 ``` The Access Key is given per [`--user`], either with command line option or within the [`[Options]`](https://hurl.dev/docs/request.html#options) section: ```hurl POST https://sts.eu-central-1.amazonaws.com/ [Options] aws-sigv4: aws:amz:eu-central-1:sts user: bob=secret [Form] Action: GetCallerIdentity Version: 2011-06-15 ``` [Doc](https://hurl.dev/docs/manual.html#aws-sigv4) ### Using curl Options curl options (for instance [`--resolve`] or [`--connect-to`]) can be used as CLI argument. In this case, they're applicable to each request of an Hurl file. ```shell $ hurl --resolve foo.com:8000:127.0.0.1 foo.hurl ``` Use [`[Options]` section](https://hurl.dev/docs/request.html#options) to configure a specific request: ```hurl GET http://bar.com HTTP 200 GET http://foo.com:8000/resolve [Options] resolve: foo.com:8000:127.0.0.1 HTTP 200 `Hello World!` ``` [Doc](https://hurl.dev/docs/request.html#options) # Manual ## Name hurl - run and test HTTP requests. ## Synopsis **hurl** [OPTIONS] [FILES...] **hurl** --test [OPTIONS] [FILES...] ## Description **Hurl** is a command line tool that runs HTTP requests defined in a simple plain text format. It can chain requests, capture values and evaluate queries on headers and body response. Hurl is very versatile, it can be used for fetching data and testing HTTP sessions: HTML content, REST / SOAP / GraphQL APIs, or any other XML / JSON based APIs. ```shell $ hurl session.hurl ``` If no input files are specified, input is read from stdin. ```shell $ echo GET http://httpbin.org/get | hurl { "args": {}, "headers": { "Accept": "*/*", "Accept-Encoding": "gzip", "Content-Length": "0", "Host": "httpbin.org", "User-Agent": "hurl/0.99.10", "X-Amzn-Trace-Id": "Root=1-5eedf4c7-520814d64e2f9249ea44e0" }, "origin": "1.2.3.4", "url": "http://httpbin.org/get" } ``` Hurl can take files as input, or directories. In the latter case, Hurl will search files with `.hurl` extension recursively. Output goes to stdout by default. To have output go to a file, use the [`-o, --output`](#output) option: ```shell $ hurl -o output input.hurl ``` By default, Hurl executes all HTTP requests and outputs the response body of the last HTTP call. To have a test oriented output, you can use [`--test`](#test) option: ```shell $ hurl --test *.hurl ``` ## Hurl File Format The Hurl file format is fully documented in [https://hurl.dev/docs/hurl-file.html](https://hurl.dev/docs/hurl-file.html) It consists of one or several HTTP requests ```hurl GET http://example.org/endpoint1 GET http://example.org/endpoint2 ``` ### Capturing values A value from an HTTP response can be-reused for successive HTTP requests. A typical example occurs with CSRF tokens. ```hurl GET https://example.org HTTP 200 # Capture the CSRF token value from html body. [Captures] csrf_token: xpath "normalize-space(//meta[@name='_csrf_token']/@content)" # Do the login ! POST https://example.org/login?user=toto&password=1234 X-CSRF-TOKEN: {{csrf_token}} ``` More information on captures can be found here [https://hurl.dev/docs/capturing-response.html](https://hurl.dev/docs/capturing-response.html) ### Asserts The HTTP response defined in the Hurl file are used to make asserts. Responses are optional. At the minimum, response includes assert on the HTTP status code. ```hurl GET http://example.org HTTP 301 ``` It can also include asserts on the response headers ```hurl GET http://example.org HTTP 301 Location: http://www.example.org ``` Explicit asserts can be included by combining a query and a predicate ```hurl GET http://example.org HTTP 301 [Asserts] xpath "string(//title)" == "301 Moved" ``` With the addition of asserts, Hurl can be used as a testing tool to run scenarios. More information on asserts can be found here [https://hurl.dev/docs/asserting-response.html](https://hurl.dev/docs/asserting-response.html) ## Configuration Options that exist in curl have exactly the same semantics. Options specified on the command line are defined for every Hurl file's entry, except if they are tagged as cli-only (can not be defined in the Hurl request `[Options]` entry) For instance: ```shell $ hurl --location foo.hurl ``` will follow redirection for each entry in `foo.hurl`. You can also define an option only for a particular entry with an `[Options]` section. For instance, this Hurl file: ```hurl GET https://example.org HTTP 301 GET https://example.org [Options] location: true HTTP 200 ``` will follow a redirection only for the second entry. Hurl looks also for a configuration file at the following places `$XDG_CONFIG_HOME/hurl/config` if `$XDG_CONFIG_HOME` exists, or `$HOME/.config/hurl/config`. The configuration file is a list of options added to each Hurl run. ```shell $ cat ~/.config/hurl/config # Hurl config file --header x-identifier:quux --verbose --delay=1s --fail-with-body ``` Most of the options can also be defined with environment variables (like `HURL_INSECURE` for [`--insecure`](#insecure)). So, in order to configure Hurl, there are four sources from the lowest priority (most easily overridden) to highest (overrides all others): - Configuration file (ex: `~/.config/hurl/config`) - Environment variables (ex: `export HURL_INSECURE=true`) - Command-line options (ex: `hurl --insecure`) - Options section options (ex: `insecure: true` in file) ## All Options ### HTTP options | Option | Description | |-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --aws-sigv4 <PROVIDER1[:PROVIDER2[:REGION[:SERVICE]]]> | Generate an `Authorization` header with an AWS SigV4 signature.

Use [`-u, --user`](#user) to specify Access Key Id (username) and Secret Key (password).

To use temporary session credentials (e.g. for an AWS IAM Role), add the `X-Amz-Security-Token` header containing the session token.
| | --cacert <FILE> | Specifies the certificate file for peer verification. The file may contain multiple CA certificates and must be in PEM format.
Normally Hurl is built to use a default file for this, so this option is typically used to alter that default file.
| | -E, --cert <CERTIFICATE[:PASSWORD]> | Client certificate file and password.

See also [`--key`](#key).
| | --compressed | Request a compressed response using one of the algorithms br, gzip, deflate and automatically decompress the content.

Environment variables: HURL_COMPRESSED
| | --connect-timeout <SECONDS> | Maximum time in seconds that you allow Hurl's connection to take.

You can specify time units in the connect timeout expression. Set Hurl to use a connect timeout of 20 seconds with `--connect-timeout 20s` or set it to 35,000 milliseconds with `--connect-timeout 35000ms`. No spaces allowed.

See also [`-m, --max-time`](#max-time).

Environment variables: HURL_CONNECT_TIMEOUT
| | --connect-to <HOST1:PORT1:HOST2:PORT2> | For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead. This option can be used several times in a command line.

See also [`--resolve`](#resolve).
| | --digest | Tell Hurl to use HTTP Digest authentication
| | -H, --header <NAME:VALUE> | Add an extra header to include in information sent. Can be used several times in a command.

Do not add newlines or carriage returns.

Environment variables: HURL_HEADER='name1:value1|name2:value2' (headers are separated by |)
| | -0, --http1.0 | Tells Hurl to use HTTP version 1.0 instead of using its internally preferred HTTP version.

Environment variables: HURL_HTTP10
| | --http1.1 | Tells Hurl to use HTTP version 1.1.

Environment variables: HURL_HTTP11
| | --http2 | Tells Hurl to use HTTP version 2.
For HTTPS, this means Hurl negotiates HTTP/2 in the TLS handshake. Hurl does this by default.
For HTTP, this means Hurl attempts to upgrade the request to HTTP/2 using the Upgrade: request header.

Environment variables: HURL_HTTP2
| | --http2-prior-knowledge | Tells Hurl to issue a non-TLS HTTP request using HTTP/2 directly without HTTP/1.1 Upgrade. It requires prior knowledge that the server supports HTTP/2 straight away. HTTPS requests still do HTTP/2 the standard way with negotiated protocol versions in the TLS handshake.

Environment variables: HURL_HTTP2_PRIOR_KNOWLEDGE
| | --http3 | Tells Hurl to try HTTP version 3 to the host in the URL, but fallback to earlier HTTP versions if the HTTP/3 connection establishment fails. HTTP/3 is only available for HTTPS and not for HTTP URLs.

Environment variables: HURL_HTTP3
| | -k, --insecure | This option explicitly allows Hurl to perform "insecure" SSL connections and transfers.

Environment variables: HURL_INSECURE
| | -4, --ipv4 | This option tells Hurl to use IPv4 addresses only when resolving host names, and not for example try IPv6.

Environment variables: HURL_IPV4
| | -6, --ipv6 | This option tells Hurl to use IPv6 addresses only when resolving host names, and not for example try IPv4.

Environment variables: HURL_IPV6
| | --key <KEY> | Private key file name.
| | --limit-rate <SPEED> | Specify the maximum transfer rate you want Hurl to use, for both downloads and uploads. This feature is useful if you have a limited pipe and you would like your transfer not to use your entire bandwidth. To make it slower than it otherwise would be.
The given speed is measured in bytes/second.

Environment variables: HURL_LIMIT_RATE
| | -L, --location | Follow redirect. To limit the amount of redirects to follow use the [`--max-redirs`](#max-redirs) option

Environment variables: HURL_LOCATION
| | --location-trusted | Like [`-L, --location`](#location), but allows sending the name + password to all hosts that the site may redirect to.
This may or may not introduce a security breach if the site redirects you to a site to which you send your authentication info (which is plaintext in the case of HTTP Basic authentication).

Environment variables: HURL_LOCATION_TRUSTED
| | --max-filesize <BYTES> | Specify the maximum size in bytes of a file to download. If the file requested is larger than this value, the transfer does not start.

Environment variables: HURL_MAX_FILESIZE

This is a cli-only option.
| | --max-redirs <NUM> | Set maximum number of redirection-followings allowed

By default, the limit is set to 50 redirections. Set this option to -1 to make it unlimited.

Environment variables: HURL_MAX_REDIRS
| | -m, --max-time <SECONDS> | Maximum time in seconds that you allow a request/response to take. This is the standard timeout.

You can specify time units in the maximum time expression. Set Hurl to use a maximum time of 20 seconds with `--max-time 20s` or set it to 35,000 milliseconds with `--max-time 35000ms`. No spaces allowed.

See also [`--connect-timeout`](#connect-timeout).

Environment variables: HURL_MAX_TIME
| | --negotiate | Tell Hurl to use Negotiate (SPNEGO) authentication.
| | --no-cookie-store | Do not use cookie storage for requests/responses in a file. By default, requests in the same Hurl file share cookie storage, this option deactivates cookie engine.

Environment variables: HURL_NO_COOKIE_STORE

This is a cli-only option.
| | --no-header <NAME> | Remove a header from information sent. Can be used several times in a command.

Environment variables: HURL_NO_HEADER='name1|name2' (names are separated by |)
| | --no-proxy <HOST(S)> | Comma-separated list of hosts which do not use a proxy.

Environment variables: no_proxy
| | --ntlm< hurlfmt ===================================== The hurlfmt crate provides the `hurlfmt` binary. It can format hurl files and to export them to JSON/HTML.

Json Skill

Explore Related Technologies & Topics