rework tests to use pytest

.github/workflows/test.yml

@@ -79,7 +79,7 @@ jobs:
  pip install -r requirements-dev.txt
  ### pytest-sentry configuration ###
  if [ "$GITHUB_REPOSITORY" = "getsentry/self-hosted" ]; then
- echo "PYTEST_SENTRY_DSN=https://[email protected]/6627632" >> $GITHUB_ENV
+ echo "PYTEST_SENTRY_DSN=${{ env.SELF_HOSTED_TESTING_DSN }} >> $GITHUB_ENV
  echo "PYTEST_SENTRY_TRACES_SAMPLE_RATE=0" >> $GITHUB_ENV
 
  # This records failures on master to sentry in order to detect flakey tests, as it's

_integration-test/run.py

@@ -2,7 +2,7 @@
 import os
 from functools import lru_cache
 import requests
-import unittest
+import pytest
 import sentry_sdk
 import time
 import json
@@ -18,142 +18,160 @@ def run_shell_command(cmd, **kwargs) -> subprocess.CompletedProcess:
  return subprocess.run(cmd, shell=True, check=True, **kwargs)
 
 
-class IntegrationTests(unittest.TestCase):
- @classmethod
- def setUpClass(cls):
- cls.session = requests.Session()
- response = None
- run_shell_command("docker compose --ansi never up -d")
- for i in range(TIMEOUT_SECONDS):
- try:
- response = requests.get(SENTRY_TEST_HOST)
- except requests.ConnectionError:
- pass
- if response is not None and response.status_code == 200:
- break
- time.sleep(1)
- assert response.status_code == 200
+def poll_for_response(request: str, session: requests.Session) -> requests.Response:
+ for i in range(TIMEOUT_SECONDS):
+ response = session.get(request, headers={"Referer": SENTRY_TEST_HOST})
+ if response.status_code == 200:
+ break
+ time.sleep(1)
+ assert response.status_code == 200
+ return response
 
- # Create test user
- run_shell_command(
- f"echo y | docker compose exec web sentry createuser --force-update --superuser --email {TEST_USER} --password {TEST_PASS}"
- )
 
- def poll_for_response(self, request: str) -> requests.Response:
- for i in range(TIMEOUT_SECONDS):
- response = self.session.get(request, headers={"Referer": SENTRY_TEST_HOST})
- if response.status_code == 200:
- break
- time.sleep(1)
- assert response.status_code == 200
- return response
-
- @lru_cache
- def get_sentry_dsn(self) -> str:
- for i in range(TIMEOUT_SECONDS):
- response = self.session.get(
- f"{SENTRY_TEST_HOST}/api/0/projects/sentry/internal/keys/",
- headers={"Referer": SENTRY_TEST_HOST},
- )
- if response.status_code == 200:
- sentry_dsn = json.loads(response.text)[0]["dsn"]["public"]
- if len(sentry_dsn) > 0:
- break
- time.sleep(1)
- sentry_dsn = json.loads(response.text)[0]["dsn"]["public"]
- assert len(sentry_dsn) > 0
- return sentry_dsn
-
- def test_initial_redirect(self):
- initial_auth_redirect = self.session.get(SENTRY_TEST_HOST)
- assert initial_auth_redirect.url == f"{SENTRY_TEST_HOST}/auth/login/sentry/"
-
- def test_login(self):
- login_csrf_token = (
- self.session.get(SENTRY_TEST_HOST)
- .text.split('"csrfmiddlewaretoken" value="')[1]
- .split('"')[0]
- )
- login_response = self.session.post(
- f"{SENTRY_TEST_HOST}/auth/login/sentry/",
- data={
- "op": "login",
- "username": TEST_USER,
- "password": TEST_PASS,
- "csrfmiddlewaretoken": login_csrf_token,
- },
- headers={"Referer": f"{SENTRY_TEST_HOST}/auth/login/sentry/"},
- )
- assert '"isAuthenticated":true' in login_response.text
- assert '"username":"[email protected]"' in login_response.text
- assert '"isSuperuser":true' in login_response.text
- assert login_response.cookies["sc"] is not None
- # Set up initial/required settings (InstallWizard request)
- self.session.headers.update({"X-CSRFToken": login_response.cookies["sc"]})
- response = self.session.put(
- f"{SENTRY_TEST_HOST}/api/0/internal/options/?query=is:required",
+@lru_cache
+def get_sentry_dsn(session: requests.Session) -> str:
+ for i in range(TIMEOUT_SECONDS):
+ response = session.get(
+ f"{SENTRY_TEST_HOST}/api/0/projects/sentry/internal/keys/",
  headers={"Referer": SENTRY_TEST_HOST},
- data={
- "mail.use-tls": False,
- "mail.username": "",
- "mail.port": 25,
- "system.admin-email": "[email protected]",
- "mail.password": "",
- "system.url-prefix": SENTRY_TEST_HOST,
- "auth.allow-registration": False,
- "beacon.anonymous": True,
- },
  )
- assert response.status_code == 200
-
- def test_receive_event(self):
- event_id = None
- with sentry_sdk.init(dsn=self.get_sentry_dsn()):
- event_id = sentry_sdk.capture_exception(Exception("a failure"))
- assert event_id is not None
- response = self.poll_for_response(
- f"{SENTRY_TEST_HOST}/api/0/projects/sentry/internal/events/{event_id}/"
- )
- response_json = json.loads(response.text)
- assert response_json["eventID"] == event_id
- assert response_json["metadata"]["value"] == "a failure"
-
- def test_cleanup_crons_running(self):
- cleanup_crons = run_shell_command(
- "docker compose --ansi never ps -a | tee debug.log | grep -E -e '\\-cleanup\\s+running\\s+' -e '\\-cleanup[_-].+\\s+Up\\s+'",
- capture_output=True,
- ).stdout
- assert len(cleanup_crons) > 0
-
- def test_custom_cas(self):
- run_shell_command(". _integration-test/custom-ca-roots/setup.sh")
- run_shell_command(
- "docker compose --ansi never run --no-deps web python3 /etc/sentry/test-custom-ca-roots.py"
- )
- run_shell_command(". _integration-test/custom-ca-roots/teardown.sh")
-
- def test_receive_transaction_events(self):
- with sentry_sdk.init(
- dsn=self.get_sentry_dsn(), profiles_sample_rate=1.0, traces_sample_rate=1.0
- ):
-
- def dummy_func():
- sum = 0
- for i in range(5):
- sum += i
- time.sleep(0.25)
-
- with sentry_sdk.start_transaction(op="task", name="Test Transactions"):
- dummy_func()
- profiles_response = self.poll_for_response(
- f"{SENTRY_TEST_HOST}/api/0/organizations/sentry/events/?dataset=profiles&field=profile.id&project=1&statsPeriod=1h"
- )
- assert profiles_response.status_code == 200
- profiles_response_json = json.loads(profiles_response.text)
- assert len(profiles_response_json) > 0
- spans_response = self.poll_for_response(
- f"{SENTRY_TEST_HOST}/api/0/organizations/sentry/events/?dataset=spansIndexed&field=id&project=1&statsPeriod=1h"
- )
- assert spans_response.status_code == 200
- spans_response_json = json.loads(spans_response.text)
- assert len(spans_response_json) > 0
+ if response.status_code == 200:
+ sentry_dsn = json.loads(response.text)[0]["dsn"]["public"]
+ if len(sentry_dsn) > 0:
+ break
+ time.sleep(1)
+ sentry_dsn = json.loads(response.text)[0]["dsn"]["public"]
+ assert len(sentry_dsn) > 0
+ return sentry_dsn
+
+
+@pytest.fixture(scope="session")
+def configure_self_hosted_environment():
+ response = None
+ run_shell_command("docker compose --ansi never up -d")
+ for i in range(TIMEOUT_SECONDS):
+ try:
+ response = requests.get(SENTRY_TEST_HOST)
+ except requests.ConnectionError:
+ pass
+ if response is not None and response.status_code == 200:
+ break
+ time.sleep(1)
+ assert response.status_code == 200
+
+ # Create test user
+ run_shell_command(
+ f"echo y | docker compose exec web sentry createuser --force-update --superuser --email {TEST_USER} --password {TEST_PASS}"
+ )
+
+
+@pytest.fixture(scope="function")
+def session_login():
+ session = requests.Session()
+ login_csrf_token = (
+ session.get(SENTRY_TEST_HOST)
+ .text.split('"csrfmiddlewaretoken" value="')[1]
+ .split('"')[0]
+ )
+ login_response = session.post(
+ f"{SENTRY_TEST_HOST}/auth/login/sentry/",
+ data={
+ "op": "login",
+ "username": TEST_USER,
+ "password": TEST_PASS,
+ "csrfmiddlewaretoken": login_csrf_token,
+ },
+ headers={"Referer": f"{SENTRY_TEST_HOST}/auth/login/sentry/"},
+ )
+ assert login_response.status_code == 200
+ yield (session, login_response)
+
+
+def test_initial_redirect():
+ initial_auth_redirect = requests.get(SENTRY_TEST_HOST)
+ assert initial_auth_redirect.url == f"{SENTRY_TEST_HOST}/auth/login/sentry/"
+
+
+def test_login(session_login):
+ session, login_response = session_login
+ assert '"isAuthenticated":true' in login_response.text
+ assert '"username":"[email protected]"' in login_response.text
+ assert '"isSuperuser":true' in login_response.text
+ assert login_response.cookies["sc"] is not None
+ # Set up initial/required settings (InstallWizard request)
+ session.headers.update({"X-CSRFToken": login_response.cookies["sc"]})
+ response = session.put(
+ f"{SENTRY_TEST_HOST}/api/0/internal/options/?query=is:required",
+ headers={"Referer": SENTRY_TEST_HOST},
+ data={
+ "mail.use-tls": False,
+ "mail.username": "",
+ "mail.port": 25,
+ "system.admin-email": "[email protected]",
+ "mail.password": "",
+ "system.url-prefix": SENTRY_TEST_HOST,
+ "auth.allow-registration": False,
+ "beacon.anonymous": True,
+ },
+ )
+ assert response.status_code == 200
+
+
+def test_receive_event(session_login):
+ event_id = None
+ session, _ = session_login
+ with sentry_sdk.init(dsn=get_sentry_dsn(session)):
+ event_id = sentry_sdk.capture_exception(Exception("a failure"))
+ assert event_id is not None
+ response = poll_for_response(
+ f"{SENTRY_TEST_HOST}/api/0/projects/sentry/internal/events/{event_id}/", session
+ )
+ response_json = json.loads(response.text)
+ assert response_json["eventID"] == event_id
+ assert response_json["metadata"]["value"] == "a failure"
+
+
+def test_cleanup_crons_running():
+ cleanup_crons = run_shell_command(
+ "docker compose --ansi never ps -a | tee debug.log | grep -E -e '\\-cleanup\\s+running\\s+' -e '\\-cleanup[_-].+\\s+Up\\s+'",
+ capture_output=True,
+ ).stdout
+ assert len(cleanup_crons) > 0
+
+
+def test_custom_cas():
+ run_shell_command(". _integration-test/custom-ca-roots/setup.sh")
+ run_shell_command(
+ "docker compose --ansi never run --no-deps web python3 /etc/sentry/test-custom-ca-roots.py"
+ )
+ run_shell_command(". _integration-test/custom-ca-roots/teardown.sh")
+
+
+def test_receive_transaction_events(session_login):
+ session, _ = session_login
+ with sentry_sdk.init(
+ dsn=get_sentry_dsn(session), profiles_sample_rate=1.0, traces_sample_rate=1.0
+ ):
+
+ def dummy_func():
+ sum = 0
+ for i in range(5):
+ sum += i
+ time.sleep(0.25)
+
+ with sentry_sdk.start_transaction(op="task", name="Test Transactions"):
+ dummy_func()
+ profiles_response = poll_for_response(
+ f"{SENTRY_TEST_HOST}/api/0/organizations/sentry/events/?dataset=profiles&field=profile.id&project=1&statsPeriod=1h",
+ session,
+ )
+ assert profiles_response.status_code == 200
+ profiles_response_json = json.loads(profiles_response.text)
+ assert len(profiles_response_json) > 0
+ spans_response = poll_for_response(
+ f"{SENTRY_TEST_HOST}/api/0/organizations/sentry/events/?dataset=spansIndexed&field=id&project=1&statsPeriod=1h",
+ session,
+ )
+ assert spans_response.status_code == 200
+ spans_response_json = json.loads(spans_response.text)
+ assert len(spans_response_json) > 0