test.yml 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896
  1. name: test
  2. on: [push, pull_request]
  3. defaults:
  4. run:
  5. shell: bash -euv -o pipefail {0}
  6. env:
  7. CFLAGS: -Werror
  8. MAKEFLAGS: -j
  9. TESTFLAGS: -k
  10. BENCHFLAGS:
  11. jobs:
  12. # run tests
  13. test:
  14. runs-on: ubuntu-latest
  15. strategy:
  16. fail-fast: false
  17. matrix:
  18. arch: [x86_64, thumb, mips, powerpc]
  19. steps:
  20. - uses: actions/checkout@v4
  21. - name: install
  22. run: |
  23. # need a few things
  24. sudo apt-get update -qq
  25. sudo apt-get install -qq gcc python3 python3-pip
  26. pip3 install toml
  27. gcc --version
  28. python3 --version
  29. # cross-compile with ARM Thumb (32-bit, little-endian)
  30. - name: install-thumb
  31. if: ${{matrix.arch == 'thumb'}}
  32. run: |
  33. sudo apt-get install -qq \
  34. gcc-arm-linux-gnueabi \
  35. libc6-dev-armel-cross \
  36. qemu-user
  37. echo "CC=arm-linux-gnueabi-gcc -mthumb --static" >> $GITHUB_ENV
  38. echo "EXEC=qemu-arm" >> $GITHUB_ENV
  39. arm-linux-gnueabi-gcc --version
  40. qemu-arm -version
  41. # cross-compile with MIPS (32-bit, big-endian)
  42. - name: install-mips
  43. if: ${{matrix.arch == 'mips'}}
  44. run: |
  45. sudo apt-get install -qq \
  46. gcc-mips-linux-gnu \
  47. libc6-dev-mips-cross \
  48. qemu-user
  49. echo "CC=mips-linux-gnu-gcc --static" >> $GITHUB_ENV
  50. echo "EXEC=qemu-mips" >> $GITHUB_ENV
  51. mips-linux-gnu-gcc --version
  52. qemu-mips -version
  53. # cross-compile with PowerPC (32-bit, big-endian)
  54. - name: install-powerpc
  55. if: ${{matrix.arch == 'powerpc'}}
  56. run: |
  57. sudo apt-get install -qq \
  58. gcc-powerpc-linux-gnu \
  59. libc6-dev-powerpc-cross \
  60. qemu-user
  61. echo "CC=powerpc-linux-gnu-gcc --static" >> $GITHUB_ENV
  62. echo "EXEC=qemu-ppc" >> $GITHUB_ENV
  63. powerpc-linux-gnu-gcc --version
  64. qemu-ppc -version
  65. # does littlefs compile?
  66. - name: test-build
  67. run: |
  68. make clean
  69. make build
  70. # make sure example can at least compile
  71. - name: test-example
  72. run: |
  73. make clean
  74. sed -n '/``` c/,/```/{/```/d; p}' README.md > test.c
  75. CFLAGS="$CFLAGS \
  76. -Duser_provided_block_device_read=NULL \
  77. -Duser_provided_block_device_prog=NULL \
  78. -Duser_provided_block_device_erase=NULL \
  79. -Duser_provided_block_device_sync=NULL \
  80. -include stdio.h" \
  81. make all
  82. rm test.c
  83. # run the tests!
  84. - name: test
  85. run: |
  86. make clean
  87. make test
  88. # collect coverage info
  89. #
  90. # Note the goal is to maximize coverage in the small, easy-to-run
  91. # tests, so we intentionally exclude more aggressive powerloss testing
  92. # from coverage results
  93. - name: cov
  94. if: ${{matrix.arch == 'x86_64'}}
  95. run: |
  96. make lfs.cov.csv
  97. ./scripts/cov.py -u lfs.cov.csv
  98. mkdir -p cov
  99. cp lfs.cov.csv cov/cov.csv
  100. # find compile-time measurements
  101. - name: sizes
  102. run: |
  103. make clean
  104. CFLAGS="$CFLAGS \
  105. -DLFS_NO_ASSERT \
  106. -DLFS_NO_DEBUG \
  107. -DLFS_NO_WARN \
  108. -DLFS_NO_ERROR" \
  109. make lfs.code.csv lfs.data.csv lfs.stack.csv lfs.structs.csv
  110. ./scripts/structs.py -u lfs.structs.csv
  111. ./scripts/summary.py lfs.code.csv lfs.data.csv lfs.stack.csv \
  112. -bfunction \
  113. -fcode=code_size \
  114. -fdata=data_size \
  115. -fstack=stack_limit --max=stack_limit
  116. mkdir -p sizes
  117. cp lfs.code.csv sizes/${{matrix.arch}}.code.csv
  118. cp lfs.data.csv sizes/${{matrix.arch}}.data.csv
  119. cp lfs.stack.csv sizes/${{matrix.arch}}.stack.csv
  120. cp lfs.structs.csv sizes/${{matrix.arch}}.structs.csv
  121. - name: sizes-readonly
  122. run: |
  123. make clean
  124. CFLAGS="$CFLAGS \
  125. -DLFS_NO_ASSERT \
  126. -DLFS_NO_DEBUG \
  127. -DLFS_NO_WARN \
  128. -DLFS_NO_ERROR \
  129. -DLFS_READONLY" \
  130. make lfs.code.csv lfs.data.csv lfs.stack.csv lfs.structs.csv
  131. ./scripts/structs.py -u lfs.structs.csv
  132. ./scripts/summary.py lfs.code.csv lfs.data.csv lfs.stack.csv \
  133. -bfunction \
  134. -fcode=code_size \
  135. -fdata=data_size \
  136. -fstack=stack_limit --max=stack_limit
  137. mkdir -p sizes
  138. cp lfs.code.csv sizes/${{matrix.arch}}-readonly.code.csv
  139. cp lfs.data.csv sizes/${{matrix.arch}}-readonly.data.csv
  140. cp lfs.stack.csv sizes/${{matrix.arch}}-readonly.stack.csv
  141. cp lfs.structs.csv sizes/${{matrix.arch}}-readonly.structs.csv
  142. - name: sizes-threadsafe
  143. run: |
  144. make clean
  145. CFLAGS="$CFLAGS \
  146. -DLFS_NO_ASSERT \
  147. -DLFS_NO_DEBUG \
  148. -DLFS_NO_WARN \
  149. -DLFS_NO_ERROR \
  150. -DLFS_THREADSAFE" \
  151. make lfs.code.csv lfs.data.csv lfs.stack.csv lfs.structs.csv
  152. ./scripts/structs.py -u lfs.structs.csv
  153. ./scripts/summary.py lfs.code.csv lfs.data.csv lfs.stack.csv \
  154. -bfunction \
  155. -fcode=code_size \
  156. -fdata=data_size \
  157. -fstack=stack_limit --max=stack_limit
  158. mkdir -p sizes
  159. cp lfs.code.csv sizes/${{matrix.arch}}-threadsafe.code.csv
  160. cp lfs.data.csv sizes/${{matrix.arch}}-threadsafe.data.csv
  161. cp lfs.stack.csv sizes/${{matrix.arch}}-threadsafe.stack.csv
  162. cp lfs.structs.csv sizes/${{matrix.arch}}-threadsafe.structs.csv
  163. - name: sizes-multiversion
  164. run: |
  165. make clean
  166. CFLAGS="$CFLAGS \
  167. -DLFS_NO_ASSERT \
  168. -DLFS_NO_DEBUG \
  169. -DLFS_NO_WARN \
  170. -DLFS_NO_ERROR \
  171. -DLFS_MULTIVERSION" \
  172. make lfs.code.csv lfs.data.csv lfs.stack.csv lfs.structs.csv
  173. ./scripts/structs.py -u lfs.structs.csv
  174. ./scripts/summary.py lfs.code.csv lfs.data.csv lfs.stack.csv \
  175. -bfunction \
  176. -fcode=code_size \
  177. -fdata=data_size \
  178. -fstack=stack_limit --max=stack_limit
  179. mkdir -p sizes
  180. cp lfs.code.csv sizes/${{matrix.arch}}-multiversion.code.csv
  181. cp lfs.data.csv sizes/${{matrix.arch}}-multiversion.data.csv
  182. cp lfs.stack.csv sizes/${{matrix.arch}}-multiversion.stack.csv
  183. cp lfs.structs.csv sizes/${{matrix.arch}}-multiversion.structs.csv
  184. - name: sizes-migrate
  185. run: |
  186. make clean
  187. CFLAGS="$CFLAGS \
  188. -DLFS_NO_ASSERT \
  189. -DLFS_NO_DEBUG \
  190. -DLFS_NO_WARN \
  191. -DLFS_NO_ERROR \
  192. -DLFS_MIGRATE" \
  193. make lfs.code.csv lfs.data.csv lfs.stack.csv lfs.structs.csv
  194. ./scripts/structs.py -u lfs.structs.csv
  195. ./scripts/summary.py lfs.code.csv lfs.data.csv lfs.stack.csv \
  196. -bfunction \
  197. -fcode=code_size \
  198. -fdata=data_size \
  199. -fstack=stack_limit --max=stack_limit
  200. mkdir -p sizes
  201. cp lfs.code.csv sizes/${{matrix.arch}}-migrate.code.csv
  202. cp lfs.data.csv sizes/${{matrix.arch}}-migrate.data.csv
  203. cp lfs.stack.csv sizes/${{matrix.arch}}-migrate.stack.csv
  204. cp lfs.structs.csv sizes/${{matrix.arch}}-migrate.structs.csv
  205. - name: sizes-error-asserts
  206. run: |
  207. make clean
  208. CFLAGS="$CFLAGS \
  209. -DLFS_NO_DEBUG \
  210. -DLFS_NO_WARN \
  211. -DLFS_NO_ERROR \
  212. -D'LFS_ASSERT(test)=do {if(!(test)) {return -1;}} while(0)'" \
  213. make lfs.code.csv lfs.data.csv lfs.stack.csv lfs.structs.csv
  214. ./scripts/structs.py -u lfs.structs.csv
  215. ./scripts/summary.py lfs.code.csv lfs.data.csv lfs.stack.csv \
  216. -bfunction \
  217. -fcode=code_size \
  218. -fdata=data_size \
  219. -fstack=stack_limit --max=stack_limit
  220. mkdir -p sizes
  221. cp lfs.code.csv sizes/${{matrix.arch}}-error-asserts.code.csv
  222. cp lfs.data.csv sizes/${{matrix.arch}}-error-asserts.data.csv
  223. cp lfs.stack.csv sizes/${{matrix.arch}}-error-asserts.stack.csv
  224. cp lfs.structs.csv sizes/${{matrix.arch}}-error-asserts.structs.csv
  225. # create size statuses
  226. - name: upload-sizes
  227. uses: actions/upload-artifact@v4
  228. with:
  229. name: sizes-${{matrix.arch}}
  230. path: sizes
  231. - name: status-sizes
  232. run: |
  233. mkdir -p status
  234. for f in $(shopt -s nullglob ; echo sizes/*.csv)
  235. do
  236. # skip .data.csv as it should always be zero
  237. [[ $f == *.data.csv ]] && continue
  238. export STEP="sizes$(echo $f \
  239. | sed -n 's/[^-.]*-\([^.]*\)\..*csv/-\1/p')"
  240. export CONTEXT="sizes (${{matrix.arch}}$(echo $f \
  241. | sed -n 's/[^-.]*-\([^.]*\)\..*csv/, \1/p')) / $(echo $f \
  242. | sed -n 's/[^.]*\.\(.*\)\.csv/\1/p')"
  243. export PREV="$(curl -sS \
  244. "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/status/master`
  245. `?per_page=100" \
  246. | jq -re 'select(.sha != env.GITHUB_SHA) | .statuses[]
  247. | select(.context == env.CONTEXT).description
  248. | capture("(?<prev>[0-9∞]+)").prev' \
  249. || echo 0)"
  250. export DESCRIPTION="$(./scripts/summary.py $f --max=stack_limit -Y \
  251. | awk '
  252. NR==2 {$1=0; printf "%s B",$NF}
  253. NR==2 && ENVIRON["PREV"]+0 != 0 {
  254. printf " (%+.1f%%)",100*($NF-ENVIRON["PREV"])/ENVIRON["PREV"]
  255. }')"
  256. jq -n '{
  257. state: "success",
  258. context: env.CONTEXT,
  259. description: env.DESCRIPTION,
  260. target_job: "${{github.job}} (${{matrix.arch}})",
  261. target_step: env.STEP,
  262. }' | tee status/$(basename $f .csv).json
  263. done
  264. - name: upload-status-sizes
  265. uses: actions/upload-artifact@v4
  266. with:
  267. name: status-sizes-${{matrix.arch}}
  268. path: status
  269. retention-days: 1
  270. # create cov statuses
  271. - name: upload-cov
  272. if: ${{matrix.arch == 'x86_64'}}
  273. uses: actions/upload-artifact@v4
  274. with:
  275. name: cov
  276. path: cov
  277. - name: status-cov
  278. if: ${{matrix.arch == 'x86_64'}}
  279. run: |
  280. mkdir -p status
  281. f=cov/cov.csv
  282. for s in lines branches
  283. do
  284. export STEP="cov"
  285. export CONTEXT="cov / $s"
  286. export PREV="$(curl -sS \
  287. "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/status/master`
  288. `?per_page=100" \
  289. | jq -re 'select(.sha != env.GITHUB_SHA) | .statuses[]
  290. | select(.context == env.CONTEXT).description
  291. | capture("(?<prev_a>[0-9]+)/(?<prev_b>[0-9]+)")
  292. | 100*((.prev_a|tonumber) / (.prev_b|tonumber))' \
  293. || echo 0)"
  294. export DESCRIPTION="$(./scripts/cov.py -u $f -f$s -Y \
  295. | awk -F '[ /%]+' -v s=$s '
  296. NR==2 {$1=0; printf "%d/%d %s",$2,$3,s}
  297. NR==2 && ENVIRON["PREV"]+0 != 0 {
  298. printf " (%+.1f%%)",$4-ENVIRON["PREV"]
  299. }')"
  300. jq -n '{
  301. state: "success",
  302. context: env.CONTEXT,
  303. description: env.DESCRIPTION,
  304. target_job: "${{github.job}} (${{matrix.arch}})",
  305. target_step: env.STEP,
  306. }' | tee status/$(basename $f .csv)-$s.json
  307. done
  308. - name: upload-status-cov
  309. if: ${{matrix.arch == 'x86_64'}}
  310. uses: actions/upload-artifact@v4
  311. with:
  312. name: status-cov
  313. path: status
  314. retention-days: 1
  315. # run as many exhaustive tests as fits in GitHub's time limits
  316. #
  317. # this grows exponentially, so it doesn't turn out to be that many
  318. test-pls:
  319. runs-on: ubuntu-latest
  320. strategy:
  321. fail-fast: false
  322. matrix:
  323. pls: [1, 2]
  324. steps:
  325. - uses: actions/checkout@v4
  326. - name: install
  327. run: |
  328. # need a few things
  329. sudo apt-get update -qq
  330. sudo apt-get install -qq gcc python3 python3-pip
  331. pip3 install toml
  332. gcc --version
  333. python3 --version
  334. - name: test-pls
  335. if: ${{matrix.pls <= 1}}
  336. run: |
  337. TESTFLAGS="$TESTFLAGS -P${{matrix.pls}}" make test
  338. # >=2pls takes multiple days to run fully, so we can only
  339. # run a subset of tests, these are the most important
  340. - name: test-limited-pls
  341. if: ${{matrix.pls > 1}}
  342. run: |
  343. TESTFLAGS="$TESTFLAGS -P${{matrix.pls}} test_dirs test_relocations" \
  344. make test
  345. # run with LFS_NO_INTRINSICS to make sure that works
  346. test-no-intrinsics:
  347. runs-on: ubuntu-latest
  348. steps:
  349. - uses: actions/checkout@v4
  350. - name: install
  351. run: |
  352. # need a few things
  353. sudo apt-get update -qq
  354. sudo apt-get install -qq gcc python3 python3-pip
  355. pip3 install toml
  356. gcc --version
  357. python3 --version
  358. - name: test-no-intrinsics
  359. run: |
  360. CFLAGS="$CFLAGS -DLFS_NO_INTRINSICS" make test
  361. # run with all trace options enabled to at least make sure these
  362. # all compile
  363. test-yes-trace:
  364. runs-on: ubuntu-latest
  365. steps:
  366. - uses: actions/checkout@v4
  367. - name: install
  368. run: |
  369. # need a few things
  370. sudo apt-get update -qq
  371. sudo apt-get install -qq gcc python3 python3-pip
  372. pip3 install toml
  373. gcc --version
  374. python3 --version
  375. - name: test-yes-trace
  376. run: |
  377. CFLAGS="$CFLAGS \
  378. -DLFS_YES_TRACE \
  379. -DLFS_RAMBD_YES_TRACE \
  380. -DLFS_FILEBD_YES_TRACE \
  381. -DLFS_RAMBD_YES_TRACE" \
  382. make test
  383. # run LFS_MULTIVERSION tests
  384. test-multiversion:
  385. runs-on: ubuntu-latest
  386. steps:
  387. - uses: actions/checkout@v4
  388. - name: install
  389. run: |
  390. # need a few things
  391. sudo apt-get update -qq
  392. sudo apt-get install -qq gcc python3 python3-pip
  393. pip3 install toml
  394. gcc --version
  395. python3 --version
  396. - name: test-multiversion
  397. run: |
  398. CFLAGS="$CFLAGS -DLFS_MULTIVERSION" make test
  399. # run tests on the older version lfs2.0
  400. test-lfs2_0:
  401. runs-on: ubuntu-latest
  402. steps:
  403. - uses: actions/checkout@v4
  404. - name: install
  405. run: |
  406. # need a few things
  407. sudo apt-get update -qq
  408. sudo apt-get install -qq gcc python3 python3-pip
  409. pip3 install toml
  410. gcc --version
  411. python3 --version
  412. - name: test-lfs2_0
  413. run: |
  414. CFLAGS="$CFLAGS -DLFS_MULTIVERSION" \
  415. TESTFLAGS="$TESTFLAGS -DDISK_VERSION=0x00020000" \
  416. make test
  417. # run under Valgrind to check for memory errors
  418. test-valgrind:
  419. runs-on: ubuntu-latest
  420. steps:
  421. - uses: actions/checkout@v4
  422. - name: install
  423. run: |
  424. # need a few things
  425. sudo apt-get update -qq
  426. sudo apt-get install -qq gcc python3 python3-pip valgrind
  427. pip3 install toml
  428. gcc --version
  429. python3 --version
  430. valgrind --version
  431. # Valgrind takes a while with diminishing value, so only test
  432. # on one geometry
  433. - name: test-valgrind
  434. run: |
  435. TESTFLAGS="$TESTFLAGS --valgrind --context=1024 -Gdefault -Pnone" \
  436. make test
  437. # test that compilation is warning free under clang
  438. # run with Clang, mostly to check for Clang-specific warnings
  439. test-clang:
  440. runs-on: ubuntu-latest
  441. steps:
  442. - uses: actions/checkout@v4
  443. - name: install
  444. run: |
  445. # need a few things
  446. sudo apt-get install -qq clang python3 python3-pip
  447. pip3 install toml
  448. clang --version
  449. python3 --version
  450. - name: test-clang
  451. run: |
  452. # override CFLAGS since Clang does not support -fcallgraph-info
  453. # and -ftrack-macro-expansions
  454. make \
  455. CC=clang \
  456. CFLAGS="$CFLAGS -MMD -g3 -I. -std=c99 -Wall -Wextra -pedantic" \
  457. test
  458. # run benchmarks
  459. #
  460. # note there's no real benefit to running these on multiple archs
  461. bench:
  462. runs-on: ubuntu-latest
  463. steps:
  464. - uses: actions/checkout@v4
  465. - name: install
  466. run: |
  467. # need a few things
  468. sudo apt-get update -qq
  469. sudo apt-get install -qq gcc python3 python3-pip valgrind
  470. pip3 install toml
  471. gcc --version
  472. python3 --version
  473. valgrind --version
  474. - name: bench
  475. run: |
  476. make bench
  477. # find bench results
  478. make lfs.bench.csv
  479. ./scripts/summary.py lfs.bench.csv \
  480. -bsuite \
  481. -freaded=bench_readed \
  482. -fproged=bench_proged \
  483. -ferased=bench_erased
  484. mkdir -p bench
  485. cp lfs.bench.csv bench/bench.csv
  486. # find perfbd results
  487. make lfs.perfbd.csv
  488. ./scripts/perfbd.py -u lfs.perfbd.csv
  489. mkdir -p bench
  490. cp lfs.perfbd.csv bench/perfbd.csv
  491. # create bench statuses
  492. - name: upload-bench
  493. uses: actions/upload-artifact@v4
  494. with:
  495. name: bench
  496. path: bench
  497. - name: status-bench
  498. run: |
  499. mkdir -p status
  500. f=bench/bench.csv
  501. for s in readed proged erased
  502. do
  503. export STEP="bench"
  504. export CONTEXT="bench / $s"
  505. export PREV="$(curl -sS \
  506. "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/status/master`
  507. `?per_page=100" \
  508. | jq -re 'select(.sha != env.GITHUB_SHA) | .statuses[]
  509. | select(.context == env.CONTEXT).description
  510. | capture("(?<prev>[0-9]+)").prev' \
  511. || echo 0)"
  512. export DESCRIPTION="$(./scripts/summary.py $f -f$s=bench_$s -Y \
  513. | awk '
  514. NR==2 {$1=0; printf "%s B",$NF}
  515. NR==2 && ENVIRON["PREV"]+0 != 0 {
  516. printf " (%+.1f%%)",100*($NF-ENVIRON["PREV"])/ENVIRON["PREV"]
  517. }')"
  518. jq -n '{
  519. state: "success",
  520. context: env.CONTEXT,
  521. description: env.DESCRIPTION,
  522. target_job: "${{github.job}}",
  523. target_step: env.STEP,
  524. }' | tee status/$(basename $f .csv)-$s.json
  525. done
  526. - name: upload-status-bench
  527. uses: actions/upload-artifact@v4
  528. with:
  529. name: status-bench
  530. path: status
  531. retention-days: 1
  532. # run compatibility tests using the current master as the previous version
  533. test-compat:
  534. runs-on: ubuntu-latest
  535. steps:
  536. - uses: actions/checkout@v4
  537. if: ${{github.event_name == 'pull_request'}}
  538. # checkout the current pr target into lfsp
  539. - uses: actions/checkout@v4
  540. if: ${{github.event_name == 'pull_request'}}
  541. with:
  542. ref: ${{github.event.pull_request.base.ref}}
  543. path: lfsp
  544. - name: install
  545. if: ${{github.event_name == 'pull_request'}}
  546. run: |
  547. # need a few things
  548. sudo apt-get update -qq
  549. sudo apt-get install -qq gcc python3 python3-pip
  550. pip3 install toml
  551. gcc --version
  552. python3 --version
  553. # adjust prefix of lfsp
  554. - name: changeprefix
  555. if: ${{github.event_name == 'pull_request'}}
  556. run: |
  557. ./scripts/changeprefix.py lfs lfsp lfsp/*.h lfsp/*.c
  558. - name: test-compat
  559. if: ${{github.event_name == 'pull_request'}}
  560. run: |
  561. TESTS=tests/test_compat.toml \
  562. SRC="$(find . lfsp -name '*.c' -maxdepth 1 \
  563. -and -not -name '*.t.*' \
  564. -and -not -name '*.b.*')" \
  565. CFLAGS="-DLFSP=lfsp/lfsp.h" \
  566. make test
  567. # self-host with littlefs-fuse for a fuzz-like test
  568. fuse:
  569. runs-on: ubuntu-latest
  570. if: ${{!endsWith(github.ref, '-prefix')}}
  571. steps:
  572. - uses: actions/checkout@v4
  573. - name: install
  574. run: |
  575. # need a few things
  576. sudo apt-get update -qq
  577. sudo apt-get install -qq gcc python3 python3-pip libfuse-dev
  578. sudo pip3 install toml
  579. gcc --version
  580. python3 --version
  581. fusermount -V
  582. - uses: actions/checkout@v4
  583. with:
  584. repository: littlefs-project/littlefs-fuse
  585. ref: v2
  586. path: littlefs-fuse
  587. - name: setup
  588. run: |
  589. # copy our new version into littlefs-fuse
  590. rm -rf littlefs-fuse/littlefs/*
  591. cp -r $(git ls-tree --name-only HEAD) littlefs-fuse/littlefs
  592. # setup disk for littlefs-fuse
  593. mkdir mount
  594. LOOP=$(sudo losetup -f)
  595. sudo chmod a+rw $LOOP
  596. dd if=/dev/zero bs=512 count=128K of=disk
  597. losetup $LOOP disk
  598. echo "LOOP=$LOOP" >> $GITHUB_ENV
  599. - name: test
  600. run: |
  601. # self-host test
  602. make -C littlefs-fuse
  603. littlefs-fuse/lfs --format $LOOP
  604. littlefs-fuse/lfs $LOOP mount
  605. ls mount
  606. mkdir mount/littlefs
  607. cp -r $(git ls-tree --name-only HEAD) mount/littlefs
  608. cd mount/littlefs
  609. stat .
  610. ls -flh
  611. make -B test-runner
  612. make -B test
  613. # test migration using littlefs-fuse
  614. migrate:
  615. runs-on: ubuntu-latest
  616. if: ${{!endsWith(github.ref, '-prefix')}}
  617. steps:
  618. - uses: actions/checkout@v4
  619. - name: install
  620. run: |
  621. # need a few things
  622. sudo apt-get update -qq
  623. sudo apt-get install -qq gcc python3 python3-pip libfuse-dev
  624. sudo pip3 install toml
  625. gcc --version
  626. python3 --version
  627. fusermount -V
  628. - uses: actions/checkout@v4
  629. with:
  630. repository: littlefs-project/littlefs-fuse
  631. ref: v2
  632. path: v2
  633. - uses: actions/checkout@v4
  634. with:
  635. repository: littlefs-project/littlefs-fuse
  636. ref: v1
  637. path: v1
  638. - name: setup
  639. run: |
  640. # copy our new version into littlefs-fuse
  641. rm -rf v2/littlefs/*
  642. cp -r $(git ls-tree --name-only HEAD) v2/littlefs
  643. # setup disk for littlefs-fuse
  644. mkdir mount
  645. LOOP=$(sudo losetup -f)
  646. sudo chmod a+rw $LOOP
  647. dd if=/dev/zero bs=512 count=128K of=disk
  648. losetup $LOOP disk
  649. echo "LOOP=$LOOP" >> $GITHUB_ENV
  650. - name: test
  651. run: |
  652. # compile v1 and v2
  653. make -C v1
  654. make -C v2
  655. # run self-host test with v1
  656. v1/lfs --format $LOOP
  657. v1/lfs $LOOP mount
  658. ls mount
  659. mkdir mount/littlefs
  660. cp -r $(git ls-tree --name-only HEAD) mount/littlefs
  661. cd mount/littlefs
  662. stat .
  663. ls -flh
  664. make -B test-runner
  665. make -B test
  666. # attempt to migrate
  667. cd ../..
  668. fusermount -u mount
  669. v2/lfs --migrate $LOOP
  670. v2/lfs $LOOP mount
  671. # run self-host test with v2 right where we left off
  672. ls mount
  673. cd mount/littlefs
  674. stat .
  675. ls -flh
  676. make -B test-runner
  677. make -B test
  678. # status related tasks that run after tests
  679. status:
  680. runs-on: ubuntu-latest
  681. needs: [test, bench]
  682. steps:
  683. - uses: actions/checkout@v4
  684. if: ${{github.event_name == 'pull_request'}}
  685. - name: install
  686. if: ${{github.event_name == 'pull_request'}}
  687. run: |
  688. # need a few things
  689. sudo apt-get install -qq gcc python3 python3-pip
  690. pip3 install toml
  691. gcc --version
  692. python3 --version
  693. - uses: actions/download-artifact@v4
  694. if: ${{github.event_name == 'pull_request'}}
  695. continue-on-error: true
  696. with:
  697. pattern: '{sizes,sizes-*}'
  698. merge-multiple: true
  699. path: sizes
  700. - uses: actions/download-artifact@v4
  701. if: ${{github.event_name == 'pull_request'}}
  702. continue-on-error: true
  703. with:
  704. pattern: '{cov,cov-*}'
  705. merge-multiple: true
  706. path: cov
  707. - uses: actions/download-artifact@v4
  708. if: ${{github.event_name == 'pull_request'}}
  709. continue-on-error: true
  710. with:
  711. pattern: '{bench,bench-*}'
  712. merge-multiple: true
  713. path: bench
  714. # try to find results from tests
  715. - name: create-table
  716. if: ${{github.event_name == 'pull_request'}}
  717. run: |
  718. # compare against pull-request target
  719. curl -sS \
  720. "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/status/`
  721. `${{github.event.pull_request.base.ref}}`
  722. `?per_page=100" \
  723. | jq -re 'select(.sha != env.GITHUB_SHA) | .statuses[]' \
  724. >> prev-status.json \
  725. || true
  726. # build table for GitHub
  727. declare -A table
  728. # sizes table
  729. i=0
  730. j=0
  731. for c in "" readonly threadsafe multiversion migrate error-asserts
  732. do
  733. # per-config results
  734. c_or_default=${c:-default}
  735. c_camel=${c_or_default^}
  736. table[$i,$j]=$c_camel
  737. ((j+=1))
  738. for s in code stack structs
  739. do
  740. f=sizes/thumb${c:+-$c}.$s.csv
  741. [ -e $f ] && table[$i,$j]=$( \
  742. export PREV="$(jq -re '
  743. select(.context == "'"sizes (thumb${c:+, $c}) / $s"'").description
  744. | capture("(?<prev>[0-9∞]+)").prev' \
  745. prev-status.json || echo 0)"
  746. ./scripts/summary.py $f --max=stack_limit -Y \
  747. | awk '
  748. NR==2 {$1=0; printf "%s B",$NF}
  749. NR==2 && ENVIRON["PREV"]+0 != 0 {
  750. printf " (%+.1f%%)",100*($NF-ENVIRON["PREV"])/ENVIRON["PREV"]
  751. }' \
  752. | sed -e 's/ /\&nbsp;/g')
  753. ((j+=1))
  754. done
  755. ((j=0, i+=1))
  756. done
  757. # coverage table
  758. i=0
  759. j=4
  760. for s in lines branches
  761. do
  762. table[$i,$j]=${s^}
  763. ((j+=1))
  764. f=cov/cov.csv
  765. [ -e $f ] && table[$i,$j]=$( \
  766. export PREV="$(jq -re '
  767. select(.context == "'"cov / $s"'").description
  768. | capture("(?<prev_a>[0-9]+)/(?<prev_b>[0-9]+)")
  769. | 100*((.prev_a|tonumber) / (.prev_b|tonumber))' \
  770. prev-status.json || echo 0)"
  771. ./scripts/cov.py -u $f -f$s -Y \
  772. | awk -F '[ /%]+' -v s=$s '
  773. NR==2 {$1=0; printf "%d/%d %s",$2,$3,s}
  774. NR==2 && ENVIRON["PREV"]+0 != 0 {
  775. printf " (%+.1f%%)",$4-ENVIRON["PREV"]
  776. }' \
  777. | sed -e 's/ /\&nbsp;/g')
  778. ((j=4, i+=1))
  779. done
  780. # benchmark table
  781. i=3
  782. j=4
  783. for s in readed proged erased
  784. do
  785. table[$i,$j]=${s^}
  786. ((j+=1))
  787. f=bench/bench.csv
  788. [ -e $f ] && table[$i,$j]=$( \
  789. export PREV="$(jq -re '
  790. select(.context == "'"bench / $s"'").description
  791. | capture("(?<prev>[0-9]+)").prev' \
  792. prev-status.json || echo 0)"
  793. ./scripts/summary.py $f -f$s=bench_$s -Y \
  794. | awk '
  795. NR==2 {$1=0; printf "%s B",$NF}
  796. NR==2 && ENVIRON["PREV"]+0 != 0 {
  797. printf " (%+.1f%%)",100*($NF-ENVIRON["PREV"])/ENVIRON["PREV"]
  798. }' \
  799. | sed -e 's/ /\&nbsp;/g')
  800. ((j=4, i+=1))
  801. done
  802. # build the actual table
  803. echo "| | Code | Stack | Structs | | Coverage |" >> table.txt
  804. echo "|:--|-----:|------:|--------:|:--|---------:|" >> table.txt
  805. for ((i=0; i<6; i++))
  806. do
  807. echo -n "|" >> table.txt
  808. for ((j=0; j<6; j++))
  809. do
  810. echo -n " " >> table.txt
  811. [[ i -eq 2 && j -eq 5 ]] && echo -n "**Benchmarks**" >> table.txt
  812. echo -n "${table[$i,$j]:-}" >> table.txt
  813. echo -n " |" >> table.txt
  814. done
  815. echo >> table.txt
  816. done
  817. cat table.txt
  818. # create a bot comment for successful runs on pull requests
  819. - name: create-comment
  820. if: ${{github.event_name == 'pull_request'}}
  821. run: |
  822. touch comment.txt
  823. echo "<details>" >> comment.txt
  824. echo "<summary>" >> comment.txt
  825. echo "Tests passed ✓, `
  826. `Code: $(awk 'NR==3 {print $4}' table.txt || true), `
  827. `Stack: $(awk 'NR==3 {print $6}' table.txt || true), `
  828. `Structs: $(awk 'NR==3 {print $8}' table.txt || true)" \
  829. >> comment.txt
  830. echo "</summary>" >> comment.txt
  831. echo >> comment.txt
  832. [ -e table.txt ] && cat table.txt >> comment.txt
  833. echo >> comment.txt
  834. echo "</details>" >> comment.txt
  835. cat comment.txt
  836. mkdir -p comment
  837. jq -n --rawfile comment comment.txt '{
  838. number: ${{github.event.number}},
  839. body: $comment,
  840. }' | tee comment/comment.json
  841. - name: upload-comment
  842. uses: actions/upload-artifact@v4
  843. with:
  844. name: comment
  845. path: comment
  846. retention-days: 1