This is the documentation for older versions of Odoo (formerly OpenERP).

See the new Odoo user documentation.

See the new Odoo technical documentation.

Bug Reports and Bug Processing

Bug Tracker

As described in the Launchpad, Community Platform section, OpenERP uses Launchpad as the bug tracker platform.

Anyone is free to report new bugs or give feedback on existing ones in OpenERP's Launchpad bugtracker. The only requirement is to sign up on Launchpad and join the OpenERP Community team, which only requires a few clicks.

Note

Some additional team memberships are required in order to accomplish specific tasks, as explained in the Bug Processing section below.

Any issue you notice in OpenERP should be reported on the appropriate project on LaunchPad. A link to report a new bug can be found on the top right side of the homepage of each Launchpad project. Here is a quick overview of the direct links for reporting bugs on each OpenERP project:

Project

Bug report interface

OpenERP Addons

http://bugs.launchpad.net/openobject-addons

OpenERP Server

http://bugs.launchpad.net/openobject-server

OpenERP GTK Client

http://bugs.launchpad.net/openobject-client

OpenERP Web Client (6.0)

http://bugs.launchpad.net/openobject-client-web

OpenERP Web (6.1)

http://bugs.launchpad.net/openerp-web

Important

The LaunchPad bug tracker automatically proposes bugs that look similar to your bug title when you attempt to report a new one. It is important to avoid reporting the same bug several times. Be careful to double-check the proposed bugs to avoid creating duplicates. However do not forget to proceed further should none of the existing bugs match yours.

Definition of a bug

At the risk of stating the obvious, here are a few key points to keep in mind concerning the definition of an OpenERP bug.

Is usually considered a bug:

  • Any system failure with a complete stop or traceback

  • Any abnormal behavior of the system resulting from an issue with OpenERP code, without changing the original functional scope or specification

  • Any security breach in the code of the software

  • Non compliance with the law for an existing feature of a certified accounting module

Is usually not considered a bug:

  • Non compliance with a customer specific need

  • Abnormal system behavior due to defective installation or configuration

  • Security breach resulting from defective installation or configuration

  • Any usage of the software which would not comply with some industry standard

Everything else is probably either a wishlist or should be made into a blueprint for change/improvement.

Bug Processing

The following figure depicts the generic Bug Handling Process currently applied at OpenERP, and more specifically on the trunk branch, also known as development version (see also the Bug Management Policy section)

Bug Management Process

The processing of bugs is divided up into several successive main stages:

  1. Incoming bugs are reported on Launchpad by the whole OpenERP Community

  2. Qualification of new bugs is performed by a dedicated team within OpenERP SA, assisted by the Drivers Team, a group of experienced Community Members.

  3. Actual bug Resolution is usually performed by the various OpenERP R&D teams, unless the Qualification step was directly able to take care of the fix, for example thanks to a patch contributed along with the bug report.

  4. The last step before a bugfix is fully released into the official trunk branches is a final technical and functional review of the fix by the Team Leader and/or the Quality Team.

Bug Qualification

In order to properly qualify each bug, the following attributes must be properly set:

  • the branch(es) it's affecting must be correct

  • the reproducibility of the bug must be verified, as well as the possible duplication (if it's a duplicate, mark it as such and stop processing it)

  • the status must be correctly set, as explained in the next section

  • the importance must be correctly set, as explained in the next section

  • if the bug is valid and must be solved (now or in the future), it must be assigned to the corresponding R&D Team

  • if the bug is not solved yet, the milestone should not be set except by the assigned R&D Team, to indicate when they plan to release the fix

Leaving a bug as New or Confirmed, but not assigning a proper Team is not useful.

Qualified Bug Status

One of the following status values must be set on a bug when qualifying it:

  • Confirmed: this means that the bug has been reproduced or is considered valid, and has been accepted. Bugs in this state are considered open. Can be set also for Wishlists that we plan to implement in a future release.

  • Incomplete: the bug description does not contain enough information to properly handle it, and prevents from reproducing it (such as missing version, no steps to reproduce, or some other important information missing). Keep in mind that bugs in this state might be updated with a response (in Launchpad bug search you can filter on Incomplete with response or Incomplete without response). As we have enabled auto-bug expiry on Launchpad these bugs will be put in status Expired automatically by Launchpad after 60 days of inactivity, and no answer. Bugs in this state are still considered open until they are Expired.

  • Invalid: the bug cannot be reproduced at all or is incorrect, for example because the poster has misunderstood OpenERP's features or is misusing the system. Bugs in this state are considered closed. Note: If this looks like it could become a Frequently Asked Question, don't hesitate to Convert to a question before answering (link is on top-right of bug page). This will mark the bug Invalid automatically, and then you can provide the answer on the linked Question.

  • Won't Fix: bugs or wishlists that we can't or don't want to fix/implement. Bugs in this state are considered closed.

  • Triaged: this status means that the qualifier is not sure if the bug should be confirmed or refused. Set this status and assign a Team to indicate that a Team Leader still needs to confirm/refuse this bug before starting to work on it. Bugs in this state are considered open.

  • Fix Released: if you know the bug was valid and has been fixed since it was reported, it may of course be marked directly as such (you may also set the appropriate milestone if you know it)

Qualified Bug Importance

Assessing the importance of a bug is a difficult and often subjective task. In order to have common criteria, we propose the following definition for the severity levels on Launchpad bugs

  • Critical: security issue (e.g. system compromised or arbitrary code execution possible), or system completely unusable, for many users. Any kind of data loss.

  • High: major part of an application not working correctly and blocking for many users: like the impossibility to display Sale Orders for all users (not just for a peculiar setup, but in most cases)

  • Medium: a minor part of an applications not working correctly (not really blocking), or a major feature not working for few users only or for a specific configuration only.

  • Low: the rest, mostly usability issues (eg. presentation/layout issues) that don't prevent to use any of the features.

  • Wishlist: nice to have features/patches, propositions to enhance/modify the current logic.

Qualified Bug Assignation

In order to be actually solved, a bug should be assigned to the R&D Team in charge of this area of OpenERP. Each team will assign milestones to indicate when they plan to release the fix for each bug. The main R&D teams and their responsibilities are currently:

  • Addons Team 1 is responsible for CRM, Project, Plugins, Knowledge, Tools

  • Addons Team 2 is responsible for MRP, Stock, Purchase, Procurement, Marketing

  • Addons Team 3 is responsible for Account, Sales, Point of sale, Association, HR

  • Framework Team is responsible for the Server/Framework

  • GTK Team is responsible for the GTK Native Client

  • Web Team is responsible for the Web Interface

Milestone Assignation

Milestones should be set only for bugs that have been fixed, to track when it happened, or by the R&D team to indicate when they plan to release the fix.

Bug Management Policy

OpenERP Bug Policy

The official OpenERP policy is different depending on the version/branch the bug affects. Bugs reported against the trunk/development branch are all processed as described in the Bug Processing section. Bugs reported on a stable branch follow a much stricter qualification process, to limit the risk of regressions on these production-grade versions.

trunk

All bugs and wishlists should be reported on Launchpad, and will be qualified by the OpenERP Launchpad Qualification team. Valid bugs will be confirmed and scheduled for resolution according to their importance. Wishlists will be accepted depending on the R&D strategy, and scheduled in the R&D backlog at the discretion of the R&D Teams.

stable

Bugs on stable releases may be reported:

  • via Launchpad for High/Critical importance (no guaranteed response time)

  • via the OpenERP Enterprise channel (former Publisher's Warranty) for Customers (guaranteed response time according to the contract)

Valid bugs that also affect trunk will be fixed in trunk, but the fix will only be applied to stable if their importance requires the release of an updated version (security issue, major issue affecting important features, etc.) Anything that looks like a change or improvement will not be accepted on stable.

You will find the complete rationale for this policy below. You may also want to have a look at the Bug Management FAQ.

Rationale for the Bug Policy

As of November 2010, OpenERP has started to enforce a stricter policy, which means that you may be surprised to see that more Launchpad bugs are closed with status Invalid or Won't Fix. The goal being pursued is to really improve the stability of the stable versions.

OpenERP used to have developers working on all bugs reported via Launchpad, regardless of the OpenERP release they were reported on, and without a strict policy on what is accepted as a bug and what is not. A few years of working in this manner has shown us that this is not efficient, as it leads to long processing times for some bugs, and too often to the introduction of regressions in the stable branches:

  • The main trouble with past stable versions was that developers did too many changes on the stable branch and introduced regressions (because the Support/Maintenance team was fixing a maximum of requests on stable branch reported by the community). This was too risky for a stable version.

  • Only very few of these changes were impacting customers ; changing a stable branch used by customers in production is always a risk that should be minimized.

  • Most of these requests (65% of bugs according to a recent bug qualification sprint) were feature improvements, not bugs.

  • The distinction was not clear between bugs fixed through the OpenERP Enterprise contract with a guaranteed response time, and those fixed for free on Launchpad. The Support team did its best to fix both.

In order to improve the situation, OpenERP has split up the teams assigned to the resolution of bugs and the corresponding processes, separating the management of general purpose community bug reports (improving the product for the future) and the management of day-to-day issues encountered on production systems (ensuring stability in a conservative manner):

  • The OpenERP Launchpad team is dedicated to processing all bugs reported via Launchpad, qualifying them as quickly as possible, and getting them solved by the R&D teams. They must not touch the stable branches directly, and any important issue reported on a stable branch will be passed on to the OpenERP Enterprise team.

  • The OpenERP Enterprise team (formerly OpenERP Publisher's Warranty) is in charge of receiving issues reported directly by customers via the OpenERP Publisher's Warranty, providing high-level expertise within short response times, including workarounds and patches when available. They carefully select the fixes to apply to the stable branches, to be published every month.

This way the responsibilities of the teams are clear, and we can appropriately implement continuous improvement, with distinct goals!

Bug Management FAQ

1. What is the policy regarding bugs encountered by users of the OpenERP Online Offer?

Customers of OpenERP's Online Offer are automatically subscribed to an OpenERP Enterprise contract so any bug they report via their dedicated Support/Maintenance channel will be handled accordingly.

2. My Launchpad bug report was refused for the stable release I reported! How can I get it fixed for my important projects/customers?

It is the responsibility of OpenERP Enterprise team (former OpenERP Publisher's Warranty) to maintain the maximum stability of the stable branches, and this implies being very strict on what can be considered important enough to qualify for a patch on a stable branch.

Note that if the bug affects the trunk as well, you can simply try to apply or backport the fix that was or will be provided for trunk. Other community contributors may also provide patches for the stable branch even if the bug was

3. My Launchpad bug report/feature request was closed as Invalid or Won't Fix, but I can prove that it really is valid! How can I get it fixed/implemented for my important projects/customers?

This may happen and is not necessarily an error. OpenERP cannot cover all possible cases and does not want to. The idea is to support the most important and common features, and try to avoid becoming overcomplicated or bloated. However OpenERP is also easily extensible and customizable, so you could instead handle your special cases or features in customization modules (if done well and often requested, they could later be included in the official addons)

4. What's the matter with OpenERP Web Client bugs being all closed as Won't Fix?

As you certainly noticed, bugs reported against the 6.0 web client series had not been receiving a lot of attention lately on Launchpad.

The reason is that the OpenERP Web Client from the 6.0 series will not be developed further in the future, as it was becoming too hard to maintain, due to its aging architecture. For the 6.1 series, a new web frontend is under development, rewritten from scratch with a clean (HTML5/Javascript) state-of-the-art architecture. This will make future improvements and maintenance much easier.

The OpenERP Bug Management Policy explains that R&D developers solve bugs reported on Launchpad in the trunk development branch, in order to improve the product for the future, for everyone. As this project will no longer be used in 6.1, these R&D efforts would now be wasted.

Concerning the correction of bugs in the stable series, this is the responsibility of the OpenERP Enterprise (OPW) maintenance team, for all the reasons explained above, and they will of course continue to do it as long as the 6.0 LTS series is supported.

The R&D Web Team can therefore dedicate all its efforts to finishing the new OpenERP 6.1 client, and making it very robust, stable, easy to improve and maintain.