-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathaction.yml
391 lines (333 loc) · 16.7 KB
/
action.yml
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
name: ESBMC verification action
author: Joshua Hines
description: Verifies C and C++ which are either specified or have a git diff, using the ESBMC.
branding:
color: green
icon: check-square
inputs:
esbmc-options:
description: Options to be used with ESBMC.
required: false
default: --incremental-bmc --quiet --color --verbosity 4
files:
description: Newline-separated file paths to be used as input for the ESBMC. If none are given, this action will run based off the git diff.
required: false
default: ""
create-artifact:
description: Whether or not to create an artifact containing ESBMC output files (y/n).
required: false
default: n
artifact-retention-days:
description: Number of days after which any produced artifacts will expire. Minimum 1 day. Maximum 90 days unless changed from the repository settings page.
required: false
default: "0"
artifact-compression-level:
description: The level of compression for Zlib to be applied to the artifact archive. Can take values from 0 to 9.
required: false
default: "6"
checkout:
description: Whether or not to automatically checkout the repository (y/n).
required: false
default: y
fail-fast:
description: Whether or not to exit the action and mark it as failed if there is an ESBMC verification failure (y/n).
required: false
default: n
display-overhead:
description: Whether or not to display the CPU seconds and peak memory usage of each run of ESBMC (y/n).
required: false
default: n
outputs:
artifact-id:
description: The GitHub ID of the created artifact.
value: ${{ steps.upload-artifact.outputs.artifact-id }}
artifact-url:
description: The URL to download the artifact zip files.
value: ${{ steps.upload-artifact.outputs.artifact-url }}
runs:
using: 'composite'
steps:
# Checkout with a fetch-depth of 2 to allow for checking git diff with previous commit.
- name: checkout
uses: actions/checkout@v4
with:
fetch-depth: 2
if: ${{ inputs.checkout == 'y' || inputs.checkout == 'Y' }}
# If files are given as input, check that they exist and exit if they don't.
- run: |
echo "----------------------------------------------------"
echo "Using specified files"
echo "..."
while IFS= read -r path || [[ -n "$path" ]]
do
if [[ ! -f "$path" ]]; then
echo "ERROR: The file $path can not be found."
exit 1
fi
done < <(printf '%s' "${{ inputs.files }}")
echo "Files verified, continuing to install."
shell: bash
if: ${{ inputs.files != '' }}
- run: |
echo "----------------------------------------------------"
echo "No files specified. Using git diff."
shell: bash
if: ${{ inputs.files == '' }}
# Get the names of all C and C++ files which have a git diff between the current and previous commit.
- name: Get Git Diff
id: get-diff
run: |
if [[ $(git rev-list --count HEAD) -le 1 ]]; then
echo "error: commit depth is less than 2. This could be because no checkout of fetch-depth 2 has occured (make sure that the 'checkout' input is set to 'y') or the current branch has a depth of less than 2."
fi
echo "FILE_DIFF<<EOF" >> "$GITHUB_ENV"
echo "$(git diff --name-only --diff-filter=ACMR HEAD HEAD^ | grep -E '\.c|\.cpp')" >> "$GITHUB_ENV"
echo "EOF" >> "$GITHUB_ENV"
shell: bash
if: ${{ inputs.files == '' }}
- run: |
echo "No git diff in files of the correct type have been detected."
echo "----------------------------------------------------"
shell: bash
if: ${{ env.FILE_DIFF == '' && inputs.files == '' }}
- name: Install ESBMC Linux
run: |
wget -q -O esbmc.zip https://github.com/esbmc/esbmc/releases/download/v7.6.1/release-ubuntu-latest.zip
unzip -o -q esbmc.zip
chmod +x $GITHUB_WORKSPACE/bin/esbmc
shell: bash
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && runner.os == 'Linux' }}
- name: Install ESBMC Windows
run: |
if ( ( "${{ inputs.display-overhead }}" -eq 'y' ) -or ( "${{ inputs.display-overhead }}" -eq 'Y' ) ) {
choco install -y -r --no-progress ptime
}
$client = new-object System.Net.WebClient
$client.DownloadFile("https://github.com/esbmc/esbmc/releases/download/v7.6.1/release-windows-latest.zip", "$env:GITHUB_WORKSPACE\esbmc.zip")
unzip -o -q esbmc.zip
chmod +x $env:GITHUB_WORKSPACE/bin/
shell: powershell
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && runner.os == 'Windows' }}
# Extract the file name given in the ESBMC options before removing spaces from them and saving them to environment variables.
- name: Get output file name Linux and Windows
run: |
export LANG=C.UTF-8
shopt -s extglob
options="${{ inputs.esbmc-options }}"
if [[ $options =~ "--output-goto" ]]; then
goto_filename=`echo "$options" | grep -oP "(--output-goto\s+\K[^\']\S*(?=\s*?))|(--output-goto\s+'\K.*(?='))"`
echo "GOTO_FILENAME=$goto_filename" >> "$GITHUB_ENV"
nospace_goto_filename="${goto_filename//+([[:space:]])/}"
echo "NOSPACE_GOTO_FILENAME=$nospace_goto_filename" >> "$GITHUB_ENV"
fi
if [[ $options =~ "--file-output" ]]; then
output_filename=`echo "$options" | grep -oP "(--file-output\s+\K[^\']\S*(?=\s*?))|(--file-output\s+'\K.*(?='))"`
echo "OUTPUT_FILENAME=$output_filename" >> "$GITHUB_ENV"
nospace_output_filename="${output_filename//+([[:space:]])/}"
echo "NOSPACE_OUTPUT_FILENAME=$nospace_output_filename" >> "$GITHUB_ENV"
fi
if [[ $options =~ "--witness-output" ]]; then
witness_filename=`echo "$options" | grep -oP "(--witness-output\s+\K[^\']\S*(?=\s*?))|(--witness-output\s+'\K.*(?='))"`
echo "WITNESS_FILENAME=$witness_filename" >> "$GITHUB_ENV"
nospace_witness_filename="${witness_filename//+([[:space:]])/}"
echo "NOSPACE_WITNESS_FILENAME=$nospace_witness_filename" >> "$GITHUB_ENV"
fi
if [[ $options =~ "--generate-html-output" ]]; then
html_filename=`echo "$options" | grep -oP "(--generate-html-output\s+\K[^\']\S*(?=\s*?))|(--generate-html-output\s+'\K.*(?='))"`
echo "HTML_FILENAME=$html_filename" >> "$GITHUB_ENV"
nospace_html_filename="${html_filename//+([[:space:]])/}"
echo "NOSPACE_HTML_FILENAME=$nospace_html_filename" >> "$GITHUB_ENV"
fi
shell: bash
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && (runner.os == 'Linux' || runner.os == 'Windows') }}
# Run ESBMC on each C and C++ file given as input or in the FILE_DIFF variable, making uniquely named output files for each ESBMC run if neccessary.
- name: Run ESBMC Linux
run: |
if [[ "${{ inputs.files }}" == '' ]]; then
run_files="${{ env.FILE_DIFF }}"
else
run_files="${{ inputs.files }}"
fi
echo "----------------------------------------------------"
echo "Running ESBMC for Linux."
while IFS= read -r path || [[ -n $path ]]
do
echo "----------------------------------------------------"
echo "Running ESBMC on $path"
if [[ "${{ inputs.fail-fast }}" == 'y' || "${{ inputs.fail-fast }}" == 'Y' ]]; then
if [[ "${{ inputs.display-overhead }}" == 'y' || "${{ inputs.display-overhead }}" == 'Y' ]]; then
\time -f "CPU time: %Us\t\t\tPeak memory usage: %Mkb" $GITHUB_WORKSPACE/bin/esbmc ${{ inputs.esbmc-options }} "$path"
else
$GITHUB_WORKSPACE/bin/esbmc ${{ inputs.esbmc-options }} "$path"
fi
else
if [[ "${{ inputs.display-overhead }}" == 'y' || "${{ inputs.display-overhead }}" == 'Y' ]]; then
\time -f "CPU time: %Us\t\t\tPeak memory usage: %Mkb" $GITHUB_WORKSPACE/bin/esbmc ${{ inputs.esbmc-options }} "$path" $FAIL_FAST || true
else
$GITHUB_WORKSPACE/bin/esbmc ${{ inputs.esbmc-options }} "$path" $FAIL_FAST || true
fi
fi
if [[ -f "$GOTO_FILENAME" ]]; then
mv "$GOTO_FILENAME" "$path""__""$NOSPACE_GOTO_FILENAME"
fi
if [[ -f "$OUTPUT_FILENAME" ]]; then
mv "$OUTPUT_FILENAME" "$path""__""$NOSPACE_OUTPUT_FILENAME"
fi
if [[ -f "$WITNESS_FILENAME" ]]; then
mv "$WITNESS_FILENAME" "$path""__""$NOSPACE_WITNESS_FILENAME"
fi
if [[ -f "$HTML_FILENAME" ]]; then
mv "$HTML_FILENAME" "$path""__""$NOSPACE_HTML_FILENAME"
fi
done < <(printf '%s' "$run_files")
echo "----------------------------------------------------"
echo "Finished verifying files."
echo "----------------------------------------------------"
shell: bash
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && runner.os == 'Linux' }}
# Run ESBMC on each C and C++ file given as input or in the FILE_DIFF variable, making uniquely named output files for each ESBMC run if neccessary.
- name: Run ESBMC Windows
run: |
if [[ "${{ inputs.files }}" == '' ]]; then
run_files="${{ env.FILE_DIFF }}"
else
run_files="${{ inputs.files }}"
fi
timer=""
if [[ "${{ inputs.display-overhead }}" == 'y' || "${{ inputs.display-overhead }}" == 'Y' ]]; then
timer="ptime"
fi
echo "----------------------------------------------------"
echo "Running ESBMC for Windows."
while IFS= read -r path || [[ -n $path ]]
do
echo "----------------------------------------------------"
echo "Running ESBMC on $path"
if [[ "${{ inputs.fail-fast }}" == 'y' || "${{ inputs.fail-fast }}" == 'Y' ]]; then
$timer $GITHUB_WORKSPACE/bin/esbmc ${{ inputs.esbmc-options }} "$path"
else
$timer $GITHUB_WORKSPACE/bin/esbmc ${{ inputs.esbmc-options }} "$path" || true
fi
if [[ -f "$GOTO_FILENAME" ]]; then
mv "$GOTO_FILENAME" "$path""__""$NOSPACE_GOTO_FILENAME"
fi
if [[ -f "$OUTPUT_FILENAME" ]]; then
mv "$OUTPUT_FILENAME" "$path""__""$NOSPACE_OUTPUT_FILENAME"
fi
if [[ -f "$WITNESS_FILENAME" ]]; then
mv "$WITNESS_FILENAME" "$path""__""$NOSPACE_WITNESS_FILENAME"
fi
if [[ -f "$HTML_FILENAME" ]]; then
mv "$HTML_FILENAME" "$path""__""$NOSPACE_HTML_FILENAME"
fi
done < <(printf '%s' "$run_files")
echo "----------------------------------------------------"
echo "Finished verifying files."
echo "----------------------------------------------------"
shell: bash
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && runner.os == 'Windows' }}
- name: Install ESBMC macOS
run: |
brew install -q boost
if [[ "${{ inputs.display-overhead }}" == 'y' || "${{ inputs.display-overhead }}" == 'Y' ]]; then
brew install -q gnu-time
fi
wget -q -O esbmc.zip https://github.com/esbmc/esbmc/releases/download/v7.6/release-macos-latest.zip
unzip -o -q esbmc.zip
chmod +x $GITHUB_WORKSPACE/bin/esbmc
shell: bash
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && runner.os == 'macOS' }}
# Extract the file name given in the ESBMC options before removing spaces from them and saving them to environment variables (macOS).
# Install grep via Brew to allow for Perl-regex support.
- name: Get output file name macOS
run: |
shopt -s extglob
if [[ "${{ inputs.esbmc-options }}" =~ "--output-goto" || "${{ inputs.esbmc-options }}" =~ "--file-output" || "${{ inputs.esbmc-options }}" =~ "--witness-output" ]]; then
brew install -q grep
fi
options="${{ inputs.esbmc-options }}"
if [[ $options =~ "--output-goto" ]]; then
goto_filename=`echo "$options" | ggrep -oP "(--output-goto\s+\K[^\']\S*(?=\s*?))|(--output-goto\s+'\K.*(?='))"`
echo "GOTO_FILENAME=$goto_filename" >> "$GITHUB_ENV"
nospace_goto_filename="${goto_filename//+([[:space:]])/}"
echo "NOSPACE_GOTO_FILENAME=$nospace_goto_filename" >> "$GITHUB_ENV"
fi
if [[ $options =~ "--file-output" ]]; then
output_filename=`echo "$options" | ggrep -oP "(--file-output\s+\K[^\']\S*(?=\s*?))|(--file-output\s+'\K.*(?='))"`
echo "OUTPUT_FILENAME=$output_filename" >> "$GITHUB_ENV"
nospace_output_filename="${output_filename//+([[:space:]])/}"
echo "NOSPACE_OUTPUT_FILENAME=$nospace_output_filename" >> "$GITHUB_ENV"
fi
if [[ $options =~ "--witness-output" ]]; then
witness_filename=`echo "$options" | ggrep -oP "(--witness-output\s+\K[^\']\S*(?=\s*?))|(--witness-output\s+'\K.*(?='))"`
echo "WITNESS_FILENAME=$witness_filename" >> "$GITHUB_ENV"
nospace_witness_filename="${witness_filename//+([[:space:]])/}"
echo "NOSPACE_WITNESS_FILENAME=$nospace_witness_filename" >> "$GITHUB_ENV"
fi
if [[ $options =~ "--generate-html-output" ]]; then
html_filename=`echo "$options" | ggrep -oP "(--generate-html-output\s+\K[^\']\S*(?=\s*?))|(--generate-html-output\s+'\K.*(?='))"`
echo "HTML_FILENAME=$html_filename" >> "$GITHUB_ENV"
nospace_html_filename="${html_filename//+([[:space:]])/}"
echo "NOSPACE_HTML_FILENAME=$nospace_html_filename" >> "$GITHUB_ENV"
fi
shell: bash
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && runner.os == 'macOS' }}
# Run ESBMC on each C and C++ file given as input or in the FILE_DIFF variable, making uniquely named output files for each ESBMC run if neccessary (macOS).
- name: Run ESBMC macOS
run: |
if [[ "${{ inputs.files }}" == '' ]]; then
run_files="${{ env.FILE_DIFF }}"
else
run_files="${{ inputs.files }}"
fi
echo "----------------------------------------------------"
echo "Running ESBMC for ${{ runner.os }}."
while IFS= read -r path || [[ -n $path ]]
do
echo "----------------------------------------------------"
echo "Running ESBMC on $path"
if [[ "${{ inputs.fail-fast }}" == 'y' || "${{ inputs.fail-fast }}" == 'Y' ]]; then
if [[ "${{ inputs.display-overhead }}" == 'y' || "${{ inputs.display-overhead }}" == 'Y' ]]; then
gtime -f "CPU time: %Us\t\t\tPeak memory usage: %Mkb" $GITHUB_WORKSPACE/bin/esbmc --smtlib --smt-formula-only ${{ inputs.esbmc-options }} "$path"
else
$GITHUB_WORKSPACE/bin/esbmc --smtlib --smt-formula-only ${{ inputs.esbmc-options }} "$path"
fi
else
if [[ "${{ inputs.display-overhead }}" == 'y' || "${{ inputs.display-overhead }}" == 'Y' ]]; then
gtime -f "CPU time: %Us\t\t\tPeak memory usage: %Mkb" $GITHUB_WORKSPACE/bin/esbmc --smtlib --smt-formula-only ${{ inputs.esbmc-options }} "$path" || true
else
$GITHUB_WORKSPACE/bin/esbmc --smtlib --smt-formula-only ${{ inputs.esbmc-options }} "$path" || true
fi
fi
if [[ -f "$GOTO_FILENAME" ]]; then
mv "$GOTO_FILENAME" "$path""__""$NOSPACE_GOTO_FILENAME"
fi
if [[ -f "$OUTPUT_FILENAME" ]]; then
mv "$OUTPUT_FILENAME" "$path""__""$NOSPACE_OUTPUT_FILENAME"
fi
if [[ -f "$WITNESS_FILENAME" ]]; then
mv "$WITNESS_FILENAME" "$path""__""$NOSPACE_WITNESS_FILENAME"
fi
if [[ -f "$HTML_FILENAME" ]]; then
mv "$HTML_FILENAME" "$path""__""$NOSPACE_HTML_FILENAME"
fi
done < <(printf '%s' "$run_files")
echo "----------------------------------------------------"
echo "Finished verifying files."
echo "----------------------------------------------------"
shell: bash
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && runner.os == 'macOS' }}
- name: Upload artifact
id: upload-artifact
uses: actions/upload-artifact@v4
with:
name: esbmc_output
path: |
**/*__${{ env.NOSPACE_GOTO_FILENAME }}
**/*__${{ env.NOSPACE_OUTPUT_FILENAME }}
**/*__${{ env.NOSPACE_WITNESS_FILENAME }}
**/*__${{ env.NOSPACE_HTML_FILENAME }}
if-no-files-found: warn
retention-days: ${{ inputs.artifact-retention-days }}
compression-level: ${{ inputs.artifact-compression-level }}
if: ${{ (env.FILE_DIFF != '' || inputs.files != '') && (inputs.create-artifact == 'y' || inputs.create-artifact == 'Y') }}