#188: new Flow service in API v2

lsulak commented 3 months ago

created new controller, service, and repository: Flow
new REST API, v2: get checkpoints (with measurements) of a flow, based on a partitioning
tested with Postman and wrote many integration tests as well as unit tests
APIv2: following kebab-case format for API paths, APIv1: keeping camelCase for backward compatibility

Closes #188

github-actions[bot] commented 3 months ago

JaCoCo server module code coverage report - scala 2.13.11

Build Failed

github-actions[bot] commented 3 months ago

JaCoCo model module code coverage report - scala 2.13.11

Build Failed

github-actions[bot] commented 3 months ago

JaCoCo agent module code coverage report - scala 2.13.11

Build Failed

lsulak commented 2 months ago

This PR showcase high-quality code that adheres to best practices and coding standards. However, it would be beneficial to add automated tests for newly created endpoint. While manual testing via tools like Postman is useful for exploratory testing and very specific scenarios, it cannot replace automated tests.

Thanks, appreciate it!

Re API tests: actually it's a good idea. Ticket here: https://github.com/AbsaOSS/atum-service/issues/210 for the future as it's quite difficult to implement all the good ideas immediately :D

lsulak commented 2 months ago

Release notes

Implements a new REST API endpoint: POST api/v2/get-flow-checkpoints for getting checkpoints (with measurements) of a flow; flow being identifiable based on an input partitioning (v2).
Using kebab-case convention for our API paths in v2 (v1 is kept camelCase as it was before, for backward compatibility reasons).

salamonpavel commented 2 months ago

This PR showcase high-quality code that adheres to best practices and coding standards. However, it would be beneficial to add automated tests for newly created endpoint. While manual testing via tools like Postman is useful for exploratory testing and very specific scenarios, it cannot replace automated tests.

Thanks, appreciate it!

Re API tests: actually it's a good idea. Ticket here: #210 for the future as it's quite difficult to implement all the good ideas immediately :D

There are also these unit tests for endpoints that could be implemented also for the new endpoint.

lsulak commented 2 months ago

This PR showcase high-quality code that adheres to best practices and coding standards. However, it would be beneficial to add automated tests for newly created endpoint. While manual testing via tools like Postman is useful for exploratory testing and very specific scenarios, it cannot replace automated tests.

Thanks, appreciate it! Re API tests: actually it's a good idea. Ticket here: #210 for the future as it's quite difficult to implement all the good ideas immediately :D

There are also these unit tests for endpoints that could be implemented also for the new endpoint.

I personally don't like covering everything with all types of tests - but in this case I'll add them, perhaps it's a good enough balance to have at least 1 test for each endpoint type / service, and since here I introduced 'flow' service / functionality, it might be nice to have it.

AbsaOSS / atum-service