An open API service indexing awesome lists of open source software.

https://github.com/angr/ci-settings

Docker image and azure templates for angr's CI
https://github.com/angr/ci-settings

Last synced: 25 days ago
JSON representation

Docker image and azure templates for angr's CI

Awesome Lists containing this project

README

        

# ci-settings

This is our repo containing the docker image used for our CI. Most people
won't need to touch this, and instead should use our regular images. This is
mostly useful if you are either hacking on CI, or super confused why tests are
failing for your pull request.

## CI options
angr CI supports directives to customize the CI run.
When making a PR, nightly tests can be enabled by adding the following line to the PR body:
```
ci: include-nightly
```
Additionally, other PRs can be used in place of default branches by simply linking the PR, for example
```
sync: angr/angr#
```

## Manual instructions

To perform a build manually:

```sh
docker run -it \
--cap-add=SYS_PTRACE \
--security-opt seccomp:unconfined \
-v /var/run/docker.sock:/var/run/docker.sock \ # for archr
angr/ci:2
```

And then, in the container:

```sh
# This script will put you in the same directory as Azure would. It also sets
# all the necessary environment variables.
source /root/scripts/manual_defaults.sh

# OPTIONAL: If you need to customize environment variables, these are the
# important ones, along with their default values.

# Change these to the relevant repo and branch
# Your pull request will be refs/pull/{id}
export BUILD_REPOSITORY_URI=angr/angr
export BUILD_SOURCEBRANCH=refs/heads/master

# We slice up our test execution among workers, 10 currently. You can play with
# these # numbers to run only a subset of the tests. You can change these
# between running the ga-test.sh script, without rebuilding.
export WORKER=0
export NUM_WORKERS=10

# And finally, to run the individual steps:

# Build step
/root/scripts/ga-build.sh
# Lint step
/root/scripts/ga-lint.sh
# Test step
/root/scripts/ga-test.sh
```

After building, there will be a `build` directory you can `cd` into that has
everything of interest. Most importantly, the `virtualenv` and `src` directories
you can use if you need to run specific tests outside of the standard testing
scripts.