Merge ~rmalz/charm-advanced-routing:rmalz/perform_config_during_update into charm-advanced-routing:master

[Robert Malz]

Reapply configuration during charm update process

With recent change:
https://git.launchpad.net/charm-advanced-routing/commit/?id=28162e0fb93b07f3894b00ad40d2093c12bbe234
charm will create a new systemd configuration file which helps solving according issue.
However new configuration will not be applied if user upgrades charm from older version without reapplying configuration which:
A) should be either documented
B) handled within charm itself.

This patch runs a configuration routine during upgrade-charm hook.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Robert Malz (rmalz)]

this patch targets a feedback from:
https://bugs.launchpad.net/charm-advanced-routing/+bug/2034029/comments/8

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:d066410c24989c3d46b143a44d776526fe20aab4
https://jenkins.canonical.com/bootstack/job/lp-charm-advanced-routing-ci/21/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest31/522/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/759/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-advanced-routing-ci/21//rebuild

review: Approve (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:e9a85bba69f5a01391c5b45857aaae543639391e
https://jenkins.canonical.com/bootstack/job/lp-charm-advanced-routing-ci/22/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest31/523/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/760/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-advanced-routing-ci/22//rebuild

review: Approve (continuous-integration)

[Eric Chen (eric-chen)]

Please check my inline comment

review: Needs Fixing

[Robert Malz (rmalz)]

Following guidance we will have a different behavior.
Current one will always apply configuration without notifying user about the change.

Eric proposal will put unit into blocked state and force user to run apply-changes action.
This way it will explicitly state that to finish upgrade configuration must be reapplied.

Putting this comment after DM with Eric to ramp up more discussion on this topic.

[Eric Chen (eric-chen)]

The default value of is_action_managed is true.

"Changes need to be applied by running the 'apply-changes' action"

In order to maintain original behavior (update won't apply new routing config until user trigger it), that's why I purpose we should follow the behavior in reconfigure_routing when there is any routing config.

In ideal case, if we know there is no new routing config, we can avoid the charm enter blocked state. That will need some extra effort.

[Giuseppe Petralia (peppepetra)]

Applying the routing on charm upgrade makes sense, but we should use `reconfigure_routing` to make sure this is only done when the is_action_managed is false and is_advanced_routing_enabled is true.

review: Needs Fixing

[Robert Malz (rmalz)]

Updated according to the discussion.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:ceffe7593a0eed156e5bddc0153723418e020f7f
https://jenkins.canonical.com/bootstack/job/lp-charm-advanced-routing-ci/23/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest31/575/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/771/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-advanced-routing-ci/23//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:33d98a4012b925f189d11e3142d71285ebfe5f83
https://jenkins.canonical.com/bootstack/job/lp-charm-advanced-routing-ci/24/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest31/576/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/772/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-advanced-routing-ci/24//rebuild

review: Needs Fixing (continuous-integration)

[Robert Malz (rmalz)]

CI has some issues:
charmcraft internal error: LXDError(brief="failed to inject host'\''s snap '\''charmcraft'\'' into target environment.", details=None, resolution=None)
Full execution log: '\''/home/ubuntu/.local/state/charmcraft/log/charmcraft-20231117-094222.612993.log'\''
make: *** [Makefile:55: build] Error 1

Unmerged commits

b0ff7cb... by Robert Malz <email address hidden> on 2023-11-07

Reapply configuration during charm update process

diff --git a/src/reactive/advanced_routing.py b/src/reactive/advanced_routing.py
index 0fc273e..005a071 100644
--- a/src/reactive/advanced_routing.py
+++ b/src/reactive/advanced_routing.py
@@ -4,7 +4,7 @@ import sys
 from advanced_routing_helper import AdvancedRoutingHelper, PolicyRoutingExists
 
 from charms.layer import status
-from charms.reactive import clear_flag, set_flag, when, when_not
+from charms.reactive import clear_flag, hook, set_flag, when, when_not
 
 from routing_validator import RoutingConfigValidatorError
 
@@ -64,3 +64,9 @@ def reconfigure_routing():
         return
 
     status.active("Unit is ready")
+
+
+@hook("upgrade-charm")
+def upgrade_charm():
+    """Perform upgrade related operations."""
+    reconfigure_routing()