[pve-devel] [PATCH ha-manager 07/18] rename rule's canonicalize stage to transform stage

[Daniel Kral]

The name 'canonicalize' was chosen when the actual goal was to transform
the rules in a canonical form for the scheduler, but as development went
on they are used to transform $rules and induce new rules from $rules,
so 'canonicalize' is not the right term anymore.

'transform' is chosen because it's broad enough for future use but still
conveys what is done with the $rules.

Signed-off-by: Daniel Kral <d.kral at proxmox.com>
---
 src/PVE/HA/Config.pm                 |  2 +-
 src/PVE/HA/Manager.pm                |  2 +-
 src/PVE/HA/Rules.pm                  | 18 +++++++++---------
 src/PVE/HA/Rules/ResourceAffinity.pm |  4 ++--
 src/test/test_rules_config.pl        |  2 +-
 5 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/src/PVE/HA/Config.pm b/src/PVE/HA/Config.pm
index b2ef26aa..bd87a0ab 100644
--- a/src/PVE/HA/Config.pm
+++ b/src/PVE/HA/Config.pm
@@ -237,7 +237,7 @@ sub read_and_check_effective_rules_config {
 
     PVE::HA::Groups::migrate_groups_to_rules($rules, $groups, $resources);
 
-    PVE::HA::Rules->canonicalize($rules, $nodes);
+    PVE::HA::Rules->transform($rules, $nodes);
 
     return $rules;
 }
diff --git a/src/PVE/HA/Manager.pm b/src/PVE/HA/Manager.pm
index 92a2c05e..12d3c0e8 100644
--- a/src/PVE/HA/Manager.pm
+++ b/src/PVE/HA/Manager.pm
@@ -754,7 +754,7 @@ sub manage {
         PVE::HA::Groups::migrate_groups_to_rules($new_rules, $self->{groups}, $sc);
 
         my $nodes = $self->{ns}->list_nodes();
-        my $messages = PVE::HA::Rules->canonicalize($new_rules, $nodes);
+        my $messages = PVE::HA::Rules->transform($new_rules, $nodes);
         $haenv->log('info', $_) for @$messages;
 
         $self->{rules} = $new_rules;
diff --git a/src/PVE/HA/Rules.pm b/src/PVE/HA/Rules.pm
index 784f2d36..c81b1525 100644
--- a/src/PVE/HA/Rules.pm
+++ b/src/PVE/HA/Rules.pm
@@ -360,7 +360,7 @@ sub check_feasibility : prototype($$$) {
     return $global_errors;
 }
 
-=head3 $class->plugin_canonicalize($rules)
+=head3 $class->plugin_transform($rules)
 
 B<OPTIONAL:> Can be implemented in the I<rule plugin>.
 
@@ -368,11 +368,11 @@ Modifies the C<$rules> to a plugin-specific canonical form.
 
 =cut
 
-sub plugin_canonicalize : prototype($$) {
+sub plugin_transform : prototype($$) {
     my ($class, $rules) = @_;
 }
 
-=head3 $class->canonicalize($rules, $nodes)
+=head3 $class->transform($rules, $nodes)
 
 Modifies C<$rules> to contain only feasible rules.
 
@@ -386,7 +386,7 @@ Returns a list of messages with the reasons why rules were removed.
 
 =cut
 
-sub canonicalize : prototype($$$) {
+sub transform : prototype($$$) {
     my ($class, $rules, $nodes) = @_;
 
     my $messages = [];
@@ -407,11 +407,11 @@ sub canonicalize : prototype($$$) {
 
     for my $type (@$types) {
         my $plugin = $class->lookup($type);
-        eval { $plugin->plugin_canonicalize($rules) };
-        next if $@; # plugin doesn't implement plugin_canonicalize(...)
+        eval { $plugin->plugin_transform($rules) };
+        next if $@; # plugin doesn't implement plugin_transform(...)
     }
 
-    $class->global_canonicalize($rules);
+    $class->global_transform($rules);
 
     return $messages;
 }
@@ -709,7 +709,7 @@ __PACKAGE__->register_check(
     },
 );
 
-=head1 INTER-PLUGIN RULE CANONICALIZATION HELPERS
+=head1 INTER-PLUGIN RULE TRANSFORMATION HELPERS
 
 =cut
 
@@ -750,7 +750,7 @@ sub create_implicit_positive_resource_affinity_node_affinity_rules {
     }
 }
 
-sub global_canonicalize {
+sub global_transform {
     my ($class, $rules) = @_;
 
     my $args = $class->get_check_arguments($rules);
diff --git a/src/PVE/HA/Rules/ResourceAffinity.pm b/src/PVE/HA/Rules/ResourceAffinity.pm
index e9b368a4..947e1580 100644
--- a/src/PVE/HA/Rules/ResourceAffinity.pm
+++ b/src/PVE/HA/Rules/ResourceAffinity.pm
@@ -251,7 +251,7 @@ __PACKAGE__->register_check(
     },
 );
 
-=head1 RESOURCE AFFINITY RULE CANONICALIZATION HELPERS
+=head1 RESOURCE AFFINITY RULE TRANSFORMATION HELPERS
 
 =cut
 
@@ -381,7 +381,7 @@ sub create_implicit_negative_resource_affinity_rules {
     }
 }
 
-sub plugin_canonicalize {
+sub plugin_transform {
     my ($class, $rules) = @_;
 
     my $args = $class->get_plugin_check_arguments($rules);
diff --git a/src/test/test_rules_config.pl b/src/test/test_rules_config.pl
index c2a7af43..3c2dac4b 100755
--- a/src/test/test_rules_config.pl
+++ b/src/test/test_rules_config.pl
@@ -53,7 +53,7 @@ sub check_cfg {
     print "--- Log ---\n";
     my $cfg = PVE::HA::Rules->parse_config($cfg_fn, $raw);
     PVE::HA::Rules->set_rule_defaults($_) for values %{ $cfg->{ids} };
-    my $messages = PVE::HA::Rules->canonicalize($cfg, $nodes);
+    my $messages = PVE::HA::Rules->transform($cfg, $nodes);
     print $_ for @$messages;
     print "--- Config ---\n";
     {
-- 
2.47.2