#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: Type: task | Status: new Priority: major | Milestone: 0.5.0 Component: core | Keywords: --------------------+------------------------------------------------------- We need to have a plaintext template for pretty logs. It will be universal for all tests and different parts of the template will be replaced by actual results/data. Ideas for example template can be found here:
https://fedorahosted.org/autoqa/wiki/Planning050logFormatting
Create the template and also some means to replace different parts of the template.
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: new Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Changes (by vhumpa):
* owner: => vhumpa
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Changes (by vhumpa):
* status: new => assigned
Comment:
I've come up with this template on how the generic pretty log could look like: http://vhumpa.fedorapeople.org/prettylog_template.txt Voluntary parts or parts that would be present only for specific test type are in [] brackets.
Here is an example for https://admin.fedoraproject.org/updates/bugzilla-3.6.5-1.fc14?_csrf_token=53... upgradepath update: http://vhumpa.fedorapeople.org/prettylog_upgradepath_example.txt
If agreed, I will now write a function/class, that will construct the pretty log on demand, which will be used both by upgradepath and depcheck tests.
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by vhumpa):
Class to construct the plain text pretty log is now up for review: https://fedorahosted.org/reviewboard/r/144/
Following I will continue with #315
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by jlaska):
I love the template, that helps get the ball rolling on this issue. The only comments I have are that 1) it feels slightly wordy in some spots, and 2) that the test Summary should be the first thing on the page.
Using your example, I've made a few modifications for review. Changes include ..
* Add the proposed update-id (e.g FEDORA-2011-XXXX) to the output. This value might not be available at the time the test runs, but if it is, it'd be good to include. This also assumes these logs are for each update, not each build, right? * Condense all the 'more info' links into just the single new document kparal created ('AutoQA_tests/Upgradepath'). There were too many links/words ... and tips for resolving the problems are documented on that page * Some minor wording adjustments * I hesitate to remove the 'SUMMARY' altogether ... since the maintainer probably doesn't care about other packages that fail or pass upgradepath. They likely only care about their update. Thoughts?
The changes are available using the links below: * http://jlaska.fedorapeople.org/prettylog_upgradepath_example.txt * http://jlaska.fedorapeople.org/prettylog_upgradepath_example2.txt (removed summary information)
My preference would be the second one, but that depends on whether we think maintainers want to know test results about other packages also tested at the same time. My sense is they don't.
Because I needed a distraction, I toyed with another html mock-up. I'm not pitching this as a substitute, I think the txt output is better. Besides, this report would need a *lot* of styling, which seems like a distraction from our immediate goal. Anyway, food for thought ... * http://jlaska.fedorapeople.org/prettylog_upgradepath_example3.html
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by vhumpa):
I agree with the template being way to wordy. Removing the footnote and putting the "Additional information" section at the bottom is also likely better.
Summary will go first then, and I don't think we should remove it for upgradepath - perhaps only packages from the one particular update should be shown there. That will often be just a single or a few packages, so it won't take much space finally. I put all the tested packages in the example before, sorry for the confusion.
Should the bodhi update ID be available, yes, let's put it there, although I wouldn't replace the update name by it. If the ID would not be available at the moment, the whole top test summary would just seem incomplete to me, but it's just a feeling.
How about adding the update ID as extra row, that would just show only when we have it?
Here's an example how I think the log could look like now: http://vhumpa.fedorapeople.org/prettylog_upgradepath_example2.txt
I like the html very much, I will add an option to generate the html version instead to the PrettyLog class as soon as we decide to go with it.
I will modify the PrettyLog class to generate the revised log as soon as we agree on it. (Please note that patch in reviewboard is not current anymore, I've done some changes to it yesterday).
Ah - and with the alignment it is way more readable, thanks :-)
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by kparal):
Replying to [comment:5 vhumpa]:
Summary will go first then, and I don't think we should remove it for
upgradepath - perhaps only packages from the one particular update should be shown there.
No perhaps, definitely.
How about adding the update ID as extra row, that would just show only
when we have it?
+1
Here's an example how I think the log could look like now: http://vhumpa.fedorapeople.org/prettylog_upgradepath_example2.txt
Looks good.
(Please note that patch in reviewboard is not current anymore, I've done
some changes to it yesterday).
For this work in heavy progress it's not much useful to use reviewboard (let's mark as discarded?). Please push to some remote git branch instead, thanks.
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by jlaska):
Replying to [comment:6 kparal]:
Replying to [comment:5 vhumpa]:
Summary will go first then, and I don't think we should remove it for
upgradepath - perhaps only packages from the one particular update should be shown there.
No perhaps, definitely.
Yeah, that's a better idea. Keep the summary, but make it specific to the update (and the packages included).
How about adding the update ID as extra row, that would just show only
when we have it?
+1
+1 also.
How will these additional pretty logs be saved on disk and referenced in the bodhi comment? Will they be referenced by the UPDATE-ID, some random integer, a long string of packages in the update? Perhaps this is getting too far ahead.
Here's an example how I think the log could look like now: http://vhumpa.fedorapeople.org/prettylog_upgradepath_example2.txt
Looks good.
Concise and informative, that seems like a winner to me
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by vhumpa):
The revised version of the PrettyLog class is now finished. It's little more complex now and actually much more straightforward than the one I posted to review board a week ago. Most important is that it's completely generic now and can be used with all tests, both multi (upgradepath, depcheck) and single-package (all the others.).
We've also decided on moving the *conf files and making a new 'conf' directory where the autoqa.conf, fas.conf, repoinfo.conf, autoqa.cron and the log_template will go. With this of course changes into makefile etc. are pending that I will do before we merge all the rather extensive changes of last/this week.
I put all the changes in the origin/vhumpa branch, so you can look over the code (and 'api') so that you know how exactly to use it. It still needs to be tested with the new dir structure and some comments still needs to be written, but the coding seems over. Refer to the overall class docstring for specific information.
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by jlaska):
Replying to [comment:8 vhumpa]:
The revised version of the PrettyLog class is now finished. It's little
more complex now and actually much more straightforward than the one I posted to review board a week ago. Most important is that it's completely generic now and can be used with all tests, both multi (upgradepath, depcheck) and single-package (all the others.).
We've also decided on moving the *conf files and making a new 'conf'
directory where the autoqa.conf, fas.conf, repoinfo.conf, autoqa.cron and the log_template will go. With this of course changes into makefile etc. are pending that I will do before we merge all the rather extensive changes of last/this week.
Good call, that's been getting on my nerves too :)
I'd really like for the main scripts (watchers and autoqa) to be able to run out of a git checkout without requiring 'make install'. Will that be possible with this new setup? Meaning, will 'autoqa' (and the watchers) now look in conf/ *and* /etc/autoqa/ for config files?
I put all the changes in the origin/vhumpa branch, so you can look over
the code (and 'api') so that you know how exactly to use it. It still needs to be tested with the new dir structure and some comments still needs to be written, but the coding seems over. Refer to the overall class docstring for specific information.
I'm looking through https://fedorahosted.org/reviewboard/r/144/ now ... will respond with any feedback.
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by kparal):
Replying to [comment:9 jlaska]:
I'd really like for the main scripts (watchers and autoqa) to be able to
run out of a git checkout without requiring 'make install'. Will that be possible with this new setup? Meaning, will 'autoqa' (and the watchers) now look in conf/ *and* /etc/autoqa/ for config files?
"Install-less" execution would require more changes than the one mentioned IMO. If we really want to have that feature supported (I never needed it much, but I have no objections either), let's create a separate ticket for that.
I'm looking through https://fedorahosted.org/reviewboard/r/144/ now ...
will respond with any feedback.
No, don't do that, that's outdated :-) Look into origin/vhumpa instead.
(My code is in origin/kparal and I'll soon create a branch origin/pretty where I'll starting merging my and vhumpa's code.)
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: assigned Priority: major | Milestone: 0.5.0 Component: core | Resolution: Keywords: | --------------------+------------------------------------------------------- Comment (by vhumpa):
Replying to [comment:9 jlaska]:
I'd really like for the main scripts (watchers and autoqa) to be able to
run out of a git checkout without requiring 'make install'. Will that be possible with this new setup? Meaning, will 'autoqa' (and the watchers) now look in conf/ *and* /etc/autoqa/ for config files?
I am just about to do the changes to reflect this around all of the AutoQA now. I agree it's a good idea to make it this way while I am at it. It's been bothering me a bit too while I was testing new stuff. No need to go for VM and do "make install" everytime can certainly come handy for some testing.
This doesn't really have much to do with pretty log anymore, so I am about to make a new ticket.
I'm looking through https://fedorahosted.org/reviewboard/r/144/ now ...
will respond with any feedback.
No, don't do that, that's outdated :-) Look into origin/vhumpa instead.
Yes please, that's outdated big time :)
#327: create plaintext template for pretty logs --------------------+------------------------------------------------------- Reporter: kparal | Owner: vhumpa Type: task | Status: closed Priority: major | Milestone: 0.5.0 Component: core | Resolution: fixed Keywords: | --------------------+------------------------------------------------------- Changes (by vhumpa):
* status: assigned => closed * resolution: => fixed
Comment:
Not current anymore with a move towards html.
autoqa-devel@lists.fedorahosted.org
-
fedora-badges