Skip to content

chore: Smoke tests for tutorial code#157

Merged
toby-coleman merged 10 commits into
mainfrom
chore/smoke-tests
Aug 8, 2025
Merged

chore: Smoke tests for tutorial code#157
toby-coleman merged 10 commits into
mainfrom
chore/smoke-tests

Conversation

@toby-coleman
Copy link
Copy Markdown
Contributor

Summary

Closes #108 by testing that all of the tutorials run without errors.

Changes

  • Adds smoke test to run all of the .py files in the examples/tutorials folder.
  • Adds smoke test stage to CI.

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.

Summary of Changes

Hello @toby-coleman, 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 introduces a robust automated testing mechanism to ensure the reliability and correctness of the project's tutorial examples. By setting up smoke tests that execute each tutorial script, it proactively identifies any regressions or issues that might prevent users from successfully running the provided code, thereby improving the overall quality and maintainability of the examples.

Highlights

  • Automated Tutorial Testing: New smoke tests have been implemented to automatically execute all Python tutorial files located in the examples/tutorials directory, ensuring they run without errors.
  • CI Integration: The newly added smoke tests are intended to be integrated into the Continuous Integration (CI) pipeline, adding an automated stage to validate tutorial code on every change.
  • Pytest Marker: A new smoke marker has been defined in pyproject.toml under [tool.pytest.ini_options], allowing for selective execution or exclusion of these specific tests.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 or fill out our survey to provide feedback.

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.

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 adds valuable smoke tests for the tutorials. My feedback focuses on improving code maintainability by removing a redundant fixture and consolidating repeated path calculations into a single constant. These changes will make the new test code cleaner and easier to manage.

Comment thread tests/smoke/test_examples_smoke.py Outdated
Comment thread tests/smoke/test_examples_smoke.py Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Jul 30, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@toby-coleman toby-coleman merged commit f9bbd25 into main Aug 8, 2025
17 checks passed
@toby-coleman toby-coleman deleted the chore/smoke-tests branch August 8, 2025 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: Smoke tests for examples

1 participant