netget-tool 0.3.4

Network protocol stubbing toolkit: ~280 protocol servers and clients whose responses come from an LLM, a script, a static rule or a person.
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
//! ZooKeeper client protocol actions

use crate::llm::actions::{
    client_trait::{Client, ClientActionResult},
    protocol_trait::Protocol,
    ActionDefinition, Parameter,
};
use crate::protocol::EventType;
use crate::state::app_state::AppState;
use anyhow::{anyhow, Context, Result};
use serde_json::json;
use std::sync::LazyLock;

// Event type constants
pub static ZOOKEEPER_CLIENT_CONNECTED_EVENT: LazyLock<EventType> = LazyLock::new(|| {
    EventType::new(
        "zookeeper_connected",
        "ZooKeeper client connected to server",
        json!({
            "type": "wait_for_more"
        }),
    )
});

pub static ZOOKEEPER_CLIENT_DATA_RECEIVED_EVENT: LazyLock<EventType> = LazyLock::new(|| {
    EventType::new(
        "zookeeper_data_received",
        "ZooKeeper client received data from server",
        json!({
            "type": "wait_for_more"
        }),
    )
    .with_parameters(vec![
        Parameter {
            name: "path".to_string(),
            type_hint: "string".to_string(),
            description: "ZNode path".to_string(),
            required: true,
        },
        Parameter {
            name: "data".to_string(),
            type_hint: "string".to_string(),
            description: "ZNode data".to_string(),
            required: true,
        },
        Parameter {
            name: "version".to_string(),
            type_hint: "integer".to_string(),
            description: "Data version".to_string(),
            required: true,
        },
    ])
});

/// Raised after a write verb (`create_znode`, `set_data`, `delete_znode`) completes.
///
/// The read verbs have their own events - `zookeeper_data_received` for `get_data`,
/// `zookeeper_children_received` for `get_children` - and neither fits a write: there is no
/// data and no child list to report, only the fact that ZooKeeper accepted the change and
/// the version it now holds. Without this the three write verbs completed silently and the
/// model was never told whether its own write landed.
pub static ZOOKEEPER_CLIENT_OPERATION_COMPLETE_EVENT: LazyLock<EventType> = LazyLock::new(|| {
    EventType::new(
        "zookeeper_operation_complete",
        "A ZooKeeper write (create/set_data/delete) completed",
        json!({
            "type": "wait_for_more"
        }),
    )
    .with_parameters(vec![
        Parameter {
            name: "operation".to_string(),
            type_hint: "string".to_string(),
            description: "The verb that completed: create, set_data or delete".to_string(),
            required: true,
        },
        Parameter {
            name: "path".to_string(),
            type_hint: "string".to_string(),
            description: "ZNode path the operation was requested for".to_string(),
            required: true,
        },
        Parameter {
            name: "created_path".to_string(),
            type_hint: "string".to_string(),
            description: "Path ZooKeeper actually created (create only; a sequential node                           gets a suffix)"
                .to_string(),
            required: false,
        },
        Parameter {
            name: "version".to_string(),
            type_hint: "integer".to_string(),
            description: "Data version after the write (set_data only)".to_string(),
            required: false,
        },
    ])
});

pub static ZOOKEEPER_CLIENT_CHILDREN_RECEIVED_EVENT: LazyLock<EventType> = LazyLock::new(|| {
    EventType::new(
        "zookeeper_children_received",
        "ZooKeeper client received children list",
        json!({
            "type": "disconnect"
        }),
    )
    .with_parameters(vec![
        Parameter {
            name: "path".to_string(),
            type_hint: "string".to_string(),
            description: "ZNode path".to_string(),
            required: true,
        },
        Parameter {
            name: "children".to_string(),
            type_hint: "array".to_string(),
            description: "Array of child node names".to_string(),
            required: true,
        },
    ])
});

/// ZooKeeper client protocol implementation
pub struct ZookeeperClientProtocol;

impl ZookeeperClientProtocol {
    pub fn new() -> Self {
        Self
    }
}

// Implement Protocol trait (common functionality)
impl Protocol for ZookeeperClientProtocol {
    fn get_async_actions(&self, _state: &AppState) -> Vec<ActionDefinition> {
        vec![
            ActionDefinition {
                name: "create_znode".to_string(),
                description: "Create a ZNode at the specified path".to_string(),
                parameters: vec![
                    Parameter {
                        name: "path".to_string(),
                        type_hint: "string".to_string(),
                        description: "ZNode path".to_string(),
                        required: true,
                    },
                    Parameter {
                        name: "data".to_string(),
                        type_hint: "string".to_string(),
                        description: "ZNode data".to_string(),
                        required: true,
                    },
                ],
                example: json!({
                    "type": "create_znode",
                    "path": "/myapp/config",
                    "data": "configuration_data"
                }),
                log_template: None,
            },
            ActionDefinition {
                name: "get_data".to_string(),
                description: "Get data from a ZNode".to_string(),
                parameters: vec![Parameter {
                    name: "path".to_string(),
                    type_hint: "string".to_string(),
                    description: "ZNode path".to_string(),
                    required: true,
                }],
                example: json!({
                    "type": "get_data",
                    "path": "/myapp/config"
                }),
                log_template: None,
            },
            ActionDefinition {
                name: "set_data".to_string(),
                description: "Set data for a ZNode".to_string(),
                parameters: vec![
                    Parameter {
                        name: "path".to_string(),
                        type_hint: "string".to_string(),
                        description: "ZNode path".to_string(),
                        required: true,
                    },
                    Parameter {
                        name: "data".to_string(),
                        type_hint: "string".to_string(),
                        description: "New ZNode data".to_string(),
                        required: true,
                    },
                ],
                example: json!({
                    "type": "set_data",
                    "path": "/myapp/config",
                    "data": "new_configuration_data"
                }),
                log_template: None,
            },
            ActionDefinition {
                name: "delete_znode".to_string(),
                description: "Delete a ZNode at the given path. ZooKeeper refuses to delete a \
                              node that still has children, so remove those first; watches \
                              registered on the node fire as a result."
                    .to_string(),
                parameters: vec![Parameter {
                    name: "path".to_string(),
                    type_hint: "string".to_string(),
                    description: "ZNode path".to_string(),
                    required: true,
                }],
                example: json!({
                    "type": "delete_znode",
                    "path": "/myapp/config"
                }),
                log_template: None,
            },
            ActionDefinition {
                name: "get_children".to_string(),
                description: "Get children of a ZNode".to_string(),
                parameters: vec![Parameter {
                    name: "path".to_string(),
                    type_hint: "string".to_string(),
                    description: "ZNode path".to_string(),
                    required: true,
                }],
                example: json!({
                    "type": "get_children",
                    "path": "/myapp"
                }),
                log_template: None,
            },
        ]
    }

    fn get_sync_actions(&self) -> Vec<ActionDefinition> {
        vec![
            ActionDefinition {
                name: "wait_for_more".to_string(),
                description: "Wait for more events from ZooKeeper".to_string(),
                parameters: vec![],
                example: json!({
                    "type": "wait_for_more"
                }),
                log_template: None,
            },
            ActionDefinition {
                name: "disconnect".to_string(),
                description: "Disconnect from the ZooKeeper server".to_string(),
                parameters: vec![],
                example: json!({
                    "type": "disconnect"
                }),
                log_template: None,
            },
        ]
    }

    fn protocol_name(&self) -> &'static str {
        "ZooKeeper"
    }

    fn get_event_types(&self) -> Vec<EventType> {
        vec![
            EventType::new(
                "zookeeper_connected",
                "Triggered when ZooKeeper client connects",
                json!({"type": "placeholder", "event_id": "zookeeper_connected"}),
            ),
            EventType::new(
                "zookeeper_data_received",
                "Triggered when ZooKeeper client receives data",
                json!({"type": "placeholder", "event_id": "zookeeper_data_received"}),
            ),
            EventType::new(
                "zookeeper_children_received",
                "Triggered when ZooKeeper client receives children list",
                json!({"type": "placeholder", "event_id": "zookeeper_children_received"}),
            ),
            EventType::new(
                "zookeeper_operation_complete",
                "Triggered when a ZooKeeper write (create/set_data/delete) completes",
                json!({"type": "placeholder", "event_id": "zookeeper_operation_complete"}),
            ),
        ]
    }

    fn stack_name(&self) -> &'static str {
        "ETH>IP>TCP>ZooKeeper"
    }

    fn keywords(&self) -> Vec<&'static str> {
        vec![
            "zookeeper",
            "zk",
            "zookeeper client",
            "connect to zookeeper",
        ]
    }

    fn metadata(&self) -> crate::protocol::metadata::ProtocolMetadataV2 {
        use crate::protocol::metadata::{DevelopmentState, ProtocolMetadataV2};

        ProtocolMetadataV2::builder()
            .state(DevelopmentState::Experimental)
            .implementation("zookeeper-async v5.0 client library")
            .llm_control("ZNode operations (create, get, set, delete, getChildren)")
            .e2e_testing(
                "tests/client/zookeeper/command_channel_test.rs drives a real zookeeper-async \
                 session against NetGet's own ZooKeeper server on 127.0.0.1",
            )
            .notes(
                "Real zookeeper-async session: create/get_data/set_data/delete/get_children \
                 run against the server and raise events. No watch mechanism - watches are \
                 registered as `false` on every call, so the client polls rather than being \
                 notified.",
            )
            .build()
    }

    fn description(&self) -> &'static str {
        "ZooKeeper client for distributed coordination"
    }

    fn example_prompt(&self) -> &'static str {
        "Connect to ZooKeeper at localhost:2181 and read /config/database"
    }

    fn group_name(&self) -> &'static str {
        "Database"
    }
    fn get_startup_examples(&self) -> crate::llm::actions::StartupExamples {
        use crate::llm::actions::StartupExamples;
        use serde_json::json;

        StartupExamples::new(
            // LLM mode: LLM controls ZooKeeper operations
            json!({
                "type": "open_client",
                "remote_addr": "localhost:2181",
                "base_stack": "zookeeper",
                "instruction": "Read configuration from /myapp/config and list its children"
            }),
            // Script mode: Code-based znode operations
            json!({
                "type": "open_client",
                "remote_addr": "localhost:2181",
                "base_stack": "zookeeper",
                "event_handlers": [{
                    "event_pattern": "zookeeper_data_received",
                    "handler": {
                        "type": "script",
                        "language": "python",
                        "code": "<zookeeper_client_handler>"
                    }
                }]
            }),
            // Static mode: Fixed znode operations
            json!({
                "type": "open_client",
                "remote_addr": "localhost:2181",
                "base_stack": "zookeeper",
                "event_handlers": [
                    {
                        "event_pattern": "zookeeper_connected",
                        "handler": {
                            "type": "static",
                            "actions": [{
                                "type": "get_data",
                                "path": "/myapp/config"
                            }]
                        }
                    },
                    {
                        "event_pattern": "zookeeper_data_received",
                        "handler": {
                            "type": "static",
                            "actions": [{
                                "type": "disconnect"
                            }]
                        }
                    }
                ]
            }),
        )
    }
}

// Implement Client trait (client-specific functionality)
impl Client for ZookeeperClientProtocol {
    fn connect(
        &self,
        ctx: crate::protocol::ConnectContext,
    ) -> std::pin::Pin<
        Box<dyn std::future::Future<Output = anyhow::Result<std::net::SocketAddr>> + Send>,
    > {
        Box::pin(async move {
            use crate::client::zookeeper::ZookeeperClient;

            ZookeeperClient::connect_with_llm_actions(
                ctx.remote_addr,
                ctx.llm_client,
                ctx.state,
                ctx.status_tx,
                ctx.client_id,
            )
            .await
        })
    }

    fn execute_action(&self, action: serde_json::Value) -> Result<ClientActionResult> {
        let action_type = action
            .get("type")
            .and_then(|v| v.as_str())
            .context("Missing 'type' field in action")?;

        match action_type {
            "create_znode" => {
                let path = action
                    .get("path")
                    .and_then(|v| v.as_str())
                    .context("Missing path")?;
                let data = action
                    .get("data")
                    .and_then(|v| v.as_str())
                    .context("Missing data")?;

                Ok(ClientActionResult::Custom {
                    name: "create_znode".to_string(),
                    data: json!({
                        "path": path,
                        "data": data
                    }),
                })
            }
            "get_data" => {
                let path = action
                    .get("path")
                    .and_then(|v| v.as_str())
                    .context("Missing path")?;

                Ok(ClientActionResult::Custom {
                    name: "get_data".to_string(),
                    data: json!({
                        "path": path
                    }),
                })
            }
            "set_data" => {
                let path = action
                    .get("path")
                    .and_then(|v| v.as_str())
                    .context("Missing path")?;
                let data = action
                    .get("data")
                    .and_then(|v| v.as_str())
                    .context("Missing data")?;

                Ok(ClientActionResult::Custom {
                    name: "set_data".to_string(),
                    data: json!({
                        "path": path,
                        "data": data
                    }),
                })
            }
            "delete_znode" => {
                let path = action
                    .get("path")
                    .and_then(|v| v.as_str())
                    .context("Missing path")?;

                Ok(ClientActionResult::Custom {
                    name: "delete_znode".to_string(),
                    data: json!({
                        "path": path
                    }),
                })
            }
            "get_children" => {
                let path = action
                    .get("path")
                    .and_then(|v| v.as_str())
                    .context("Missing path")?;

                Ok(ClientActionResult::Custom {
                    name: "get_children".to_string(),
                    data: json!({
                        "path": path
                    }),
                })
            }
            "wait_for_more" => Ok(ClientActionResult::WaitForMore),
            "disconnect" => Ok(ClientActionResult::Disconnect),
            _ => Err(anyhow!("Unknown action type: {}", action_type)),
        }
    }
}