build_virtualenv 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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. # Use --builtin-venv to use the better `venv` module from CPython 3.4+ rather
  28. # than the 2/3 compatible `virtualenv`.
  29. dh_virtualenv \
  30. --install-suffix "matrix-synapse" \
  31. --builtin-venv \
  32. --python "$SNAKE" \
  33. --upgrade-pip \
  34. --preinstall="lxml" \
  35. --preinstall="mock" \
  36. --preinstall="wheel" \
  37. --extra-pip-arg="--no-cache-dir" \
  38. --extra-pip-arg="--compile" \
  39. --extras="all,systemd,test"
  40. PACKAGE_BUILD_DIR="debian/matrix-synapse-py3"
  41. VIRTUALENV_DIR="${PACKAGE_BUILD_DIR}${DH_VIRTUALENV_INSTALL_ROOT}/matrix-synapse"
  42. TARGET_PYTHON="${VIRTUALENV_DIR}/bin/python"
  43. case "$DEB_BUILD_OPTIONS" in
  44. *nocheck*)
  45. # Skip running tests if "nocheck" present in $DEB_BUILD_OPTIONS
  46. ;;
  47. *)
  48. # Copy tests to a temporary directory so that we can put them on the
  49. # PYTHONPATH without putting the uninstalled synapse on the pythonpath.
  50. tmpdir=$(mktemp -d)
  51. trap 'rm -r $tmpdir' EXIT
  52. cp -r tests "$tmpdir"
  53. PYTHONPATH="$tmpdir" \
  54. "${TARGET_PYTHON}" -m twisted.trial --reporter=text -j2 tests
  55. ;;
  56. esac
  57. # build the config file
  58. "${TARGET_PYTHON}" "${VIRTUALENV_DIR}/bin/generate_config" \
  59. --config-dir="/etc/matrix-synapse" \
  60. --data-dir="/var/lib/matrix-synapse" |
  61. perl -pe '
  62. # tweak the paths to the tls certs and signing keys
  63. /^tls_.*_path:/ and s/SERVERNAME/homeserver/;
  64. /^signing_key_path:/ and s/SERVERNAME/homeserver/;
  65. # tweak the pid file location
  66. /^pid_file:/ and s#:.*#: "/var/run/matrix-synapse.pid"#;
  67. # tweak the path to the log config
  68. /^log_config:/ and s/SERVERNAME\.log\.config/log.yaml/;
  69. # tweak the path to the media store
  70. /^media_store_path:/ and s#/media_store#/media#;
  71. # remove the server_name setting, which is set in a separate file
  72. /^server_name:/ and $_ = "#\n# This is set in /etc/matrix-synapse/conf.d/server_name.yaml for Debian installations.\n# $_";
  73. # remove the report_stats setting, which is set in a separate file
  74. /^# report_stats:/ and $_ = "";
  75. ' > "${PACKAGE_BUILD_DIR}/etc/matrix-synapse/homeserver.yaml"
  76. # build the log config file
  77. "${TARGET_PYTHON}" "${VIRTUALENV_DIR}/bin/generate_log_config" \
  78. --output-file="${PACKAGE_BUILD_DIR}/etc/matrix-synapse/log.yaml"
  79. # add a dependency on the right version of python to substvars.
  80. PYPKG=$(basename "$SNAKE")
  81. echo "synapse:pydepends=$PYPKG" >> debian/matrix-synapse-py3.substvars
  82. # add a couple of triggers. This is needed so that dh-virtualenv can rebuild
  83. # the venv when the system python changes (see
  84. # https://dh-virtualenv.readthedocs.io/en/latest/tutorial.html#step-2-set-up-packaging-for-your-project)
  85. #
  86. # we do it here rather than the more conventional way of just adding it to
  87. # debian/matrix-synapse-py3.triggers, because we need to add a trigger on the
  88. # right version of python.
  89. cat >>"debian/.debhelper/generated/matrix-synapse-py3/triggers" <<EOF
  90. # triggers for dh-virtualenv
  91. interest-noawait $SNAKE
  92. interest dh-virtualenv-interpreter-update
  93. EOF