harn-stdlib 0.8.26

Embedded Harn standard library source catalog
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

import { filter_nil } from "std/collections"

/**
 * runtime_task.
 *
 * @effects: [host]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: runtime_task()
 */
pub fn runtime_task() -> string {
  return host_call("runtime.task", {}) ?? ""
}

/**
 * runtime_pipeline_input.
 *
 * @effects: [host]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: runtime_pipeline_input()
 */
pub fn runtime_pipeline_input() {
  return host_call("runtime.pipeline_input", {})
}

/**
 * runtime_dry_run.
 *
 * @effects: [host]
 * @allocation: stack-only
 * @errors: []
 * @api_stability: stable
 * @example: runtime_dry_run()
 */
pub fn runtime_dry_run() -> bool {
  return host_call("runtime.dry_run", {}) ?? false
}

/**
 * runtime_approved_plan.
 *
 * @effects: [host]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: runtime_approved_plan()
 */
pub fn runtime_approved_plan() -> string {
  return host_call("runtime.approved_plan", {}) ?? ""
}

/**
 * process_run.
 *
 * @effects: [host]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: process_run(argv, options)
 */
pub fn process_run(argv: list<string>, options = nil) {
  let opts = options ?? {}
  return host_call("process.exec", filter_nil(opts + {mode: "argv", argv: argv})) ?? {}
}

/**
 * process_shell.
 *
 * @effects: [host]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: process_shell(command, options)
 */
pub fn process_shell(command: string, options = nil) {
  let opts = options ?? {}
  return host_call("process.exec", filter_nil(opts + {mode: "shell", command: command})) ?? {}
}

/**
 * process_result_text.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: process_result_text(result)
 */
pub fn process_result_text(result: dict) -> string {
  let stdout = result?.stdout ?? ""
  let stderr = result?.stderr ?? ""
  if stdout && stderr {
    return "${stdout}\n${stderr}"
  }
  if stdout {
    return stdout
  }
  if stderr {
    return stderr
  }
  return result?.combined ?? result?.inline_output ?? ""
}

/**
 * process_result_success.
 *
 * @effects: []
 * @allocation: stack-only
 * @errors: []
 * @api_stability: stable
 * @example: process_result_success(result)
 */
pub fn process_result_success(result: dict) -> bool {
  if result?.success != nil {
    return result?.success ? true : false
  }
  let status = result?.status ?? "completed"
  let exit_code = result?.exit_code ?? -1
  return status == "completed" && exit_code == 0
}

/**
 * shell_quote.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: shell_quote(value)
 */
pub fn shell_quote(value) -> string {
  return "'" + to_string(value ?? "").replace("'", "'\"'\"'") + "'"
}

/**
 * interaction_ask.
 *
 * @effects: [host]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: interaction_ask(question)
 */
pub fn interaction_ask(question) -> string {
  return host_call("interaction.ask", {question: question}) ?? ""
}

/**
 * interaction_ask_with_kind.
 *
 * @effects: [host]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: interaction_ask_with_kind(question, kind)
 */
pub fn interaction_ask_with_kind(question, kind) -> string {
  return host_call("interaction.ask", {question: question, type: kind}) ?? ""
}

/**
 * record_run_metadata.
 *
 * @effects: [host]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: record_run_metadata(run, workflow_name)
 */
pub fn record_run_metadata(run, workflow_name) {
  if run?.path {
    host_call(
      "runtime.record_run",
      {
        workflow: workflow_name,
        path: run?.path,
        status: run?.status ?? "",
        fixture_type: run?.run?.replay_fixture?._type,
        usage: run?.usage,
        persisted_path: run?.persisted_path,
        summary: transcript_summary(run?.transcript),
        transcript_state: run?.transcript?.state ?? "",
        message_count: len(transcript_messages(run?.transcript)),
        event_count: len(transcript_events(run?.transcript)),
        asset_count: len(transcript_assets(run?.transcript)),
      },
    )
  }
}