workshop 1.0.19

A tool for presenting programming workshops
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
use crate::{
    ui::tui::{self, screens, widgets::StatusMode},
    Error,
};
use std::path::Path;
use tokio::{
    io::{AsyncBufReadExt, BufReader},
    process::Command,
    sync::mpsc::Sender,
};
use tokio_util::sync::CancellationToken;
use tracing::{debug, error};

/// Result of command execution
#[derive(Debug, Clone)]
pub struct CommandResult {
    pub success: bool,
    pub exit_code: i32,
    pub last_line: String,
}

/// Generic command runner that sends output to the Log screen
#[derive(Clone)]
pub struct CommandRunner {
    event_sender: Sender<screens::Event>,
}

impl CommandRunner {
    /// Create a new CommandRunner
    pub fn new(event_sender: Sender<screens::Event>) -> Self {
        Self { event_sender }
    }

    /// Run a command and stream output to the Log screen
    ///
    /// This function:
    /// - Shows the Log screen when command starts
    /// - Streams stdout to Log screen (bypassing env filter)
    /// - Logs stderr using error!() macro
    /// - Hides Log screen on success, leaves visible on failure
    pub async fn run_command(
        &self,
        cmd: &str,
        args: &[&str],
        working_dir: Option<&std::path::Path>,
        token: &CancellationToken,
        trace: bool,
    ) -> Result<CommandResult, Error> {
        self.run_command_with_env(cmd, args, working_dir, &[], token, trace)
            .await
    }

    /// Run a command with environment variables and stream output to the Log screen
    ///
    /// This function:
    /// - Shows the Log screen when command starts
    /// - Streams stdout to Log screen (bypassing env filter)
    /// - Logs stderr using error!() macro
    /// - Hides Log screen on success, leaves visible on failure
    pub async fn run_command_with_env(
        &self,
        cmd: &str,
        args: &[&str],
        working_dir: Option<&std::path::Path>,
        env_vars: &[(&str, &str)],
        token: &CancellationToken,
        trace: bool,
    ) -> Result<CommandResult, Error> {
        // Build command
        let mut command = Command::new(cmd);
        command.args(args);

        // Set environment variables
        for (key, value) in env_vars {
            debug!("Setting environment variable: {key}={value}");
            command.env(key, value);
        }

        if let Some(dir) = working_dir {
            debug!("Setting working directory: {}", dir.display());
            command.current_dir(dir);
        } else {
            debug!(
                "No working directory specified, using current directory: {}",
                std::env::current_dir().unwrap().display()
            );
        }

        // Send command info to log screen
        let cmd_info = format!("{cmd} {}", args.join(" "));
        debug!("Running command: {cmd_info}");
        self.event_sender
            .send(
                (
                    Some(screens::Screens::Log),
                    tui::Event::CommandStarted(StatusMode::Messages, cmd_info.clone()),
                )
                    .into(),
            )
            .await?;

        // Spawn process with piped stdout/stderr
        let mut child = match command
            .stdout(std::process::Stdio::piped())
            .stderr(std::process::Stdio::piped())
            .spawn()
        {
            Ok(child) => child,
            Err(e) => {
                error!("Failed to spawn command '{cmd}': {e}");
                return Err(Error::Command(format!(
                    "Failed to spawn command '{cmd}': {e}"
                )));
            }
        };

        // Handle stdout
        let stdout = child.stdout.take().unwrap();
        let stdout_reader = BufReader::new(stdout);
        let mut stdout_lines = stdout_reader.lines();

        // Handle stderr
        let stderr = child.stderr.take().unwrap();
        let stderr_reader = BufReader::new(stderr);
        let mut stderr_lines = stderr_reader.lines();

        // Stream output until process completes or is cancelled
        let mut stdout_finished = false;
        let mut stderr_finished = false;
        let mut stdout_line: Option<String> = None;
        let mut stderr_line: Option<String> = None;

        let exit_status = loop {
            tokio::select! {
                // Handle cancellation
                _ = token.cancelled() => {
                    let _ = child.kill().await;
                    return Err(Error::Command("Command cancelled".to_string()));
                }

                // Read stdout line by line
                line = stdout_lines.next_line(), if !stdout_finished => {
                    match line {
                        Ok(Some(line)) => {
                            if let Some(prev_line) = stdout_line.take() {
                                if trace {
                                    self.event_sender
                                        .send((
                                            Some(screens::Screens::Log),
                                            tui::Event::CommandOutput(prev_line, None)
                                        ).into())
                                        .await?;
                                }
                            }
                            stdout_line = Some(line);
                        }
                        Ok(None) => {
                            // EOF on stdout
                            stdout_finished = true;
                        },
                        Err(e) => {
                            error!("Error reading stdout: {}", e);
                            stdout_finished = true;
                        },
                    }
                }

                // Read stderr line by line
                line = stderr_lines.next_line(), if !stderr_finished => {
                    match line {
                        Ok(Some(line)) => {
                            if let Some(prev_line) = stderr_line.take() {
                                if trace {
                                    self.event_sender
                                        .send((
                                            Some(screens::Screens::Log),
                                            tui::Event::CommandOutput(prev_line, None)
                                        ).into())
                                        .await?;
                                }
                            }
                            stderr_line = Some(line);
                        }
                        Ok(None) => {
                            // EOF on stderr
                            stderr_finished = true;
                        },
                        Err(e) => {
                            error!("Error reading stderr: {}", e);
                            stderr_finished = true;
                        },
                    }
                }

                // Wait for process completion
                status = child.wait() => {
                    break status?;
                }
            }
        };

        let success = exit_status.success();
        let exit_code = exit_status.code().unwrap_or(-1);
        let last_line = stdout_line.unwrap_or_else(|| stderr_line.unwrap_or_default());

        let result = CommandResult {
            success,
            exit_code,
            last_line: last_line.clone(),
        };

        Ok(result)
    }

    /// Run docker-compose up -d followed by python check.py
    /// This is a convenience method for lesson solution checking
    pub async fn check_solution(
        &self,
        docker_compose_executable: &str,
        python_executable: &str,
        lesson_dir: &Path,
        token: &CancellationToken,
    ) -> Result<CommandResult, Error> {
        // Calculate PROJECT_ROOT and LESSON_PATH for docker-compose environment
        let (project_root, lesson_path) = self.calculate_docker_env_paths(lesson_dir)?;

        // Set up environment variables for docker-compose
        let env_vars = [
            ("PROJECT_ROOT", project_root.as_str()),
            ("LESSON_PATH", lesson_path.as_str()),
        ];

        // Clean up any previous containers
        self.run_command_with_env(
            docker_compose_executable,
            &[
                "rmi",
                "-f",
                "workshop-lesson",
                "ucw-checker-02-tcp-transport",
                "ucw-checker-03-ping-checkpoint",
                "ucw-checker-04-quic-transport",
                "ucw-checker-05-identify-checkpoint",
                "ucw-checker-06-gossipsub-checkpoint",
                "ucw-checker-07-kademlia-checkpoint",
                "ucw-checker-08-final-checkpoint",
            ],
            Some(lesson_dir),
            &env_vars,
            token,
            false,
        )
        .await?;

        // Clean up any previous containers
        self.run_command_with_env(
            docker_compose_executable,
            &[
                "rm",
                "-f",
                "workshop-lesson",
                "ucw-checker-02-tcp-transport",
                "ucw-checker-03-ping-checkpoint",
                "ucw-checker-04-quic-transport",
                "ucw-checker-05-identify-checkpoint",
                "ucw-checker-06-gossipsub-checkpoint",
                "ucw-checker-07-kademlia-checkpoint",
                "ucw-checker-08-final-checkpoint",
            ],
            Some(lesson_dir),
            &env_vars,
            token,
            false,
        )
        .await?;

        // Clean up all other containers
        self.run_command_with_env(
            docker_compose_executable,
            &["image", "prune", "-a", "-f"],
            Some(lesson_dir),
            &env_vars,
            token,
            false,
        )
        .await?;

        // Clean up any previous networks
        self.run_command_with_env(
            docker_compose_executable,
            &["network", "rm", "-f", "workshop-net"],
            Some(lesson_dir),
            &env_vars,
            token,
            false,
        )
        .await?;

        // Create the network
        self.run_command_with_env(
            docker_compose_executable,
            &[
                "network",
                "create",
                "--driver",
                "bridge",
                "--subnet",
                "172.16.16.0/24",
                "workshop-net",
            ],
            Some(lesson_dir),
            &env_vars,
            token,
            false,
        )
        .await?;

        // Run docker compose up --build
        let docker_result = self
            .run_command_with_env(
                docker_compose_executable.as_ref(),
                &[
                    "compose",
                    "--project-name",
                    "workshop",
                    "up",
                    "--build",
                    "--remove-orphans",
                    "--force-recreate",
                ],
                Some(lesson_dir),
                &env_vars,
                token,
                false,
            )
            .await?;

        if !docker_result.success {
            return Ok(docker_result);
        }

        // Clean up any previous containers
        self.run_command_with_env(
            docker_compose_executable,
            &[
                "rmi",
                "-f",
                "workshop-lesson",
                "ucw-checker-02-tcp-transport",
                "ucw-checker-03-ping-checkpoint",
                "ucw-checker-04-quic-transport",
                "ucw-checker-05-identify-checkpoint",
                "ucw-checker-06-gossipsub-checkpoint",
                "ucw-checker-07-kademlia-checkpoint",
                "ucw-checker-08-final-checkpoint",
            ],
            Some(lesson_dir),
            &env_vars,
            token,
            false,
        )
        .await?;

        // Clean up all other containers
        self.run_command_with_env(
            docker_compose_executable,
            &["prune", "-a", "-f"],
            Some(lesson_dir),
            &env_vars,
            token,
            false,
        )
        .await?;

        // Run python check.py
        self.run_command(
            python_executable.as_ref(),
            &["check.py"],
            Some(lesson_dir),
            token,
            true,
        )
        .await
    }

    /// Run deps.py script for dependency checking
    pub async fn check_dependencies(
        &self,
        python_executable: &str,
        deps_script: &Path,
        token: &CancellationToken,
    ) -> Result<CommandResult, Error> {
        let script_dir = deps_script
            .parent()
            .unwrap_or_else(|| std::path::Path::new("."));

        self.run_command(
            python_executable.as_ref(),
            &[deps_script.to_str().unwrap()],
            Some(script_dir),
            token,
            true,
        )
        .await
    }

    /// Run git to clone a repository to our application data directory
    pub async fn install_workshop(
        &self,
        git_executable: &str,
        repo_url: &str,
        data_dir: &Path,
        token: &CancellationToken,
    ) -> Result<CommandResult, Error> {
        debug!(
            "Running '{} clone {}' into '{}'",
            git_executable,
            repo_url,
            data_dir.display()
        );

        self.run_command(
            git_executable.as_ref(),
            &["clone", "--depth", "1", repo_url],
            Some(data_dir),
            token,
            true,
        )
        .await
    }

    /// Calculate PROJECT_ROOT and LESSON_PATH environment variables for docker-compose
    fn calculate_docker_env_paths(&self, lesson_dir: &Path) -> Result<(String, String), Error> {
        // Find the .workshops directory by going up from lesson_dir
        let mut current = lesson_dir;
        let workshops_dir = loop {
            if current
                .file_name()
                .map(|n| n == ".workshops")
                .unwrap_or(false)
            {
                break current;
            }
            if let Some(parent) = current.parent() {
                current = parent;
            } else {
                return Err(Error::Command(
                    "Could not find .workshops directory".to_string(),
                ));
            }
        };

        // PROJECT_ROOT is the parent of .workshops directory
        let project_root = workshops_dir
            .parent()
            .ok_or_else(|| Error::Command("Could not find PROJECT_ROOT directory".to_string()))?;

        // LESSON_PATH is the relative path from PROJECT_ROOT to lesson_dir
        let lesson_path = lesson_dir
            .strip_prefix(project_root)
            .map_err(|_| Error::Command("Could not calculate LESSON_PATH".to_string()))?;

        Ok((
            project_root.to_string_lossy().to_string(),
            lesson_path.to_string_lossy().to_string(),
        ))
    }
}