WebOfTrust / keria

KERI Agent in the cloud
https://keria.readthedocs.io/en/latest/
Apache License 2.0
16 stars 26 forks source link

Proposal: run integration tests on PR #233

Open lenkan opened 2 months ago

lenkan commented 2 months ago

I would like to add a step to the PR workflow that runs some sort of integration tests so that we can identify any regressions before merging PRs. It would be nice if the tests where implemented right here in this repository. However, I think the integration tests in https://github.com/WebOfTrust/signify-ts are the most complete ones currently.

I will outline my simple proposal below. Any thoughts or alternative approaches?

Proposal - run signify-ts integration tests

I propose that we add a docker-compose environment similar to the one in signify-ts, it really only needs two small adjustments to run tests from here:

Considerations

In case of planned breaking changes, such as changing a endpoint path or adding new required parameters, it would be obvious that the clients need updating ASAP in order to keep the builds healthy.

Another challenge is how to is the potential for false negatives. For example if a bad update to signify-ts causes tests to fail on PRs in keria. Could be solved by pinning the commit of the integration test suite, and only manually upgrade it when needed.

rodolfomiranda commented 2 months ago

+1

2byrds commented 2 months ago

Adding for consideration to the top 10 https://github.com/WebOfTrust/keri/discussions/78