theupdateframework / theupdateframework/python-tuf

ngclient: make update progress easier to follow in logs

Open
#1,804 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog enhancement
Dominant language
Python
Stars
1.7k
Forks
304
Avg merge
1d 2h
Merged PRs (30d)
17

Description

This might be a hard issue to close but I'd like it if it was easier to follow the client update process in the logs:
It's certainly already possible with debug logging but requires a lot of reading and probably a fairly deep understanding of the components.

I'd like to see

  • the major specification steps (the ones required to see which branches the code took in validating metadata)
  • State changes in "trusted metadata set" with
    • local metadata loads
    • metadata downloads

...without any other logs getting in the way

This is specifically not a 1.0 blocker: just moving a TODO item from code to issue tracker

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the ngclient update flow and reviewing the existing debug logging around specification steps and the trusted metadata set. Define which major validation branches and local-load or download state changes should be visible without unrelated logs. Done means the update process can be followed from focused logs alone.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.