hrobot 6.1.0

Unofficial Hetzner Robot API client
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

use hrobot::{
    api::firewall::{Filter, FirewallTemplateConfig, Ipv4Filter, Rule, Rules},
    AsyncRobot,
};
use serial_test::file_serial;
use tracing::info;
use tracing_test::traced_test;

mod common;

#[tokio::test]
#[traced_test]
#[file_serial]
async fn get_firewall() {
    let _ = dotenvy::dotenv().ok();

    let robot = AsyncRobot::default();

    let server_id = common::provisioned_server_id().await;
    let firewall = robot.get_firewall(server_id).await.unwrap();

    info!("{firewall:#?}");
}

#[tokio::test]
#[traced_test]
#[file_serial]
async fn list_firewall_templates() {
    let _ = dotenvy::dotenv().ok();

    let robot = crate::AsyncRobot::default();

    let templates = robot.list_firewall_templates().await.unwrap();
    info!("{templates:#?}");
}

#[tokio::test]
#[traced_test]
#[file_serial]
async fn get_firewall_template() {
    let _ = dotenvy::dotenv().ok();

    let robot = crate::AsyncRobot::default();

    let templates = robot.list_firewall_templates().await.unwrap();
    info!("{templates:#?}");

    if let Some(template_ref) = templates.first() {
        let template = robot.get_firewall_template(template_ref.id).await.unwrap();
        info!("{template:#?}");
    }
}

#[tokio::test]
#[traced_test]
#[file_serial]
async fn set_firewall_configuration() {
    let _ = dotenvy::dotenv().ok();

    let robot = crate::AsyncRobot::default();
    let server = common::provisioned_server().await;
    common::wait_firewall_ready(&robot, server.id).await;

    // Fetch the current firewall configuration.
    let original_firewall = robot.get_firewall(server.id).await.unwrap();
    let mut config = original_firewall.config();

    // Apply a new rule
    common::wait_firewall_ready(&robot, server.id).await;
    let allow_1234 =
        Rule::accept("allow 1234").matching(Filter::Ipv4(Ipv4Filter::tcp(None).to_port(1234)));
    config.rules.ingress.push(allow_1234.clone());
    info!("{config:#?}");
    let _ = robot.set_firewall_config(server.id, &config).await.unwrap();

    info!("Waiting for firewall to be applied to {}", server.name);
    common::wait_firewall_ready(&robot, server.id).await;
    let applied_configuration = robot.get_firewall(server.id).await.unwrap();
    assert_eq!(
        applied_configuration.rules.ingress.last(),
        Some(&allow_1234)
    );

    // Revert to the original firewall config.
    let _ = robot
        .set_firewall_config(server.id, &original_firewall.config())
        .await
        .unwrap();
}

#[tokio::test]
#[traced_test]
#[file_serial]
async fn apply_firewall_template() {
    let _ = dotenvy::dotenv().ok();

    let robot = crate::AsyncRobot::default();
    let server = common::provisioned_server().await;
    common::wait_firewall_ready(&robot, server.id).await;

    // Fetch the current firewall configuration.
    let original_firewall = robot.get_firewall(server.id).await.unwrap();
    let config = original_firewall.config();
    info!("{config:#?}");

    // Create a firewall template that mimics the server's current configuration.
    // so as to be as non-disruptive as possible.
    let template = robot
        .create_firewall_template(config.to_template_config("test-template-from-config"))
        .await
        .unwrap();

    let _ = robot
        .apply_firewall_template(server.id, template.id)
        .await
        .unwrap();

    info!(
        "Waiting for firewall template to be applied to {}",
        server.name
    );

    common::wait_firewall_ready(&robot, server.id).await;
    let applied_configuration = robot.get_firewall(server.id).await.unwrap();
    assert_eq!(applied_configuration.rules, config.rules,);
    assert_eq!(applied_configuration.rules, template.rules);

    // Revert to the original firewall config.
    let _ = robot
        .set_firewall_config(server.id, &original_firewall.config())
        .await
        .unwrap();

    // Delete the temporary template.
    robot.delete_firewall_template(template.id).await.unwrap();
}

#[tokio::test]
#[traced_test]
#[file_serial]
async fn delete_firewall() {
    let _ = dotenvy::dotenv().ok();

    let robot = crate::AsyncRobot::default();
    let server = common::provisioned_server().await;
    common::wait_firewall_ready(&robot, server.id).await;

    // Fetch the current firewall configuration.
    let original_firewall = robot.get_firewall(server.id).await.unwrap();
    let original_config = original_firewall.config();
    info!("{original_config:#?}");

    let _ = robot.delete_firewall(server.id).await.unwrap();

    info!("Waiting for firewall to be applied to {}", server.name);

    common::wait_firewall_ready(&robot, server.id).await;
    let applied_configuration = robot.get_firewall(server.id).await.unwrap();
    // For some reason the default firewal has 2 identical "Allow all" rules.
    assert_eq!(applied_configuration.rules.ingress.len(), 2);
    assert_eq!(applied_configuration.rules.egress.len(), 1);

    // Revert to the original firewall config.
    let _ = robot
        .set_firewall_config(server.id, &original_firewall.config())
        .await
        .unwrap();
}

#[tokio::test]
#[traced_test]
#[file_serial]
async fn create_update_delete_firewall_template() {
    let _ = dotenvy::dotenv().ok();

    let robot = crate::AsyncRobot::default();

    let template = robot
        .create_firewall_template(FirewallTemplateConfig {
            name: "Lockdown".to_string(),
            filter_ipv6: false,
            whitelist_hetzner_services: false,
            is_default: false,
            rules: Rules {
                ingress: vec![Rule::discard("Deny in")],
                egress: vec![Rule::discard("Deny out")],
            },
        })
        .await
        .unwrap();

    let _ = robot
        .update_firewall_template(
            template.id,
            FirewallTemplateConfig {
                name: "Come on in".to_string(),
                filter_ipv6: false,
                whitelist_hetzner_services: true,
                is_default: false,
                rules: Rules {
                    ingress: vec![Rule::accept("Allow in")],
                    egress: vec![Rule::accept("Allow out")],
                },
            },
        )
        .await
        .unwrap();

    robot.delete_firewall_template(template.id).await.unwrap();
}