record_store 6.5.1 → 6.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad3694c8bdf89c030abd7d0b6e4dda77f6b0627783c11d5f96194b18c0be047d
-  data.tar.gz: 65a8d64e1a5feff467d78297d9ed299d409d2bad617829d99291f9ddd0557558
+  metadata.gz: d08c3213971934f91db50a1f602c45e7110ec2f73c71bde5b02dcff1fd2e0731
+  data.tar.gz: 478970b2e7adf68a312544f97c0effd775398517340344d2eb6e0fdfc23c3cd9
 SHA512:
-  metadata.gz: 257591b26a8b5b58d3752742d43be0acd79268ba0d3f69f2bf09b8469beefc70171900ba04f2b651ffd97d4bed82a49a42c65d002b3cb666e20178ba8d15864c
-  data.tar.gz: 8a605452495449a6a18e55ea57facb5d582977c21df5b74863fdda8ed185a9eafce3d788f6cab8b680bad019edf152c52548aa1dae7356700cf8026c1d5c5e1e
+  metadata.gz: c67e750aedfdf0d8d9e5dc5bbb8ca01c2b5a0cd68a880f67fdc8f2094805b3ee8b231303b2f65c6f1012873f15a23a3383de786b7c44dc62cbf7eca2709058bb
+  data.tar.gz: 2d774dae370703a8807d7b91e4dbe50a1186ba920d7df2b8a3bf3276e930fb1f4342a050bdfcc84f8fdfae0231692064e969911452c0631f25809cd2da9aaca5

data/.rubocop.yml

@@ -1,19 +1,40 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6.4
   Exclude:
     - vendor/**/*
   UseCache: true
   CacheRootDirectory: tmp/rubocop
 
+Naming/InclusiveLanguage:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/QuotedSymbols:
+  Enabled: false
+
 Style/MethodCallWithArgsParentheses:
   Include:
     - '**/*.rb'
 
-Style/ClassAndModuleChildren:
-  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 6.5.5
+- Include DNSimple validation error details in exceptions
+
+## 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:

data/lib/record_store/cli.rb

@@ -193,14 +193,12 @@ module RecordStore
 
     desc 'secrets', 'Decrypts DynECT credentials'
     def secrets
-      environment = begin
-        if ENV['PRODUCTION']
-          'production'
-        elsif ENV['CI']
-          'ci'
-        else
-          'dev'
-        end
+      environment = if ENV['PRODUCTION']
+        'production'
+      elsif ENV['CI']
+        'ci'
+      else
+        'dev'
       end
 
       secrets = %x(ejson decrypt #{RecordStore.secrets_path.sub(/\.json\z/, ".#{environment}.ejson")})

data/lib/record_store/provider/dnsimple/patch_request_error_to_include_errors.rb

@@ -0,0 +1,20 @@
+module Dnsimple
+  class RequestError < Error
+    private
+
+    alias_method :original_message_from, :message_from
+
+    def message_from(http_response)
+      message = original_message_from(http_response)
+      return unless json_response?(http_response)
+
+      base_error = http_response.parsed_response.dig("errors", "base")&.join(", ")
+      message += ": #{base_error}" unless base_error.nil?
+      message
+    end
+
+    def json_response?(http_response)
+      http_response.headers["Content-Type"]&.start_with?("application/json")
+    end
+  end
+end

data/lib/record_store/provider/dnsimple.rb

@@ -1,5 +1,6 @@
 require 'dnsimple'
 require_relative 'dnsimple/patch_api_header'
+require_relative 'dnsimple/patch_request_error_to_include_errors'
 
 module RecordStore
   class Provider::DNSimple < Provider
@@ -20,12 +21,10 @@ module RecordStore
       def retrieve_current_records(zone:, stdout: $stdout)
         retry_on_connection_errors do
           session.zones.all_records(account_id, zone).data.map do |record|
-            begin
-              build_from_api(record, zone)
-            rescue StandardError
-              stdout.puts "Cannot build record: #{record}"
-              raise
-            end
+            build_from_api(record, zone)
+          rescue StandardError
+            stdout.puts "Cannot build record: #{record}"
+            raise
           end.compact
         end
       end

data/lib/record_store/provider/dynect.rb

@@ -36,11 +36,9 @@ module RecordStore
       def retrieve_current_records(zone:, stdout: $stdout)
         session.get_all_records(zone).body.fetch('data').flat_map do |_type, records|
           records.map do |record_body|
-            begin
-              build_from_api(record_body)
-            rescue StandardError
-              stdout.puts "Cannot build record: #{record_body}"
-            end
+            build_from_api(record_body)
+          rescue StandardError
+            stdout.puts "Cannot build record: #{record_body}"
           end
         end.compact
       end

data/lib/record_store/provider/google_cloud_dns.rb

@@ -22,13 +22,11 @@ module RecordStore
 
           # Unroll each record set into multiple records
           record_set.data.map do |record|
-            begin
-              record_set_member = record_set.dup
-              record_set_member.data = [record]
-              build_from_api(record_set_member)
-            rescue StandardError
-              stdout.puts "Cannot build record: #{record}"
-            end
+            record_set_member = record_set.dup
+            record_set_member.data = [record]
+            build_from_api(record_set_member)
+          rescue StandardError
+            stdout.puts "Cannot build record: #{record}"
           end
         end
 
@@ -44,12 +42,10 @@ module RecordStore
       private
 
       def session
-        @dns ||= begin
-          Google::Cloud::Dns.new(
-            project_id: secrets.fetch('project_id'),
-            credentials: Google::Cloud::Dns::Credentials.new(secrets),
-          )
-        end
+        @dns ||= Google::Cloud::Dns.new(
+          project_id: secrets.fetch('project_id'),
+          credentials: Google::Cloud::Dns::Credentials.new(secrets),
+        )
       end
 
       def secrets

data/lib/record_store/provider/ns1.rb

@@ -50,7 +50,7 @@ module RecordStore
       # Downloads all the records from the provider.
       #
       # Returns: an array of `Record` for each record in the provider's zone
-      def retrieve_current_records(zone:, stdout: $stdout) # rubocop:disable Lint/UnusedMethodArgument
+      def retrieve_current_records(zone:, stdout: $stdout)
         records_for_zone(zone)
           .flat_map { |short_record| build_from_api(short_record) }
           .compact

data/lib/record_store/provider.rb

@@ -3,6 +3,7 @@ require 'resolv'
 module RecordStore
   class Provider
     class Error < StandardError; end
+
     class UnparseableBodyError < Error; end
 
     class << self
@@ -152,24 +153,22 @@ module RecordStore
         )
 
         loop do
-          begin
-            return yield
-          rescue UnparseableBodyError
-            raise if max_retries <= 0
-            max_retries -= 1
-
-            waiter.wait(message: 'Waiting to retry after receiving an unparseable response')
-          rescue Net::OpenTimeout, Errno::ETIMEDOUT
-            raise if max_timeouts <= 0
-            max_timeouts -= 1
-
-            $stderr.puts('Retrying after a connection timeout')
-          rescue Errno::ECONNRESET
-            raise if max_conn_resets <= 0
-            max_conn_resets -= 1
-
-            waiter.wait
-          end
+          return yield
+        rescue UnparseableBodyError
+          raise if max_retries <= 0
+          max_retries -= 1
+
+          waiter.wait(message: 'Waiting to retry after receiving an unparseable response')
+        rescue Net::OpenTimeout, Errno::ETIMEDOUT
+          raise if max_timeouts <= 0
+          max_timeouts -= 1
+
+          $stderr.puts('Retrying after a connection timeout')
+        rescue Errno::ECONNRESET
+          raise if max_conn_resets <= 0
+          max_conn_resets -= 1
+
+          waiter.wait
         end
       end
     end

data/lib/record_store/version.rb

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

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

@@ -29,11 +29,11 @@ module RecordStore
 
             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]
+            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)
+              filters_for_records_to_template: filters_for_records_to_template,
+              filters_for_records_to_exclude: filters_for_records_to_exclude)
           end
 
           private
@@ -70,8 +70,9 @@ module RecordStore
         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

data/lib/record_store/zone/yaml_definitions.rb

@@ -31,7 +31,7 @@ module RecordStore
       end
 
       def write(name, config:, records:, format: :file)
-        raise ArgumentError, "format must be :directory or :file" unless %i(file directory).include?(format)
+        raise ArgumentError, "format must be :directory or :file" unless [:file, :directory].include?(format)
         name = name.chomp('.')
         zone_file = "#{RecordStore.zones_path}/#{name}.yml"
         zone = { name => { config: config.to_hash } }

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)
@@ -52,7 +53,7 @@ module RecordStore
         (ENV['RECORD_STORE_MAX_THREADS'] || DEFAULT_MAX_PARALLEL_THREADS).to_i
       end
 
-      def modified(verbose: false) # rubocop:disable Lint/UnusedMethodArgument
+      def modified(verbose: false)
         modified_zones = []
         mutex = Mutex.new
         zones = all
@@ -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)
@@ -79,10 +85,8 @@ module RecordStore
     end
 
     def build_changesets(all: false)
-      @changesets ||= begin
-        providers.map do |provider|
-          Changeset.build_from(provider: provider, zone: self, all: all)
-        end
+      @changesets ||= providers.map do |provider|
+        Changeset.build_from(provider: provider, zone: self, all: all)
       end
     end
 
@@ -272,6 +276,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))
@@ -52,7 +53,7 @@ module RecordStore
     def zones_path
       @zones_path ||= Pathname.new(
         File.expand_path(config.fetch('zones_path'),
-        File.dirname(config_path)),
+          File.dirname(config_path)),
       ).realpath.to_s
     end
 
@@ -63,7 +64,7 @@ module RecordStore
     def implicit_records_templates_path
       @implicit_records_templates_path ||= Pathname.new(
         File.expand_path(config.fetch('implicit_records_templates_path'),
-        File.dirname(config_path)),
+          File.dirname(config_path)),
       ).realpath.to_s
     end
 

data/record_store.gemspec

@@ -48,6 +48,7 @@ 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', '~> 1.0.0'
+  spec.add_development_dependency 'rubocop', '~> 1.18.0'
+  spec.add_development_dependency 'rubocop-shopify', '~> 2.2.0'
   spec.add_development_dependency 'minitest-focus'
 end

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.1
+  version: 6.5.5
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-09 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -303,14 +303,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.18.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -357,6 +371,7 @@ files:
 - lib/record_store/provider.rb
 - lib/record_store/provider/dnsimple.rb
 - lib/record_store/provider/dnsimple/patch_api_header.rb
+- lib/record_store/provider/dnsimple/patch_request_error_to_include_errors.rb
 - lib/record_store/provider/dynect.rb
 - lib/record_store/provider/google_cloud_dns.rb
 - lib/record_store/provider/ns1.rb