#!/bin/bash # NOTE: This file is sourced in CI across different repos (e.g. snuba), # thus, renaming this file or any functions can break CI! # # Module containing code shared across various shell scripts # Execute functions from this module via the script do.sh # shellcheck disable=SC2034 # Unused variables # shellcheck disable=SC2001 # https://github.com/koalaman/shellcheck/wiki/SC2001 # This block is a safe-guard since in CI calling tput will fail and abort scripts if [ -z "${CI+x}" ]; then bold="$(tput bold)" red="$(tput setaf 1)" green="$(tput setaf 2)" yellow="$(tput setaf 3)" reset="$(tput sgr0)" fi venv_name=".venv" # XDG paths' standardized defaults: # (see https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables ) export XDG_DATA_HOME="${XDG_DATA_HOME:-$HOME/.local/share}" export XDG_CONFIG_HOME="${XDG_CONFIG_HOME:-$HOME/.config}" export XDG_STATE_HOME="${XDG_STATE_HOME:-$HOME/.local/state}" export XDG_DATA_DIRS="${XDG_DATA_DIRS:-/usr/local/share/:/usr/share/}" export XDG_CONFIG_DIRS="${XDG_CONFIG_DIRS:-/etc/xdg}" export XDG_CACHE_HOME="${XDG_CACHE_HOME:-$HOME/.cache}" export XDG_RUNTIME_DIR="${XDG_RUNTIME_DIR:-/var/run}" # Check if a command is available require() { command -v "$1" >/dev/null 2>&1 } configure-sentry-cli() { if [ -z "${SENTRY_DEVENV_NO_REPORT+x}" ]; then if ! require sentry-cli; then if [ -f "${venv_name}/bin/pip" ]; then pip-install sentry-cli else curl -sL https://sentry.io/get-cli/ | SENTRY_CLI_VERSION=2.14.4 bash fi fi fi } query-valid-python-version() { python_version=$(python3 -V 2>&1 | awk '{print $2}') if [[ -n "${SENTRY_PYTHON_VERSION:-}" ]]; then if [ "$python_version" != "$SENTRY_PYTHON_VERSION" ]; then cat <= 3.8.10, < 3.9. Either run "rm -rf ${venv_name} && direnv allow" to OR set SENTRY_PYTHON_VERSION=${python_version} to an .env file to bypass this check." EOF return 1 fi fi } sudo-askpass() { if [ -z "${sudo-askpass-x}" ]; then sudo --askpass "$@" else sudo "$@" fi } pip-install() { pip install --constraint requirements-dev-frozen.txt "$@" } upgrade-pip() { pip-install pip } install-py-dev() { upgrade-pip # It places us within top src dir to be at the same path as setup.py # This helps when getsentry calls into this script cd "${HERE}/.." || exit echo "--> Installing Sentry (for development)" # pip doesn't do well with swapping drop-ins pip uninstall -qqy djangorestframework-stubs django-stubs pip-install -r requirements-dev-frozen.txt # SENTRY_LIGHT_BUILD=1 disables webpacking during setup.py. # Webpacked assets are only necessary for devserver (which does it lazily anyways) # and acceptance tests, which webpack automatically if run. python3 -m tools.fast_editable --path . } setup-git-config() { git config --local branch.autosetuprebase always git config --local core.ignorecase false git config --local blame.ignoreRevsFile .git-blame-ignore-revs } setup-git() { setup-git-config # if hooks are explicitly turned off do nothing if [[ "$(git config core.hooksPath)" == '/dev/null' ]]; then echo "--> core.hooksPath set to /dev/null. Skipping git hook setup" echo "" return fi echo "--> Installing git hooks" mkdir -p .git/hooks && cd .git/hooks && ln -sf ../../config/hooks/* ./ && cd - || exit # shellcheck disable=SC2016 python3 -c '' || ( echo 'Please run `make setup-pyenv` to install the required Python 3 version.' exit 1 ) if ! require pre-commit; then pip-install -r requirements-dev.txt fi pre-commit install --install-hooks echo "" } node-version-check() { # Checks to see if node's version matches the one specified in package.json for Volta. node -pe "process.exit(Number(!(process.version == 'v' + require('./.volta.json').volta.node )))" || ( echo 'Unexpected node version. Recommended to use https://github.com/volta-cli/volta' echo 'Run `volta install node` and `volta install yarn` to update your toolchain.' echo 'If you do not have volta installed run `curl https://get.volta.sh | bash` or visit https://volta.sh' exit 1 ) } install-js-dev() { node-version-check echo "--> Installing Yarn packages (for development)" # Use NODE_ENV=development so that yarn installs both dependencies + devDependencies NODE_ENV=development yarn install --frozen-lockfile # A common problem is with node packages not existing in `node_modules` even though `yarn install` # says everything is up to date. Even though `yarn install` is run already, it doesn't take into # account the state of the current filesystem (it only checks .yarn-integrity). # Add an additional check against `node_modules` yarn check --verify-tree || yarn install --check-files } develop() { install-js-dev install-py-dev setup-git } init-config() { sentry init --dev } run-dependent-services() { sentry devservices up } create-db() { container_name=${POSTGRES_CONTAINER:-sentry_postgres} echo "--> Creating 'sentry' database" docker exec "${container_name}" createdb -h 127.0.0.1 -U postgres -E utf-8 sentry || true echo "--> Creating 'control' and 'region' database" docker exec "${container_name}" createdb -h 127.0.0.1 -U postgres -E utf-8 control || true docker exec "${container_name}" createdb -h 127.0.0.1 -U postgres -E utf-8 region || true } apply-migrations() { echo "--> Applying migrations" sentry upgrade --noinput } create-superuser() { echo "--> Creating a superuser account" if [[ -n "${GITHUB_ACTIONS+x}" ]]; then sentry createuser --superuser --email foo@tbd.com --no-password --no-input else sentry createuser --superuser --email admin@sentry.io --password admin --no-input echo "Password is admin." fi } build-platform-assets() { echo "--> Building platform assets" echo "from sentry.utils.integrationdocs import sync_docs; sync_docs(quiet=True)" | sentry exec # make sure this didn't silently do nothing test -f src/sentry/integration-docs/android.json } bootstrap() { develop init-config run-dependent-services create-db apply-migrations create-superuser # Load mocks requires a superuser bin/load-mocks build-platform-assets echo "--> Finished bootstrapping. Have a nice day." } clean() { echo "--> Cleaning static cache" rm -rf dist/* src/sentry/static/sentry/dist/* echo "--> Cleaning integration docs cache" rm -rf src/sentry/integration-docs echo "--> Cleaning pyc files" find . -name "*.pyc" -delete echo "--> Cleaning python build artifacts" rm -rf build/ dist/ src/sentry/assets.json echo "" } drop-db() { container_name=${POSTGRES_CONTAINER:-sentry_postgres} echo "--> Dropping existing 'sentry' database" docker exec "${container_name}" dropdb --if-exists -h 127.0.0.1 -U postgres sentry echo "--> Dropping 'control' and 'region' database" docker exec "${container_name}" dropdb --if-exists -h 127.0.0.1 -U postgres control docker exec "${container_name}" dropdb --if-exists -h 127.0.0.1 -U postgres region } reset-db() { drop-db create-db apply-migrations create-superuser echo 'Finished resetting database. To load mock data, run `./bin/load-mocks`' } prerequisites() { if [ -z "${CI+x}" ]; then brew update -q && brew bundle -q else HOMEBREW_NO_AUTO_UPDATE=on brew install pyenv fi } direnv-help() { cat >&2 <