Implement per-resource sorting (#25)

sous-chefs · Jul 9, 2024 · c7a01fa · c7a01fa
1 parent 10a0973
commit c7a01fa
Show file tree

Hide file tree

Showing 50 changed files with 58 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@ This file is used to list changes made in each version of isc_kea.
 
 ## Unreleased
 
+- Add per-resource sorting for all array based configuration resources
+
 ## 1.5.0 - *2024-07-08*
 
 - Add sort functions to `config_dhcp4_client_class` and `config_dhcp6_client_class`

diff --git a/metadata.rb b/metadata.rb
@@ -17,5 +17,5 @@
 supports 'scientific'
 supports 'ubuntu'
 
-depends 'chef_auto_accumulator', '~> 0.5'
+depends 'chef_auto_accumulator', '~> 0.6'
 depends 'yum-epel', '~> 4.1'
diff --git a/resources/config_dhcp4_client_class.rb b/resources/config_dhcp4_client_class.rb
@@ -26,7 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp4 client-classes),
     config_path_type: :array,
-    config_path_sort_function: [:fetch, 'name'],
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => class_name,
     },

diff --git a/resources/config_dhcp4_global_host_reservation.rb b/resources/config_dhcp4_global_host_reservation.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp4 reservations),
     config_path_type: :array,
+    config_path_sort_keys: %w(ip_address),
     config_match: {
       'ip_address' => ip_address,
     },

diff --git a/resources/config_dhcp4_hooks_library.rb b/resources/config_dhcp4_hooks_library.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp4 hooks-libraries),
     config_path_type: :array,
+    config_path_sort_keys: %w(library),
     config_match: {
       'library' => library,
     },

diff --git a/resources/config_dhcp4_loggers.rb b/resources/config_dhcp4_loggers.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp4 loggers),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => logger_name,
     },

diff --git a/resources/config_dhcp4_loggers_output.rb b/resources/config_dhcp4_loggers_output.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(logger_name),
     config_path_override: %w(Dhcp4 loggers),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(library),
     config_path_match_key: 'name',
     config_path_match_value: logger_name,
     config_path_contained_key: 'output_options',

diff --git a/resources/config_dhcp4_option_data.rb b/resources/config_dhcp4_option_data.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp4 option-data),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => option_name,
       'code' => code,

diff --git a/resources/config_dhcp4_option_def.rb b/resources/config_dhcp4_option_def.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp4 option-def),
     config_path_type: :array,
+    config_path_sort_keys: %w(code name),
     config_match: {
       'name' => option_name,
       'code' => code,

diff --git a/resources/config_dhcp4_shared_network.rb b/resources/config_dhcp4_shared_network.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp4 shared-networks),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => network_name,
     },

diff --git a/resources/config_dhcp4_shared_network_option_data.rb b/resources/config_dhcp4_shared_network_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(shared_network_name),
     config_path_override: %w(Dhcp4 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: 'name',
     config_path_match_value: shared_network_name,
     config_path_contained_key: 'option-data',

diff --git a/resources/config_dhcp4_shared_network_subnet.rb b/resources/config_dhcp4_shared_network_subnet.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(shared_network_name),
     config_path_override: %w(Dhcp4 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(subnet),
     config_path_match_key: 'name',
     config_path_match_value: shared_network_name,
     config_path_contained_key: 'subnet4',

diff --git a/resources/config_dhcp4_shared_network_subnet_option_data.rb b/resources/config_dhcp4_shared_network_subnet_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(shared_network_name subnet),
     config_path_override: %w(Dhcp4 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: %w(name subnet),
     config_path_match_value: [ shared_network_name, subnet ],
     config_path_contained_key: %w(subnet4 option-data),

diff --git a/resources/config_dhcp4_shared_network_subnet_pool.rb b/resources/config_dhcp4_shared_network_subnet_pool.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet shared_network_name),
     config_path_override: %w(Dhcp4 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(pool),
     config_path_match_key: %w(name subnet),
     config_path_match_value: [ shared_network_name, subnet ],
     config_path_contained_key: %w(subnet4 pools),

diff --git a/resources/config_dhcp4_subnet.rb b/resources/config_dhcp4_subnet.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp4 subnet4),
     config_path_type: :array,
+    config_path_sort_keys: %w(id subnet),
     config_match: {
       'subnet' => subnet,
       'id' => id,

diff --git a/resources/config_dhcp4_subnet_host_reservation.rb b/resources/config_dhcp4_subnet_host_reservation.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet),
     config_path_override: %w(Dhcp4 subnet4),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(ip_address),
     config_path_match_key: 'subnet',
     config_path_match_value: subnet,
     config_path_match: {

diff --git a/resources/config_dhcp4_subnet_host_reservation_option_data.rb b/resources/config_dhcp4_subnet_host_reservation_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet ip_address),
     config_path_override: %w(Dhcp4 subnet4),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: %w(subnet ip-address),
     config_path_match_value: [ subnet, ip_address ],
     config_path_contained_key: %w(reservations option-data),

diff --git a/resources/config_dhcp4_subnet_option_data.rb b/resources/config_dhcp4_subnet_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet),
     config_path_override: %w(Dhcp4 subnet4),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: 'subnet',
     config_path_match_value: subnet,
     config_path_contained_key: 'option-data',

diff --git a/resources/config_dhcp4_subnet_pool.rb b/resources/config_dhcp4_subnet_pool.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet),
     config_path_override: %w(Dhcp4 subnet4),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(pool),
     config_path_match_key: 'subnet',
     config_path_match_value: subnet,
     config_path_contained_key: 'pools',

diff --git a/resources/config_dhcp4_subnet_pool_option_data.rb b/resources/config_dhcp4_subnet_pool_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet pool),
     config_path_override: %w(Dhcp4 subnet4),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: %w(subnet pool),
     config_path_match_value: [ subnet, pool ],
     config_path_contained_key: %w(pools option-data),

diff --git a/resources/config_dhcp6_client_class.rb b/resources/config_dhcp6_client_class.rb
@@ -26,7 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 client-classes),
     config_path_type: :array,
-    config_path_sort_function: [:fetch, 'name'],
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => class_name,
     },

diff --git a/resources/config_dhcp6_config_control_config_database.rb b/resources/config_dhcp6_config_control_config_database.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 config-control config-databases),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => database_name,
     },

diff --git a/resources/config_dhcp6_global_host_reservation.rb b/resources/config_dhcp6_global_host_reservation.rb
@@ -27,8 +27,9 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 reservations),
     config_path_type: :array,
+    config_path_sort_keys: %w(ip_addresses),
     config_match: {
-      'ip_address' => ip_address,
+      'ip_addresses' => ip_addresses,
     },
     permit_nil_properties: true,
   }.freeze

diff --git a/resources/config_dhcp6_hooks_library.rb b/resources/config_dhcp6_hooks_library.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 hooks-libraries),
     config_path_type: :array,
+    config_path_sort_keys: %w(library),
     config_match: {
       'library' => library,
     },

diff --git a/resources/config_dhcp6_loggers.rb b/resources/config_dhcp6_loggers.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 loggers),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => logger_name,
     },

diff --git a/resources/config_dhcp6_loggers_output.rb b/resources/config_dhcp6_loggers_output.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(logger_name),
     config_path_override: %w(Dhcp6 loggers),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(library),
     config_path_match_key: 'name',
     config_path_match_value: logger_name,
     config_path_contained_key: 'output_options',

diff --git a/resources/config_dhcp6_option_data.rb b/resources/config_dhcp6_option_data.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 option-data),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => option_name,
       'code' => code,

diff --git a/resources/config_dhcp6_option_def.rb b/resources/config_dhcp6_option_def.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 option-def),
     config_path_type: :array,
+    config_path_sort_keys: %w(code name),
     config_match: {
       'name' => option_name,
       'code' => code,

diff --git a/resources/config_dhcp6_shared_network.rb b/resources/config_dhcp6_shared_network.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 shared-networks),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_path_match_key: 'name',
     config_path_match_value: network_name,
     property_translation_matrix: {

diff --git a/resources/config_dhcp6_shared_network_option_data.rb b/resources/config_dhcp6_shared_network_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(shared_network_name),
     config_path_override: %w(Dhcp6 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: 'name',
     config_path_match_value: shared_network_name,
     config_path_contained_key: 'option-data',

diff --git a/resources/config_dhcp6_shared_network_subnet.rb b/resources/config_dhcp6_shared_network_subnet.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(shared_network_name),
     config_path_override: %w(Dhcp6 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(subnet),
     config_path_match_key: 'name',
     config_path_match_value: shared_network_name,
     config_path_contained_key: 'subnet4',

diff --git a/resources/config_dhcp6_shared_network_subnet_option_data.rb b/resources/config_dhcp6_shared_network_subnet_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(shared_network_name subnet),
     config_path_override: %w(Dhcp6 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: %w(name subnet),
     config_path_match_value: [ shared_network_name, subnet ],
     config_path_contained_key: %w(subnet6 option-data),

diff --git a/resources/config_dhcp6_shared_network_subnet_pd_pool.rb b/resources/config_dhcp6_shared_network_subnet_pd_pool.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet),
     config_path_override: %w(Dhcp6 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(pool),
     config_path_match_key: %w(name subnet),
     config_path_match_value: [ shared_network_name, subnet ],
     config_path_contained_key: %w(subnet6 pd-pools),

diff --git a/resources/config_dhcp6_shared_network_subnet_pool.rb b/resources/config_dhcp6_shared_network_subnet_pool.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet shared_network_name),
     config_path_override: %w(Dhcp6 shared-networks),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(subnet),
     config_path_match_key: %w(name subnet),
     config_path_match_value: [ shared_network_name, subnet ],
     config_path_contained_key: %w(subnet6 pools),

diff --git a/resources/config_dhcp6_subnet.rb b/resources/config_dhcp6_subnet.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(Dhcp6 subnet6),
     config_path_type: :array,
+    config_path_sort_keys: %w(id subnet),
     config_match: {
       'subnet' => subnet,
       'id' => id,

diff --git a/resources/config_dhcp6_subnet_host_reservation.rb b/resources/config_dhcp6_subnet_host_reservation.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet),
     config_path_override: %w(Dhcp6 subnet6),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(ip_addresses),
     config_path_match_key: 'subnet',
     config_path_match_value: subnet,
     config_path_contained_key: 'reservations',

diff --git a/resources/config_dhcp6_subnet_host_reservation_option_data.rb b/resources/config_dhcp6_subnet_host_reservation_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet ip_addresses),
     config_path_override: %w(Dhcp6 subnet6),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: %w(subnet ip-addresses),
     config_path_match_value: [ subnet, ip_addresses ],
     config_path_contained_key: %w(reservations option-data),

diff --git a/resources/config_dhcp6_subnet_option_data.rb b/resources/config_dhcp6_subnet_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet),
     config_path_override: %w(Dhcp6 subnet6),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: 'subnet',
     config_path_match_value: subnet,
     config_path_contained_key: 'option-data',

diff --git a/resources/config_dhcp6_subnet_pd_pool.rb b/resources/config_dhcp6_subnet_pd_pool.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet),
     config_path_override: %w(Dhcp6 subnet6),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(prefix),
     config_path_match_key: 'subnet',
     config_path_match_value: subnet,
     config_path_contained_key: 'pd-pools',

diff --git a/resources/config_dhcp6_subnet_pool.rb b/resources/config_dhcp6_subnet_pool.rb
@@ -28,6 +28,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet),
     config_path_override: %w(Dhcp6 subnet6),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(pool),
     config_path_match_key: 'subnet',
     config_path_match_value: subnet,
     config_path_contained_key: 'pools',

diff --git a/resources/config_dhcp6_subnet_pool_option_data.rb b/resources/config_dhcp6_subnet_pool_option_data.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet pool),
     config_path_override: %w(Dhcp6 subnet6),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(code name),
     config_path_match_key: %w(subnet pool),
     config_path_match_value: [ subnet, pool ],
     config_path_contained_key: %w(pools option-data),

diff --git a/resources/config_dhcp6_subnet_prefix_delegation.rb b/resources/config_dhcp6_subnet_prefix_delegation.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(subnet_id),
     config_path_override: %w(Dhcp6 subnet6),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(prefix),
     config_path_match_key: 'subnet',
     config_path_match_value: subnet,
     config_path_contained_key: 'reservations',

diff --git a/resources/config_dhcp_ddns_forward_ddns_domain.rb b/resources/config_dhcp_ddns_forward_ddns_domain.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(DhcpDdns forward-ddns ddns-domains),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => zone_name,
     },

diff --git a/resources/config_dhcp_ddns_hooks_library.rb b/resources/config_dhcp_ddns_hooks_library.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(DhcpDdns hooks-libraries),
     config_path_type: :array,
+    config_path_sort_keys: %w(library),
     config_match: {
       'library' => library,
     },

diff --git a/resources/config_dhcp_ddns_loggers.rb b/resources/config_dhcp_ddns_loggers.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(DhcpDdns loggers),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => logger_name,
     },

diff --git a/resources/config_dhcp_ddns_loggers_output.rb b/resources/config_dhcp_ddns_loggers_output.rb
@@ -27,6 +27,7 @@ def auto_accumulator_options_override
     config_properties_skip: %i(logger_name),
     config_path_override: %w(DhcpDdns loggers),
     config_path_type: :array_contained,
+    config_path_sort_keys: %w(library),
     config_path_match_key: 'name',
     config_path_match_value: logger_name,
     config_path_contained_key: 'output_options',

diff --git a/resources/config_dhcp_ddns_reverse_ddns_domain.rb b/resources/config_dhcp_ddns_reverse_ddns_domain.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(DhcpDdns reverse-ddns ddns-domains),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => zone_name,
     },

diff --git a/resources/config_dhcp_ddns_tsig_key.rb b/resources/config_dhcp_ddns_tsig_key.rb
@@ -26,6 +26,7 @@ def auto_accumulator_options_override
   {
     config_path_override: %w(DhcpDdns tsig-keys),
     config_path_type: :array,
+    config_path_sort_keys: %w(name),
     config_match: {
       'name' => key_name,
     },

diff --git a/resources/partial/_config_auto_accumulator_kea.rb b/resources/partial/_config_auto_accumulator_kea.rb
@@ -52,6 +52,10 @@
 property :filemode, String,
           default: '0644'
 
+property :sort, [true, false],
+          default: false,
+          desired_state: false
+
 property :extra_options, Hash,
           coerce: proc { |p| p.transform_keys(&:to_s) }