[CONTROLLER-922] Errors in feature config files are not reported enough Created: 06/Oct/14  Updated: 17/Jun/15  Resolved: 17/Jun/15

Status: Verified
Project: controller
Component/s: config
Affects Version/s: Helium
Fix Version/s: None

Type: Bug
Reporter: Vratko Polak Assignee: Vratko Polak
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: Linux
Platform: PC

Issue Links:
Blocks
blocks CONTROLLER-523 Milestone: Continuos: Improve error-r... Resolved
External issue ID: 2150

 Description   

Some XML configuration files packaged in features encourage users to make manual edits. But if a user makes a typo, it is not reported back, configuration file is ignored instead. More precisely, the user gets a message ending with something like
etc/opendaylight/karaf/41-bgp-example.xml is not a config subsystem config file
on level DEBUG and that is it. As default log level is INFO, currently the user is left wondering about what went wrong. Pre-karaf ODL builds used to print out full exception, which was helpful in localizing error in config file. This can be considered a bug, as existing functionality is not exercised just because configuration file comes from a feature.

 Comments   
Comment by Vratko Polak [ 06/Oct/14 ]

My idea of how the fix could look like: https://git.opendaylight.org/gerrit/#/c/11752/

Comment by Vratko Polak [ 08/Jan/15 ]

Updated patches:
https://git.opendaylight.org/gerrit/#/c/12457/3 (stable/helium)
https://git.opendaylight.org/gerrit/#/c/11752/3 (master)

Now, only .xml files (and not /etc/jetty.xml) are apllied,
so (hopefully) no false alarms in error reporting.
Sadly, only syntactic (XML) errors are detected, semantic ones
still result in silent non-appearance of functionality.
Typical example is 41-bgp-example.xml
when user uses (previously valid) "bgp-id" instead of "bgp-rib-id".

Comment by Vratko Polak [ 29/May/15 ]

Maros has made a patch with possible final fix:
https://git.opendaylight.org/gerrit/#/c/21100/

I have verified that in case of XML syntax error, the log contains nice helpful warning.
Verification of typos of semantic nature is currently not possible, due to CONTROLLER-1349.

Comment by Vratko Polak [ 17/Jun/15 ]

As a subset of original description was fixed indeed, I have created CONTROLLER-1372 with the rest of description, so that this bug can be closed as VERIFIED FIXED (on Lithium RC1 builds).

Generated at Wed Feb 07 19:54:13 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.