wiki:TicketQuery

Version 1 (modified by trac, 4 years ago) (diff)

--

TicketQuery Wiki Macro

The TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting. The query language used by the [[TicketQuery]] macro is described in the TracQuery page.

Usage

[[TicketQuery]]

Wiki macro listing tickets that match certain criteria.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value".

If the key is the name of a field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage. Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character. Commas (,) can be included in field values by escaping them with a backslash (\).

Groups of field constraints to be OR-ed together can be separated by a literal or argument.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

The format parameter determines how the list of tickets is presented:

  • list -- the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line.
  • compact -- the tickets are presented as a comma-separated list of ticket IDs.
  • count -- only the count of matching tickets is displayed
  • rawcount -- only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
  • table -- a view similar to the custom query view (but without the controls)
  • progress -- a view similar to the milestone progress bars

The max parameter can be used to limit the number of tickets shown (defaults to 0, i.e. no maximum).

The order parameter sets the field used for ordering tickets (defaults to id).

The desc parameter indicates whether the order of the tickets should be reversed (defaults to false).

The group parameter sets the field used for grouping tickets (defaults to not being set).

The groupdesc parameter indicates whether the natural display order of the groups should be reversed (defaults to false).

The verbose parameter can be set to a true value in order to get the description for the listed tickets. For table format only. deprecated in favor of the rows parameter

The rows parameter can be used to specify which field(s) should be viewed as a row, e.g. rows=description|summary

The col parameter can be used to specify which fields should be viewed as columns. For table format only.

For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format. Also, using "&" as a field separator still works (except for order) but is deprecated.

Examples

Example Result Macro
Number of Triage tickets: 1 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 22 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 1 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 1 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 0 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 3 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 82 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 1 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 113 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 0 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 0 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 0 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 0 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 0 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 0 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 0 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 0 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #99, #105, #104 [[TicketQuery(max=3,order=modified,desc=1,compact)]]

Details of ticket #1:

[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]

Ticket Owner Reporter
#1 johren@bbn.com johren@bbn.com
Summary Test GIMI ticket

Format: list

[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

No results

Format: compact

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

No results

Format: count

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:

0

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

Format: table

You can choose the columns displayed in the table format (format=table) using col=<field>. You can specify multiple fields and the order they are displayed by placing pipes (|) between the columns:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Results (1 - 3 of 87)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#112 fixed irods path not correct in production JS for new projects johren@bbn.com johren@bbn.com
#105 fixed List of Properties in OEDL Thierry.Rakotoarivelo@nicta.com.au dbhat@bbn.com
#102 fixed Automatically append Slice Name to Host name - Move to Production divyashri.bhat@gmail.com dbhat@bbn.com
1 2 3 4 5 6 7 8 9 10 11

Full rows

In table format you can specify full rows using rows=<field>:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]

This is displayed as:

Results (1 - 3 of 87)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#112 fixed irods path not correct in production JS for new projects johren@bbn.com johren@bbn.com
Description

I did some testing with a new project today and noticed that the irods path used when I dumped data to iRODS is incorrect. It does not include the project in the path.

Divya helped me dig into a little more and we saw that the irods_path is not correct in Job Service. It should be geni-joTestNew/new01

johren-joTest081101-2014-08-11T21-22-13:
uuid: d71444c5-a763-41f3-8123-62dc41d8d33b
href: http://gimi4.casa.umass.edu:8002/jobs/d71444c5-a763-41f3-8123-62dc41d8d33b
name: johren-joTest081101-2014-08-11T21-22-13
type: job
status: finished
oml_db: postgres://oml2:omlisgoodforyou@128.119.44.12/johren-joTest081101-2014-08-11T21-22-13
irods_path: new01
username: johren
log_file: http://gimi4.casa.umass.edu:8002/logs/d71444c5-a763-41f3-8123-62dc41d8d33b.log

GES seems to have the correct path:

{
type: "project",
uuid: "812aeaf1-8676-4c2c-8226-5dedc8cee997",
href: "/projects/812aeaf1-8676-4c2c-8226-5dedc8cee997",
name: "joTestNew",
path: "geni-joTestNew/",
irods_user: "geni-johren1",
users: [ ],
experiments: [
{
uuid: "2c67ef56-773b-4bff-8222-fc30d4e19c99",
href: "/experiments/2c67ef56-773b-4bff-8222-fc30d4e19c99",
name: "new01",
type: "experiment",
path: "geni-joTestNew/new01/"
},
{
uuid: "4dd03846-7f85-4751-9d86-8e57e715e2ce",
href: "/experiments/4dd03846-7f85-4751-9d86-8e57e715e2ce",
name: "newABC",
type: "experiment",
path: "geni-joTestNew/newABC/"
}
]
}

#105 fixed List of Properties in OEDL Thierry.Rakotoarivelo@nicta.com.au dbhat@bbn.com
Description

Currently we have experiments where we run the same application per group with a variation of just one Property, for e.g,

defGroup('Source1', property.source1) do |node|
  node.addApplication("ping") do |app|
    app.setProperty('target', property.sinkaddr12)
    app.setProperty('count', 30)
    app.measure('ping', :samples => 1)
  end
  node.addApplication("ping") do |app|
    app.setProperty('target', property.sinkaddr13)
    app.setProperty('count', 30)
    app.measure('ping', :samples => 1)
  end
   node.addApplication("ping") do |app|
    app.setProperty('target', property.sinkaddr21)
    app.setProperty('count', 30)
    app.measure('ping', :samples => 1)
  end
   node.addApplication("ping") do |app|
    app.setProperty('target', property.sinkaddr23)
    app.setProperty('count', 30)
    app.measure('ping', :samples => 1)
  end
  node.addApplication("ping") do |app|
    app.setProperty('target', property.sinkaddr24)
    app.setProperty('count', 30)
    app.measure('ping', :samples => 1)
  end
end

In the above example, it is only the target address which changes for each application. Could we have a construct similar to:

a) setProperty as a list and have the parser iterate through the list to run the application

defGroup('Source1', property.source1) do |node|
  node.addApplication("ping") do |app|
    app.setProperty('target', property.sinkaddr12, property.sinkaddr13, property.sinkaddr21, property.sinkaddr23, property.sinkaddr24 )
    app.setProperty('count', 30)
    app.measure('ping', :samples => 1)
  end
end

b) Allow defProperty to take list of properties as an as an input and have the addApplication iterate through the list. For e.g.,

defProperty('sinkaddrs', '192.168.1.7', '192.168.1.8','192.168.1.13', '192.168.1.14', '192.168.1.15', "Ping destination address")

defGroup('Source1', property.source1) do |node|
  node.addApplication("ping") do |app|
     app.setProperty('count', 30)
     app.addProperty('target', property.sinkaddrs) do |prop|
        app.setProperty(prop)    
     end
     app.measure('ping', :samples => 1)
  end
end
#102 fixed Automatically append Slice Name to Host name - Move to Production divyashri.bhat@gmail.com dbhat@bbn.com
Description

This ticket relates to:

http://groups.geni.net/gimi/ticket/98

Some initial testing has been done on Dev instance for this fix.
This change will be moved to production.

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports