From Fedora Project Wiki

(initial page)
 
(Undo revision 587709 by Jpbn (talk))
Tag: Undo
(43 intermediate revisions by 14 users not shown)
Line 1: Line 1:
= Fedora Easy Karma =
{{autolang|base=yes}}
 
{| style="float:right;"
! colspan="2" | Quick Links
|-
|[http://fedorapeople.org/cgit/till/public_git/fedora-easy-karma.git gitweb]
|}
fedora-easy-karma allows you to easily portion out karma points for testing updates that you have currently installed. The typical workflow is as follows:
fedora-easy-karma allows you to easily portion out karma points for testing updates that you have currently installed. The typical workflow is as follows:


# install packages from updates-testing: <code>yum --enablerepo=updates-testing update</code>
# install packages from [[QA:Updates_Testing|updates-testing]]: {{command|su -c 'dnf --enablerepo<nowiki>=</nowiki>updates-testing --best update'}}
# Store your FAS username in {{filename|~/.fedora.upn}}
# Use these packages to identify breakage or directly run fedora-easy-karma and test packages according to the update notes
# Use these packages to identify breakage or directly run fedora-easy-karma and test packages according to the update notes
# Run fedora-easy-karma
# Run fedora-easy-karma
== Installation ==
You can install {{package|fedora-easy-karma}} for any supported Fedora release by using the command: {{command|su -c 'dnf --best --enablerepo<nowiki>=</nowiki>updates-testing install fedora-easy-karma'}}


== Example Output ==
== Example Output ==
<pre>
<pre>
$ fedora-easy-karma --help
$ fedora-easy-karma --help
Usage: fedora-easy-karma.py [options]
Usage: fedora-easy-karma [options] [pattern, ..]


You will be asked for every package installed from updates-testing to provide
You will be asked for every package installed from updates-testing to provide
feedback using karma points. After you have selected the karma points, you will
feedback using karma points. If patterns are provided, you will be only prompted
be asked for a comment. An empty comments skips the package
for updates related to packages or builds that match any of the patterns.
Possible wildcards are *, ?, [seq] and [!seq] as explained at
http://docs.python.org/library/fnmatch.html
After selecting the karma points, you will be asked for a comment. An empty
comment skips the update.


Possible karma points are:
Possible karma points are:
Line 20: Line 32:
  0 : The update has not been tested much or at all
  0 : The update has not been tested much or at all
  1 : The update seems not to break anything new
  1 : The update seems not to break anything new
All other inputs will skip the update
All other inputs will skip the update.
You can use <CTRL>-<D> on an empty prompt to exit
If you use a default comment, '<CTRL>-<X> <backspace>' can be used to delete the
default comment to easily enter a custom one.


The source can be found at
The source can be found at
Line 26: Line 41:
Please send bug reports and feature requests to
Please send bug reports and feature requests to
'Till Maas <opensource@till.name>'
'Till Maas <opensource@till.name>'
For patches please use 'git send-mail'.
For patches please use 'git send-email'.


Options:
Options:
   -h, --help            show this help message and exit
   -h, --help            show this help message and exit
  --bodhi-cached        Use cached bodhi query
  --bodhi-cachedir=BODHI_CACHEDIR
                        Directory to store bodhi cache, default: ~/.fedora-
                        easy-karma
  --bodhi-update-cache  Update bodhi query cache
  --critpath-only      Only consider unapproved critpath updates
  --debug              Enable debug output
  --default-comment=COMMENT
                        Default comment to use, default:
  --default-karma=KARMA
                        Default karma to use, default:
   --fas-username=FAS_USERNAME
   --fas-username=FAS_USERNAME
                         FAS username
                         FAS username
   --include-commented  Also ask for more comments on updates that already got
   --include-commented  Also ask for more comments on updates that already got
                         a comment from you
                         a comment from you, this is enabled if patterns are
                        provided
   --installed-max-days=DAYS
   --installed-max-days=DAYS
                         Only check packages installed within the last XX days,
                         Only check packages installed within the last XX days,
Line 40: Line 67:
                         Only check packages installed for at least XX days,
                         Only check packages installed for at least XX days,
                         default: 0
                         default: 0
  --list-rpms-only      Only list affected rpms
  --no-skip-empty-comment
                        Do not skip update if comment is empty
   --product=PRODUCT    product to query Bodhi for, 'F' for Fedora, 'EL-' for
   --product=PRODUCT    product to query Bodhi for, 'F' for Fedora, 'EL-' for
                         EPEL, default: F
                         EPEL, default: F
Line 45: Line 75:
                         releasever to query Bodhi for, default: releasever
                         releasever to query Bodhi for, default: releasever
                         from yum
                         from yum
  --retries=RETRIES    Number if retries when submitting a comment in case of
                        an error, default: 3
   --wrap-bugs          Apply line-wrapping to bugs
   --wrap-bugs          Apply line-wrapping to bugs
  --wrap-rpms          Apply line-wrapping to list of installed rpms
   --wrap-width=WRAP_WIDTH
   --wrap-width=WRAP_WIDTH
                         Width to use for line wrapping of updates, default: 80
                         Width to use for line wrapping of updates, default: 80
 
$ fedora-easy-karma
$ feodra-easy-karma
Getting list of installed packages...
Getting list of packages in updates-testing...
================================================================================
================================================================================
     git-cola-1.4.1.2-2.fc12, python-jsonpickle-0.3.1-1.fc12
     fedora-easy-karma-0-0.7.20100709git561718c8.fc12
================================================================================
================================================================================
   Update ID: FEDORA-2010-1627
   Update ID: FEDORA-2010-11029
     Release: Fedora 12
     Release: Fedora 12
     Status: testing
     Status: testing
       Type: bugfix
       Type: enhancement
       Karma: 0
       Karma: 1
      Bugs: https://bugzilla.redhat.com/546131 - Desktop file for git-cola should be more specific than "Cola"
       Notes: Introduce the --critpath-only parameter.
          : https://bugzilla.redhat.com/532499 - git-cola ships a copy of jsonpickle
   Submitter: till
          : https://bugzilla.redhat.com/543248 - Review Request: python-jsonpickle - A module that allows any object to be serialized into JSON
   Submitted: 2010-07-09 15:30:58
       Notes: * git-cola no longer ships copies of python-jsonpickle and python-
   Comments: bodhi - 2010-07-09 15:30:58 (karma 0)
          : simplejson
             This update has been submitted for testing by till.
          :  * "Classic" GUI option (similar to gitk)
             bodhi - 2010-07-13 07:45:42 (karma 0)
          :  * Fixed keyboard shotcuts (all use modifiers)
          :  * Vim keybindings to the treeview
          :  * Better renaming handling
          :  * Check for upstream changes
          :  * Can clone a repository from the gui
          :  * Support for more git commands
   Submitter: mathstuf
   Submitted: 2010-02-06 21:30:22
   Comments: mathstuf - 2010-02-06 21:30:48 (karma 0)
             This update has been submitted for testing
             bodhi - 2010-02-09 04:59:01 (karma 0)
             This update has been pushed to testing
             This update has been pushed to testing
            robatino (proventesters) - 2010-07-13 08:49:36 (karma 1)
            Seems to work properly.


   https://admin.fedoraproject.org/updates/F12/FEDORA-2010-1627
   https://admin.fedoraproject.org/updates/F12/FEDORA-2010-11029
 
inst. RPMS: fedora-easy-karma-0-0.7.20100709git561718c8.fc12.noarch - Fedora update feedback made easy (installed 0 days ago)


inst. RPMS: git-cola-1.4.1.2-2.fc12.noarch
          : python-jsonpickle-0.3.1-1.fc12.noarch
Comment? -1/0/1 ->karma, other -> skip> 1
Comment? -1/0/1 ->karma, other -> skip> 1
Comment> git-cola works without obvious breakage for some read only operations
Comment> It works perfectly.
FAS Password for till:
FAS Password for till:
</pre>
</pre>
== Example Workflows ==
=== Update Everything, then look at updates and perform some direct testing ===
First update:
dnf update --best --enablerepo<nowiki>=</nowiki>"*-testing"
The run fedora-easy-karma:
fedora-easy-karma
Now read the presented update information. If there is an update to would like to test, do it now in parallel, e.g. if it is a text editor, run it, open some files, edit something etc. Decide what karma should be provided according to [[QA:Update feedback guidelines]], then enter it in the prompt. If you do not know how to test the package, just skip it hitting "Enter".
== Frequently Asked Questions ==
* Q: I just updated package foo from updates-testing, but when I run fedora-easy-karma, why I am not asked for feedback?
: A: The update for the package is probably already requested to become stable or maybe to be unpushed from testing. You will not be asked for feedback on such updates. If you found a new bug, please open a bug report instead.


== Source ==
== Source ==
Currently the source is available at a [http://fedorapeople.org/gitweb?p=till/public_git/fedora-easy-karma.git Fedorapeople git repository]
 
Currently the source is available at the [https://pagure.io/fedora-easy-karma fedora-easy-karma pagure project].
 
[[Category:QA]]

Revision as of 16:46, 10 September 2020

Quick Links
gitweb

fedora-easy-karma allows you to easily portion out karma points for testing updates that you have currently installed. The typical workflow is as follows:

  1. install packages from updates-testing: su -c 'dnf --enablerepo=updates-testing --best update'
  2. Store your FAS username in ~/.fedora.upn
  3. Use these packages to identify breakage or directly run fedora-easy-karma and test packages according to the update notes
  4. Run fedora-easy-karma

Installation

You can install Package-x-generic-16.pngfedora-easy-karma for any supported Fedora release by using the command: su -c 'dnf --best --enablerepo=updates-testing install fedora-easy-karma'

Example Output

$ fedora-easy-karma --help
Usage: fedora-easy-karma [options] [pattern, ..]

You will be asked for every package installed from updates-testing to provide
feedback using karma points. If patterns are provided, you will be only prompted
for updates related to packages or builds that match any of the patterns.
Possible wildcards are *, ?, [seq] and [!seq] as explained at
http://docs.python.org/library/fnmatch.html
After selecting the karma points, you will be asked for a comment. An empty
comment skips the update.

Possible karma points are:
-1 : Update breaks something or does not fix a bug it is supposed to
 0 : The update has not been tested much or at all
 1 : The update seems not to break anything new
All other inputs will skip the update.
You can use <CTRL>-<D> on an empty prompt to exit
If you use a default comment, '<CTRL>-<X> <backspace>' can be used to delete the
default comment to easily enter a custom one.

The source can be found at
http://fedorapeople.org/gitweb?p=till/public_git/fedora-easy-karma.git;a=summary
Please send bug reports and feature requests to
'Till Maas <opensource@till.name>'
For patches please use 'git send-email'.

Options:
  -h, --help            show this help message and exit
  --bodhi-cached        Use cached bodhi query
  --bodhi-cachedir=BODHI_CACHEDIR
                        Directory to store bodhi cache, default: ~/.fedora-
                        easy-karma
  --bodhi-update-cache  Update bodhi query cache
  --critpath-only       Only consider unapproved critpath updates
  --debug               Enable debug output
  --default-comment=COMMENT
                        Default comment to use, default:
  --default-karma=KARMA
                        Default karma to use, default:
  --fas-username=FAS_USERNAME
                        FAS username
  --include-commented   Also ask for more comments on updates that already got
                        a comment from you, this is enabled if patterns are
                        provided
  --installed-max-days=DAYS
                        Only check packages installed within the last XX days,
                        default: 28
  --installed-min-days=DAYS
                        Only check packages installed for at least XX days,
                        default: 0
  --list-rpms-only      Only list affected rpms
  --no-skip-empty-comment
                        Do not skip update if comment is empty
  --product=PRODUCT     product to query Bodhi for, 'F' for Fedora, 'EL-' for
                        EPEL, default: F
  --releasever=RELEASEVER
                        releasever to query Bodhi for, default: releasever
                        from yum
  --retries=RETRIES     Number if retries when submitting a comment in case of
                        an error, default: 3
  --wrap-bugs           Apply line-wrapping to bugs
  --wrap-rpms           Apply line-wrapping to list of installed rpms
  --wrap-width=WRAP_WIDTH
                        Width to use for line wrapping of updates, default: 80
$ fedora-easy-karma
Getting list of installed packages...
Getting list of packages in updates-testing...
================================================================================
     fedora-easy-karma-0-0.7.20100709git561718c8.fc12
================================================================================
  Update ID: FEDORA-2010-11029
    Release: Fedora 12
     Status: testing
       Type: enhancement
      Karma: 1
      Notes: Introduce the --critpath-only parameter.
  Submitter: till
  Submitted: 2010-07-09 15:30:58
   Comments: bodhi - 2010-07-09 15:30:58 (karma 0)
             This update has been submitted for testing by till.
             bodhi - 2010-07-13 07:45:42 (karma 0)
             This update has been pushed to testing
             robatino (proventesters) - 2010-07-13 08:49:36 (karma 1)
             Seems to work properly.

  https://admin.fedoraproject.org/updates/F12/FEDORA-2010-11029

 inst. RPMS: fedora-easy-karma-0-0.7.20100709git561718c8.fc12.noarch - Fedora update feedback made easy (installed 0 days ago)

Comment? -1/0/1 ->karma, other -> skip> 1
Comment> It works perfectly.
FAS Password for till:

Example Workflows

Update Everything, then look at updates and perform some direct testing

First update:

dnf update --best --enablerepo="*-testing"

The run fedora-easy-karma:

fedora-easy-karma

Now read the presented update information. If there is an update to would like to test, do it now in parallel, e.g. if it is a text editor, run it, open some files, edit something etc. Decide what karma should be provided according to QA:Update feedback guidelines, then enter it in the prompt. If you do not know how to test the package, just skip it hitting "Enter".

Frequently Asked Questions

  • Q: I just updated package foo from updates-testing, but when I run fedora-easy-karma, why I am not asked for feedback?
A: The update for the package is probably already requested to become stable or maybe to be unpushed from testing. You will not be asked for feedback on such updates. If you found a new bug, please open a bug report instead.


Source

Currently the source is available at the fedora-easy-karma pagure project.