Actions
Bug #57345
closedmgr/dashboard: "openapi-check" test fails
Status:
Resolved
Priority:
High
Assignee:
Category:
Build, CI, Dependencies & Tools
Target version:
-
% Done:
100%
Source:
Tags:
Backport:
quincy,pacific
Regression:
No
Severity:
3 - minor
Reviewed:
Description
Description of problem¶
openapi-check test fails.
Environment¶
ceph versionstring: 91c57c3fb160db1c95d412b966d703ca08ee75ef- Platform (OS/distro/release): ubuntu jammy
- Cluster details (nodes, monitors, OSDs):
- Did it happen on a stable environment or after a migration/upgrade?:
- Browser used (e.g.:
Version 86.0.4240.198 (Official Build) (64-bit)):
How reproducible¶
not reproduciable. almost 1 out of 20 times.
Steps:
make check
Actual results¶
openapi-check run-test: commands[1] | diff openapi.yaml /home/jenkins-build/build/workspace/ceph-pull-requests/src/pybind/mgr/dashboard/.tox/openapi-check/tmp/openapi.yaml 10483c10483 < - description: Get Cluster Details --- > - description: Get Ceph Users ERROR: InvocationError for command /usr/bin/diff openapi.yaml .tox/openapi-check/tmp/openapi.yaml (exited with code 1)
Expected results¶
test passes
Additional info¶
found at https://jenkins.ceph.com/job/ceph-pull-requests/102789/consoleText
Updated by Laura Flores over 1 year ago
https://tox.wiki/en/3.2.0/example/general.html#understanding-invocationerror-exit-codes
Looks like "(exited with code 1)" indicates a catch-all error. Not exceedingly helpful.
https://docs.ceph.com/en/latest/dev/developer_guide/dash-devel/#rest-api-documentation
If changes are made to the controllers/ directory, it’s very likely that they will result in changes to the generated OpenAPI specification. For that reason, a checker has been implemented to block unintended changes. This check is automatically triggered by the Pull Request CI (make check) and can be also manually invoked: tox -e openapi-check.
If that checker failed, it means that the current Pull Request is modifying the Ceph API and therefore:
The versioned OpenAPI specification should be updated explicitly: tox -e openapi-fix.
The team @ceph/api will be requested for reviews (this is automated via GitHub CODEOWNERS), in order to assess the impact of changes.
Updated by Laura Flores over 1 year ago
Might have to do with https://github.com/ceph/ceph/commit/05c1b776c29795af6d015dd14aae2aa1f5d1b912#diff-bd84516dac4dc4b76ed366cf95b2d1c3dedc23c3c03a5f58dd0aa0b03e31eec5, which made a relevant change to openapi.yaml.
Although, this PR was only merged 13 hours ago. The Tracker was raised 8 days ago.
Updated by Ilya Dryomov over 1 year ago
- Related to Bug #57475: mgr/dashboard: 16 - run-tox-mgr-dashboard-openapi (Failed) added
Updated by Pere Díaz Bou over 1 year ago
- Status changed from New to Fix Under Review
- Assignee set to Pere Díaz Bou
- Backport set to quincy,pacific
- Pull request ID set to 48032
Updated by Ernesto Puerta over 1 year ago
- Related to deleted (Bug #57475: mgr/dashboard: 16 - run-tox-mgr-dashboard-openapi (Failed))
Updated by Ernesto Puerta over 1 year ago
- Has duplicate Bug #57475: mgr/dashboard: 16 - run-tox-mgr-dashboard-openapi (Failed) added
Updated by Nizamudeen A over 1 year ago
- Category set to Build, CI, Dependencies & Tools
- Status changed from Fix Under Review to Pending Backport
Updated by Backport Bot over 1 year ago
- Copied to Backport #57492: quincy: mgr/dashboard: "openapi-check" test fails added
Updated by Backport Bot over 1 year ago
- Copied to Backport #57493: pacific: mgr/dashboard: "openapi-check" test fails added
Updated by Konstantin Shalygin over 1 year ago
- Status changed from Pending Backport to Resolved
- % Done changed from 0 to 100
- Tags deleted (
backport_processed)
Actions