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

setup package build and testing framework for pdg-staging #37

Open
2 tasks done
mbjones opened this issue Jan 31, 2024 · 3 comments
Open
2 tasks done

setup package build and testing framework for pdg-staging #37

mbjones opened this issue Jan 31, 2024 · 3 comments
Assignees
Labels
pdg testing Building or running tests

Comments

@mbjones
Copy link
Member

mbjones commented Jan 31, 2024

In discussing the need to better package testing, we discussed the need to run unit and integration tests for all packages. This issue is to set up poetry package metadata and pytest as a testing framework and create example tests to be expanded.

  • Configure poetry
  • Configure pytest
@mbjones mbjones self-assigned this Jan 31, 2024
@mbjones mbjones added the testing Building or running tests label Jan 31, 2024
@mbjones
Copy link
Member Author

mbjones commented Jan 31, 2024

Started implementation of this build and test framework in branch https://github.com/PermafrostDiscoveryGateway/viz-staging/tree/feature-37-poetry-build . This provides a pyproject.toml file and a basic pytest setup with tests in the tests directory. Example tests are currently just no-ops, and this is meant to be a starting point for a discussion on package build and setup for testing.

To build the package, run poetry build, to install it run poetry install. To run the tests, run pytest from the root of the package directory.

@julietcohen @westminsterabi feedback appreciated, and let's discuss if this would help build out a better package test suite

@mbjones
Copy link
Member Author

mbjones commented Feb 1, 2024

After successful test run by @westminsterabi , I went ahead and merged PR #38 into develop. Let's follow this same package and test structure for the other packages, viz-workflow, viz-raster, etc.

@mbjones
Copy link
Member Author

mbjones commented Feb 2, 2024

Found an issue that pydantic was a required package but was not listed in the package dependencies. Fixed in sha 50449ab and pushed to develop.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pdg testing Building or running tests
Projects
Status: In Review
Development

No branches or pull requests

1 participant