Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/tools/lib/sanity_check.py

21 lines
623 B
Python
Raw Normal View History

test_server: Improve warning in venv check. This (1) changes test_server to use the common `check_venv` method and (2) improves check_venv to provide a clearer error message in the case that you're inside Vagrant but not in a venv. Tweaked by tabbott to borrow logic from run_dev.py.
2017-04-03 11:48:57 +02:00
import os
import pwd
tools: Create more consistent checks for venv. This helps make the Zulip development environment somewhat more robust to new contributors, since it will give them a nice warning if they try running any of our development tools outside the Zulip virtualenv. Fixes #3468.
2017-02-05 21:24:28 +01:00
import sys
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-11 00:54:34 +02:00
python: Convert function type annotations to Python 3 style. Generated by com2ann (slightly patched to avoid also converting assignment type annotations, which require Python 3.6), followed by some manual whitespace adjustment, and six fixes for runtime issues: - def __init__(self, token: Token, parent: Optional[Node]) -> None: + def __init__(self, token: Token, parent: "Optional[Node]") -> None: -def main(options: argparse.Namespace) -> NoReturn: +def main(options: argparse.Namespace) -> "NoReturn": -def fetch_request(url: str, callback: Any, **kwargs: Any) -> Generator[Callable[..., Any], Any, None]: +def fetch_request(url: str, callback: Any, **kwargs: Any) -> "Generator[Callable[..., Any], Any, None]": -def assert_server_running(server: subprocess.Popen[bytes], log_file: Optional[str]) -> None: +def assert_server_running(server: "subprocess.Popen[bytes]", log_file: Optional[str]) -> None: -def server_is_up(server: subprocess.Popen[bytes], log_file: Optional[str]) -> bool: +def server_is_up(server: "subprocess.Popen[bytes]", log_file: Optional[str]) -> bool: - method_kwarg_pairs: List[FuncKwargPair], + method_kwarg_pairs: "List[FuncKwargPair]", Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-19 03:48:37 +02:00
def check_venv(filename: str) -> None:
sanity_check: Test for the virtualenv by its path. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 21:03:52 +02:00
if os.path.basename(sys.prefix) != "zulip-py3-venv":
python: Convert percent formatting to Python 3.6 f-strings. Generated by pyupgrade --py36-plus. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-10 06:41:04 +02:00
print(f"You need to run {filename} inside a Zulip dev environment.")
test_server: Improve warning in venv check. This (1) changes test_server to use the common `check_venv` method and (2) improves check_venv to provide a clearer error message in the case that you're inside Vagrant but not in a venv. Tweaked by tabbott to borrow logic from run_dev.py.
2017-04-03 11:48:57 +02:00
user_id = os.getuid()
user_name = pwd.getpwuid(user_id).pw_name
sanity_check: Improve output for manual installation. We should still display the `source` advice when not in Vagrant or a Droplet, since that's an important hint for anyone using local installation on Linux. We move the "If you are using Vagrant..." text a bit after to highlight things nicely for folks who are running tools outside Vagrant. Also tighten text to avoid line-wrapping on an 80 character console.
2021-04-01 19:54:52 +02:00
print(
"You can `source /srv/zulip-py3-venv/bin/activate` "
"to enter the development environment."
)
ruff: Fix PLR1714 Consider merging multiple comparisons. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-07-22 01:15:10 +02:00
if user_name not in ("vagrant", "zulipdev"):
sanity_check: Improve output for manual installation. We should still display the `source` advice when not in Vagrant or a Droplet, since that's an important hint for anyone using local installation on Linux. We move the "If you are using Vagrant..." text a bit after to highlight things nicely for folks who are running tools outside Vagrant. Also tighten text to avoid line-wrapping on an 80 character console.
2021-04-01 19:54:52 +02:00
print()
print("If you are using Vagrant, first run `vagrant ssh` to enter the Vagrant guest.")
tools: Create more consistent checks for venv. This helps make the Zulip development environment somewhat more robust to new contributors, since it will give them a nice warning if they try running any of our development tools outside the Zulip virtualenv. Fixes #3468.
2017-02-05 21:24:28 +01:00
sys.exit(1)