tickets (Ticket management in Noi)

The lino_noi.lib.tickets plugin extends lino_xl.lib.tickets to make it collaborate with lino_noi.lib.working.

In Lino Noi the site of a ticket also indicates "who is going to pay" for our work. Lino Noi uses this information when generating a service report.

This is a tested document. The following instructions are used for initialization:

>>> from lino import startup
>>> startup('lino_book.projects.noi1e.settings.demo')
>>> from lino.api.doctest import *

Tickets

Here is a textual description of the fields and their layout used in the detail window of a ticket.

>>> from lino.utils.diag import py2rst
>>> print(py2rst(tickets.AllTickets.detail_layout, True))
... 
(main) [visible for all]:
- **General** (general_tab_1):
  - **None** (overview)
  - (general2):
    - (general2_1): **Project** (site), **End user** (end_user), **Ticket type** (ticket_type)
    - (triager_panel_1) [visible for developer admin]: **Assign to** (quick_assign_to) [visible for all], **Private** (private) [visible for all]
    - (general2_3): **Priority** (priority), **Planned time** (planned_time), **Deadline** (deadline)
    - (general2_4): **Regular** (regular_hours), **Extra** (extra_hours), **Free** (free_hours)
    - **Sessions** (working.SessionsByTicket) [visible for contributor developer admin]
  - (general3): **Workflow** (workflow_buttons), **Comments** (comments.CommentsByRFC)
- **More** (more_tab_1):
  - (more1):
    - (more1_1): **ID** (id), **Reference** (ref)
    - **Summary** (summary)
    - **Parent** (parent)
    - **Tickets** (TicketsByParent) [visible for customer contributor developer admin]
  - (more2): **Description** (description), **Resolution** (upgrade_notes), **Upload files** (uploads.UploadsByController)
  - (more3):
    - **State** (state)
    - **Assigned to** (assigned_to)
    - (more3_3): **Author** (user), **Created** (created)
    - (more3_4): **Modified** (modified), **Fixed since** (fixed_since)
    - **Duplicate of** (duplicate_of)
    - **Duplicates** (DuplicatesByTicket)
- **Links** (links_1): **Mentioned in** (comments.CommentsByMentioned), **Dependencies** (tickets.LinksByTicket) [visible for developer admin]
class lino_noi.lib.tickets.Ticket

The Django model used to represent a ticket in Noi. Adds some fields and methods.

assigned_to

The user who is working on this ticket.

site

The site this ticket belongs to. You can select only sites you are subscribed to.

Screenshots

../../_images/tickets.Ticket.merge.png

The life cycle of a ticket

In Lino Noi we use the default tickets workflow defined in lino_xl.lib.tickets.TicketStates.

Projects

The list of projects in our demo database depends on who is looking at it. Anonymous users can see only public projects:

>>> rt.show(tickets.Sites)
=========== ============= ======== ================ ======== ============== ====
 Reference   Designation   Client   Contact person   Remark   Workflow       ID
----------- ------------- -------- ---------------- -------- -------------- ----
 aab         aab                                              **⚒ Active**   6
 bcc         bcc                                              **⚒ Active**   7
 bugs        bugs                                             **⚒ Active**   5
 dde         dde                                              **⚒ Active**   8
 docs        docs                                             **⚒ Active**   4
 pypi        pypi                                             **⚒ Active**   3
=========== ============= ======== ================ ======== ============== ====
>>> rt.login("marc").show(tickets.Sites)
=========== ===================== ===================== ================ ======== ================================ ====
 Reference   Designation           Client                Contact person   Remark   Workflow                         ID
----------- --------------------- --------------------- ---------------- -------- -------------------------------- ----
 aab         aab                                                                   **⚒ Active**                     6
 bcc         bcc                                                                   **⚒ Active**                     7
 bugs        bugs                                                                  **⚒ Active** → [⚹] [☉] [☾] [☑]   5
 dde         dde                                                                   **⚒ Active** → [⚹] [☉] [☾] [☑]   8
 docs        docs                                                                  **⚒ Active**                     4
 pypi        pypi                                                                  **⚒ Active**                     3
 welsch      Bäckerei Ausdemwald   Bäckerei Ausdemwald   Annette Arens             **⚒ Active** → [⚹] [☉] [☾] [☑]   2
=========== ===================== ===================== ================ ======== ================================ ====
>>> rt.login("jean").show(tickets.Sites)
=========== ===================== ===================== ================ ======== ================================ ====
 Reference   Designation           Client                Contact person   Remark   Workflow                         ID
----------- --------------------- --------------------- ---------------- -------- -------------------------------- ----
 aab         aab                                                                   **⚒ Active** → [⚹] [☉] [☾] [☑]   6
 bcc         bcc                                                                   **⚒ Active** → [⚹] [☉] [☾] [☑]   7
 bugs        bugs                                                                  **⚒ Active** → [⚹] [☉] [☾] [☑]   5
 dde         dde                                                                   **⚒ Active** → [⚹] [☉] [☾] [☑]   8
 docs        docs                                                                  **⚒ Active** → [⚹] [☉] [☾] [☑]   4
 pypi        pypi                                                                  **⚒ Active** → [⚹] [☉] [☾] [☑]   3
 welket      Rumma & Ko OÜ         Rumma & Ko OÜ         Andreas Arens             **⚒ Active** → [⚹] [☉] [☾] [☑]   1
 welsch      Bäckerei Ausdemwald   Bäckerei Ausdemwald   Annette Arens             **⚒ Active** → [⚹] [☉] [☾] [☑]   2
=========== ===================== ===================== ================ ======== ================================ ====
>>> rt.login("mathieu").show(tickets.Sites)
=========== ============= ======== ================ ======== ================================ ====
 Reference   Designation   Client   Contact person   Remark   Workflow                         ID
----------- ------------- -------- ---------------- -------- -------------------------------- ----
 aab         aab                                              **⚒ Active** → [⚹] [☉] [☾] [☑]   6
 bcc         bcc                                              **⚒ Active**                     7
 bugs        bugs                                             **⚒ Active**                     5
 dde         dde                                              **⚒ Active**                     8
 docs        docs                                             **⚒ Active**                     4
 pypi        pypi                                             **⚒ Active** → [⚹] [☉] [☾] [☑]   3
=========== ============= ======== ================ ======== ================================ ====

List of sites to which Jean is "subscribed" (i.e. that are assigned to a team where Jean is member):

>>> rt.login("jean").show(tickets.MySites)
=================== ============= ================================
 Project             Description   Workflow
------------------- ------------- --------------------------------
 `aab <Detail>`__                  **⚒ Active** → [⚹] [☉] [☾] [☑]
 `pypi <Detail>`__                 **⚒ Active** → [⚹] [☉] [☾] [☑]
=================== ============= ================================

List of tickets that have not yet been assigned to a site:

>>> pv = dict(has_site=dd.YesNo.no)
>>> rt.login("robin").show(tickets.AllTickets, param_values=pv)
... 
===== ============================================== ========== ====================================== =========
 ID    Summary                                        Priority   Workflow                               Project
----- ---------------------------------------------- ---------- -------------------------------------- ---------
 110   Why is foo so bar                              30         [✋] [▶] **☐ Ready** → [☒]
 108   No more foo when bar is gone                   30         [✋] [▶] **⚒ Working** → [☾] [☐] [☒]
 100   Cannot delete foo                              30         [✋] [▶] **⚒ Working** → [☾] [☐] [☒]
 94    How can I see where bar?                       30         [✋] [▶] **☐ Ready** → [☒]
 90    No more foo when bar is gone                   30         [✋] [▶] **☎ Talk** → [☾] [☉] [☐] [☒]
 80    Foo never bars                                 30         [✋] [▶] **☒ Refused**
 70    'NoneType' object has no attribute 'isocode'   30         [✋] [▶] **☐ Ready** → [☒]
 66    Irritating message when bar                    30         [✋] [▶] **☎ Talk** → [☾] [☉] [☐] [☒]
 60    Default account in invoices per partner        30         [✋] [▶] **⚒ Working** → [☾] [☐] [☒]
 52    'NoneType' object has no attribute 'isocode'   30         [✋] [▶] **⚒ Working** → [☾] [☐] [☒]
 50    Misc optimizations in Baz                      30         [✋] [▶] **☎ Talk** → [☾] [☉] [☐] [☒]
 40    How can I see where bar?                       30         [✋] [▶] **☒ Refused**
 38    Why is foo so bar                              30         [✋] [▶] **☐ Ready** → [☒]
 30    Irritating message when bar                    30         [✋] [▶] **☐ Ready** → [☒]
 24    Default account in invoices per partner        30         [✋] [▶] **☒ Refused**
 20    Why is foo so bar                              30         [✋] [▶] **⚒ Working** → [☾] [☐] [☒]
 10    Where can I find a Foo when bazing Bazes?      30         [✋] [▶] **☎ Talk** → [☾] [☉] [☐] [☒]
===== ============================================== ========== ====================================== =========

Ticket types

The demo fixture defines the following ticket types.

>>> rt.show(tickets.TicketTypes)
============= ================== ================== ================
 Designation   Designation (de)   Designation (fr)   Reporting type
------------- ------------------ ------------------ ----------------
 Bugfix        Bugfix             Bugfix
 Enhancement   Enhancement        Enhancement
 Upgrade       Upgrade            Upgrade
============= ================== ================== ================

Deciding what to do next

Show all active tickets reported by me.

>>> rt.login('jean').show(tickets.MyTicketsToWork)
... 
========== ================================================= ====================================== =========
 Priority   Ticket                                            Workflow                               Project
---------- ------------------------------------------------- -------------------------------------- ---------
 30         `#91 (☉ Cannot delete foo) <Detail>`__            [▶] **☉ Open** → [☎] [⚒] [☐] [☑] [☒]   aab
 30         `#59 (☉ Misc optimizations in Baz) <Detail>`__    [▶] **☉ Open** → [☎] [⚒] [☐] [☑] [☒]   aab
 30         `#11 (☉ Class-based Foos and Bars?) <Detail>`__   [▶] **☉ Open** → [☎] [⚒] [☐] [☑] [☒]   aab
========== ================================================= ====================================== =========
>>> rt.login('jean').show(tickets.MyTickets)
... 
========== ==================================================================== ================= ============== ========= ======= ====== ==============================================
 Priority   Ticket                                                               Assigned to       Planned time   Regular   Extra   Free   Workflow
---------- -------------------------------------------------------------------- ----------------- -------------- --------- ------- ------ ----------------------------------------------
 30         `#113 (⚹ Misc optimizations in Baz) <Detail>`__                      Romain Raffault                                           [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30         `#106 (☎ 'NoneType' object has no attribute 'isocode') <Detail>`__   Romain Raffault                                           [▶] **☎ Talk** → [☾] [☉] [⚒] [☐] [☑] [☒]
 30         `#99 (☉ No more foo when bar is gone) <Detail>`__                                                                              [✋] [▶] **☉ Open** → [☾] [☎] [⚒] [☐] [☑] [☒]
 30         `#92 (⚒ Why is foo so bar) <Detail>`__                               Rolf Rompen                                               [▶] **⚒ Working** → [☾] [☎] [☐] [☑] [☒]
 30         `#78 (☐ Default account in invoices per partner) <Detail>`__         Rolf Rompen                                               [▶] **☐ Ready** → [☎] [☑] [☒]
 30         `#57 (⚹ Irritating message when bar) <Detail>`__                                                                               [✋] [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30         `#50 (☎ Misc optimizations in Baz) <Detail>`__                                                                                 [✋] [▶] **☎ Talk** → [☾] [☉] [☐] [☒]
 30         `#43 (☉ 'NoneType' object has no attribute 'isocode') <Detail>`__                                                              [✋] [▶] **☉ Open** → [☾] [☎] [⚒] [☐] [☑] [☒]
 30         `#36 (⚒ No more foo when bar is gone) <Detail>`__                    Luc                                                       [▶] **⚒ Working** → [☾] [☎] [☐] [☑] [☒]
 30         `#22 (☐ How can I see where bar?) <Detail>`__                        Rolf Rompen                                               [▶] **☐ Ready** → [☎] [☑] [☒]
 30         `#1 (⚹ Föö fails to bar when baz) <Detail>`__                                                                                  [✋] [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
========== ==================================================================== ================= ============== ========= ======= ====== ==============================================

The backlog

The TicketsBySite panel shows all the tickets for a given site. It is a scrum backlog.

>>> welket = tickets.Site.objects.get(ref="welket")
>>> rt.login("robin").show(tickets.TicketsBySite, welket)
... 
===================== ==================================================================== ============== ========== ======= ====== ==============================================
 Priority              Ticket                                                               Planned time   Regular    Extra   Free   Workflow
--------------------- -------------------------------------------------------------------- -------------- ---------- ------- ------ ----------------------------------------------
 30                    `#114 (☎ Default account in invoices per partner) <Detail>`__                                                 [✋] [▶] **☎ Talk** → [☾] [☉] [⚒] [☐] [☑] [☒]
 30                    `#113 (⚹ Misc optimizations in Baz) <Detail>`__                                                               [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30                    `#106 (☎ 'NoneType' object has no attribute 'isocode') <Detail>`__                                            [▶] **☎ Talk** → [☾] [☉] [⚒] [☐] [☑] [☒]
 30                    `#97 (⚹ 'NoneType' object has no attribute 'isocode') <Detail>`__                                             [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30                    `#84 (⚒ Irritating message when bar) <Detail>`__                                                              [▶] **⚒ Working** → [☾] [☎] [☐] [☑] [☒]
 30                    `#82 (☎ Cannot delete foo) <Detail>`__                                                                        [▶] **☎ Talk** → [☾] [☉] [⚒] [☐] [☑] [☒]
 30                    `#81 (⚹ No more foo when bar is gone) <Detail>`__                                                             [✋] [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30                    `#74 (☎ Why is foo so bar) <Detail>`__                                                                        [▶] **☎ Talk** → [☾] [☉] [⚒] [☐] [☑] [☒]
 30                    `#68 (⚒ Misc optimizations in Baz) <Detail>`__                                                                [▶] **⚒ Working** → [☾] [☎] [☐] [☑] [☒]
 30                    `#65 (⚹ Why is foo so bar) <Detail>`__                                                                        [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30                    `#62 (☐ Foo never bars) <Detail>`__                                                                           [✋] [▶] **☐ Ready** → [☎] [☑] [☒]
 30                    `#58 (☎ How can I see where bar?) <Detail>`__                                                                 [▶] **☎ Talk** → [☾] [☉] [⚒] [☐] [☑] [☒]
 30                    `#49 (⚹ How can I see where bar?) <Detail>`__                                                                 [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30                    `#44 (⚒ Foo never bars) <Detail>`__                                                                           [▶] **⚒ Working** → [☾] [☎] [☐] [☑] [☒]
 30                    `#42 (☎ Default account in invoices per partner) <Detail>`__                                                  [▶] **☎ Talk** → [☾] [☉] [⚒] [☐] [☑] [☒]
 30                    `#36 (⚒ No more foo when bar is gone) <Detail>`__                                                             [▶] **⚒ Working** → [☾] [☎] [☐] [☑] [☒]
 30                    `#33 (⚹ Default account in invoices per partner) <Detail>`__                                                  [✋] [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30                    `#18 (☎ No more foo when bar is gone) <Detail>`__                                                             [✋] [▶] **☎ Talk** → [☾] [☉] [⚒] [☐] [☑] [☒]
 30                    `#17 (⚹ Foo never bars) <Detail>`__                                                                           [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 30                    `#14 (☐ Bar cannot baz) <Detail>`__                                                 0:10                      [✋] [▶] **☐ Ready** → [☎] [☑] [☒]
 30                    `#12 (⚒ Foo cannot bar) <Detail>`__                                                 1:30                      [▶] **⚒ Working** → [☾] [☎] [☐] [☑] [☒]
 30                    `#4 (⚒ Foo and bar don't baz) <Detail>`__                                           2:18                      [▶] **⚒ Working** → [☾] [☎] [☐] [☑] [☒]
 30                    `#1 (⚹ Föö fails to bar when baz) <Detail>`__                                                                 [✋] [▶] **⚹ New** → [☾] [☎] [☉] [⚒] [☐] [☑]
 **Total (23 rows)**                                                                                       **3:58**
===================== ==================================================================== ============== ========== ======= ====== ==============================================

Note that anonymous cannot see tickets of a non-public site.

>>> rt.show(tickets.TicketsBySite, welket)
... 
No data to display
>>> pypi = tickets.Site.objects.get(ref="pypi")
>>> rt.show(tickets.TicketsBySite, pypi)
... 
No data to display

Filtering tickets

Lino Noi modifies the list of the parameters you can use for filterings tickets be setting a custom params_layout.

>>> show_fields(tickets.AllTickets, all=True)
... 
+--------------------+--------------------+-----------------------------------------------------------------------+
| Internal name      | Verbose name       | Help text                                                             |
+====================+====================+=======================================================================+
| user               | Author             | The author or reporter of this ticket. The user who reported this     |
|                    |                    | ticket to the database and is responsible for managing it.            |
+--------------------+--------------------+-----------------------------------------------------------------------+
| end_user           | End user           | Only rows concerning this end user.                                   |
+--------------------+--------------------+-----------------------------------------------------------------------+
| assigned_to        | Assigned_to        | Only tickets with this user assigned.                                 |
+--------------------+--------------------+-----------------------------------------------------------------------+
| not_assigned_to    | Not assigned to    | Only that this user is not assigned to.                               |
+--------------------+--------------------+-----------------------------------------------------------------------+
| interesting_for    | Interesting for    | Only tickets interesting for this partner.                            |
+--------------------+--------------------+-----------------------------------------------------------------------+
| site               | Project            | Show only tickets within this project.                                |
+--------------------+--------------------+-----------------------------------------------------------------------+
| has_site           | Has site           | Show only (or hide) tickets which have a site assigned.               |
+--------------------+--------------------+-----------------------------------------------------------------------+
| state              | State              | Only rows having this state.                                          |
+--------------------+--------------------+-----------------------------------------------------------------------+
| show_assigned      | Assigned           | Show only (or hide) tickets that are assigned to somebody.            |
+--------------------+--------------------+-----------------------------------------------------------------------+
| show_active        | Active             | Show only (or hide) tickets which are active (i.e. state is Talk      |
|                    |                    | or ToDo).                                                             |
+--------------------+--------------------+-----------------------------------------------------------------------+
| show_todo          | To do              | Show only (or hide) tickets that are todo (i.e. state is New          |
|                    |                    | or ToDo).                                                             |
+--------------------+--------------------+-----------------------------------------------------------------------+
| show_private       | Private            | Show only (or hide) tickets that are marked private.                  |
+--------------------+--------------------+-----------------------------------------------------------------------+
| start_date         | Date from          | Start of observed date range                                          |
+--------------------+--------------------+-----------------------------------------------------------------------+
| end_date           | until              | End of observed date range                                            |
+--------------------+--------------------+-----------------------------------------------------------------------+
| observed_event     | Observed event     |                                                                       |
+--------------------+--------------------+-----------------------------------------------------------------------+
| has_ref            | Has reference      |                                                                       |
+--------------------+--------------------+-----------------------------------------------------------------------+
| last_commenter     | Commented Last     | Only tickets that have this use commenting last.                      |
+--------------------+--------------------+-----------------------------------------------------------------------+
| not_last_commenter | Not Commented Last | Only tickets where this use is not the last commenter.                |
+--------------------+--------------------+-----------------------------------------------------------------------+
| subscriber         | Site Subscriber    | Limit tickets to tickets that have a site this user is subscribed to. |
+--------------------+--------------------+-----------------------------------------------------------------------+

Change observers

Don't read this.

>>> ar = rt.login('robin')
>>> list(tickets.Site.objects.get(ref="welket").get_change_observers())
... 
[(User #6 ('Luc'), <notify.MailModes.often:often>), (User #3 ('Romain Raffault'), <notify.MailModes.often:often>)]
>>> list(comments.Comment.objects.get(pk=1).get_change_observers())
... 
[(User #6 ('Luc'), <notify.MailModes.often:often>), (User #3 ('Romain Raffault'), <notify.MailModes.often:often>)]
>>> list(comments.Comment.objects.get(pk=155).get_change_observers())
... 
[(User #7 ('Jean'), <notify.MailModes.often:often>),
 (User #5 ('Mathieu'), <notify.MailModes.often:often>),
 (User #1 ('Robin Rood'), <notify.MailModes.often:often>)]