Skip to content

metadata API: Constants for top-level rolenames #1648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
lukpueh opened this issue Oct 28, 2021 · 1 comment · Fixed by #1672
Closed

metadata API: Constants for top-level rolenames #1648

lukpueh opened this issue Oct 28, 2021 · 1 comment · Fixed by #1672
Assignees
@ivanayov
Labels
backlog Issues to address with priority for current development goals good first issue Bite-sized items for first time contributors
Milestone
Sprint 13

Comments

@lukpueh
Copy link
Member

lukpueh commented Oct 28, 2021

Description of issue or feature request:

Top-level role names - "root", "timestamp", "snapshot" and "targets" - are hardcoded throughout the code base. Good coding practice suggests to create constants for these and use them instead.

See

grep -rE  [\"\']\(root\|targets\|snapshot\|timestamp\)[\"\'] tuf/api/ tuf/ngclient/

Current behavior:

  • Top-level role names are hardcoded

Expected behavior:

  • Constants for top-level role names are defined in tuf/api/metadata.py and
  • Constants are used in TUF 1.0-bound code, that is at least in tuf/api/* and tuf/ngclient/* and probably any new test modules.
@lukpueh lukpueh added the good first issue Bite-sized items for first time contributors label Oct 28, 2021
@sechkova sechkova added the backlog Issues to address with priority for current development goals label Nov 10, 2021
@ivanayov
Copy link
Collaborator

I'd like to work on that, please.

ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 12, 2021
Create constants for top-level rolenames
d06193e 
This is a change in the metadata API to remove hardcoded rolenames
and use constants instead.
Adresses theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 12, 2021
Apply top-level rolenames constants in tests
bbfb98b 
This applies the use of constants of top-level rolenames in the
tests instead of the previously hardcoded strings.
Addresses theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
@ivanayov ivanayov mentioned this issue Nov 12, 2021
Merged
3 tasks
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 12, 2021
Create constants for top-level rolenames
7f094c5 
This is a change in the metadata API to remove hardcoded rolenames
and use constants instead.
Adresses theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 12, 2021
Apply top-level rolenames constants in tests
010dcc8 
This applies the use of constants of top-level rolenames in the
tests instead of the previously hardcoded strings.
Addresses theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 12, 2021
Create constants for top-level rolenames
855bb36 
This is a change in the metadata API to remove hardcoded rolenames
and use constants instead.
Adresses theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 12, 2021
Apply top-level rolenames constants in tests
13d0345 
This applies the use of constants of top-level rolenames in the
tests instead of the previously hardcoded strings.
Addresses theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 12, 2021
Apply top-level rolenames constants in tests
3a7e025 
This applies the use of constants of top-level rolenames in the
tests instead of the previously hardcoded strings.
Addresses theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 17, 2021
Create constants for top-level rolenames
a48c98f 
This is a change in the metadata API to remove hardcoded rolenames
and use constants instead.
Fixes theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 17, 2021
Apply top-level rolenames constants in tests
a6c8c73 
This applies the use of constants of top-level rolenames in the
tests instead of the previously hardcoded strings.
Fixes theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 22, 2021
Create constants for top-level rolenames
4524ca1 
This is a change in the metadata API to remove hardcoded rolenames
and use constants instead.
Fixes theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 22, 2021
Apply top-level rolenames constants in tests
699972c 
This applies the use of constants of top-level rolenames in the
tests instead of the previously hardcoded strings.
Fixes theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
@sechkova sechkova added this to the Sprint 13 milestone Nov 24, 2021
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 25, 2021
Create constants for top-level rolenames
b992bb9 
This is a change in the metadata API to remove hardcoded rolenames
and use constants instead.
Fixes theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Nov 25, 2021
Apply top-level rolenames constants in tests
1c0c253 
This applies the use of constants of top-level rolenames in the
tests instead of the previously hardcoded strings.
Fixes theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Dec 2, 2021
Create constants for top-level rolenames
d7c6534 
This is a change in the metadata API to remove hardcoded rolenames
and use constants instead.
Fixes theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
ivanayov pushed a commit to ivanayov/python-tuf that referenced this issue Dec 2, 2021
Apply top-level rolenames constants in tests
00589f0 
This applies the use of constants of top-level rolenames in the
tests instead of the previously hardcoded strings.
Fixes theupdateframework#1648

Signed-off-by: Ivana Atanasova <[email protected]>
@jku jku closed this as completed in #1672 Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ivanayov ivanayov

Labels
backlog Issues to address with priority for current development goals good first issue Bite-sized items for first time contributors
Projects
None yet
Milestone
Sprint 13
Development

Successfully merging a pull request may close this issue.

Create constants for top-level rolenames ivanayov/python-tuf
3 participants
@lukpueh @ivanayov @sechkova