Skip to content

Commit 0c806ff

Browse files
authored
add docker-helper.sh to lift examples using pac-nix docker image (#514)
this introduces the src/test/make/docker-helper.sh script which is a (hopefully) developer-friendly method for lifting examples in a Docker container provided by [pac-nix][]. to ensure reproducibility, this uses an x86_64-linux docker container with cross-compiler provided by nix. for more details, see #288 which the docker-helper.sh is stolen from. the usage is comprehensively documented in [readme]. the general flow is: 1. activate the docker-helper.sh environment: `eval $(docker-helper.sh env)`. (you will need to re-run this if you close your terminal) 2. pull the docker image: `docker-helper.sh pull` 3. start the docker container: `docker-helper.sh start` 4. (optional) clean the directory you want to lift: `make SUBDIRS=extraspec_incorrect/malloc_memcpy_strlen_memset_free clean` 5. compile and lift the directory: `make SUBDIRS=extraspec_incorrect/malloc_memcpy_strlen_memset_free` 6. commit the results (eventually, we want to move the binaries into an out-of-repo location. but until then, committing is probably fine.) [pac-nix]: https://github.com/katrinafyi/pac-nix/ [readme]: https://github.com/UQ-PAC/BASIL/blob/docker-helper/src/test/readme.md this PR does not make any changes to the existing examples. it only serves to make the Docker container available and accessible for people who want to use it as a uniform lifting environment. I do think that all examples should eventually be re-lifted using a consistent method, but this will come later.
1 parent 60d0d4c commit 0c806ff

15 files changed

Lines changed: 966 additions & 90 deletions

File tree

.gitattributes

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
*.mill linguist-language=Scala
22
mill linguist-generated
33
mill.bat linguist-generated
4+
5+
src/test/compiled.url.txt text eol=lf
6+
src/test/make/docker-flake.txt text eol=lf
7+
8+
Makefile text eol=lf
9+
*.sh text eol=lf
10+
*.mk text eol=lf
11+
*.md5sum text eol=lf linguist-generated

.github/workflows/check-doc-links.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ args=(
3232
--insecure
3333
--no-progress
3434
--max-concurrency 16
35+
--max-retries 10
36+
--timeout 40
3537
"$@"
3638
)
3739

docs/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
# Devleopment Guidelines
3232

3333
- [Testing](development/testing.md)
34+
- [Integration (system) tests](development/integration-tests.md)
3435
- [Assertions](development/assertions.md)
3536
- [Scala](development/scala.md)
3637

0 commit comments

Comments
 (0)