record_store 6.3.1 → 6.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6875c27f0cf86510b733a58f668d44560eeb40e7c8b6c9438183fee175bc514
-  data.tar.gz: 3599cc9903a5afe46d544f8aeef349961fdc2d95011973325bbdcc75972c56c5
+  metadata.gz: ad3694c8bdf89c030abd7d0b6e4dda77f6b0627783c11d5f96194b18c0be047d
+  data.tar.gz: 65a8d64e1a5feff467d78297d9ed299d409d2bad617829d99291f9ddd0557558
 SHA512:
-  metadata.gz: 9a6def9342919457cc71fdda4691c92310450dfc28a476eee6d353b73798b8d1b612b4775982704b0c44b2e657149a02f0e96330796b03d591619ad5930509ae
-  data.tar.gz: 42183ae0ecd31e27a2d40977ecdda6cb51c0368ff24ac3a2de4411ab016809c5551ee3faeb50eb53503be059ece4bc41889e6c73d3e1f0ab53e7ab9290563628
+  metadata.gz: 257591b26a8b5b58d3752742d43be0acd79268ba0d3f69f2bf09b8469beefc70171900ba04f2b651ffd97d4bed82a49a42c65d002b3cb666e20178ba8d15864c
+  data.tar.gz: 8a605452495449a6a18e55ea57facb5d582977c21df5b74863fdda8ed185a9eafce3d788f6cab8b680bad019edf152c52548aa1dae7356700cf8026c1d5c5e1e

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [push, pull_request]
+
+env:
+  SRB_SKIP_GEM_RBIS: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.7.1 ]
+    name: Test Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: rubocop
+        run: bin/rubocop --version && bin/rubocop
+      - name: setup
+        run: bin/setup
+      - name: test
+        run: bundle exec rake test

data/.rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml

@@ -195,6 +195,7 @@ Style/FrozenStringLiteralComment:
   SupportedStyles:
     - always
     - never
+  SafeAutoCorrect: true
 
 Style/GlobalVars:
   AllowedVariables: []
@@ -264,7 +265,7 @@ Style/MethodCallWithArgsParentheses:
   - raise
   - puts
   Exclude:
-  - Gemfile
+  - '**/Gemfile'
 
 Style/MethodDefParentheses:
   EnforcedStyle: require_parentheses
@@ -577,6 +578,7 @@ Layout/BlockEndNewline:
 
 Style/CaseEquality:
   Enabled: true
+  AllowOnConstant: true
 
 Style/CharacterLiteral:
   Enabled: true
@@ -659,6 +661,9 @@ Style/IfWithSemicolon:
 Style/IdenticalConditionalBranches:
   Enabled: true
 
+Layout/IndentationStyle:
+  Enabled: true
+
 Style/InfiniteLoop:
   Enabled: true
 
@@ -803,9 +808,6 @@ Layout/SpaceInsideRangeLiteral:
 Style/SymbolLiteral:
   Enabled: true
 
-Layout/IndentationStyle:
-  Enabled: true
-
 Layout/TrailingWhitespace:
   Enabled: true
 
@@ -834,7 +836,7 @@ Style/ZeroLengthPredicate:
   Enabled: true
 
 Layout/HeredocIndentation:
-  EnforcedStyle: squiggly
+  Enabled: true
 
 Lint/AmbiguousOperator:
   Enabled: true
@@ -1015,3 +1017,6 @@ Style/ModuleFunction:
 
 Lint/OrderedMagicComments:
   Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## 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:
+
+- `each_record`: the template will generate all `injected_records` in the template for each Record in the Zone that matches criteria listed here.
+- `conflict_with`: if any Record in the Zone matches the criteria listed here, the template will avoid injecting any of its generated implicit records into the zone
+- `injected_records`: the implicit records that will be generated by the template for every Zone Record that matches the `each_record` criteria
+
 ## 6.3.1
 - Improve resiliency in the face of temporary provider outages [BUGFIX]
 

data/README.md

@@ -116,6 +116,13 @@ When running `bin/record-store apply`, a `Changeset` is generated by comparing t
 
 Record store attempts to parallelize some of the bulk zone fetching operations. It does so by spawning multiple threads (default: 10). This value can be configured by setting the RECORD_STORE_MAX_THREADS environment variable to a positive integer value.
 
+
+### Templates
+
+Record Store supports injecting implicit records into a zone based on templates. Each `Zone` can have a list of `Zone::Config::ImplicitRecordTemplate` in its `Zone::Config` that can define their own criteria for which records they use for generating implicit template records, which records conflict with the template-generated records, and what the template-generated records look like. These records are injected at the time of `Zone` initialization within `Zone#build_records`.
+
+Templates can help reduce zone file bloat where instead of defining many generic literals within the zone file for a given criteria zone record, these generic records can be implicitly injected into the `Zone` at the time of initialization based on information provided within the template.
+
 ----
 
 # Development

data/bin/console

@@ -6,6 +6,7 @@ require 'record_store'
 
 RecordStore.zones_path = File.expand_path('../../dev/zones', __FILE__)
 RecordStore.config_path = File.expand_path('../../dev/config.yml', __FILE__)
+RecordStore.implicit_records_templates_path = File.expand_path('../../dev/templates/implicit_records', __FILE__)
 
 require 'pry'
 binding.pry(RecordStore) # rubocop:disable Lint/Debugger

data/lib/record_store.rb

@@ -28,6 +28,7 @@ require 'record_store/zone/yaml_definitions'
 require 'record_store/zone'
 require 'record_store/zone/config'
 require 'record_store/zone/config/ignore_pattern'
+require 'record_store/zone/config/implicit_record_template'
 require 'record_store/changeset'
 require 'record_store/provider'
 require 'record_store/provider/dynect'
@@ -59,6 +60,13 @@ module RecordStore
       @config_path ||= File.expand_path('config.yml', Dir.pwd)
     end
 
+    def implicit_records_templates_path
+      @implicit_records_templates_path ||= Pathname.new(
+        File.expand_path(config.fetch('implicit_records_templates_path'),
+        File.dirname(config_path)),
+      ).realpath.to_s
+    end
+
     def config_path=(config_path)
       @config = @zones_path = @secrets_path = nil
       @config_path = config_path

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '6.3.1'.freeze
+  VERSION = '6.5.1'.freeze
 end

data/lib/record_store/zone.rb

@@ -20,6 +20,7 @@ module RecordStore
     validate :validate_provider_can_handle_zone_records
     validate :validate_no_empty_non_terminal
     validate :validate_can_handle_alias_records
+    validate :validate_no_duplicate_keys
 
     class << self
       def download(name, provider_name, **write_options)
@@ -70,10 +71,11 @@ module RecordStore
       end
     end
 
-    def initialize(name:, records: [], config: {})
+    def initialize(name:, records: [], config: {}, abstract_syntax_trees: {})
       @name = Record.ensure_ends_with_dot(name)
       @config = RecordStore::Zone::Config.new(config.deep_symbolize_keys)
       @records = build_records(records)
+      @abstract_syntax_trees = abstract_syntax_trees
     end
 
     def build_changesets(all: false)
@@ -189,7 +191,13 @@ module RecordStore
     end
 
     def build_records(records)
-      records.map { |record| Record.build_from_yaml_definition(record) }
+      all_records = records.map { |record| Record.build_from_yaml_definition(record) }
+
+      config.implicit_records_templates.each do |template|
+        all_records.push(*template.generate_records_to_inject(current_records: all_records))
+      end
+
+      all_records
     end
 
     def validate_records
@@ -301,5 +309,34 @@ module RecordStore
 
       errors.add(:records, "ALIAS record should be defined on the root of the zone: #{alias_record}")
     end
+
+    def validate_no_duplicate_keys
+      @abstract_syntax_trees.each do |filename, ast|
+        validate_no_duplicate_keys_in_node(filename, ast)
+      end
+    end
+
+    def validate_no_duplicate_keys_in_node(filename, node)
+      if node.mapping?
+        keys = node
+          .children
+          .each_slice(2)
+          .map(&:first)
+          .map(&:value)
+          .sort
+        dup_keys = keys
+          .find_all { |k| keys.count(k) > 1 }
+          .uniq
+        unless dup_keys.empty?
+          location = "#{File.basename(filename)}:#{node.start_line}"
+          description = "multiple definitions for keys #{dup_keys}"
+          errors.add(:records, "#{location}: #{description}")
+        end
+      end
+
+      node.children&.each do |child|
+        validate_no_duplicate_keys_in_node(filename, child)
+      end
+    end
   end
 end

data/lib/record_store/zone/config.rb

@@ -3,15 +3,17 @@ module RecordStore
     class Config
       include ActiveModel::Validations
 
-      attr_reader :ignore_patterns, :providers, :supports_alias
+      attr_reader :ignore_patterns, :providers, :supports_alias, :implicit_records_templates
 
       validate :validate_zone_config
 
-      def initialize(ignore_patterns: [], providers: nil, supports_alias: nil)
+      def initialize(ignore_patterns: [], providers: nil, supports_alias: nil, implicit_records_templates: [])
         @ignore_patterns = ignore_patterns.map do |ignore_pattern|
           Zone::Config::IgnorePattern.new(ignore_pattern)
         end
-
+        @implicit_records_templates = implicit_records_templates.map do |filename|
+          Zone::Config::ImplicitRecordTemplate.from_file(filename: filename)
+        end
         @providers = providers
         @supports_alias = supports_alias
       end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+module RecordStore
+  class Zone
+    class Config
+      class TemplateContext
+        def self.build(record:, current_records:)
+          new(record: record, current_records: current_records)
+        end
+
+        def initialize(record:, current_records:)
+          @record = record
+          @current_records = current_records
+        end
+
+        def fetch_binding
+          binding
+        end
+
+        private
+
+        attr_reader :record, :current_records
+      end
+
+      class ImplicitRecordTemplate
+        class << self
+          def from_file(filename:)
+            filepath = template_filepath_for(filename: filename)
+            template_file = File.read(filepath)
+
+            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
+
+          def template_filepath_for(filename:)
+            "#{RecordStore.implicit_records_templates_path}/#{filename}"
+          end
+        end
+
+        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:)
+          current_records
+            .select { |record| should_template?(record: record) }
+            .map { |record| template_record_for(record: record, current_records: current_records) }
+            .each_with_object([]) do |template_records, records_to_inject|
+              next unless should_inject?(
+                template_records: template_records,
+                current_records: current_records + records_to_inject
+              )
+
+              records_to_inject.push(
+                *template_records.fetch(:injected_records, []).map { |r_yml| Record.build_from_yaml_definition(r_yml) }
+              )
+            end
+        end
+
+        private
+
+        attr_reader :template, :filters_for_records_to_template, :filters_for_records_to_exclude
+
+        def should_inject?(template_records:, current_records:)
+          current_records.none? do |record|
+            template_records[: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_exclude.none? { |filter| record_match?(record: record, filter: filter) }
+        end
+
+        def record_match?(record:, filter:)
+          filter.all? do |key, value|
+            if value.is_a?(Regexp)
+              value.match(record.public_send(key))
+            else
+              record.public_send(key) == value
+            end
+          end
+        end
+
+        def template_record_for(record:, current_records:)
+          context = TemplateContext.build(record: record, current_records: current_records)
+
+          YAML.load(
+            template.result(context.fetch_binding)
+          ).deep_symbolize_keys
+        end
+      end
+    end
+  end
+end

data/lib/record_store/zone/yaml_definitions.rb

@@ -66,7 +66,10 @@ module RecordStore
         Dir["#{dir}/#{name}/*__*.yml"].each do |record_file|
           definition['records'] += load_yml_record_definitions(name, record_file)
         end
-        Zone.new(name: name, records: definition['records'], config: definition['config'])
+
+        asts = { filename => Psych.parse_file(filename) }
+
+        Zone.new(name: name, records: definition['records'], config: definition['config'], abstract_syntax_trees: asts)
       end
 
       def load_yml_record_definitions(name, record_file)

data/record_store.gemspec

@@ -48,6 +48,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'rubocop', '0.89.1'
+  spec.add_development_dependency 'rubocop', '~> 1.0.0'
   spec.add_development_dependency 'minitest-focus'
 end

data/template/config.yml

@@ -1,2 +1,3 @@
 zones_path: zones/
 secrets_path: secrets.json
+implicit_records_templates_path: templates/implicit_records/

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

@@ -0,0 +1,15 @@
+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.
+injected_records:
+- type: CNAME
+  ttl: 3600
+  fqdn: <%= record.fqdn %>.added.information.com
+  cname: <%= record.fqdn %>.more.added.information.com.
+

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

@@ -5,6 +5,8 @@ dynect.example.com:
     ignore_patterns:
     - type: NS
       fqdn: dynect.example.com.
+    implicit_record_templates:
+    - implicit_example.yml.erb
   records:
   - type: A
     fqdn: a-record.dynect.example.com.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 6.5.1
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -301,16 +301,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.1
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -335,6 +335,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml"
 - ".rubocop.yml"
@@ -380,6 +381,7 @@ files:
 - lib/record_store/zone.rb
 - lib/record_store/zone/config.rb
 - lib/record_store/zone/config/ignore_pattern.rb
+- lib/record_store/zone/config/implicit_record_template.rb
 - lib/record_store/zone/yaml_definitions.rb
 - record_store.gemspec
 - shipit.rubygems.yml
@@ -389,6 +391,7 @@ files:
 - template/bin/test
 - template/config.yml
 - template/secrets.json
+- template/templates/implicit_records/implicit_example.yml.erb
 - template/zones/dnsimple.example.com.yml
 - template/zones/dnsimple.example.com/A__a-record.yml
 - template/zones/dnsimple.example.com/TXT__marco.yml
@@ -414,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Manage DNS using git