[EPIC] Steering API integration test suite (high prio endpoints)

Parent: [EPIC] Basic test coverage for all services (aura#175)

To ensure friction-less integration and compatibility with other services, we need a test suite for the Steering API.

These tests should be running as a CI/CD pipeline step and provide these benefits:

• No broken code is committed to main
• The Dashboard test suite is not the only place to uncover bugs or breaking changes (transfer of responsibilities)
• Any API changes are documented and transparent by changes of the test cases
• API consumers, like people at the radio stations using the API, have the added benefit to get a "code example" on how to use the API. This previously was an error prone process, as the API Docs at https://api.aura.radio/steering/ are not fully documented.

Sub Tasks

High priority

Already done by @eigenwijsje:

• /api/v1/users/** (99%)
• /api/v1/rrules/** (read-only)
• /api/v1/notes/** (100%)
• /api/v1/shows/** (100%)
• /api/v1/hosts/** (87%)
• /api/v1/images/** (97%)
• /api/v1/timeslots/** (98%)
• /api/v1/schedules/** (100%) (Collision detection might be good to have 100% plus further thinking about test case which have existing data in the test case, to trigger "special scenarios")

Follow up task

• [EPIC] Steering API integration test suite (med... (#208 - closed)

changed milestone to %1.0-alpha5 — Capable Capybara

added P1 discuss labels

mentioned in issue aura#175

marked this issue as related to aura#175

mentioned in issue #43 (closed)

marked this issue as related to #43 (closed)

mentioned in issue #208 (closed)

changed the description

changed milestone to %1.0-alpha4 — Raving Raccoon

changed title from [EPIC] Steering API integration test suite to [EPIC] Steering API integration test suite (high prio endpoints)

added EPIC label

added 1 deleted label

added To Do label

changed the description

assigned to @chrizz

removed discuss label

marked the checklist item /api/v1/images/** (92%) as incomplete

changed the description

@chrizz I have unchecked the image endpoints, since afaik they are currently failing.

https://gitlab.servus.at/aura/steering/-/jobs/15617#L373

Thanks. So the coverage decreased from 92% to 29%.

edit: almost all other test areas also decreased in coverage, so they are now open to be extended @chrizz.

The numbers in the log show the progress inside the testsuite:

program/tests/test_hosts.py ......s.                                     [ 10%]
program/tests/test_images.py ...............                             [ 29%]
program/tests/test_schedules.py .................                        [ 50%]
program/tests/test_shows.py ........                                     [ 60%]
program/tests/test_timeslots.py ..........                               [ 73%]
program/tests/test_users.py ...............                              [ 92%]
program/tests/test_notes.py ......                                       [100%]

The actual coverage numbers for the tests are higher than the ones you have:

Name                              Stmts   Miss  Cover
-----------------------------------------------------
program/tests/test_hosts.py          45      6    87%
program/tests/test_images.py         73      1    99%
program/tests/test_notes.py          51      0   100%
program/tests/test_schedules.py     116      0   100%
program/tests/test_shows.py          43      0   100%
program/tests/test_timeslots.py      44      1    98%
program/tests/test_users.py          84      1    99%

Oh! forgive me looking in the wrong section. Sorry for that :-)

marked the checklist item /api/v1/images/** (92%) as completed

changed the description

changed the description

changed the description

Just enabled "Pipeline must succeed" in "Settings => Merge requests" to avoid merging branches with failed tests. Verified by !38 (closed)

Super! Thank you for observing and fixing

There were some annotations missing in the OpenAPI specs but I'm not sure if I addded them correctly or if that's intended - please check !39 (merged)

Is there something left to be done since @eigenwijsje completed all sub tasks?

@eigenwijsje thanks for completing all the test cases here! Next time, when silently taking things over, please try to communicate with the team/@chrizz along the road. Just to avoid confusion :-)

Re-assigning the completed ticket from Chris to Ernesto.

added Doing label and removed To Do label

closed

removed Doing label

assigned to @eigenwijsje and unassigned @chrizz