record_store 6.5.0 → 6.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f5d50f38de714c7b8d6d316070fc9d6bca5ac4d40751629c3c565866178d628
-  data.tar.gz: 14e3171ad53e5903404fcda9404bbfa109ec63db0c9253d8f3f7df76ee0e0ff1
+  metadata.gz: 16f9a10f5929ea735a99f35ec95365468ae74f1ca96b895ab66f77b22092cef2
+  data.tar.gz: cfa31577b7ed26208894fb03f2635ba1111d45bccd95a187553b4ce9750f9c98
 SHA512:
-  metadata.gz: ac87302ec7f2d9e1afcbac7af6ef340a7a6fdd7d503a2f941fb7e7f021a46eb3a2b071841a152b264ba1956c50aa45141853a3bfdda4e8101a5e226ddec595ac
-  data.tar.gz: 17fdee4d8ca5b4e9692e6a3718cdbb143e076890b2752a9dd4516c110835edbd73208056c8be8bfc5d18b926d97050d33300a04c29639d77cdc1429b2caf41cc
+  metadata.gz: d27fedbd2fe747f57fb595660fbd2f57aba841449db6d5c2ce571aa30f41c6a8cb8453960f336be1535e0b70fee532e317a89c320688eb55506ba247de19cf4a
+  data.tar.gz: 0dbb66a9617e4b7cb9a79f0e531e63984c63acf9d461cef32778317545d839ae83836a0ab02d36226e43a3ffaa865847c0c8a6e91f2af68a3d18c1346faed053

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # CHANGELOG
 
+## 6.5.4
+- Updates config path structure for build pipeline
+
+## 6.5.3
+- Adds check for detecting shadowed records, used when a record being added to a zone in record-store will have no effect because it is shadowed by another record.
+
+## 6.5.2
+- Ensure filters for implicit_records, `except_record` and `conflict_with`, are truly optional [BUGFIX]
+
+## 6.5.1
+
+Add support for a new parameter in the implicit records templates:
+
+- `except_record`: the template will *NOT* generate the `injected_records` for records matching `except_record`, even if they matched `each_record`.
+
+Also added support for regular expressions in the matching, using the already available `!ruby/regexp` text in a YAML value. The object loaded from the YAML
+will be of `Regexp` type, and will thus be used to _match_ the value, instead of being identical only. This is supported in both `except_record` and
+`each_record` fields.
+
+## 6.5.0
+
+...
+
 ## 6.4.0
 
 Add support for injecting implicit records into a zone based on a pre-configured template. Brief overview of template keys:

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '6.5.0'.freeze
+  VERSION = '6.5.4'.freeze
 end

data/lib/record_store/zone/config/implicit_record_template.rb

@@ -26,9 +26,14 @@ module RecordStore
           def from_file(filename:)
             filepath = template_filepath_for(filename: filename)
             template_file = File.read(filepath)
-            filters_for_records_to_template = YAML.load(template_file).deep_symbolize_keys[:each_record]
 
-            new(template: ERB.new(template_file), filters_for_records_to_template: filters_for_records_to_template)
+            template_file_yaml = YAML.load(template_file).deep_symbolize_keys
+            filters_for_records_to_template = template_file_yaml[:each_record]
+            filters_for_records_to_exclude = template_file_yaml[:except_record] || []
+
+            new(template: ERB.new(template_file),
+                filters_for_records_to_template: filters_for_records_to_template,
+                filters_for_records_to_exclude: filters_for_records_to_exclude)
           end
 
           private
@@ -38,9 +43,10 @@ module RecordStore
           end
         end
 
-        def initialize(template:, filters_for_records_to_template:)
+        def initialize(template:, filters_for_records_to_template:, filters_for_records_to_exclude:)
           @template = template
           @filters_for_records_to_template = filters_for_records_to_template
+          @filters_for_records_to_exclude = filters_for_records_to_exclude
         end
 
         def generate_records_to_inject(current_records:)
@@ -61,23 +67,29 @@ module RecordStore
 
         private
 
-        attr_reader :template, :filters_for_records_to_template
+        attr_reader :template, :filters_for_records_to_template, :filters_for_records_to_exclude
 
         def should_inject?(template_records:, current_records:)
+          conflict_with = template_records[:conflict_with] || []
           current_records.none? do |record|
-            template_records[:conflict_with].any? do |filter|
+            conflict_with.any? do |filter|
               record_match?(record: record, filter: filter)
             end
           end
         end
 
         def should_template?(record:)
-          filters_for_records_to_template.any? { |filter| record_match?(record: record, filter: filter) }
+          filters_for_records_to_template.any? { |filter| record_match?(record: record, filter: filter) } && \
+            filters_for_records_to_exclude.none? { |filter| record_match?(record: record, filter: filter) }
         end
 
         def record_match?(record:, filter:)
           filter.all? do |key, value|
-            record.public_send(key) == value
+            if value.is_a?(Regexp)
+              value.match(record.public_send(key))
+            else
+              record.public_send(key) == value
+            end
           end
         end
 

data/lib/record_store/zone.rb

@@ -21,6 +21,7 @@ module RecordStore
     validate :validate_no_empty_non_terminal
     validate :validate_can_handle_alias_records
     validate :validate_no_duplicate_keys
+    validate :validate_zone_record_not_shadowed
 
     class << self
       def download(name, provider_name, **write_options)
@@ -62,7 +63,12 @@ module RecordStore
             current_zone = nil
             while zones.any?
               mutex.synchronize { current_zone = zones.shift }
-              mutex.synchronize { modified_zones << current_zone } unless current_zone.unchanged?
+              break if current_zone.nil? # account for the race between `zones.any?` and `zones.shift`
+
+              # `unchanged?` is deliberately outside locked context since it's a bit CPU/time heavy
+              unless current_zone.unchanged?
+                mutex.synchronize { modified_zones << current_zone }
+              end
             end
           end
         end.each(&:join)
@@ -272,6 +278,26 @@ module RecordStore
       end
     end
 
+    def validate_zone_record_not_shadowed
+      nameserver_fqdns = records
+        .select { |record| record.is_a?(Record::NS) && name != record.fqdn }
+        .map { |record| record.fqdn.delete_suffix(".") }
+        .uniq
+
+      nameserver_fqdns.each do |ns_record|
+        selected_records = records.reject do |record|
+          record.is_a?(Record::NS) && \
+            record.fqdn.delete_suffix(".") == ns_record
+        end
+        selected_records.each do |record|
+          normalized_record = record.fqdn.delete_suffix(".")
+          next unless normalized_record.end_with?(".#{ns_record}") || normalized_record == ns_record
+          errors.add(:records, "Record #{record.fqdn} #{record.type} in Zone #{name} " \
+            "is shadowed by #{ns_record} and will be ignored")
+        end
+      end
+    end
+
     def validate_no_empty_non_terminal
       return unless config.empty_non_terminal_over_wildcard?
 

data/lib/record_store.rb

@@ -44,6 +44,7 @@ module RecordStore
   class << self
     attr_writer :secrets_path
     attr_writer :zones_path
+    attr_writer :implicit_records_templates_path
 
     def secrets_path
       @secrets_path ||= File.expand_path(config.fetch('secrets_path'), File.dirname(config_path))

data/template/templates/implicit_records/implicit_example.yml.erb

@@ -2,6 +2,8 @@ each_record:
 - type: A
   fqdn: abc.123.com.
 - type: TXT
+except_record:
+- fqdn: !ruby/regexp /^_/
 conflict_with:
 - type: TXT
   fqdn: <%= record.fqdn %>.more.domain.com.

data/template/zones/dynect.example.com.yml

@@ -5,7 +5,7 @@ dynect.example.com:
     ignore_patterns:
     - type: NS
       fqdn: dynect.example.com.
-    implicit_record_templates:
+    implicit_records_templates:
     - implicit_example.yml.erb
   records:
   - type: A

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 6.5.0
+  version: 6.5.4
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -417,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Manage DNS using git