hurl 8.0.0

/*
 * 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 std::time::Duration;

use hurl_core::types::{BytesPerSec, Count};

use crate::http::{FollowLocation, HeaderVec, IpResolve, RequestedHttpVersion};
use crate::pretty::PrettyMode;
use crate::util::path::ContextDir;

use super::output::Output;

/// Build a [`RunnerOptions`] instance.
pub struct RunnerOptionsBuilder {
    allow_reuse: bool,
    aws_sigv4: Option<String>,
    cacert_file: Option<String>,
    client_cert_file: Option<String>,
    client_key_file: Option<String>,
    color_stdout: bool,
    compressed: bool,
    connect_timeout: Duration,
    connects_to: Vec<String>,
    context_dir: ContextDir,
    continue_on_error: bool,
    cookie_input_file: Option<String>,
    delay: Duration,
    digest: bool,
    follow_location: FollowLocation,
    from_entry: Option<usize>,
    headers: HeaderVec,
    http_version: RequestedHttpVersion,
    no_assert: bool,
    insecure: bool,
    ip_resolve: IpResolve,
    max_filesize: Option<u64>,
    max_recv_speed: Option<BytesPerSec>,
    max_redirect: Count,
    max_send_speed: Option<BytesPerSec>,
    negotiate: bool,
    netrc: bool,
    netrc_file: Option<String>,
    netrc_optional: bool,
    no_proxy: Option<String>,
    ntlm: bool,
    output: Option<Output>,
    path_as_is: bool,
    pretty_mode: PrettyMode,
    pinned_pub_key: Option<String>,
    proxy: Option<String>,
    repeat: Option<Count>,
    resolves: Vec<String>,
    retry: Option<Count>,
    retry_interval: Duration,
    skip: bool,
    ssl_no_revoke: bool,
    timeout: Duration,
    to_entry: Option<usize>,
    unix_socket: Option<String>,
    use_cookie_store: bool,
    user: Option<String>,
    user_agent: Option<String>,
}

impl Default for RunnerOptionsBuilder {
    fn default() -> Self {
        RunnerOptionsBuilder {
            allow_reuse: true,
            aws_sigv4: None,
            cacert_file: None,
            client_cert_file: None,
            client_key_file: None,
            color_stdout: true,
            compressed: false,
            connect_timeout: Duration::from_secs(300),
            connects_to: vec![],
            context_dir: ContextDir::default(),
            continue_on_error: false,
            cookie_input_file: None,
            delay: Duration::from_millis(0),
            digest: false,
            follow_location: FollowLocation::default(),
            from_entry: None,
            headers: HeaderVec::new(),
            http_version: RequestedHttpVersion::default(),
            no_assert: false,
            insecure: false,
            ip_resolve: IpResolve::default(),
            max_filesize: None,
            max_recv_speed: None,
            max_redirect: Count::Finite(50),
            max_send_speed: None,
            negotiate: false,
            netrc: false,
            netrc_file: None,
            netrc_optional: false,
            no_proxy: None,
            ntlm: false,
            output: None,
            path_as_is: false,
            pinned_pub_key: None,
            pretty_mode: PrettyMode::Automatic,
            proxy: None,
            repeat: None,
            resolves: vec![],
            retry: None,
            retry_interval: Duration::from_millis(1000),
            skip: false,
            ssl_no_revoke: false,
            timeout: Duration::from_secs(300),
            to_entry: None,
            unix_socket: None,
            use_cookie_store: true,
            user: None,
            user_agent: None,
        }
    }
}

impl RunnerOptionsBuilder {
    /// Returns a new Hurl runner options builder with a default values.
    pub fn new() -> Self {
        RunnerOptionsBuilder::default()
    }

    /// Allow reusing internal connections, `true` by default. Setting this to `false` forces the
    /// HTTP client to use a new HTTP connection, and also marks this new connection as not reusable.
    /// The main use-case for not allowing connection reuse is when we want to switch HTTP version
    /// mid-file with an `[Options]` section. As the HTTP version setter is just a query, and is not
    /// always honored by libcurl when reusing connection, this allows to be sure that the client
    /// will set the queried HTTP version.
    pub fn allow_reuse(&mut self, allow_reuse: bool) -> &mut Self {
        self.allow_reuse = allow_reuse;
        self
    }

    /// Specifies the AWS SigV4 option
    pub fn aws_sigv4(&mut self, aws_sigv4: Option<String>) -> &mut Self {
        self.aws_sigv4 = aws_sigv4;
        self
    }

    /// Specifies the certificate file for peer verification.
    /// The file may contain multiple CA certificates and must be in PEM format.
    pub fn cacert_file(&mut self, cacert_file: Option<String>) -> &mut Self {
        self.cacert_file = cacert_file;
        self
    }

    /// Sets Client certificate file and password.
    pub fn client_cert_file(&mut self, client_cert_file: Option<String>) -> &mut Self {
        self.client_cert_file = client_cert_file;
        self
    }

    /// Sets private key file name.
    pub fn client_key_file(&mut self, client_key_file: Option<String>) -> &mut Self {
        self.client_key_file = client_key_file;
        self
    }

    /// Whether we use color in stdout, or not. This property is used when response is outputted
    /// to a file or to standard output through `[Options]` section.
    pub fn color_stdout(&mut self, color_stdout: bool) -> &mut Self {
        self.color_stdout = color_stdout;
        self
    }

    /// Requests a compressed response using one of the algorithms br, gzip, deflate and
    /// automatically decompress the content.
    pub fn compressed(&mut self, compressed: bool) -> &mut Self {
        self.compressed = compressed;
        self
    }

    /// Sets maximum time that you allow Hurl’s connection to take.
    ///
    /// Default 300 seconds.
    pub fn connect_timeout(&mut self, connect_timeout: Duration) -> &mut Self {
        self.connect_timeout = connect_timeout;
        self
    }

    /// Sets hosts mappings.
    ///
    /// Each value has the following format HOST1:PORT1:HOST2:PORT2
    /// For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead.
    pub fn connects_to(&mut self, connects_to: &[String]) -> &mut Self {
        self.connects_to = connects_to.to_vec();
        self
    }

    /// Sets delay (timeout) before the request.
    ///
    /// Default is 0 ms.
    pub fn delay(&mut self, delay: Duration) -> &mut Self {
        self.delay = delay;
        self
    }

    /// Sets root file system to import files in Hurl.
    ///
    /// This is used for both files in multipart form data and request body.
    pub fn context_dir(&mut self, context_dir: &ContextDir) -> &mut Self {
        self.context_dir = context_dir.clone();
        self
    }

    /// Sets stopping or continuing executing requests to the end of the Hurl file even when an error occurs.
    ///
    /// By default, Hurl exits after an error in the HTTP response. Note that this option does
    /// not affect the behavior with multiple input Hurl files.
    pub fn continue_on_error(&mut self, continue_on_error: bool) -> &mut Self {
        self.continue_on_error = continue_on_error;
        self
    }

    /// Reads cookies from this file (using the Netscape cookie file format).
    pub fn cookie_input_file(&mut self, cookie_input_file: Option<String>) -> &mut Self {
        self.cookie_input_file = cookie_input_file;
        self
    }

    /// Sets stopping or continuing executing requests to the end of the Hurl file even when an assert error occurs.
    ///
    /// By default, Hurl exits after an assert error in the HTTP response. Note that this option does
    /// not affect the behavior with multiple input Hurl files.
    pub fn fail_fast(&mut self, fail_fast: bool) -> &mut Self {
        self.continue_on_error = !fail_fast;
        self
    }

    /// Sets follow redirect.
    ///
    /// To limit the amount of redirects to follow use [`Self::max_redirect`].
    pub fn follow_location(&mut self, follow_location: FollowLocation) -> &mut Self {
        self.follow_location = follow_location;
        self
    }

    /// Executes Hurl file from `from_entry` (starting at 1), ignores the beginning of the file.
    pub fn from_entry(&mut self, from_entry: Option<usize>) -> &mut Self {
        self.from_entry = from_entry;
        self
    }

    /// Sets additional headers (overrides if a header already exists).
    pub fn headers(&mut self, headers: HeaderVec) -> &mut Self {
        self.headers = headers;
        self
    }

    /// Set requested HTTP version (can be different of the effective HTTP version).
    pub fn http_version(&mut self, version: RequestedHttpVersion) -> &mut Self {
        self.http_version = version;
        self
    }

    /// Ignores all asserts defined in the Hurl file.
    pub fn no_assert(&mut self, no_assert: bool) -> &mut Self {
        self.no_assert = no_assert;
        self
    }

    /// Allows Hurl to perform “insecure” SSL connections and transfers.
    pub fn insecure(&mut self, insecure: bool) -> &mut Self {
        self.insecure = insecure;
        self
    }

    /// Set IP version.
    pub fn ip_resolve(&mut self, ip_resolve: IpResolve) -> &mut Self {
        self.ip_resolve = ip_resolve;
        self
    }

    /// Set the file size limit
    pub fn max_filesize(&mut self, max_filesize: Option<u64>) -> &mut Self {
        self.max_filesize = max_filesize;
        self
    }

    /// Set maximum number of redirection-followings allowed
    ///
    /// By default, the limit is set to 50 redirections
    pub fn max_redirect(&mut self, max_redirect: Count) -> &mut Self {
        self.max_redirect = max_redirect;
        self
    }

    /// Set the maximum upload speed.
    pub fn max_send_speed(&mut self, max_send_speed: Option<BytesPerSec>) -> &mut Self {
        self.max_send_speed = max_send_speed;
        self
    }

    /// Set the maximum download speed.
    pub fn max_recv_speed(&mut self, max_recv_speed: Option<BytesPerSec>) -> &mut Self {
        self.max_recv_speed = max_recv_speed;
        self
    }

    /// Sets the path-as-is flag.
    pub fn path_as_is(&mut self, path_as_is: bool) -> &mut Self {
        self.path_as_is = path_as_is;
        self
    }

    /// Enables HTTP Digest authentication.
    pub fn digest(&mut self, digest: bool) -> &mut Self {
        self.digest = digest;
        self
    }

    /// Sets the HTTP Negotiate (SPNEGO) authentication flag.
    pub fn negotiate(&mut self, negotiate: bool) -> &mut Self {
        self.negotiate = negotiate;
        self
    }

    /// Sets the netrc flag.
    pub fn netrc(&mut self, netrc: bool) -> &mut Self {
        self.netrc = netrc;
        self
    }

    /// Sets the netrc file.
    pub fn netrc_file(&mut self, netrc_file: Option<String>) -> &mut Self {
        self.netrc_file = netrc_file;
        self
    }

    /// Sets the optional netrc flag.
    pub fn netrc_optional(&mut self, netrc_optional: bool) -> &mut Self {
        self.netrc_optional = netrc_optional;
        self
    }

    /// Sets list of hosts which do not use a proxy.
    pub fn no_proxy(&mut self, no_proxy: Option<String>) -> &mut Self {
        self.no_proxy = no_proxy;
        self
    }

    /// Enables HTTP NTLM authentication.
    pub fn ntlm(&mut self, ntlm: bool) -> &mut Self {
        self.ntlm = ntlm;
        self
    }

    /// Specifies the file to output the HTTP response instead of stdout.
    pub fn output(&mut self, output: Option<Output>) -> &mut Self {
        self.output = output;
        self
    }

    /// Sets the pinned public key.
    pub fn pinned_pub_key(&mut self, pinned_pub_key: Option<String>) -> &mut Self {
        self.pinned_pub_key = pinned_pub_key;
        self
    }

    /// Set the pretty mode to prettify response output for supported content type (JSON only for the moment)?
    pub fn pretty(&mut self, pretty_mode: PrettyMode) -> &mut Self {
        self.pretty_mode = pretty_mode;
        self
    }

    /// Sets the specified proxy to be used.
    pub fn proxy(&mut self, proxy: Option<String>) -> &mut Self {
        self.proxy = proxy;
        self
    }

    /// Set the number of repetition for a given entry.
    pub fn repeat(&mut self, repeat: Option<Count>) -> &mut Self {
        self.repeat = repeat;
        self
    }

    /// Provides a custom address for a specific host and port pair.
    pub fn resolves(&mut self, resolves: &[String]) -> &mut Self {
        self.resolves = resolves.to_vec();
        self
    }

    /// Sets maximum number of retries.
    ///
    /// Default is 0.
    pub fn retry(&mut self, retry: Option<Count>) -> &mut Self {
        self.retry = retry;
        self
    }

    /// Sets duration between each retry.
    ///
    /// Default is 1000 ms.
    pub fn retry_interval(&mut self, retry_interval: Duration) -> &mut Self {
        self.retry_interval = retry_interval;
        self
    }

    /// Skip the run without executing any request.
    pub fn skip(&mut self, skip: bool) -> &mut Self {
        self.skip = skip;
        self
    }

    /// Disables certificate revocation checks for SSL backends where such behavior is present.
    pub fn ssl_no_revoke(&mut self, ssl_no_revoke: bool) -> &mut Self {
        self.ssl_no_revoke = ssl_no_revoke;
        self
    }

    /// Sets maximum time allowed for the transfer.
    ///
    /// Default 300 seconds.
    pub fn timeout(&mut self, timeout: Duration) -> &mut Self {
        self.timeout = timeout;
        self
    }

    /// Executes Hurl file to `to_entry` (starting at 1), ignores the remaining of the file.
    pub fn to_entry(&mut self, to_entry: Option<usize>) -> &mut Self {
        self.to_entry = to_entry;
        self
    }

    /// Sets the specified unix domain socket to connect through, instead of using the network.
    pub fn unix_socket(&mut self, unix_socket: Option<String>) -> &mut Self {
        self.unix_socket = unix_socket;
        self
    }

    pub fn use_cookie_store(&mut self, use_cookie_store: bool) -> &mut Self {
        self.use_cookie_store = use_cookie_store;
        self
    }
    /// Adds basic Authentication header to each request.
    pub fn user(&mut self, user: Option<String>) -> &mut Self {
        self.user = user;
        self
    }

    /// Specifies the User-Agent string to send to the HTTP server.
    pub fn user_agent(&mut self, user_agent: Option<String>) -> &mut Self {
        self.user_agent = user_agent;
        self
    }

    /// Create an instance of [`RunnerOptions`].
    pub fn build(&self) -> RunnerOptions {
        RunnerOptions {
            allow_reuse: self.allow_reuse,
            aws_sigv4: self.aws_sigv4.clone(),
            cacert_file: self.cacert_file.clone(),
            client_cert_file: self.client_cert_file.clone(),
            client_key_file: self.client_key_file.clone(),
            color_stdout: self.color_stdout,
            compressed: self.compressed,
            connect_timeout: self.connect_timeout,
            connects_to: self.connects_to.clone(),
            delay: self.delay,
            context_dir: self.context_dir.clone(),
            continue_on_error: self.continue_on_error,
            cookie_input_file: self.cookie_input_file.clone(),
            digest: self.digest,
            follow_location: self.follow_location,
            from_entry: self.from_entry,
            headers: self.headers.clone(),
            http_version: self.http_version,
            no_assert: self.no_assert,
            insecure: self.insecure,
            ip_resolve: self.ip_resolve,
            max_filesize: self.max_filesize,
            max_recv_speed: self.max_recv_speed,
            max_redirect: self.max_redirect,
            max_send_speed: self.max_send_speed,
            negotiate: self.negotiate,
            netrc: self.netrc,
            netrc_file: self.netrc_file.clone(),
            netrc_optional: self.netrc_optional,
            no_proxy: self.no_proxy.clone(),
            ntlm: self.ntlm,
            output: self.output.clone(),
            path_as_is: self.path_as_is,
            pinned_pub_key: self.pinned_pub_key.clone(),
            pretty: self.pretty_mode,
            proxy: self.proxy.clone(),
            repeat: self.repeat,
            resolves: self.resolves.clone(),
            retry: self.retry,
            retry_interval: self.retry_interval,
            skip: self.skip,
            ssl_no_revoke: self.ssl_no_revoke,
            timeout: self.timeout,
            to_entry: self.to_entry,
            unix_socket: self.unix_socket.clone(),
            use_cookie_store: self.use_cookie_store,
            user: self.user.clone(),
            user_agent: self.user_agent.clone(),
        }
    }
}

/// Represents the configuration options to run an Hurl file.
///
/// Most options are used to configure the HTTP client used for running requests, while other
/// are used to configure asserts settings, output etc....
#[derive(Clone, Debug, PartialEq)]
pub struct RunnerOptions {
    /// Allow reusing internal connections.
    pub(crate) allow_reuse: bool,
    /// Specifies the AWS SigV4 option.
    pub(crate) aws_sigv4: Option<String>,
    /// Specifies the certificate file for peer verification.
    pub(crate) cacert_file: Option<String>,
    /// Sets Client certificate file and password.
    pub(crate) client_cert_file: Option<String>,
    /// Sets private key file name.
    pub(crate) client_key_file: Option<String>,
    /// Whether we use color in stdout, or not. This property is used when response is outputted
    /// to a file or to standard output through `[Options]` section.
    pub(crate) color_stdout: bool,
    /// Requests a compressed response using one of the algorithms br, gzip, deflate and
    /// automatically decompress the content.
    pub(crate) compressed: bool,
    /// Sets maximum time that you allow Hurl’s connection to take.
    pub(crate) connect_timeout: Duration,
    /// Sets hosts mappings.
    pub(crate) connects_to: Vec<String>,
    /// Sets delay (timeout) before the request.
    pub(crate) delay: Duration,
    /// Sets root file system to import files in Hurl.
    pub(crate) context_dir: ContextDir,
    /// Sets stopping or continuing executing requests to the end of the Hurl file even when an error occurs.
    pub(crate) continue_on_error: bool,
    /// Reads cookies from this file (using the Netscape cookie file format).
    pub(crate) cookie_input_file: Option<String>,
    /// Enables HTTP Digest authentication.
    pub(crate) digest: bool,
    /// Sets follow redirect.
    pub(crate) follow_location: FollowLocation,
    /// Executes Hurl file from from_entry (starting at 1), ignores the beginning of the file.
    pub(crate) from_entry: Option<usize>,
    /// Sets additional headers (overrides if a header already exists).
    pub(crate) headers: HeaderVec,
    /// Set requested HTTP version (can be different of the effective HTTP version).
    pub(crate) http_version: RequestedHttpVersion,
    /// Ignores all asserts defined in the Hurl file.
    pub(crate) no_assert: bool,
    /// Set IP version.
    pub(crate) ip_resolve: IpResolve,
    /// Allows Hurl to perform “insecure” SSL connections and transfers.
    pub(crate) insecure: bool,
    /// Set the file size limit.
    pub(crate) max_filesize: Option<u64>,
    /// Set the maximum download speed.
    pub(crate) max_recv_speed: Option<BytesPerSec>,
    /// Set maximum number of redirection-followings allowed.
    pub(crate) max_redirect: Count,
    /// Set the maximum upload speed.
    pub(crate) max_send_speed: Option<BytesPerSec>,
    /// Enables HTTP Negotiate (SPNEGO) authentication.
    pub(crate) negotiate: bool,
    /// Sets the netrc flag.
    pub(crate) netrc: bool,
    /// Sets the netrc file.
    pub(crate) netrc_file: Option<String>,
    /// Sets the optional netrc flag.
    pub(crate) netrc_optional: bool,
    /// Sets list of hosts which do not use a proxy.
    pub(crate) no_proxy: Option<String>,
    /// Enables HTTP NTLM authentication.
    pub(crate) ntlm: bool,
    /// Specifies the file to output the HTTP response.
    pub(crate) output: Option<Output>,
    pub(crate) path_as_is: bool,
    /// Sets the pinned public key.
    pub(crate) pinned_pub_key: Option<String>,
    /// Prettify response output for supported content type (JSON only for the moment).
    pub(crate) pretty: PrettyMode,
    /// Sets the specified proxy to be used.
    pub(crate) proxy: Option<String>,
    /// Set the number of repetition for a given entry.
    pub(crate) repeat: Option<Count>,
    /// Provides a custom address for a specific host and port pair.
    pub(crate) resolves: Vec<String>,
    /// Sets maximum number of retries.
    pub(crate) retry: Option<Count>,
    /// Sets duration between each retry.
    pub(crate) retry_interval: Duration,
    /// Skip the run without executing any request.
    pub(crate) skip: bool,
    /// Disables certificate revocation checks for SSL backends where such behavior is present.
    pub(crate) ssl_no_revoke: bool,
    /// Sets maximum time allowed for the transfer.
    pub(crate) timeout: Duration,
    /// Executes Hurl file to to_entry (starting at 1), ignores the remaining of the file.
    pub(crate) to_entry: Option<usize>,
    /// Sets the specified unix domain socket to connect through, instead of using the network.
    pub(crate) unix_socket: Option<String>,
    /// Activates the cookie support for a single file.
    pub(crate) use_cookie_store: bool,
    /// Adds basic Authentication header to each request.
    pub(crate) user: Option<String>,
    /// Specifies the User-Agent string to send to the HTTP server.
    pub(crate) user_agent: Option<String>,
}

impl Default for RunnerOptions {
    fn default() -> Self {
        RunnerOptionsBuilder::default().build()
    }
}

impl Eq for RunnerOptions {}