{"id":112,"date":"2011-09-08T23:07:51","date_gmt":"2011-09-09T03:07:51","guid":{"rendered":"http:\/\/www.jetmore.org\/john\/blog\/?p=112"},"modified":"2012-05-11T15:15:48","modified_gmt":"2012-05-11T19:15:48","slug":"custom-testlink-macro-for-trac","status":"publish","type":"post","link":"https:\/\/www.jetmore.org\/john\/blog\/2011\/09\/custom-testlink-macro-for-trac\/","title":{"rendered":"Custom TestLink Macro for Trac"},"content":{"rendered":"

I’ve been spending a lot of time lately trying to get the workflow between Trac and TestLink to make sense. I’m far from having the perfect solution, but a great first step was creating a Trac wiki macro that will link to specific test cases in TestLink. There’s lots of areas in which this could be improved in the future…<\/p>\n

Create this as conf\/TestLinkMacro.py in your project (replacing test.example.com with your TestLink host):<\/p>\n

\r\nimport re\r\n\r\nfrom trac.wiki.macros import WikiMacroBase\r\n\r\nclass TestLinkMacro(WikiMacroBase):\r\n    """Macro to generate automatic links to test cases in TestLink.\r\n    """\r\n\r\n    def expand_macro(self, formatter, name, args):\r\n        """Expand a TestLink test case ID into a link\r\n        """\r\n        TestLinkServer = 'test.example.com'\r\n        matches = re.match(r'(.*)-(d+)$', args)\r\n        \r\n        return '<a href="https:\/\/' + TestLinkServer + '\/linkto.php?tprojectPrefix=' + matches.group(1) + '&item=testcase&id=' + matches.group(0) + '">[[TestLink(' + matches.group(0) + ')]]<\/a>'\r\n<\/pre>\n
After putting this in place, and possibly restarting Trac, you can create a direct link to test case m3-123 in a wiki by typing [[TestLink(m3-123)]].  Note that I could have changed the actual string displayed in the wiki to anything I wanted, but I chose to leave it looking identical to the actual macro (but linked) so that it would reinforce to people the correct format for the test case links.<\/p>\n
This macro is useful in several ways, but the most obvious is allowing us to enter regression test case IDs into commit messages (which then get associated with a ticket in Trac and are displayed with the wiki engine, making the test case link clickable).
\nWith commit messages being associated with tickets automatically and being displayed by the wiki engine, this gives us a nice syntax to enter regression case links into commit messages and be very followable later<\/p>\n
Edit 2011-09-13:<\/strong><\/p>\n
See also this update to my use of macros for linking to test cases<\/a> and this comment on custom ticket field wiki parsing<\/a>, both of which have a direct relation to this post<\/p>\n","protected":false},"excerpt":{"rendered":"
I’ve been spending a lot of time lately trying to get the workflow between Trac and TestLink to make sense. I’m far from having the perfect solution, but a great first step was creating a Trac wiki macro that will … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[5],"tags":[8,14],"_links":{"self":[{"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/posts\/112"}],"collection":[{"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/comments?post=112"}],"version-history":[{"count":3,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/posts\/112\/revisions"}],"predecessor-version":[{"id":689,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/posts\/112\/revisions\/689"}],"wp:attachment":[{"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/media?parent=112"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/categories?post=112"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/tags?post=112"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}