add preservation of comment lines

[wififreedom]

I've implemented preservation of comments in the existing config file when doing one of uci commands 'add', 'delete', 'set', 'add_list', 'del_list', 'import' and 'export'.

Both comment lines before a non-comment (config/option/list) line and comments at the end of a non-comment line are preserved with the non-comment line. For example:

# comment before config line 1 is preserved
# comment before config line 2 is preserved
config interface 'myinterface' # comment after config is preserved
        # comment before option line 1 is preserved
        # comment before option line 2 is preserved
        option myoption 'myvalue' # comment after option is preserved
# this comment after all config/option/list lines is not preserved

uci command line commands 'set' (for adding config lines and option lines) and 'add_list' (for adding list lines) now also support setting and updating comment lines before and a comment after the config/option/list line. For example:

uci set "dhcp.lan=dhcp## comment after: config dhcp 'lan'"
uci set "dhcp.lan.interface=lan## comment after: option interface 'lan'"
uci add_list "dhcp.lan.ra_flags=managed_config## comment before line 1\\n# comment before line 2\\n#comment after: list ra_flags 'managed_config'"

results in:

config dhcp 'lan' # comment after: config dhcp 'lan'
        option interface 'lan' # comment after: option interface 'lan'
        # comment before line 1
        #comment before line 2
        list ra_flags 'managed_config' # comment after: list ra_flags 'managed_config'

Comment lines are auto-indented when preserved.

Limitations:

• Comments at the end of the file are not preserved

[GeorgeSapkin]

You'll need to look into the submission guidelines regarding commit formatting, etc.

[wififreedom]

I will rebase with a proper commit message once I'm satisfied.

I'm interested in early reactions if this feature is even desirable.

[wififreedom]

Tests written.

[wififreedom]

The shunit2 test is broken, does not fail if one of the subtests fails, because exit code 1 is not propagated.

In tests/shunit2/tests.sh:

/bin/sh ${FULL_SUITE}

rm -rf ${TESTS_DIR}

should be:

/bin/sh ${FULL_SUITE}
EXITCODE=$?

rm -rf ${TESTS_DIR}

exit ${EXITCODE}

See #21

[wififreedom]

Additions i could implement:

• DONE extend the 'get' command to optionally show the comments
• extend the 'show' command to optionally also include the comments
• allow working with comments (set, add_list, ...) in the lua wrapper (but I don't know anything about lua, let alone about programming a wrapper for lua)