icann_rdap_cli/rt/

results.rs

use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};

/// Contains the results of test execution.
use chrono::{DateTime, Utc};
use icann_rdap_common::check::{
    process::{do_check_processing, get_summaries},
    CheckSummary,
};
use {
    icann_rdap_client::{
        md::{string::StringUtil, table::MultiPartTable, MdOptions},
        rdap::ResponseData,
        RdapClientError,
    },
    icann_rdap_common::{
        check::{Check, CheckClass, CheckItem, Checks},
        response::ExtensionId,
    },
    reqwest::StatusCode,
    serde::Serialize,
    strum_macros::Display,
};

use super::exec::TestOptions;

#[derive(Debug, Serialize, Clone)]
pub enum TestResults {
    Http(HttpResults),
    String(Box<StringResult>),
}

impl TestResults {
    pub fn to_md(&self, options: &MdOptions) -> String {
        match self {
            TestResults::Http(http_results) => http_results.to_md(options),
            TestResults::String(string_result) => string_result.to_md(options),
        }
    }

    pub fn execution_errors(&self) -> bool {
        match self {
            TestResults::Http(http_results) => http_results.execution_errors(),
            TestResults::String(string_result) => string_result.execution_errors(),
        }
    }

    pub fn are_there_checks(&self, classes: Vec<CheckClass>) -> bool {
        match self {
            TestResults::Http(http_results) => http_results.are_there_checks(classes),
            TestResults::String(string_result) => string_result.are_there_checks(classes),
        }
    }

    pub fn filter_test_results(&self, classes: Vec<CheckClass>) -> TestResults {
        match self {
            TestResults::Http(http_results) => {
                TestResults::Http(http_results.clone().filter_test_results(&classes))
            }
            TestResults::String(string_result) => TestResults::String(Box::new(
                string_result.clone().filter_test_results(&classes),
            )),
        }
    }
}

#[derive(Debug, Serialize, Clone)]
pub struct HttpResults {
    pub query_url: String,
    pub start_time: DateTime<Utc>,
    pub end_time: Option<DateTime<Utc>>,
    pub dns_data: DnsData,
    pub service_checks: Vec<CheckItem>,
    pub test_runs: Vec<TestRun>,
}

#[derive(Debug, Serialize, Clone)]
pub struct StringResult {
    pub test_run: Option<TestRun>,
}

impl HttpResults {
    pub fn new(query_url: String, dns_data: DnsData) -> Self {
        Self {
            query_url,
            dns_data,
            service_checks: vec![],
            test_runs: vec![],
            start_time: Utc::now(),
            end_time: None,
        }
    }

    pub fn end(&mut self, options: &TestOptions) {
        self.end_time = Some(Utc::now());

        //service checks
        if self.dns_data.v4_cname.is_some() && self.dns_data.v4_addrs.is_empty() {
            self.service_checks
                .push(Check::CnameWithoutARecords.check_item());
        }
        if self.dns_data.v6_cname.is_some() && self.dns_data.v6_addrs.is_empty() {
            self.service_checks
                .push(Check::CnameWithoutAAAARecords.check_item());
        }
        if self.dns_data.v4_addrs.is_empty() {
            self.service_checks.push(Check::NoARecords.check_item());
        }
        if self.dns_data.v6_addrs.is_empty() {
            self.service_checks.push(Check::NoAAAARecords.check_item());

            // see if required by Gtld Profile
            let tig0 = ExtensionId::IcannRdapTechnicalImplementationGuide0.to_string();
            let tig1 = ExtensionId::IcannRdapTechnicalImplementationGuide1.to_string();
            let both_tigs = format!("{tig0}|{tig1}");
            if options.expect_extensions.contains(&tig0)
                || options.expect_extensions.contains(&tig1)
                || options.expect_extensions.contains(&both_tigs)
            {
                self.service_checks
                    .push(Check::Ipv6SupportRequiredByGtldProfile.check_item())
            }
        }
    }

    pub fn add_test_run(&mut self, test_run: TestRun) {
        self.test_runs.push(test_run);
    }

    pub fn to_md(&self, options: &MdOptions) -> String {
        let mut md = String::new();

        // h1
        md.push_str(&format!(
            "\n{}\n",
            self.query_url.to_owned().to_header(1, options)
        ));

        // table
        let mut table = MultiPartTable::new();

        // test results summary
        table = table.multi_raw(vec![
            "Start Time".to_inline(options),
            "End Time".to_inline(options),
            "Duration".to_inline(options),
            "Tested".to_inline(options),
        ]);
        let (end_time_s, duration_s) = if let Some(end_time) = self.end_time {
            (
                format_date_time(end_time),
                format!("{} s", (end_time - self.start_time).num_seconds()),
            )
        } else {
            ("FATAL".to_em(options), "N/A".to_string())
        };
        let tested = self
            .test_runs
            .iter()
            .filter(|r| matches!(r.outcome, RunOutcome::Tested))
            .count();
        table = table.multi_raw(vec![
            format_date_time(self.start_time),
            end_time_s,
            duration_s,
            format!("{tested} of {}", self.test_runs.len()),
        ]);

        // dns data
        table = table.multi_raw(vec![
            "DNS Query".to_inline(options),
            "DNS Answer".to_inline(options),
        ]);
        let v4_cname = if let Some(ref cname) = self.dns_data.v4_cname {
            cname.to_owned()
        } else {
            format!("{} A records", self.dns_data.v4_addrs.len())
        };
        table = table.multi_raw(vec!["A (v4)".to_string(), v4_cname]);
        let v6_cname = if let Some(ref cname) = self.dns_data.v6_cname {
            cname.to_owned()
        } else {
            format!("{} AAAA records", self.dns_data.v6_addrs.len())
        };
        table = table.multi_raw(vec!["AAAA (v6)".to_string(), v6_cname]);

        // summary of each run
        table = table.multi_raw(vec![
            "Address".to_inline(options),
            "Attributes".to_inline(options),
            "Duration".to_inline(options),
            "Outcome".to_inline(options),
        ]);
        for test_run in &self.test_runs {
            table = test_run.add_summary(table, options);
        }
        md.push_str(&table.to_md_table(options));

        md.push('\n');

        // checks that are about the service and not a particular test run
        if !self.service_checks.is_empty() {
            md.push_str(&"Service Checks".to_string().to_header(1, options));
            let mut table = MultiPartTable::new();

            table = table.multi_raw(vec!["Message".to_inline(options)]);
            for c in &self.service_checks {
                let message = check_item_md(c, options);
                table = table.multi_raw(vec![message]);
            }
            md.push_str(&table.to_md_table(options));
            md.push('\n');
        }

        // each run in detail
        for run in &self.test_runs {
            md.push_str(&run.to_md(options));
        }
        md
    }

    pub fn execution_errors(&self) -> bool {
        self.test_runs
            .iter()
            .filter(|r| !matches!(r.outcome, RunOutcome::Tested | RunOutcome::Skipped))
            .count()
            != 0
    }

    pub fn are_there_checks(&self, classes: Vec<CheckClass>) -> bool {
        // see if there are any checks in the test runs
        let run_count = self
            .test_runs
            .iter()
            .filter(|r| {
                r.summaries
                    .as_deref()
                    .unwrap_or_default()
                    .iter()
                    .any(|s| classes.contains(&s.item.check_class))
            })
            .count();
        // see if there are any classes in the service checks
        let service_count = self
            .service_checks
            .iter()
            .filter(|c| classes.contains(&c.check_class))
            .count();
        run_count + service_count != 0
    }

    pub fn filter_test_results(self, classes: &[CheckClass]) -> Self {
        // filter service checks
        let filtered_service_checks: Vec<CheckItem> = self
            .service_checks
            .into_iter()
            .filter(|c| classes.contains(&c.check_class))
            .collect();

        // filter test runs
        let mut filtered_test_runs = vec![];
        for mut test_run in self.test_runs {
            let filtered_summary: Vec<CheckSummary> = test_run
                .summaries
                .unwrap_or_default()
                .into_iter()
                .filter(|s| classes.contains(&s.item.check_class))
                .collect();
            test_run.summaries = Some(filtered_summary);
            filtered_test_runs.push(test_run);
        }

        // return
        Self {
            service_checks: filtered_service_checks,
            test_runs: filtered_test_runs,
            ..self
        }
    }
}

impl StringResult {
    pub fn new(test_run: TestRun) -> Self {
        Self {
            test_run: Some(test_run),
        }
    }

    pub fn to_md(&self, options: &MdOptions) -> String {
        let mut md = String::new();

        if let Some(test_run) = &self.test_run {
            md.push_str(&test_run.to_md(options));
        }
        md
    }

    pub fn execution_errors(&self) -> bool {
        self.test_run
            .iter()
            .filter(|r| !matches!(r.outcome, RunOutcome::Tested | RunOutcome::Skipped))
            .count()
            != 0
    }

    pub fn are_there_checks(&self, classes: Vec<CheckClass>) -> bool {
        // see if there are any checks in the test runs
        let run_count = self
            .test_run
            .iter()
            .filter(|r| {
                r.summaries
                    .as_deref()
                    .unwrap_or_default()
                    .iter()
                    .any(|s| classes.contains(&s.item.check_class))
            })
            .count();
        run_count != 0
    }

    pub fn filter_test_results(self, classes: &[CheckClass]) -> Self {
        // filter test runs
        let mut filtered_test_run = None;
        if let Some(mut test_run) = self.test_run {
            let filtered_summary: Vec<CheckSummary> = test_run
                .summaries
                .unwrap_or_default()
                .into_iter()
                .filter(|s| classes.contains(&s.item.check_class))
                .collect();
            test_run.summaries = Some(filtered_summary);
            filtered_test_run = Some(test_run);
        }
        // return
        Self {
            test_run: filtered_test_run,
        }
    }
}

#[derive(Debug, Serialize, Clone, Default)]
pub struct DnsData {
    pub v4_cname: Option<String>,
    pub v6_cname: Option<String>,
    pub v4_addrs: Vec<Ipv4Addr>,
    pub v6_addrs: Vec<Ipv6Addr>,
}

#[derive(Debug, Serialize, Display, Clone)]
#[strum(serialize_all = "SCREAMING_SNAKE_CASE")]
pub enum RunOutcome {
    Tested,
    NetworkError,
    HttpProtocolError,
    HttpConnectError,
    HttpRedirectResponse,
    HttpTimeoutError,
    HttpNon200Error,
    HttpTooManyRequestsError,
    HttpNotFoundError,
    HttpBadRequestError,
    HttpUnauthorizedError,
    HttpForbiddenError,
    JsonError,
    RdapDataError,
    InternalError,
    Skipped,
}

#[derive(Debug, Serialize, Display, Clone)]
#[strum(serialize_all = "snake_case")]
pub enum RunFeature {
    OriginHeader,
    ExtsList,
}

impl RunOutcome {
    pub fn to_md(&self, options: &MdOptions) -> String {
        match self {
            Self::Tested => self.to_bold(options),
            Self::Skipped => self.to_string(),
            _ => self.to_em(options),
        }
    }
}

#[derive(Debug, Serialize, Clone)]
pub struct TestRun {
    pub features: Vec<RunFeature>,
    pub socket_addr: Option<SocketAddr>,
    pub start_time: DateTime<Utc>,
    pub end_time: Option<DateTime<Utc>>,
    pub response_data: Option<ResponseData>,
    pub outcome: RunOutcome,
    pub summaries: Option<Vec<CheckSummary>>,
}

impl TestRun {
    pub fn new(features: Vec<RunFeature>) -> Self {
        Self {
            features,
            start_time: Utc::now(),
            socket_addr: None,
            end_time: None,
            response_data: None,
            outcome: RunOutcome::Skipped,
            summaries: None,
        }
    }

    pub fn new_ip(features: Vec<RunFeature>, socket_addr: SocketAddr) -> Self {
        Self {
            features,
            start_time: Utc::now(),
            socket_addr: Some(socket_addr),
            end_time: None,
            response_data: None,
            outcome: RunOutcome::Skipped,
            summaries: None,
        }
    }

    pub fn new_v4(features: Vec<RunFeature>, ipv4: Ipv4Addr, port: u16) -> Self {
        Self::new_ip(features, SocketAddr::new(IpAddr::V4(ipv4), port))
    }

    pub fn new_v6(features: Vec<RunFeature>, ipv6: Ipv6Addr, port: u16) -> Self {
        Self::new_ip(features, SocketAddr::new(IpAddr::V6(ipv6), port))
    }

    pub fn end(
        mut self,
        rdap_response: Result<ResponseData, RdapClientError>,
        options: &TestOptions,
    ) -> Self {
        if let Ok(response_data) = rdap_response {
            self.end_time = Some(Utc::now());
            self.outcome = RunOutcome::Tested;
            self.summaries = Some(get_summaries(&do_checks(&response_data, options), None));
            self.response_data = Some(response_data);
        } else {
            self.outcome = match rdap_response.err().unwrap() {
                RdapClientError::InvalidQueryValue
                | RdapClientError::AmbiguousQueryType
                | RdapClientError::Poison
                | RdapClientError::DomainNameError(_)
                | RdapClientError::BootstrapUnavailable
                | RdapClientError::BootstrapError(_)
                | RdapClientError::IanaResponse(_) => RunOutcome::InternalError,
                RdapClientError::Response(_) => RunOutcome::RdapDataError,
                RdapClientError::Json(_) => RunOutcome::JsonError,
                RdapClientError::ParsingError(e) => {
                    let status_code = e.http_data.status_code();
                    if status_code > 299 && status_code < 400 {
                        RunOutcome::HttpRedirectResponse
                    } else {
                        RunOutcome::JsonError
                    }
                }
                RdapClientError::IoError(_) => RunOutcome::NetworkError,
                RdapClientError::Client(e) => {
                    if e.is_redirect() {
                        RunOutcome::HttpRedirectResponse
                    } else if e.is_connect() {
                        RunOutcome::HttpConnectError
                    } else if e.is_timeout() {
                        RunOutcome::HttpTimeoutError
                    } else if e.is_status() {
                        match e.status().unwrap() {
                            StatusCode::TOO_MANY_REQUESTS => RunOutcome::HttpTooManyRequestsError,
                            StatusCode::NOT_FOUND => RunOutcome::HttpNotFoundError,
                            StatusCode::BAD_REQUEST => RunOutcome::HttpBadRequestError,
                            StatusCode::UNAUTHORIZED => RunOutcome::HttpUnauthorizedError,
                            StatusCode::FORBIDDEN => RunOutcome::HttpForbiddenError,
                            _ => RunOutcome::HttpNon200Error,
                        }
                    } else {
                        RunOutcome::HttpProtocolError
                    }
                }
            };
            self.end_time = Some(Utc::now());
        };
        self
    }

    fn add_summary(&self, mut table: MultiPartTable, options: &MdOptions) -> MultiPartTable {
        let duration_s = if let Some(end_time) = self.end_time {
            format!("{} ms", (end_time - self.start_time).num_milliseconds())
        } else {
            "n/a".to_string()
        };
        table = table.multi_raw(vec![
            socket_addr_string(self.socket_addr),
            self.attribute_set(),
            duration_s,
            self.outcome.to_md(options),
        ]);
        table
    }

    fn to_md(&self, options: &MdOptions) -> String {
        let mut md = String::new();

        // h1
        let header_value = format!(
            "{} - {}",
            socket_addr_string(self.socket_addr),
            self.attribute_set()
        );
        md.push_str(&format!("\n{}\n", header_value.to_header(1, options)));

        // if outcome is tested
        if matches!(self.outcome, RunOutcome::Tested) {
            // get check items according to class
            let mut check_v: Vec<(String, String)> = vec![];
            for summary in self.summaries.as_deref().unwrap_or_default() {
                let message = check_item_md(&summary.item, options);
                check_v.push((summary.structure.to_string(), message));
            }

            // table
            let mut table = MultiPartTable::new();

            if check_v.is_empty() {
                table = table.header_ref(&"No issues or errors.");
            } else {
                table = table.multi_raw(vec![
                    "RDAP Structure".to_inline(options),
                    "Message".to_inline(options),
                ]);
                for c in check_v {
                    table = table.nv_raw(&c.0, c.1);
                }
            }
            md.push_str(&table.to_md_table(options));
        } else {
            let mut table = MultiPartTable::new();
            table = table.multi_raw(vec![self.outcome.to_md(options)]);
            md.push_str(&table.to_md_table(options));
        }

        md
    }

    fn attribute_set(&self) -> String {
        let socket_type = socket_type_string(self.socket_addr);
        if !self.features.is_empty() {
            format!(
                "{socket_type}, {}",
                self.features
                    .iter()
                    .map(|f| f.to_string())
                    .collect::<Vec<_>>()
                    .join(", ")
            )
        } else {
            socket_type.to_string()
        }
    }
}

fn socket_type_string(sock: Option<SocketAddr>) -> String {
    if let Some(sock) = sock {
        if sock.is_ipv4() {
            "v4".to_string()
        } else {
            "v6".to_string()
        }
    } else {
        "file".to_string()
    }
}

fn socket_addr_string(sock: Option<SocketAddr>) -> String {
    if let Some(sock) = sock {
        sock.to_string()
    } else {
        "localhost".to_string()
    }
}

fn check_item_md(item: &CheckItem, options: &MdOptions) -> String {
    if !matches!(item.check_class, CheckClass::Informational)
        && !matches!(item.check_class, CheckClass::SpecificationNote)
    {
        item.to_string().to_em(options)
    } else {
        item.to_string()
    }
}

fn format_date_time(date: DateTime<Utc>) -> String {
    date.format("%a, %v %X %Z").to_string()
}

fn do_checks(response: &ResponseData, options: &TestOptions) -> Checks {
    let http_data = if matches!(options.test_type, super::exec::TestType::Http(_)) {
        Some(&response.http_data)
    } else {
        None
    };
    do_check_processing(
        &response.rdap,
        http_data,
        Some(&options.expect_extensions),
        options.allow_unregistered_extensions,
    )
}