Add --set to config append, --report to config {set,append,remove} (rebased onto develop)

[atarkowska]

This is the same as gh-4791 but rebased onto develop.

---

What this PR does

Adds --set option to omero config append, to indicate a value should only be added if it's not already in the list, taking into account the defaults, see #4597

Adds --report option to omero config {append,set,remove}. This will always print out Changed: ... if a change was made, and nothing if no change was made.

Testing this PR

1. Check omero config append/set/remove behaves as before.

2. Try something like

   omero config append --set omero.web.ui.top_links '["History", "history", {"title": "History"}]'
   

   this should have no effect (E.g. omero config get, or omero web restart and check the top-links) because this value is part of the standard defaults.

3. Try it without --set, you should see the old behaviour i.e. the duplicate value is appended

   omero config append omero.web.ui.top_links '["History", "history", {"title": "History"}]'
   

4. Add a different value, e.g.

   omero config append --set omero.web.ui.top_links '["BBC", "http://www.bbc.co.uk/"]'
   

5. Try omero config {append,set,remove} --report. If a change was made you should see a message such as Changed: Appended omero.web.ui.top_links:["BBC", "http://www.bbc.co.uk/"]

The idea behind this is to assist with Ansible deployments where you want to programmatically know whether or not a change was made.

Related reading

• Idempotent configuration commands & config management #4597
• Motivation: Deploy mapr on the IDR with Ansible
  • Web apps: IDR Mapr infrastructure#104

[atarkowska]

--rebased-from #4791

[joshmoore]

Thanks for opening this. See naming discussion under #4791 (comment)

[joshmoore]

[hudson@ome-c6100-1 dist]$ bin/omero config append --set --report josh.test '"foo"'
Changed: Appended josh.test:"foo"
[hudson@ome-c6100-1 dist]$ bin/omero config append --set --report josh.test '"foo"'
[hudson@ome-c6100-1 dist]$ bin/omero config append --set --report josh.test '"bar"'
Changed: Appended josh.test:"bar"
[hudson@ome-c6100-1 dist]$ bin/omero config append --report josh.test '"bar"'
Changed: Appended josh.test:"bar"
[hudson@ome-c6100-1 dist]$ bin/omero config get josh.test
["foo", "bar", "bar"]
[hudson@ome-c6100-1 dist]$ bin/omero config set josh.test
[hudson@ome-c6100-1 dist]$

[joshmoore]

Tests pass as they did on metadata52. I've listed this PR for API review based on the naming discussion linked above.