Skip to content

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

Merged
alexander-alderman-webb merged 3 commits intomasterfrom
webb/running-tests-contributing
Sep 24, 2025
Merged

docs: Update contributing guidelines with instructions to run tests with tox#4857
alexander-alderman-webb merged 3 commits intomasterfrom
webb/running-tests-contributing

Conversation

@alexander-alderman-webb
Copy link
Copy Markdown
Contributor

@alexander-alderman-webb alexander-alderman-webb commented Sep 24, 2025

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

@alexander-alderman-webb alexander-alderman-webb requested a review from a team as a code owner September 24, 2025 08:11
@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 24, 2025 •
edited
Loading

❌ 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
sentrivana approved these changes Sep 24, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@sentrivana sentrivana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding! See one comment.

Comment thread CONTRIBUTING.md Outdated
@alexander-alderman-webb alexander-alderman-webb merged commit d9811fe into master Sep 24, 2025
121 of 123 checks passed
@alexander-alderman-webb alexander-alderman-webb deleted the webb/running-tests-contributing branch September 24, 2025 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sentrivana sentrivana sentrivana approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md test instructions

2 participants

@alexander-alderman-webb @sentrivana