5,576
edits
Changes
From SME Server
Jump to navigationJump to search→Verifying Bugs
<noinclude>{{Languages}}</noinclude>
<noinclude>{{Languages}}</noinclude>
==Bug Tracker==
==Bug Tracker==
Please help us to make our software as reliable as possible. Please report possible bugs only via the bug tracker and to encourage others to do the same.
Please help us to make our software as reliable as possible. Please report possible bugs only via the bug tracker and encourage others to do the same.
Bugzilla is just a standard communication format for problem solving. Replies may seem abrupt but that is just the nature of the medium. Don't be concerned by a stark Wontfix or Invalid, it's how the system works. Discussions are for forums
Find, report and fix bugs here http://bugs.contribs.org
Find, report and fix bugs here http://bugs.contribs.org
===Bugzilla is easy===
===Bugzilla is easy===
A frequent complaint is Bugzilla is too hard or convoluted, but it is hard to justify.
A frequent complaint is Bugzilla is too hard or convoluted, but it is hard to justify the complaint.
*You open an account
*You open an account
===Searching Bugs===
===Searching Bugs===
Have you searched bugzilla, and read the SME Server Manual and FAQ ?
Have you searched bugzilla, and read the SME Server Manual and FAQ ?
Simple and Advanced aren't necessarily easy so we added prepared searches to the bugzilla page headers.
* Simple
* Simple
* Advanced
* Advanced
You can restrict searches by using a selection or multiple selections of a category <br />
You can restrict searches by using a selection or multiple selections of a category <br />
Use Control Click to select/deselect from selection sets, if none are selected all are.
Use Control Click to select/deselect from selection sets, if none are selected the defailt is all.
* Reports
* Reports
===Reporting Bugs===
===Reporting Bugs===
Please take the time to read
Please take the time to read
[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]
[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]
(available in multiple languages)
(available in multiple languages)
For bugs in SME Server Release, SME Server Future & SME Server Translations the following format is suggested. It's not always appropriate eg. New Feature Requests
For bugs in SME Server Release, SME Server Future & SME Server Translations the following format is suggested. It's not always appropriate so use some discretion, see eg. New Feature Requests
When reporting a new bug, and after choosing the platform, the next screen asks for more details on your problem. There are 4 main fields that need to be completed. These are '''Component,''' '''Found-In-Version,''' '''Summary,''' and '''Description.''' Fields such as '''Flags''' and '''Requestee''' should be left blank initially by most reporters. The '''CC''' field is for other people you would like notices on this issue to be sent to. YOU will always be automatically included by default, so you don't need to 'cc' yourself. The '''Attachment''' button at the bottom of the page is used to attach additional file information such as log files that may be helpful.
'''Component:''' As accurately as possible, you may choose which category your issue fits into. If Unknown then choose UNKNOWN.
'''Found-in-version:''' Usually self explanatory. If it applies to more than one version, choose the most recent stable release.
'''Summary:''' How would you describe the bug. A good summary should quickly and uniquely identify a bug report. It should explain the problem, not your suggested solution.
'''Summary:''' How would you describe the bug. BE BRIEF. A good summary should quickly and uniquely identify a bug report. It should explain the problem, not your suggested solution.
* Good: "Canceling a File Copy dialog crashes File Manager"
* Good: "Canceling a File Copy dialog crashes File Manager"
* Bad: "Browser should work with my web site"
* Bad: "Browser should work with my web site"
'''Description:''' The details of your problem report, including:
'''Description:''' Present the details of your problem in this section. You may use the following as a template:
'''ENVIRONMENT''': '''''Give a brief server history'''''
eg. SME Server 7.1, Updated to 7.3 with yum
eg. SME Server 7.1, Updated to 7.3 with yum
'''MODIFICATIONS''': '''''List any contribs or modifications you have on the server'''''
If the following produce any output, attach the results (don't post inline)
eg. If the following produce any output, attach the results (don't post inline)
/sbin/e-smith/audittools/templates
/sbin/e-smith/audittools/newrpms
'''''or say''''', no custom-templates or contribs.
'''ORIGINAL PROBLEM''': '''''State what you were trying to do.'''''
'''STEPS TO REPRODUCE''': '''''As accurately and exactly as possible state what you did to get your problem.'''''
'''ACTUAL RESULTS''': '''''List what you got as a result.'''''
'''EXPECTED RESULTS''': '''''List what you expected to happen.'''''
'''Attachment:''' This is used to attach (not post in line) any logs or results of command line queries such as the examples listed in "Modifications" above.
Finally, when satisfied with your entries, submit your bug report by pressing the '''COMMIT''' button.
===Verifying Bugs===
===Verifying Bugs===
Bugs in the SME Server Release, SME Server Future & SME Server Translations products
Bugs in the SME Server Release, SME Contribs & SME Server Translations products
need to be verified if fixed. (otherwise they can be closed)
need to be verified when fixed, see the [[Verification_Queue]] for the current list. See [[SME_Server:Documentation:QA:Verification]] for a detailed description of the verification process. <br />
An example is [[bugzilla:3727]]. You can use the text below as a template.
An example is [[bugzilla:3727]] or [[bugzilla:7364]].
'''Information from here is used in the Updates Announcements and if you use this format will save duplication of work'''
'''Information from here is used in the Updates Announcements and if you use this format, it will save duplication of work'''
Other Products can be Closed after being fixed, as they are not part of the updates process.
Other Products can be Closed after being fixed, as they are not part of the updates process.
= Environment:
The bug report will detail the exact package and version needed. These are normally in smeupdates-testing and can be installed by :
yum --enablerepo=smeupdates-testing update <package>
for example
yum --enablerepo=smeupdates-testing update e-smith-ldap
As it is a manual step to move packages into smeupdates-testing the most recent packages will be in smetest and can be installed from there if necessary.
for example
yum --enablerepo=smetest update e-smith-ldap
or if you need several repositories :
yum --enablerepo=smetest,smeupdates-testing,smedev update e-smith-ldap
When performing verification, please use the following template:
'''VERIFICATION TEMPLATE'''
= ENVIRONMENT:
= Current version installed:
= ORIGINAL PROBLEM:
= Original problem:
= RESOLUTION:
= Resolution:
= CURRENT VERSION INSTALLED:
= Updated version installed:
= TESTING:
= Problem fixed:
= UPDATED VERSION INSTALLED:
= Verified or Reopen:
= PROBLEM FIXED:
= VERIFIED OR REOPEN:
= DOCUMENTATION IMPACT:
= SUGGESTED RELEASE NOTES:
AS AN EXAMPLE:
VERIFICATION
= ENVIRONMENT:
[description of test system (version, installation methods, upgrade history. etc).
If you have some non-core package installed, run /sbin/e-smith/audittools/newrpms and provide output]
= ORIGINAL PROBLEM:
[Summarise bug]
= RESOLUTION:
[Insert changelog for new package]
In example:
Fixed in e-smith-base
* Mon Apr 21 2013 chris burnat <devlist@burnat.com> 5.4.0-27.sme
- Fix the way '.' works in bash [SME: 7532]
= CURRENT VERSION INSTALLED:
[rpm -qa <package name>]
=TESTING:
[Reproduce bug if you can, showing steps taken]
= UPDATED VERSION INSTALLED:
[Update to new package, show steps taken]
and:
[rpm -qa <package name>]
= PROBLEM FIXED?:
[Repeat steps carried out under TESTING above.
= VERIFIED OR REOPEN:
[Problem fixed, then VERIFIED - not fixed, then REOPEN]
Note: if you may not have rights to toggle resolution, someone will do it for you
= DOCUMENTATION IMPACT:
[Does something need documentation, eg a db or new procedure? if affirmative, please provide details, someone will later punt to docteam for action]
= SUGGESTED RELEASE NOTES:
[Summary of what was fixed]
===Testing===
It is recommended that some basic tests be carried out before resolving VERIFIED. The scope of these tests very much depends on functionality associated with the package(s) under consideration. The following list whilst not fully inclusive can be used as a guide:
*Hosting http
*Hosting https
*Access external http
*Access external https
*SSH access to server
*Send Email
*Receive Email
*Use Webmail
*Use Samba
*FTP access to SME
*Check /var/log/messages or/and any other relevant log.
===General===
===General===
====Bug Categories====
====Bug Categories====
With the release of SME 7.3, development is now focussed on reaching 8.0
Bugs are sorted by '''Product''', they should be mostly self explanatory. Future/7.x/8.x/9.x may need clarifying.
With the release of SME 8.0, development is now focussed on reaching 9.0
*SME Server Future
*SME Server Future
*SME Server Release 7.X
*SME Server Release 7.X
- The error is severe enough that we need to fix it, taking time away from 8.x development
- The error is severe enough that we need to fix it, taking time away from 9.x development
- The bug is being worked on actively
- The bug is being worked on actively
- The bug has been cloned from 8.x for backporting
- The bug has been cloned from 8.x for backporting
*SME Server Release 8.X
*SME Server Release 8.X
- The error is severe enough that we need to fix it, taking time away from 9.x development
- The bug is being worked on actively
*SME Server Release 9.X
- current development
- current development
====Bug Triage====
====Bug Triage====
If you can help do these steps, the developers can concentrate on fixing the bugs. <br >
The steps in this list is maybe 90% of the time of most bugs.
If you can help, the developers can concentrate on fixing the bugs. <br >
The steps in this list take approx 90% of the time in the resolving of most bugs.
Reread [http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]
Reread [http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to report bugs effectively]
Now look at the bug reports in Bugzilla with your developer hat on.
Now look at the bug reports in Bugzilla with your developer hat on.
* Go into triage mode
* Go into triage mode this page can help You : [[Bugzilla_Reports]]
* Ask the questions asked by the essay
* Ask the questions asked by the essay
* Get the information from the reporter
* Get the information from the reporter
====Bug Status====
====Bug Status====
[http://www.bugzilla.org/docs/tip/html/lifecycle.html Lifecycle of a Bug]
[http://www.bugzilla.org/docs/tip/html/lifecycle.html Lifecycle of a Bug]
Note. Project Developers tend not to look at unconfirmed bugs as they only have so much time, so it's important regular users check each others bugs.
Note. Project Developers tend not to look at unconfirmed bugs as they only have so much time, so it's important regular users check each others bugs.
* NEW
* NEEDINFO
Once bugs are confirmed, '''by anyone''' see note above, change the status to new,
This is a new state that should be used when more information is needed by the bug reporter.
* CONFIRMED
Once bugs are confirmed to be valid and present in SME Server, '''by anyone''' see note above, change the status to CONFIRMED.
Only change to CONFIRMED if the bug is well written and has enough information to proceed.
* IN_PROGRESS
This indicates a developer is actively working on the bug.
* FIXED
* FIXED
Set to fixed after the problem has been solved for others,
Set to fixed after the problem has been solved for others,
Alternatives to Fixed are :
Alternatives to Fixed are :
* INVALID
* NOTABUG
If you see that a problem is not a bug. eg User error
If you see that a problem is not a bug. eg User error
Mark INVALID if the report is of documented (i.e. expected and correct)
Mark INVALID if the report is of documented (i.e. expected and correct)
====Bugzilla flags====
====Bugzilla flags====
These will be obvious to the people they are intended to serve. If you feel
These will be obvious to the people they are intended to serve. If you feel
comfortable setting them based on information contained in the bug or needs
comfortable setting them based on information contained in the bug or needs
* [-+?]
* [-+?]
Set the flag to ? to say someone needs to look at it
Set the flag to ? to say someone needs to look at it
[[Category:SME Server]][[Category:SME9-Development]][[Category:Developer]]
