Try to use GitHub Actions

[XVilka]

Travis is too clunky, also it is possible to use new action template from https://discuss.ocaml.org/t/github-actions-for-ocaml-opam-now-available/4745

[ivg]

It looks very promising, the main roadblocker is #1111, which I think is resolved by #1114 but it looks like that we need to rebase/merge master into this PR.

The other missing thing is running, tests and checks, with make test and make check (as adding --with-tests and --with-docs won't really run them, and they (tests) are built despite the presence of this flag.

[rvantonder]

👋 incidentally I recently tried to get BAP to compile using a GH action. I tried going the ./configure route and not opam install (this would allow make test and make check right?). The furthest I got was

./setup.exe -quiet -build 
ocamlfind ocamlopt -package unix -package ocamlbuild -linkpkg -package findlib myocamlbuild.ml /home/runner/.opam/4.09.0/lib/ocamlbuild/ocamlbuild.cmx -o myocamlbuild
Fatal error: exception Failure("No variable llvm_cxxflags defined when trying to expand \"${llvm_cxxflags}\".")
make: *** [build] Error 1

job. I'm just trying to get it running on ubuntu-latest for a start, so the workflow file is:

name: LSIF
on: [push, pull_request]
jobs:
  build:
    name: Build and push LSIF data
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: OCaml setup
        uses: avsm/setup-ocaml@master
        with:
          ocaml-version: '4.09.0'
      - run: opam depext -yt bap
      - run: sudo apt-get install libcurl4-gnutls-dev # turns out depext didn't pick up this this dependency 🤷 
      - run: opam install -t . --deps-only
      - run: opam exec -- ./configure --enable-everything
      - run: opam exec -- make

[ivg]

incidentally I recently tried to get BAP to compile using a GH action. I tried going the ./configure route and not opam install (this would allow make test and make check right?). The furthest I got was

Not actually, the opam/opam file which is pinned in the @XVilka's proposal will enable tests and this is the file that is used in Travis. The reason why it didn't work is because of #1111, which is solved by #1114 so we need to rebase/merge #1114 into this PR.

The main culprit why it didn't work with the ./configure approach (which is also viable) is that the ./configure invocation should be slightly more complicated, and query conf-bap-llvm for the actual location/version of LLVM.

P.S. Glad to see you back doing BAPish things :)

[dbrumley]

I probably don't have much, but can share I recently went through some github actions migration recently. One thing we settled on was starting to use shell scripts since it made it easier to test.
Something like: https://github.com/ForAllSecure/VulnerabilitiesLab/blob/master/.github/workflows/docker_publish.yml

Though AFAIK, there is a run syntax for shell scripts. https://github.com/docker-practice/actions-setup-docker/blob/master/.github/workflows/ci.yaml#L32

[XVilka]

@dbrumley there is already existing GitHub Action for publishing to Docker, we use it in radare2 project: https://github.com/marketplace/actions/publish-docker

[XVilka]

I wanted to setup also Windows worker, but strangely z3 is disabled for win32 for some reason by @fdopen in fdopen/opam-repository-mingw@7ca1bb1

[XVilka]

After trying MacOS build again it seems there is a new error, and it might be in the code:

┌─ The following actions failed
│ ∗ install bap master
└─ 
╶─ No changes have been performed
# context              2.0.7 | macos/x86_64 | ocaml-base-compiler.4.09.1 | pinned(git+file:///Users/runner/runners/2.263.0/work/bap/bap#HEAD#856b159b)
# path                 ~/.opam/4.09.1/.opam-switch/build/bap.master
# command              ~/.opam/opam-init/hooks/sandbox.sh install make test
# exit-code            2
# env-file             ~/.opam/log/bap-91713-4f4523.env
# output-file          ~/.opam/log/bap-91713-4f4523.out
### output ###
# [...]
# bil.info> providing a lifter for all BIL lifters
# powerpc.info> Providing PowerPC semantics in BIL
# cache.warning> Failed to read config file: ("Unix.Unix_error(Unix.ENOENT, \"open\", \".cache/config.3\")")
# Failed to initialize BAP: Internal error: (Sys_error ".cache/data: No such file or directory")
# Backtrace:
# Raised by primitive operation at file "plugins/cache/bap_cache_gc.ml", line 101, characters 2-18
# Called from file "plugins/cache/bap_cache_gc.ml", line 143, characters 16-43
# Called from file "plugins/cache/bap_cache_main.ml", line 138, characters 2-27
# Called from file "lib/bap_main/bap_main.ml", line 789, characters 37-46
# Called from file "lib/bap_main/bap_main.ml", line 945, characters 25-28
# 
# make: *** [test] Error 1

# Run eval $(opam env) to update the current shell environment
'opam install bap -v --yes --with-test' failed.

[ivg]

Ok, I've pushed the fix to #1109, reset Oleg's morning attempts and rebased the original patch onto the new master.

[ivg]

Finally, we passed the test and sandboxing issues, but still failing on macos since we're picking not the installed LLVM, but the LLVM which is shipped with the os (and which is stripped and doesn't have arm,powerpc, and other targets).

[XVilka]

The MacOS build looks stuck at:

Running ./bap.tests/api-options.exp ...
##[error]The operation was canceled.

BTW, good we decided to build with MacOS as well - already a few bugs were spotted.

[XVilka]

It works!

[ivg]

Finally, thanks to everyone for the hard work! This is the first step, we will move more of our infrastructure to the actions and optimize the testsuite that takes more than hour on Mac (for some unknown to us reason). But anyway, we now have a working CI system, and soon we will get CICD :)