docs: Update contributing guidelines with instructions to run tests with tox #4857

alexander-alderman-webb · 2025-09-24T08:11:15Z

Description

The instructions to run tests are outdated. I replaced them with a little background about tox and some commands you can use to run the tests.

Issues

Closes #4548

Reminders

Please add tests to validate your changes, and lint your code using tox -e linters.
Add GH Issue ID & Linear ID (if applicable)
PR title should use conventional commit style (feat:, fix:, ref:, meta:)
For external contributors: CONTRIBUTING.md, Sentry SDK development docs, Discord community

…ith tox

codecov · 2025-09-24T08:15:18Z

❌ 24 Tests Failed:

Tests completed	Failed	Passed	Skipped
22036	24	22012	2100

View the top 3 failed test(s) by shortest run time

tests.integrations.aws_lambda.test_aws_lambda::test_basic_exception

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_error_has_existing_trace_context[RaiseErrorPerformanceEnabled]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_error_has_new_trace_context[RaiseErrorPerformanceDisabled]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_error_has_new_trace_context[RaiseErrorPerformanceEnabled]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_headers[empty dict headers]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_headers[empty list headers]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_headers[empty string headers]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_headers[no headers]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_headers[none headers]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_init_error

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_non_dict_event[event as bool]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_non_dict_event[event as dict]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_non_dict_event[event as empty list]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_non_dict_event[event as float]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_non_dict_event[event as integer]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_non_dict_event[event as list of dicts]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_non_dict_event[event as string]

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_request_data

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_span_origin

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_timeout_error

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_trace_continuation

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_traces_sampler_has_correct_sampling_context

Stack Traces | 0s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_error_has_existing_trace_context[RaiseErrorPerformanceDisabled]

Stack Traces | 0.001s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

tests.integrations.aws_lambda.test_aws_lambda::test_basic_no_exception

Stack Traces | 71.4s run time

.../integrations/aws_lambda/test_aws_lambda.py:70: in test_environment
    LocalLambdaStack.wait_for_stack()
.../integrations/aws_lambda/utils.py:221: in wait_for_stack
    raise TimeoutError(
E   TimeoutError: AWS SAM failed to start within 60 seconds. (Maybe Docker is not running?)

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

sentrivana

Thanks for adding! See one comment.

CONTRIBUTING.md

docs: Update contributing guidelines with instructions to run tests w…

735ed9d

…ith tox

alexander-alderman-webb requested a review from a team as a code owner September 24, 2025 08:11

sentrivana approved these changes Sep 24, 2025

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

alexander-alderman-webb added 2 commits September 24, 2025 12:09

Add pyenv link

1b507dc

Merge branch 'master' into webb/running-tests-contributing

03186db

alexander-alderman-webb merged commit d9811fe into master Sep 24, 2025
121 of 123 checks passed

alexander-alderman-webb deleted the webb/running-tests-contributing branch September 24, 2025 10:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: Update contributing guidelines with instructions to run tests with tox #4857

docs: Update contributing guidelines with instructions to run tests with tox #4857

alexander-alderman-webb commented Sep 24, 2025

Uh oh!

codecov bot commented Sep 24, 2025 •

edited

Loading

Uh oh!

sentrivana left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

docs: Update contributing guidelines with instructions to run tests with tox #4857

docs: Update contributing guidelines with instructions to run tests with tox #4857

Conversation

alexander-alderman-webb commented Sep 24, 2025

Description

Issues

Reminders

Uh oh!

codecov bot commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ 24 Tests Failed:

Uh oh!

sentrivana left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Sep 24, 2025 •

edited

Loading