Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation & example on writing tests for Hamilton code #1044

Open
skrawcz opened this issue Jul 19, 2024 · 0 comments
Open

Add documentation & example on writing tests for Hamilton code #1044

skrawcz opened this issue Jul 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@skrawcz
Copy link
Collaborator

skrawcz commented Jul 19, 2024

Is your feature request related to a problem? Please describe.
We don't have an example and documentation around testing hamilton code. It's more straightforward than people think, e.g. some think that with decorators testing becomes harder.

Describe the solution you'd like

  1. A section in the User Guide on writing tests.
  2. This should cover unit testing functions without decorators, and functions with decorators.
  3. This should cover integration testing parts of a DAG - using overrides to show how to run various parts of the graph.
  4. This should cover how test custom materializers -- basically just show an example of how we test the in built ones. E.g. create a resource folder with python code, or use create_adhoc_module from adhoc_utils.

Describe alternatives you've considered
N/A

Additional context
You can largely see how the Hamilton tests work for an idea for content/material.

@skrawcz skrawcz added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant