speedtest-rs 0.2.0

Speedtest.net testing utility and crate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

use crate::distance::{self, EarthLocation};
use crate::{error::SpeedTestError, speedtest::SpeedTestServer, speedtest_config::SpeedTestConfig};
use std::cmp::Ordering::Less;

pub struct SpeedTestServersConfig {
    pub servers: Vec<SpeedTestServer>,
}

impl SpeedTestServersConfig {
    pub fn parse_with_config(
        server_config_xml: &str,
        config: &SpeedTestConfig,
    ) -> Result<SpeedTestServersConfig, SpeedTestError> {
        let document = roxmltree::Document::parse(server_config_xml)?;
        let servers = document
            .descendants()
            .filter(|node| node.tag_name().name() == "server")
            .map::<Result<_, SpeedTestError>, _>(|n| {
                let location = EarthLocation {
                    latitude: n
                        .attribute("lat")
                        .ok_or(SpeedTestError::ServerParseError)?
                        .parse()?,
                    longitude: n
                        .attribute("lon")
                        .ok_or(SpeedTestError::ServerParseError)?
                        .parse()?,
                };
                Ok(SpeedTestServer {
                    country: n
                        .attribute("country")
                        .ok_or(SpeedTestError::ServerParseError)?
                        .to_string(),
                    host: n
                        .attribute("host")
                        .ok_or(SpeedTestError::ServerParseError)?
                        .to_string(),
                    id: n
                        .attribute("id")
                        .ok_or(SpeedTestError::ServerParseError)?
                        .parse()?,
                    location: location.clone(),
                    distance: Some(distance::compute_distance(&config.location, &location)),
                    name: n
                        .attribute("name")
                        .ok_or(SpeedTestError::ServerParseError)?
                        .to_string(),
                    sponsor: n
                        .attribute("sponsor")
                        .ok_or(SpeedTestError::ServerParseError)?
                        .to_string(),
                    url: n
                        .attribute("url")
                        .ok_or(SpeedTestError::ServerParseError)?
                        .to_string(),
                })
            })
            .filter_map(Result::ok)
            .filter(|server| !config.ignore_servers.contains(&server.id))
            .collect();
        Ok(SpeedTestServersConfig { servers })
    }

    pub fn servers_sorted_by_distance(&self, config: &SpeedTestConfig) -> Vec<SpeedTestServer> {
        let location = &config.location;
        let mut sorted_servers = self.servers.clone();
        sorted_servers.sort_by(|a, b| {
            let a_distance = distance::compute_distance(location, &a.location);
            let b_distance = distance::compute_distance(location, &b.location);
            a_distance.partial_cmp(&b_distance).unwrap_or(Less)
        });
        sorted_servers
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::speedtest_config::*;

    fn sample_spt_config() -> SpeedTestConfig {
        // Somewhere in Los Angeles
        SpeedTestConfig {
            location: EarthLocation {
                latitude: 32.9954,
                longitude: -117.0753,
            },
            ..SpeedTestConfig::default()
        }
    }

    #[test]
    fn test_parse_speedtest_servers_xml() {
        let spt_config = sample_spt_config();
        let config_str = include_str!("../tests/config/geo-test-servers-static.php.xml");

        let server_config =
            SpeedTestServersConfig::parse_with_config(config_str, &spt_config).unwrap();
        assert!(server_config.servers.len() > 5);
        let server = server_config.servers.get(1).unwrap();
        assert!(!server.url.is_empty());
        assert!(!server.country.is_empty());
    }

    #[test]
    fn test_parse_speedtest_servers_xml_with_ignore_servers() {
        let spt_config = SpeedTestConfig {
            ignore_servers: vec![5905],
            ..sample_spt_config()
        };
        let config_str = include_str!("../tests/config/geo-test-servers-static.php.xml");

        let server_config =
            SpeedTestServersConfig::parse_with_config(config_str, &spt_config).unwrap();
        assert!(server_config.servers.iter().all(|s| s.id != 5905));
        assert!(server_config.servers.len() > 5);
        let server = server_config.servers.get(1).unwrap();
        assert!(!server.url.is_empty());
        assert!(!server.country.is_empty());
    }

    #[test]
    fn test_fastest_server() {
        let spt_config = sample_spt_config();
        let config_str = include_str!("../tests/config/geo-test-servers-static.php.xml");

        let config = SpeedTestServersConfig::parse_with_config(config_str, &spt_config).unwrap();
        let closest_server = &config.servers_sorted_by_distance(&spt_config)[0];
        assert_eq!("Los Angeles, CA", closest_server.name);
    }
}