Skip to content

fix: use T.Context in tests#2768

Merged
julieqiu merged 1 commit intogoogleapis:mainfrom
julieqiu:context
Nov 4, 2025
Merged

fix: use T.Context in tests#2768
julieqiu merged 1 commit intogoogleapis:mainfrom
julieqiu:context

Conversation

@julieqiu
Copy link
Copy Markdown
Member

@julieqiu julieqiu commented Nov 3, 2025

T.Context returns a context that is canceled just before Cleanup-registered functions are called, and is intended to be used in tests. See https://pkg.go.dev/testing#T.Context.

@julieqiu julieqiu requested a review from a team as a code owner November 3, 2025 23:02
@gemini-code-assist
Copy link
Copy Markdown
Contributor

gemini-code-assist bot commented Nov 3, 2025

Summary of Changes

Hello @julieqiu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the context handling within Go test files by replacing direct calls to context.Background() with t.Context(). This change aligns with best practices for Go testing, providing a context that is automatically canceled when the test's Cleanup functions are invoked. The primary goal is to enhance the reliability and resource management of tests by ensuring that any operations tied to the context are properly terminated upon test completion.

Highlights

  • Standardized Test Context Usage: Replaced context.Background() with t.Context() across numerous Go test files to ensure proper context management and resource cleanup within test functions.
  • Improved Test Reliability: Leveraging t.Context() ensures that contexts are automatically canceled just before Cleanup-registered functions are called, leading to more robust and isolated test environments.
  • Widespread Application: This change has been applied consistently across various test files within internal/automation, internal/container, internal/docker, internal/librarian, and system_test.go.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@julieqiu julieqiu enabled auto-merge (squash) November 3, 2025 23:07
@codecov
Copy link
Copy Markdown

codecov bot commented Nov 3, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.74%. Comparing base (2984d7a) to head (1775009).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2768      +/-   ##
==========================================
- Coverage   86.93%   86.74%   -0.19%     
==========================================
  Files         118      119       +1     
  Lines        9901    10152     +251     
==========================================
+ Hits         8607     8806     +199     
- Misses        915      947      +32     
- Partials      379      399      +20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gemini-code-assist[bot]
gemini-code-assist bot reviewed Nov 3, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly replaces context.Background() with t.Context() in tests, which is a good practice for managing test lifecycles and enabling cancellations. However, there are several instances where the formatting has been broken, including incorrect indentation and multiple statements on a single line, which will cause compilation errors. I've provided suggestions to fix these formatting issues.

@julieqiu julieqiu merged commit 7e7cd2d into googleapis:main Nov 4, 2025
6 checks passed
@cloud-sdk-librarian-robot cloud-sdk-librarian-robot mentioned this pull request Nov 6, 2025
Closed
@ldetmer ldetmer mentioned this pull request Nov 6, 2025
Merged
ldetmer added a commit that referenced this pull request Nov 6, 2025
@ldetmer
chore: librarian release pull request: 20251106T145301Z (#2808)
f360e18 
PR created by the Librarian CLI to initialize a release. Merging this PR
will auto trigger a release.

Librarian Version: not available
Language Image:
us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/librarian-release-container:latest
<details><summary>librarian: 1.0.0</summary>

##
[1.0.0](v0.5.0...v1.0.0)
(2025-11-06)

### Features

* Remove `..._gax` dependency (#2713)
([01675b7](01675b72))

* add context to Librarian PRs (#2698)
([0523329](0523329a))

* add a package comment linter (#2712)
([1bd3e32](1bd3e32e))

* generate pom.xml files (#2682)
([50b95f2](50b95f20))

* add test-container test logic (#2656)
([514cf7e](514cf7e5))

* improve rust-publish logging (#2671)
([585ed50](585ed50b))

* write a timing log at the end of update-image (#2771)
([5fc9e3b](5fc9e3b6))

* migrate Java container from sdk-platform-java (#2670)
([69ac47f](69ac47fd))

* switch to original head after running update-image (#2696)
([7a3e404](7a3e404a))

* format bulk commit from other sources in release notes (#2665)
([7c52da2](7c52da2b))

* enable multi-version API generation (#2699)
([86c5250](86c52507))

* release stage to update pom.xml files (#2772)
([be56755](be567550))

* use proto presence info to generate null-safe code (#2726)
([e36fb81](e36fb81a))

* Base messages in google_cloud_protobuf (#2660)
([e607ea6](e607ea63))

### Bug Fixes

* retry Github 503 requests up to 3 times (#2650)
([09468fa](09468faf))

* Changed docs to ConfigurationException (#2697)
([0950c1e](0950c1e3))

* fix the reference to the old &#34;librariangen&#34; folder (#2677)
([09dc53f](09dc53fe))

* run godoclint via golangci-lint (#2751)
([264a6a0](264a6a0e))

* pass context as the first argument (#2769)
([298a3bd](298a3bd8))

* Move HTTP client creation to `_gax` (#2672)
([4968d63](4968d63d))

* deduplicate bulk commits (#2758)
([4dfae9a](4dfae9ae))

* Support additional api paths for an existing library (#2666)
([50046f5](50046f55))

* remove stray TODO (#2748)
([5072f0e](5072f0e0))

* omit status field when empty (#2654)
([572ae4f](572ae4f3))

* use T.Context in tests (#2768)
([7e7cd2d](7e7cd2dd))

* wrap error to provide more context for commitAndPush (#2767)
([a2a41a4](a2a41a4a))

* use t.Fatal in tests for proper failure handling (#2759)
([cdabb28](cdabb287))

* enforce removal before copying library files (#2765)
([d5ac6c8](d5ac6c87))

* change log level to debug (#2798)
([f042d0b](f042d0bd))

* change path to `doc.go` in docgen test (#2700)
([fd6bae4](fd6bae40))

### Documentation

* use consistent library id in flags and examples (#2770)
([87a1005](87a10056))

</details>
@julieqiu julieqiu deleted the context branch December 31, 2025 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ldetmer ldetmer ldetmer approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@julieqiu @ldetmer