Test musedev docker

[ftc]

Scripts to test the fixr api in the musedev docker container.

[smover]

@ftc can you test the finalize method?

A test case is the following, you can use it with docker as you are calling the "version" endpoint:

$ BASEPATH=`pwd`/test/data && sed "s:REPOPATH:${BASEPATH}:" test/data/finalize_input.json  | ./biggroumcheck.sh /Users/sergiomover/works/projects/muse/repos/biggroum/python/fixrgraph/musedev/test/data 04f68b69a6f9fa254661b481a757fa1c834b52e1 finalize

You need to unzip the AwesomeApp.zip file in /Users/sergiomover/works/projects/muse/repos/biggroum/python/fixrgraph/musedev/test/data before (add this step to the test script).

You need to run the search service to make it work.

• Build the docker image for the search service in https://github.com/cuplv/FixrGraphPatternSearch/tree/develop/docker_search (follow the README.md instruction, just build the image)
• Build the docker image for the source code service https://github.com/cuplv/fixr_source_code_service/tree/master/docker (follow the README.md instruction, just build the image)
• Use the docker compose file in https://github.com/cuplv/biggroum/tree/develop/docker_compose. Generate the docker compose:

  python get_docker_compose.py

Run the services:

# docker-compose up

The other issue is to reach the search service from the musedev docker container. You can either play with the docker compose file or running the musedev docker container telling how to reach the host system (never done that but it should be possible https://forums.docker.com/t/accessing-host-machine-from-within-docker-container/14248/11)

[smover]

The changes to the biggroumscript.sh breaks the tests in python/fixrgraph/musedev/test.

We were testing that the bash script was calling the python script correctly, but now the bash script became "path dependent" (e.g., biggroumsetup/biggroum and /root/biggroumsetup) and without a way to skip the setup process (we cannot test the script on mac anymore for example, because path are hardcoded and the update-alternative command that is always called).

The comment Note: Environment variable to determine run was difficult. docker does not run .bashrc on shell start, sourcing .bashrc in script also failed does not really explain why we switched from environment variables (which are quite easy to set when invoking the script, for local testing) to files, it just motivates a workaround.

Why does sourcing .bashrc file does not work? That seems to break the behavior of bash, while it should not be the case.

Here my main complaints:

• The script uses the absolute path /root, while you should use ${HOME} and save everything there (e.g., what does it happen if tomorrow the musedev image change and you run as another user?).

• Using the absolute path (e.g. /root/biggroumsetup) further makes the local testing (outside the container) impossible. It would be ok to replace the absolute path with a relative path (e.g. ${HOME}/biggroumsetup_completed). At this point you could really just save a file with the additional environment variables you set during the setup.

• using the relative path biggroumsetup to invoke the python script is another issue for running the test locally (e.g., on a machine where we already have a setup). The lines in the script are:

  cd "$(dirname "${BASH_SOURCE[0]}")"
  python biggroumsetup/biggroum/python/fixrgraph/musedev/biggroumscript.py "${dir}" "${commit}" "${cmd}" "${graph_extractor_path}" "${fixr_search_endpoint}" < /dev/stdin 1> /dev/stdout 2> /dev/stderr

  FIrst, cd "$(dirname "${BASH_SOURCE[0]}")" may not work on the musedev deployment unless the biggroumcheck.sh script is always in the home directory.

You have the same issues for the other environment variables you keep setting:

export GRAPH_EXTRACTOR_PATH="${HOME}/biggroumsetup/fixrgraphextractor_2.12-0.1.0-one-jar.jar" >>setup_log 2>&1 && \
export PYTHONPATH="${HOME}/biggroumsetup/biggroum/python:$PYTHONPATH"  >>setup_log 2>&1

They were inside the setup first, under the assumption that the container was created fresh at every run. I would just export those environment variables in the setup and export them in the bashrc (and execute the bashrc every time), so we do not lose them and we can test the script locally.

I would also not change directory before invoking the biggroumscript.py, and I would use an environment variable telling where is the biggroum repository:

${BIGGROUMREPO}/python/fixrgraph/musedev/biggroumscript.py`

• You should move the update_alternative command in the setup steps (the change is persistent, I think)

[smover]

@ftc can you take a look at the readme file explaining how to test the API: https://github.com/cuplv/biggroum/blob/test_musedev_docker/python/fixrgraph/musedev/README.md

There are some TODOs to be completed there (ignore the one about configuring the .muse.tml file). The others are: missing address for the search server missing test cases (for talk and reaction --- look at the python ones to get the input/output) missing commands to manually run the container