Fix image tests: vncserver, websockify, jupyter-remote-desktop-proxy #159
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This is a GitHub workflow defining a set of jobs with a set of steps. | |
| # ref: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions | |
| # | |
| name: Test | |
| on: | |
| pull_request: | |
| push: | |
| branches-ignore: | |
| - "dependabot/**" | |
| - "pre-commit-ci-update-config" | |
| tags: ["**"] | |
| workflow_dispatch: | |
| jobs: | |
| dummy: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: 1 | |
| run: | | |
| # container_id=$(docker run -d -p 5901:5901 --security-opt seccomp=unconfined quay.io/consideratio/test:turbo vncserver -xstartup /opt/install/jupyter_remote_desktop_proxy/share/xstartup -verbose -fg -geometry 1680x1050 -SecurityTypes None -rfbport 5901) | |
| container_id=$(docker run -d -p 5901:5901 -v $(pwd):/mnt/test --security-opt seccomp=unconfined quay.io/consideratio/test:turbo python /mnt/test/dummy-tcp-server.py) | |
| sleep 3 | |
| # echo "::group::Installing netcat (inside container)" | |
| # docker exec --user root $container_id bash -c ' | |
| # apt update | |
| # apt install -y netcat | |
| # ' | |
| # echo "::endgroup::" | |
| echo "::group::Testing vncserver with netcat (inside container)" | |
| docker exec $container_id bash -c 'timeout --preserve-status 1 nc -v localhost 5901' 2>&1 | tee output-inside.txt | |
| cat output-inside.txt | grep --quiet RFB && echo "Passed inside test" || { echo "Failed inside test" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| echo "::group::Testing vncserver with netcat (outside container)" | |
| timeout --preserve-status 1 nc -v localhost 5901 2>&1 | tee output-outside.txt | |
| cat output-outside.txt | grep --quiet RFB && echo "Passed outside test" || { echo "Failed outside test" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| # echo "::group::vncserver logs" | |
| # docker exec $container_id bash -c "cat ~/.vnc/*.log" | |
| # echo "::endgroup::" | |
| docker logs $container_id | |
| docker stop $container_id > /dev/null | |
| if [ "$TEST_OK" == "false" ]; then | |
| echo "One or more tests failed!" | |
| exit 1 | |
| fi | |
| # - name: 2 | |
| # run: | | |
| container: | |
| runs-on: ubuntu-22.04 | |
| timeout-minutes: 10 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - vncserver: tigervnc | |
| image: quay.io/consideratio/test:tiger | |
| - vncserver: turbovnc | |
| image: quay.io/consideratio/test:turbo | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install test requirements (websocat) | |
| run: | | |
| wget -q https://github.com/vi/websocat/releases/download/v1.12.0/websocat.x86_64-unknown-linux-musl \ | |
| -O /usr/local/bin/websocat | |
| chmod +x /usr/local/bin/websocat | |
| websocat --help=long | |
| # - name: Build image | |
| # run: | | |
| # docker build --build-arg vncserver=${{ matrix.vncserver }} -t jupyter-remote-desktop-proxy . | |
| - name: (inside container) websockify --help | |
| run: | | |
| docker run ${{ matrix.image }} websockify --help | |
| - name: (inside container) vncserver -help | |
| run: | | |
| # -help flag is not available for TurboVNC, but it emits the -help | |
| # equivalent information anyhow if passed -help, but also errors. Due | |
| # to this, we fallback to use the errorcode of vncsrever -list. | |
| docker run ${{ matrix.image }} bash -c "vncserver -help || vncserver -list > /dev/null" | |
| - name: Test vncserver | |
| if: always() | |
| run: | | |
| container_id=$(docker run -d -p 5901:5901 --security-opt seccomp=unconfined ${{ matrix.image }} vncserver -xstartup /opt/install/jupyter_remote_desktop_proxy/share/xstartup -verbose -fg -geometry 1680x1050 -SecurityTypes None -rfbport 5901) | |
| sleep 1 | |
| # echo "::group::Installing netcat (inside container)" | |
| # docker exec --user root $container_id bash -c ' | |
| # apt update | |
| # apt install -y netcat | |
| # ' | |
| # echo "::endgroup::" | |
| echo "::group::Testing vncserver with netcat (inside container)" | |
| docker exec $container_id bash -c 'timeout --preserve-status 1 nc -v localhost 5901' 2>&1 | tee output-inside.txt | |
| cat output-inside.txt | grep --quiet RFB && echo "Passed inside test" || { echo "Failed inside test" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| echo "::group::Testing vncserver with netcat (outside container)" | |
| timeout --preserve-status 1 nc -v localhost 5901 2>&1 | tee output-outside.txt | |
| cat output-outside.txt | grep --quiet RFB && echo "Passed outside test" || { echo "Failed outside test" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| echo "::group::vncserver logs" | |
| docker exec $container_id bash -c "cat ~/.vnc/*.log" | |
| echo "::endgroup::" | |
| docker stop $container_id > /dev/null | |
| if [ "$TEST_OK" == "false" ]; then | |
| echo "One or more tests failed!" | |
| exit 1 | |
| fi | |
| - name: Test websockify'ed vncserver | |
| if: always() | |
| run: | | |
| container_id=$(docker run -d -p 5901:5901 --security-opt seccomp=unconfined ${{ matrix.image }} websockify --verbose --log-file=/tmp/websockify.log --heartbeat=30 5901 -- vncserver -xstartup /opt/install/jupyter_remote_desktop_proxy/share/xstartup -verbose -fg -geometry 1680x1050 -SecurityTypes None -rfbport 5901) | |
| sleep 3 | |
| # echo "::group::Installing websocat (inside container)" | |
| # docker exec --user root $container_id bash -c ' | |
| # wget -q https://github.com/vi/websocat/releases/download/v1.12.0/websocat.x86_64-unknown-linux-musl \ | |
| # -O /usr/local/bin/websocat | |
| # chmod +x /usr/local/bin/websocat | |
| # ' | |
| # echo "::endgroup::" | |
| echo "::group::Testing websockify'ed vncserver with websocat (inside container)" | |
| docker exec $container_id bash -c 'websocat --binary --one-message --exit-on-eof "ws://localhost:5901/"' 2>&1 | tee output-inside.txt | |
| cat output-inside.txt | grep --quiet RFB && echo "Passed inside test" || { echo "Failed inside test" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| echo "::group::Testing websockify'ed vncserver with websocat (outside container)" | |
| websocat --binary --one-message --exit-on-eof "ws://localhost:5901/" 2>&1 | tee output-outside.txt | |
| cat output-outside.txt | grep --quiet RFB && echo "Passed outside test" || { echo "Failed outside test" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| echo "::group::websockify logs" | |
| docker exec $container_id bash -c "cat /tmp/websockify.log" | |
| echo "::endgroup::" | |
| echo "::group::vncserver logs" | |
| docker exec $container_id bash -c "cat ~/.vnc/*.log" | |
| echo "::endgroup::" | |
| docker stop $container_id > /dev/null | |
| if [ "$TEST_OK" == "false" ]; then | |
| echo "One or more tests failed!" | |
| exit 1 | |
| fi | |
| - name: Test project's proxy to websockify'ed vncserver | |
| if: always() | |
| run: | | |
| container_id=$(docker run -d -p 8888:8888 --security-opt seccomp=unconfined -e JUPYTER_TOKEN=secret ${{ matrix.image }}) | |
| sleep 5 | |
| echo "::group::Testing /desktop/ to return rendered index.html template" | |
| curl --silent --fail 'http://localhost:8888/desktop/?token=secret' | grep --quiet 'Jupyter Remote Desktop Proxy' && echo "Passed" || { echo "Failed" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| echo "::group::Testing /desktop/ to provide pre-built viewer.js" | |
| curl --silent --fail 'http://localhost:8888/desktop/static/dist/viewer.js?token=secret' > /dev/null && echo "Passed" || { echo "Failed" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| echo "::group::Testing /desktop-websockify/ to return a vncserver typical response, accepting one initial test failure" | |
| websocat --binary --one-message --exit-on-eof 'ws://localhost:8888/desktop-websockify/?token=secret' | grep --quiet RFB && echo "Passed initial websocket test" || { \ | |
| echo "Failed initial websocket test" && sleep 3 && websocat --binary --one-message --exit-on-eof 'ws://localhost:8888/desktop-websockify/?token=secret' | tee /dev/tty | grep --quiet RFB && echo "Passed second websocket test" || { echo "Failed second websocket test" && TEST_OK=false; } \ | |
| } | |
| echo "::endgroup::" | |
| echo "::group::jupyter_server logs" | |
| docker logs $container_id | |
| echo "::endgroup::" | |
| echo "::group::websockify logs" | |
| docker exec $container_id bash -c "cat /tmp/websockify.log" | |
| echo "::endgroup::" | |
| echo "::group::vncserver logs" | |
| docker exec $container_id bash -c "cat ~/.vnc/*.log" | |
| echo "::endgroup::" | |
| echo "::group::Testing container's ability to terminate via SIGTERM" | |
| timeout 5 docker stop $container_id > /dev/null && echo "Passed" || { echo "Failed" && TEST_OK=false; } | |
| echo "::endgroup::" | |
| if [ "$TEST_OK" == "false" ]; then | |
| echo "One or more tests failed!" | |
| exit 1 | |
| fi | |
| # TODO: Check VNC desktop works, e.g. by comparing Playwright screenshots | |
| # https://playwright.dev/docs/test-snapshots |