build_virtualenv 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. #!/bin/bash
  2. #
  3. # runs dh_virtualenv to build the virtualenv in the build directory,
  4. # and then runs the trial tests against the installed synapse.
  5. set -e
  6. export DH_VIRTUALENV_INSTALL_ROOT=/opt/venvs
  7. # make sure that the virtualenv links to the specific version of python, by
  8. # dereferencing the python3 symlink.
  9. #
  10. # Otherwise, if somebody tries to install (say) the stretch package on buster,
  11. # they will get a confusing error about "No module named 'synapse'", because
  12. # python won't look in the right directory. At least this way, the error will
  13. # be a *bit* more obvious.
  14. #
  15. SNAKE=$(readlink -e /usr/bin/python3)
  16. # try to set the CFLAGS so any compiled C extensions are compiled with the most
  17. # generic as possible x64 instructions, so that compiling it on a new Intel chip
  18. # doesn't enable features not available on older ones or AMD.
  19. #
  20. # TODO: add similar things for non-amd64, or figure out a more generic way to
  21. # do this.
  22. case $(dpkg-architecture -q DEB_HOST_ARCH) in
  23. amd64)
  24. export CFLAGS=-march=x86-64
  25. ;;
  26. esac
  27. # Manually install Poetry and export a pip-compatible `requirements.txt`
  28. TEMP_VENV="$(mktemp -d)"
  29. python3 -m venv "$TEMP_VENV"
  30. source "$TEMP_VENV/bin/activate"
  31. pip install -U pip
  32. pip install poetry==1.3.2
  33. poetry export \
  34. --extras all \
  35. --extras test \
  36. --extras systemd \
  37. -o exported_requirements.txt
  38. deactivate
  39. rm -rf "$TEMP_VENV"
  40. # Use --no-deps to only install pinned versions in exported_requirements.txt,
  41. # and to avoid https://github.com/pypa/pip/issues/9644
  42. dh_virtualenv \
  43. --install-suffix "matrix-synapse" \
  44. --builtin-venv \
  45. --python "$SNAKE" \
  46. --upgrade-pip \
  47. --preinstall="lxml" \
  48. --preinstall="mock" \
  49. --preinstall="wheel" \
  50. --extra-pip-arg="--no-deps" \
  51. --extra-pip-arg="--no-cache-dir" \
  52. --extra-pip-arg="--compile" \
  53. --extras="all,systemd,test" \
  54. --requirements="exported_requirements.txt"
  55. PACKAGE_BUILD_DIR="$(pwd)/debian/matrix-synapse-py3"
  56. VIRTUALENV_DIR="${PACKAGE_BUILD_DIR}${DH_VIRTUALENV_INSTALL_ROOT}/matrix-synapse"
  57. TARGET_PYTHON="${VIRTUALENV_DIR}/bin/python"
  58. case "$DEB_BUILD_OPTIONS" in
  59. *nocheck*)
  60. # Skip running tests if "nocheck" present in $DEB_BUILD_OPTIONS
  61. ;;
  62. *)
  63. # Copy tests to a temporary directory so that we can put them on the
  64. # PYTHONPATH without putting the uninstalled synapse on the pythonpath.
  65. tmpdir=$(mktemp -d)
  66. trap 'rm -r $tmpdir' EXIT
  67. cp -r tests "$tmpdir"
  68. # To avoid pulling in the unbuilt Synapse in the local directory
  69. pushd /
  70. PYTHONPATH="$tmpdir" \
  71. "${TARGET_PYTHON}" -m twisted.trial --reporter=text -j2 tests
  72. popd
  73. ;;
  74. esac
  75. # build the config file
  76. "${TARGET_PYTHON}" "${VIRTUALENV_DIR}/bin/generate_config" \
  77. --config-dir="/etc/matrix-synapse" \
  78. --data-dir="/var/lib/matrix-synapse" |
  79. perl -pe '
  80. # tweak the paths to the tls certs and signing keys
  81. /^tls_.*_path:/ and s/SERVERNAME/homeserver/;
  82. /^signing_key_path:/ and s/SERVERNAME/homeserver/;
  83. # tweak the pid file location
  84. /^pid_file:/ and s#:.*#: "/var/run/matrix-synapse.pid"#;
  85. # tweak the path to the log config
  86. /^log_config:/ and s/SERVERNAME\.log\.config/log.yaml/;
  87. # tweak the path to the media store
  88. /^media_store_path:/ and s#/media_store#/media#;
  89. # remove the server_name setting, which is set in a separate file
  90. /^server_name:/ and $_ = "#\n# This is set in /etc/matrix-synapse/conf.d/server_name.yaml for Debian installations.\n# $_";
  91. # remove the report_stats setting, which is set in a separate file
  92. /^# report_stats:/ and $_ = "";
  93. ' > "${PACKAGE_BUILD_DIR}/etc/matrix-synapse/homeserver.yaml"
  94. # build the log config file
  95. "${TARGET_PYTHON}" "${VIRTUALENV_DIR}/bin/generate_log_config" \
  96. --output-file="${PACKAGE_BUILD_DIR}/etc/matrix-synapse/log.yaml"
  97. # add a dependency on the right version of python to substvars.
  98. PYPKG=$(basename "$SNAKE")
  99. echo "synapse:pydepends=$PYPKG" >> debian/matrix-synapse-py3.substvars
  100. # add a couple of triggers. This is needed so that dh-virtualenv can rebuild
  101. # the venv when the system python changes (see
  102. # https://dh-virtualenv.readthedocs.io/en/latest/tutorial.html#step-2-set-up-packaging-for-your-project)
  103. #
  104. # we do it here rather than the more conventional way of just adding it to
  105. # debian/matrix-synapse-py3.triggers, because we need to add a trigger on the
  106. # right version of python.
  107. cat >>"debian/.debhelper/generated/matrix-synapse-py3/triggers" <<EOF
  108. # triggers for dh-virtualenv
  109. interest-noawait $SNAKE
  110. interest dh-virtualenv-interpreter-update
  111. EOF