[aiconformance]: better output of shell commands in markdown

Author: justinsb

tests/e2e/scenarios/ai-conformance/validators/exec.go

@@ -30,7 +30,7 @@ func (h *ValidatorHarness) ShellExec(shellCommand string) *CommandResult {
 	var stderr bytes.Buffer
 	cmd.Stderr = &stderr
 
-	h.Logf("ShellExec(%q)", shellCommand)
+	h.output.BeforeShellExec(shellCommand)
 	err := cmd.Run()
 
 	result := &CommandResult{
@@ -39,7 +39,7 @@ func (h *ValidatorHarness) ShellExec(shellCommand string) *CommandResult {
 		err:    err,
 	}
 
-	h.output.OnShellExec(shellCommand, result)
+	h.output.AfterShellExec(shellCommand, result)
 
 	if err != nil {
 		h.Logf("Command failed: %q", shellCommand)

tests/e2e/scenarios/ai-conformance/validators/markdown.go

@@ -101,17 +101,22 @@ func (o *MarkdownOutput) renderHTML() error {
 	return nil
 }
 
-// OnShellExec writes the executed shell command and its output to the markdown file in a formatted code block.
-func (o *MarkdownOutput) OnShellExec(command string, results *CommandResult) {
+// BeforeShellExec writes the executed shell command to the markdown file in a formatted code block.
+func (o *MarkdownOutput) BeforeShellExec(command string) {
 	o.printf("```bash\n> %s\n", command)
+	o.printf("```\n")
+}
+
+// AfterShellExec writes the result of the executed shell command to the markdown file in a formatted code block.
+func (o *MarkdownOutput) AfterShellExec(command string, results *CommandResult) {
+	o.printf("```bash")
 	o.printf("%s", results.Stdout())
 	o.printf("%s", results.Stderr())
+	o.printf("```\n")
 
 	if results.Err() != nil {
 		o.printf("Error:\n```\n%v\n```\n", results.Err())
 	}
-
-	o.printf("```\n")
 }
 
 // printf is a helper method to write formatted text to the markdown file.

tests/e2e/scenarios/ai-conformance/validators/output.go

@@ -27,8 +27,10 @@ type OutputSink interface {
 	// WriteText writes a text string to the output sink.
 	WriteText(text string)
 
-	// OnShellExec is called when a shell command is executed, with the command, its stdout, stderr, and any error that occurred.
-	OnShellExec(command string, results *CommandResult)
+	// BeforeShellExec is called when a shell command is about to be executed, with the command string.
+	BeforeShellExec(command string)
+	// AfterShellExec is called when a shell command has been executed, with the command, its stdout, stderr, and any error that occurred.
+	AfterShellExec(command string, results *CommandResult)
 
 	// Success indicates a successful check, allowing the output sink to format it accordingly.
 	Success(text string)