[jboss-jira] [JBoss JIRA] Issue Comment Edited: (LOGTOOL-20) Detect parameters being inconsistent with log message template

[Sanne Grinovero (JIRA)]

    [ https://issues.jboss.org/browse/LOGTOOL-20?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12608690#comment-12608690 ] 

Sanne Grinovero edited comment on LOGTOOL-20 at 6/14/11 6:33 PM:
-----------------------------------------------------------------

Hi James, thanks a lot. If that takes more time could you split the issue (or if you prefer I can open another one?), as having this one solved already would be very nice: I'm confident that many projects would quickly identify some untested log statement as we just mass-converted some project to use the new logging and so log statements are mostly untested even on mature codebases, and when this happens it's quite bad as the (original) statement is hidden/lost.

      was (Author: sannegrinovero):
    Hi James, thanks a lot. If that takes more time could you split the issue (or if you prefer I can open another one?), as having this one solved already would be very nice: I'm confident that many projects would quickly identify some untested log statement as we just mass-converted some and so log statements are mostly untested even on mature codebases, and when this happens it's quite bad as the (original) statement is hidden/lost.
  
> Detect parameters being inconsistent with log message template
> --------------------------------------------------------------
>
>                 Key: LOGTOOL-20
>                 URL: https://issues.jboss.org/browse/LOGTOOL-20
>             Project: Log Tool
>          Issue Type: Feature Request
>      Security Level: Public(Everyone can see) 
>            Reporter: Sanne Grinovero
>            Assignee: James Perkins
>             Fix For: 1.0.0.Beta8
>
>
> In both Infinispan and Hibernate we had reports of issues following the same patterns, as in code like:
> {code}
> @LogMessage(level = ERROR)
> @Message(id = 21, value = "Unable to synchronize source of %s for entity %s")
> void unableToSynchronizeSource(String indexName, @Cause Exception e);
> {code}
> People might do mistakes in the string template, forget to pass enough parameters, or not use the positional _%1$s_ variants. We can hardly write tests to cover all log messages, while I think it would be quite cool if the annotation processor could verify messages consistency with parameters at compile time.
> It would be just awesome if it could check for type consistency as well.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira