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
- 9h 56m
- Merged PRs (30d)
- 29
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
-
Run links keep only the last value of repeated query parametersPossibly taken @pheus claimed this 1 day ago. Openapp: scripts severity: medium status: accepted type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
netbox-community/netbox-scripts#83 · 1 assignee ·
Maintainers usually reply within 1 day
-
app: scripts 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
-
Cleanup confirmation treats retained Job history as a blockerPossibly taken @pheus claimed this 1 day ago. Openapp: scripts severity: medium status: accepted type: bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
netbox-community/netbox-scripts#79 · 1 assignee ·
Maintainers usually reply within 1 day
-
Failed REST uploads expose internal error detailsPossibly taken @pheus claimed this 1 day ago. Openapp: scripts severity: medium status: accepted type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
netbox-community/netbox-scripts#77 · 1 assignee ·
Maintainers usually reply within 1 day
-
app: scripts 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
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
-
area:docs documentation effort:M ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
mczielinski/ob-analytics#423 ·
Maintainers usually reply within 1 day
-
infra
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 3 days
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
vllm-project/vllm-ascend#21033 ·
Maintainers usually reply within 1 day