Skip to content
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

Implement ci-dnf-stack/unit tests and documentation for Python API #213

Open
10 of 21 tasks
kontura opened this issue Jan 3, 2023 · 1 comment
Open
10 of 21 tasks

Implement ci-dnf-stack/unit tests and documentation for Python API #213

kontura opened this issue Jan 3, 2023 · 1 comment
Assignees
@kontura
Labels
epic Priority: MEDIUM Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take
Milestone
Fedora 41

Comments

@kontura
Copy link
Contributor

kontura commented Jan 3, 2023 •
edited by jan-kolarik
Loading

Every function on dnf5 Python API should be documented and should have a test to verify that it works. The tests should be unit tests if possible or a CI tests if necessary based on the required setup for the given test.

In general we should first create documentation for a function and then based on it create the tests.

We need tests for:

libdnf5.base:

[libdnf::advisory]:

libdnf5,repo:

  • RepoQuery
  • [RepoSack]
    • add missing API docs
    • don't forget to mention how variables are substituted when creating repos

libdnf5.rpm:

(The list will be continually updated and links should point to Python docs not cpp.)
@kontura kontura mentioned this issue Jan 23, 2023
Merged
@kontura kontura mentioned this issue Mar 1, 2023
Merged
@glum23 glum23 mentioned this issue Jun 26, 2023
Merged
@j-mracek j-mracek added the Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take label Aug 29, 2023
@kontura kontura self-assigned this Oct 23, 2023
@kontura kontura changed the title Implement ci-dnf-stack tests and documentation for Python API Implement ci-dnf-stack/Unit tests and documentation for Python API Oct 23, 2023
@kontura kontura changed the title Implement ci-dnf-stack/Unit tests and documentation for Python API Implement ci-dnf-stack/unit tests and documentation for Python API Oct 23, 2023
kontura added a commit to kontura/dnf5 that referenced this issue Oct 24, 2023
@kontura
Add advisory python API tests
28ca3dd 
For: rpm-software-management#213
kontura added a commit to kontura/dnf5 that referenced this issue Oct 24, 2023
@kontura
Add advisory python API tests
7425f0c 
For: rpm-software-management#213
@kontura kontura mentioned this issue Oct 24, 2023
Merged
kontura added a commit to kontura/dnf5 that referenced this issue Oct 24, 2023
@kontura
Add advisory python API tests
694b747 
For: rpm-software-management#213
@kontura
Copy link
Contributor Author

kontura commented Oct 24, 2023

Advisory docs and tests: #987

github-merge-queue bot pushed a commit that referenced this issue Oct 27, 2023
@kontura @j-mracek
Add advisory python API tests
5ff69c9 
For: #213
@mcurlej mcurlej added the epic label Nov 3, 2023
@jan-kolarik jan-kolarik added this to the Fedora 40 milestone Jan 9, 2024
@jan-kolarik jan-kolarik mentioned this issue Feb 15, 2024
Merged
@jan-kolarik jan-kolarik mentioned this issue Mar 11, 2024
Open
@jan-kolarik jan-kolarik pinned this issue May 9, 2024
@jan-kolarik jan-kolarik modified the milestones: Fedora 40, Fedora 41 May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kontura kontura

Labels
epic Priority: MEDIUM Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take
Projects
DNF team
Status: In Progress
Milestone
Fedora 41
Development

No branches or pull requests
4 participants
@j-mracek @kontura @mcurlej @jan-kolarik