Distinguish expected script failures from unexpected errors
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
Research direction
Start by comparing the script execution paths with NetBox's netbox/netbox/jobs.py and its existing Job statuses and handling. Done means AbortScript produces Failed, unhandled exceptions produce Errored, diagnostics and log sanitization remain useful, rollback behavior is documented, and log_failure() retains its logging-only semantics.
Written by the indexing model from the issue text.
Description
Plugin Version
v0.0.1
Proposed functionality
Use the final Job status to distinguish success, an intentional refusal, and an unexpected error. AbortScript should result in Failed, while an unhandled exception should result in Errored. Both currently produce a failed Job.
Apply this consistently across execution paths, preserve useful diagnostics and log sanitization, and document the rollback behavior.
Keep log_failure() as a logging operation unless a separate compatibility decision changes it. This status change should not give logging calls new transaction semantics.
Use case
A deployment script may correctly stop because a prerequisite is missing. Operators and automation need to distinguish that outcome from a programming error without reading the entire log.
Related request: netbox-community/netbox#22951.
External dependencies
Reuse the existing statuses and handling in NetBox's Job runner. No new package or service is expected.
- Dominant language
- Python
- Stars
- 8
- Forks
- 0
- Avg merge
- 11h 41m
- Merged PRs (30d)
- 38
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from netbox-community/netbox-scripts
-
app: scripts Bucket: Improve status: backlog type: documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
netbox-community/netbox-scripts#80 ·
Maintainers usually reply within 1 day
-
app: scripts Bucket: KTLO severity: low status: backlog type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
netbox-community/netbox-scripts#76 ·
Maintainers usually reply within 1 day
-
app: scripts Bucket: KTLO severity: medium status: backlog type: bug
Difficulty 4/5 3-5 days Newbie friendliness 52/100
netbox-community/netbox-scripts#114 ·
Maintainers usually reply within 1 day
-
app: scripts Bucket: KTLO severity: medium status: backlog type: bug
Difficulty 4/5 3-5 days Newbie friendliness 55/100
netbox-community/netbox-scripts#112 ·
Maintainers usually reply within 1 day
-
app: scripts Bucket: KTLO severity: low status: backlog type: bug
Difficulty 4/5 3-5 days Newbie friendliness 45/100
netbox-community/netbox-scripts#111 ·
Maintainers usually reply within 1 day
All issues in netbox-community/netbox-scripts
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Textualize/textual#6753 · 1 comment ·
-
priority:low size:small
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
RonaldHensbergen/composable-data-stack#1177 ·
Maintainers usually reply within 1 day
-
Use registered media types for HDF5 and NetCDF, and stop claiming media_type must be IANA-registeredOpendocumentation metadata
Difficulty 2/5 1-3 hours Newbie friendliness 87/100
Maintainers usually reply within 1 day
-
check-typing: ty 0.0.98+ fails on the renamed rule `unresolved-import` (now `import-not-found`)Possibly taken @oberstet claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 91/100
crossbario/cfxdb#145 ·