host-identity 1.1.1

Stable, collision-resistant host identity resolution across platforms, container runtimes, cloud providers, and Kubernetes
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

//! `DigitalOcean` Droplet metadata identity source.
//!
//! `GET http://169.254.169.254/metadata/v1/id` — plaintext droplet ID, no
//! special headers required.
//!
//! Authoritative reference:
//! [DigitalOcean: Droplet metadata API reference](https://docs.digitalocean.com/reference/api/metadata-api/)
//! — documents the `169.254.169.254` link-local endpoint, the `/metadata/v1/`
//! tree, and the `/metadata/v1/id` plaintext numeric droplet ID.

use crate::source::SourceKind;
use crate::sources::cloud::{CloudEndpoint, CloudMetadata};

/// `DigitalOcean` Droplet numeric ID.
pub type DigitalOceanMetadata<T> = CloudMetadata<DigitalOceanEndpoint, T>;

/// Endpoint descriptor for [`DigitalOceanMetadata`].
pub struct DigitalOceanEndpoint;

impl CloudEndpoint for DigitalOceanEndpoint {
    const DEBUG_NAME: &'static str = "DigitalOceanMetadata";
    const DEFAULT_BASE_URL: &'static str = "http://169.254.169.254";
    const PATH: &'static str = "/metadata/v1/id";
    const KIND: SourceKind = SourceKind::DigitalOceanMetadata;

    fn headers() -> &'static [(&'static str, &'static str)] {
        &[]
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::source::Source;
    use crate::sources::cloud::test_support::{StubTransport, ok, status};

    #[test]
    fn happy_path_returns_droplet_id() {
        let source = DigitalOceanMetadata::new(StubTransport::new(vec![ok("1234567")]));
        let probe = source.probe().unwrap().expect("should produce a probe");
        assert_eq!(probe.kind(), SourceKind::DigitalOceanMetadata);
        assert_eq!(probe.value(), "1234567");
    }

    #[test]
    fn hits_expected_path_with_no_extra_headers() {
        let (stub, transport) = StubTransport::shared(vec![ok("42")]);
        let source = DigitalOceanMetadata::with_base_url(transport, "http://do.test");
        assert!(source.probe().unwrap().is_some());

        let requests = stub.requests();
        assert_eq!(requests.len(), 1);
        let (method, uri, headers) = &requests[0];
        assert_eq!(method, http::Method::GET);
        assert_eq!(uri, "http://do.test/metadata/v1/id");
        assert!(headers.is_empty());
    }

    #[test]
    fn non_2xx_returns_none() {
        let source = DigitalOceanMetadata::new(StubTransport::new(vec![status(404)]));
        assert!(source.probe().unwrap().is_none());
    }
}