Lines
92.9 %
Functions
95.71 %
Branches
100 %
/*
* Hurl (https://hurl.dev)
* Copyright (C) 2026 Orange
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use super::placeholder;
use crate::ast::{
BooleanOption, CountOption, DurationOption, EntryOption, NaturalOption, OptionKind, SourceInfo,
VariableDefinition, VariableValue, VerbosityOption, is_variable_reserved,
};
use crate::combinator::{choice, non_recover};
use crate::parser::duration::duration;
use crate::parser::number::{integer, natural, number};
use crate::parser::primitives::{
boolean, line_terminator, literal, null, optional_line_terminators, try_literal,
zero_or_more_spaces,
use crate::parser::string::{quoted_template, unquoted_template};
use crate::parser::{ParseError, ParseErrorKind, ParseResult, filename, filename_password};
use crate::reader::Reader;
use crate::types::Count;
/// Parse an option in an `[Options]` section.
pub fn parse(reader: &mut Reader) -> ParseResult<EntryOption> {
let line_terminators = optional_line_terminators(reader)?;
let space0 = zero_or_more_spaces(reader)?;
let start = reader.cursor();
// We accept '_' even if there is no option name with this character. We do this to be able to
// enter the parsing of the option name and to have better error description (ex: 'max-redirs'
// vs 'max_redirs').
let option =
reader.read_while(|c| c.is_ascii_alphanumeric() || c == '-' || c == '.' || c == '_');
let space1 = zero_or_more_spaces(reader)?;
try_literal(":", reader)?;
let space2 = zero_or_more_spaces(reader)?;
let kind = match option.as_str() {
"aws-sigv4" => option_aws_sigv4(reader)?,
"cacert" => option_cacert(reader)?,
"cert" => option_cert(reader)?,
"compressed" => option_compressed(reader)?,
"connect-to" => option_connect_to(reader)?,
"connect-timeout" => option_connect_timeout(reader)?,
"delay" => option_delay(reader)?,
"digest" => option_digest(reader)?,
"fail-with-body" => option_fail_with_boddy(reader)?,
"insecure" => option_insecure(reader)?,
"header" => option_header(reader)?,
"http1.0" => option_http_10(reader)?,
"http1.1" => option_http_11(reader)?,
"http2-prior-knowledge" => option_http_2_prior_knowledge(reader)?,
"http2" => option_http_2(reader)?,
"http3" => option_http_3(reader)?,
"ipv4" => option_ipv4(reader)?,
"ipv6" => option_ipv6(reader)?,
"key" => option_key(reader)?,
"limit-rate" => option_limit_rate(reader)?,
"location" => option_follow_location(reader)?,
"location-trusted" => option_follow_location_trusted(reader)?,
"max-redirs" => option_max_redirect(reader)?,
"max-time" => option_max_time(reader)?,
"negotiate" => option_negotiate(reader)?,
"netrc" => option_netrc(reader)?,
"netrc-file" => option_netrc_file(reader)?,
"netrc-optional" => option_netrc_optional(reader)?,
"no-header" => option_no_header(reader)?,
"no-jsonpath-coercion" => option_no_jsonpath_coercion(reader)?,
"ntlm" => option_ntlm(reader)?,
"output" => option_output(reader)?,
"path-as-is" => option_path_as_is(reader)?,
"pinnedpubkey" => option_pinned_pub_key(reader)?,
"proxy" => option_proxy(reader)?,
"repeat" => option_repeat(reader)?,
"resolve" => option_resolve(reader)?,
"retry" => option_retry(reader)?,
"retry-interval" => option_retry_interval(reader)?,
"skip" => option_skip(reader)?,
"unix-socket" => option_unix_socket(reader)?,
"user" => option_user(reader)?,
"variable" => option_variable(reader)?,
"variables-file" => option_variables_file(reader)?,
"verbose" => option_verbose(reader)?,
"verbosity" => option_verbosity(reader)?,
"very-verbose" => option_very_verbose(reader)?,
_ => {
return Err(ParseError::new(
start.pos,
false,
ParseErrorKind::InvalidOption(option.to_string()),
));
}
let line_terminator0 = line_terminator(reader)?;
Ok(EntryOption {
line_terminators,
space0,
space1,
space2,
kind,
line_terminator0,
})
fn option_aws_sigv4(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = unquoted_template(reader)?;
Ok(OptionKind::AwsSigV4(value))
fn option_cacert(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = filename::parse(reader)?;
Ok(OptionKind::CaCertificate(value))
fn option_cert(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = filename_password::parse(reader)?;
Ok(OptionKind::ClientCert(value))
fn option_compressed(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = non_recover(boolean_option, reader)?;
Ok(OptionKind::Compressed(value))
fn option_connect_to(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::ConnectTo(value))
fn option_connect_timeout(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = duration_option(reader)?;
Ok(OptionKind::ConnectTimeout(value))
fn option_delay(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Delay(value))
fn option_digest(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Digest(value))
fn option_fail_with_boddy(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::FailWithBody(value))
fn option_follow_location(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::FollowLocation(value))
fn option_follow_location_trusted(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::FollowLocationTrusted(value))
fn option_header(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Header(value))
fn option_http_10(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Http10(value))
fn option_http_11(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Http11(value))
fn option_http_2(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Http2(value))
fn option_http_2_prior_knowledge(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Http2PriorKnowledge(value))
fn option_http_3(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Http3(value))
fn option_insecure(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Insecure(value))
fn option_ipv4(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::IpV4(value))
fn option_ipv6(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::IpV6(value))
fn option_key(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::ClientKey(value))
fn option_limit_rate(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = non_recover(natural_option, reader)?;
Ok(OptionKind::LimitRate(value))
fn option_max_redirect(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = non_recover(count_option, reader)?;
Ok(OptionKind::MaxRedirect(value))
fn option_max_time(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::MaxTime(value))
fn option_negotiate(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = boolean_option(reader)?;
Ok(OptionKind::Negotiate(value))
fn option_netrc(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::NetRc(value))
fn option_netrc_file(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::NetRcFile(value))
fn option_netrc_optional(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::NetRcOptional(value))
fn option_no_header(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::NoHeader(value))
fn option_no_jsonpath_coercion(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::NoJsonpathCoercion(value))
fn option_ntlm(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Ntlm(value))
fn option_output(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Output(value))
fn option_path_as_is(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::PathAsIs(value))
fn option_pinned_pub_key(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::PinnedPublicKey(value))
fn option_proxy(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Proxy(value))
fn option_repeat(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Repeat(value))
fn option_resolve(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Resolve(value))
fn option_retry(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Retry(value))
fn option_retry_interval(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = non_recover(duration_option, reader)?;
Ok(OptionKind::RetryInterval(value))
fn option_skip(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Skip(value))
fn option_user(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::User(value))
fn option_unix_socket(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::UnixSocket(value))
fn option_variable(reader: &mut Reader) -> ParseResult<OptionKind> {
let value = variable_definition(reader)?;
Ok(OptionKind::Variable(value))
fn option_variables_file(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::VariablesFile(value))
fn option_verbose(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::Verbose(value))
fn option_verbosity(reader: &mut Reader) -> ParseResult<OptionKind> {
let name = reader.read_while(|c| c.is_ascii_alphabetic());
match name.as_str() {
"brief" => Ok(OptionKind::Verbosity(VerbosityOption::Brief)),
"verbose" => Ok(OptionKind::Verbosity(VerbosityOption::Verbose)),
"debug" => Ok(OptionKind::Verbosity(VerbosityOption::Debug)),
reader.seek(start);
let kind = ParseErrorKind::Expecting {
value: "brief|verbose|debug".to_string(),
Err(ParseError::new(start.pos, false, kind))
fn option_very_verbose(reader: &mut Reader) -> ParseResult<OptionKind> {
Ok(OptionKind::VeryVerbose(value))
fn count(reader: &mut Reader) -> ParseResult<Count> {
let value = non_recover(integer, reader)?;
if value.as_i64() == -1 {
Ok(Count::Infinite)
} else if value.as_i64() >= 0 {
Ok(Count::Finite(value.as_i64() as usize))
} else {
value: "Expecting a count value".to_string(),
fn boolean_option(reader: &mut Reader) -> ParseResult<BooleanOption> {
match boolean(reader) {
Ok(v) => Ok(BooleanOption::Literal(v)),
Err(_) => {
let exp = placeholder::parse(reader).map_err(|e| {
value: "true|false".to_string(),
ParseError::new(e.pos, false, kind)
})?;
Ok(BooleanOption::Placeholder(exp))
fn natural_option(reader: &mut Reader) -> ParseResult<NaturalOption> {
match natural(reader) {
Ok(v) => Ok(NaturalOption::Literal(v)),
let placeholder = placeholder::parse(reader).map_err(|e| {
value: "integer >= 0".to_string(),
Ok(NaturalOption::Placeholder(placeholder))
fn count_option(reader: &mut Reader) -> ParseResult<CountOption> {
match count(reader) {
Ok(v) => Ok(CountOption::Literal(v)),
value: "integer >= -1".to_string(),
Ok(CountOption::Placeholder(placeholder))
fn duration_option(reader: &mut Reader) -> ParseResult<DurationOption> {
match duration(reader) {
Ok(v) => Ok(DurationOption::Literal(v)),
Err(e) => {
if e.recoverable {
value: "integer".to_string(),
Ok(DurationOption::Placeholder(placeholder))
Err(e)
fn variable_definition(reader: &mut Reader) -> ParseResult<VariableDefinition> {
let name = variable_name(reader)?;
literal("=", reader)?;
let value = variable_value(reader)?;
let end = reader.cursor();
let source_info = SourceInfo {
start: start.pos,
end: end.pos,
Ok(VariableDefinition {
source_info,
name,
value,
fn variable_name(reader: &mut Reader) -> ParseResult<String> {
let name = reader.read_while(|c| c.is_alphanumeric() || c == '_' || c == '-');
if name.is_empty() {
value: "variable name".to_string(),
return Err(ParseError::new(start.pos, false, kind));
} else if is_variable_reserved(&name) {
let kind = ParseErrorKind::Variable(format!(
"conflicts with the {name} function, use a different name"
Ok(name)
// `null`, a boolean or a number is only a variable value when the literal spans the whole
// value. When more characters follow (as in `11aa` or `true_is_true`), the literal is just
// the start of an unquoted string, so return a recoverable error to fall back to it.
fn literal_value<T>(reader: &mut Reader, value: T) -> ParseResult<T> {
match reader.peek() {
None | Some(' ' | '\t' | '\r' | '\n' | '#') => Ok(value),
Some(_) => {
value: "variable value".to_string(),
Err(ParseError::new(reader.cursor().pos, true, kind))
fn variable_value(reader: &mut Reader) -> ParseResult<VariableValue> {
choice(
&[
|p1| match null(p1) {
Ok(()) => literal_value(p1, VariableValue::Null),
Err(e) => Err(e),
},
|p1| match boolean(p1) {
Ok(value) => literal_value(p1, VariableValue::Bool(value)),
|p1| match number(p1) {
Ok(value) => literal_value(p1, VariableValue::Number(value)),
|p1| match quoted_template(p1) {
Ok(value) => Ok(VariableValue::String(value)),
|p1| match unquoted_template(p1) {
],
reader,
)
.map_err(|e| {
#[cfg(test)]
mod tests {
use super::*;
use crate::ast::{I64, LineTerminator, Number, Template, TemplateElement, Whitespace};
use crate::reader::Pos;
use crate::types::ToSource;
#[test]
fn test_option_insecure() {
let mut reader = Reader::new("insecure: true");
let option = parse(&mut reader).unwrap();
assert_eq!(
option,
EntryOption {
line_terminators: vec![],
space0: Whitespace {
value: String::new(),
source_info: SourceInfo {
start: Pos { line: 1, column: 1 },
end: Pos { line: 1, column: 1 },
space1: Whitespace {
start: Pos { line: 1, column: 9 },
end: Pos { line: 1, column: 9 },
space2: Whitespace {
value: " ".to_string(),
start: Pos {
line: 1,
column: 10,
end: Pos {
column: 11,
kind: OptionKind::Insecure(BooleanOption::Literal(true)),
line_terminator0: LineTerminator {
column: 15,
comment: None,
newline: Whitespace {
);
fn test_option_insecure_error() {
let mut reader = Reader::new("insecure: error");
let error = parse(&mut reader).err().unwrap();
assert!(!error.recoverable);
fn test_option_no_jsonpath_coercion() {
let mut reader = Reader::new("no-jsonpath-coercion: true");
option.kind,
OptionKind::NoJsonpathCoercion(BooleanOption::Literal(true))
fn test_option_cacert() {
let mut reader = Reader::new("cacert: /home/foo/cert.pem");
start: Pos { line: 1, column: 7 },
end: Pos { line: 1, column: 7 },
start: Pos { line: 1, column: 8 },
kind: OptionKind::CaCertificate(Template::new(
None,
vec![TemplateElement::String {
value: "/home/foo/cert.pem".to_string(),
source: "/home/foo/cert.pem".to_source()
}],
SourceInfo {
column: 27,
)),
fn test_option_variables_file() {
let mut reader = Reader::new("variables-file: vars.env");
column: 16,
column: 17,
kind: OptionKind::VariablesFile(Template::new(
value: "vars.env".to_string(),
source: "vars.env".to_source()
column: 25,
fn test_option_cacert_error() {
let mut reader = Reader::new("cacert: ###");
fn test_option_cert() {
let mut reader = Reader::new("/etc/client-cert.pem #foo");
option_cert(&mut reader).unwrap(),
OptionKind::ClientCert(Template::new(
value: "/etc/client-cert.pem".to_string(),
source: "/etc/client-cert.pem".to_source()
column: 21,
fn test_option_retry_error() {
let mut reader = Reader::new("retry: ###");
assert_eq!(error.pos, Pos { line: 1, column: 8 });
error.kind,
ParseErrorKind::Expecting {
value: "integer >= -1".to_string()
fn test_variable_definition() {
let mut reader = Reader::new("a=1");
variable_definition(&mut reader).unwrap(),
VariableDefinition {
source_info: SourceInfo::new(Pos::new(1, 1), Pos::new(1, 4)),
name: "a".to_string(),
source_info: SourceInfo::new(Pos::new(1, 2), Pos::new(1, 2)),
source_info: SourceInfo::new(Pos::new(1, 3), Pos::new(1, 3)),
value: VariableValue::Number(Number::Integer(I64::new(1, "1".to_source()))),
fn test_variable_value() {
let mut reader = Reader::new("null");
assert_eq!(variable_value(&mut reader).unwrap(), VariableValue::Null);
let mut reader = Reader::new("true");
variable_value(&mut reader).unwrap(),
VariableValue::Bool(true)
let mut reader = Reader::new("1");
VariableValue::Number(Number::Integer(I64::new(1, "1".to_source())))
let mut reader = Reader::new("toto");
VariableValue::String(Template::new(
value: "toto".to_string(),
source: "toto".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 5)),
))
let mut reader = Reader::new("\"123\"");
Some('"'),
value: "123".to_string(),
source: "123".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 6))
fn test_variable_value_string_with_literal_prefix() {
let mut reader = Reader::new("11aa");
value: "11aa".to_string(),
source: "11aa".to_source(),
let mut reader = Reader::new("0.5x");
value: "0.5x".to_string(),
source: "0.5x".to_source(),
let mut reader = Reader::new("true_is_true");
value: "true_is_true".to_string(),
source: "true_is_true".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 13)),
let mut reader = Reader::new("nullable");
value: "nullable".to_string(),
source: "nullable".to_source(),
SourceInfo::new(Pos::new(1, 1), Pos::new(1, 9)),