Merge pull request #7 from Evolix/whois

Whois service (.fr only for now)

Gemfile

@@ -36,6 +36,9 @@ gem 'bcrypt', '~> 3.1.7'
 # Use ActiveStorage variant
 # gem 'mini_magick', '~> 4.8'
 
+gem 'open4'
+gem 'naught'
+
 # Reduces boot times through caching; required in config/boot.rb
 gem 'bootsnap', '>= 1.1.0', require: false
 
@@ -58,6 +61,10 @@ group :development do
   gem 'annotate', require: false
   gem 'letter_opener_web'
 
+
+  gem "guard"
+  gem "guard-minitest"
+
   gem 'capistrano-rails'
   gem "capistrano", "~> 3.10", require: false
   gem "capistrano-rbenv", require: false

Gemfile.lock

@@ -106,8 +106,22 @@ GEM
     erubi (1.7.1)
     execjs (2.7.0)
     ffi (1.9.23)
+    formatador (0.2.5)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     io-like (0.3.0)
@@ -129,6 +143,7 @@ GEM
     loofah (2.2.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
+    lumberjack (1.0.13)
     mail (2.7.0)
       mini_mime (>= 0.1.1)
     marcel (0.3.2)
@@ -141,12 +156,18 @@ GEM
     msgpack (1.2.4)
     multi_json (1.13.1)
     mysql2 (0.5.1)
+    naught (1.1.0)
+    nenv (0.3.0)
     net-scp (1.2.1)
       net-ssh (>= 2.6.5)
     net-ssh (4.2.0)
     nio4r (2.3.1)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    open4 (1.3.4)
     orm_adapter (0.5.0)
     parallel (1.12.1)
     parser (2.5.1.0)
@@ -228,6 +249,7 @@ GEM
     selenium-webdriver (3.12.0)
       childprocess (~> 0.5)
       rubyzip (~> 1.2)
+    shellany (0.0.1)
     simple_form (4.0.1)
       actionpack (>= 5.0)
       activemodel (>= 5.0)
@@ -290,11 +312,15 @@ DEPENDENCIES
   chromedriver-helper
   devise (~> 4.4)
   devise-i18n (~> 1.6)
+  guard
+  guard-minitest
   jbuilder (~> 2.5)
   launchy
   letter_opener_web
   listen (>= 3.0.5, < 3.2)
   mysql2 (>= 0.4.4, < 0.6.0)
+  naught
+  open4
   pry-byebug
   pry-rails
   puma (~> 3.11)

Guardfile

@@ -0,0 +1,29 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard "minitest", spring: "bin/rails test" do
+  # Rails 5
+  watch(%r{^app/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^app/controllers/application_controller\.rb$}) { "test/controllers" }
+  watch(%r{^app/controllers/(.+)_controller\.rb$}) { |m| "test/integration/#{m[1]}_test.rb" }
+  watch(%r{^app/views/(.+)_mailer/.+}) { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  watch(%r{^app/services/whois/.+\.rb}) { |_m| "test/services/whois" }
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$}) { "test" }
+  watch(%r{^test/fixtures/.+\.yml$}) { "test" }
+end

app/helpers/domain_helper.rb

@@ -0,0 +1,12 @@
+module DomainHelper
+  def normalize_domain(str)
+    str.strip.downcase
+  end
+
+  def tld(str)
+    parts = normalize_domain(str).split(".")
+    fail ArgumentError unless parts.size >= 2
+
+    ".#{parts.last}"
+  end
+end

app/jobs/whois_sync_job.rb

@@ -0,0 +1,27 @@
+class WhoisSyncJob < ApplicationJob
+  queue_as :default
+
+  rescue_from ActiveRecord::RecordNotFound do; end
+
+  attr_reader :check
+
+  def perform(check_id)
+    @check = Check.find(check_id)
+    response = Whois.ask(check.domain)
+
+    return unless response.valid?
+
+    update_from_response(response)
+
+    check.save!
+  rescue Whois::DomainNotFoundError
+    check.active = false
+    check.save!
+  end
+
+  def update_from_response(response)
+    check.domain_created_at = response.created_at
+    check.domain_updated_at = response.updated_at
+    check.domain_expire_at = response.expire_at
+  end
+end

app/models/check.rb

@@ -28,6 +28,7 @@
 
 class Check < ApplicationRecord
   belongs_to :user
+  has_many :logs, class_name: "CheckLog"
 
   enum kind: [:domain, :ssl]
 
@@ -39,12 +40,13 @@ class Check < ApplicationRecord
 
   validates :kind, presence: true
   validates :domain, presence: true
-  validates :domain_created_at, presence: true
   validate :domain_created_at_past
   validate :domain_updated_at_past
   validates :comment, length: { maximum: 255 }
   validates :vendor, length: { maximum: 255 }
 
+  after_save :enqueue_sync
+
   protected
 
   def domain_created_at_past
@@ -54,4 +56,11 @@ class Check < ApplicationRecord
   def domain_updated_at_past
     errors.add(:domain_updated_at, :past) if domain_updated_at.present? && domain_updated_at.future?
   end
+
+  def enqueue_sync
+    return unless active?
+    return unless saved_changes.key?("domain")
+
+    WhoisSyncJob.perform_later(id) if domain?
+  end
 end

app/models/check_log.rb

@@ -0,0 +1,28 @@
+# == Schema Information
+#
+# Table name: check_logs
+#
+#  id              :bigint(8)        not null, primary key
+#  error           :text(65535)
+#  exit_status     :integer
+#  parsed_response :text(65535)
+#  raw_response    :text(65535)
+#  status          :integer
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  check_id        :bigint(8)
+#
+# Indexes
+#
+#  index_check_logs_on_check_id  (check_id)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (check_id => checks.id)
+#
+
+class CheckLog < ApplicationRecord
+  belongs_to :check
+
+  enum status: [:pending, :succeed, :failed]
+end

app/services/check_logger.rb

@@ -0,0 +1,47 @@
+class CheckLogger
+  attr_reader :check_log
+
+  def initialize(check)
+    @check_log = CheckLog.create!(check: check, status: :pending)
+  end
+
+  def log(event, message)
+    case event
+    when :after_command
+      log_command_result(message)
+    when :parsed_response
+      log_parsed_response(message)
+    when :parser_error, :service_error
+      log_error(message)
+    end
+  end
+
+  private
+
+  def log_command_result(result)
+    check_log.exit_status = result.exit_status
+    check_log.raw_response = result.stdout
+
+    if result.exit_status > 0 # rubocop:disable Style/NumericPredicate
+      check_log.error = result.stderr
+      check_log.status = :failed
+    end
+
+    check_log.save!
+  end
+
+  def log_parsed_response(response)
+    check_log.parsed_response = response.to_json
+
+    if response.valid?
+      check_log.succeed!
+    else
+      check_log.failed!
+    end
+  end
+
+  def log_error(exception)
+    check_log.error = [exception.message, exception.backtrace].join("\n")
+    check_log.failed!
+  end
+end

app/services/system_command.rb

@@ -0,0 +1,52 @@
+require "open4"
+require "null_logger"
+
+SystemCommandResult = Struct.new(:command, :exit_status, :stdout, :stderr)
+
+class SystemCommand
+  attr_reader :program
+  attr_reader :args
+  attr_reader :logger
+
+  def initialize(program, args, logger: NullLogger.new)
+    @program = program
+    @args = Array.wrap(args)
+    @logger = logger
+  end
+
+  def execute
+    logger.log :before_command, syscmd
+
+    result = call(syscmd)
+
+    logger.log :after_command, result
+
+    result
+  end
+
+  def syscmd
+    escaped_args = args.map { |arg|
+      '"' + escape_arg(arg) + '"'
+    }
+
+    [program, escaped_args].join(" ")
+  end
+
+  private
+
+  def call(cmd)
+    pid, _, stdout, stderr = Open4.popen4 cmd
+    _, status = Process.waitpid2 pid
+
+    SystemCommandResult.new(
+      syscmd,
+      status.exitstatus,
+      stdout.read.strip,
+      stderr.read.strip,
+    )
+  end
+
+  def escape_arg(arg)
+    arg.to_s.gsub('"') { '\"' }
+  end
+end

app/services/whois.rb

@@ -0,0 +1,50 @@
+require "null_logger"
+require "domain_helper"
+require "system_command"
+require_relative "whois/parser"
+require_relative "whois/response"
+require_relative "whois/errors"
+
+module Whois
+  class << self
+    def ask(domain, system_klass: SystemCommand, logger: NullLogger.new)
+      Service.new(domain, system_klass: system_klass, logger: logger).call
+    end
+  end
+
+  class Service
+    attr_reader :domain
+    attr_reader :logger
+    attr_reader :system_klass
+
+    def initialize(domain, system_klass: SystemCommand, logger: NullLogger.new)
+      @domain = domain
+      @logger = logger
+      @system_klass = system_klass
+    end
+
+    def call
+      result = run_command
+      parse(result)
+    rescue StandardError => ex
+      logger.log :service_error, ex
+      raise
+    end
+
+    def run_command
+      command = system_klass.new("whois", domain, logger: logger)
+      result = command.execute
+
+      unless result.exit_status.zero?
+        fail WhoisCommandError, "Whois command failed with status #{result.exit_status}"
+      end
+
+      result
+    end
+
+    def parse(result)
+      parser = Parser.for(domain, logger: logger)
+      parser.parse(result.stdout)
+    end
+  end
+end

app/services/whois/errors.rb

@@ -0,0 +1,12 @@
+module Whois
+  class WhoisError < StandardError; end
+
+  class WhoisCommandError < WhoisError; end
+  class UnsupportedDomainError < WhoisError; end
+  class DomainNotFoundError < WhoisError; end
+  class ParserError < WhoisError; end
+
+  class FieldNotFoundError < ParserError; end
+  class MissingDateFormatError < ParserError; end
+  class InvalidDateError < ParserError; end
+end

app/services/whois/parser.rb

@@ -0,0 +1,19 @@
+require "null_logger"
+require "whois/errors"
+require "whois/parser/fr"
+
+module Whois
+  module Parser
+    PARSERS = [Fr].freeze
+
+    class << self
+      def for(domain, logger: NullLogger.new)
+        parser_class = PARSERS.find { |k| k.supports?(domain) }
+
+        fail UnsupportedDomainError, "Unsupported domain '#{domain}'" if parser_class.nil?
+
+        parser_class.new(domain, logger: logger)
+      end
+    end
+  end
+end

app/services/whois/parser/base.rb

@@ -0,0 +1,89 @@
+require "null_logger"
+require_relative "../response"
+require_relative "../errors"
+require_relative "entry_builder"
+
+module Whois
+  module Parser
+    class Base
+      extend DomainHelper
+
+      attr_reader :domain
+      attr_reader :logger
+      attr_reader :response
+      attr_reader :entries
+      attr_reader :date_format
+
+      def initialize(domain, logger: NullLogger.new)
+        @domain = domain
+        @logger = logger
+        @response = Response.new(domain)
+        @date_format = nil
+      end
+
+      def parse(raw)
+        @entries = build_entries(raw)
+
+        do_parse
+
+        logger.log :parsed_response, response
+
+        response
+      rescue StandardError => ex
+        logger.log :parser_error, ex
+        raise
+      end
+
+      protected
+
+      def get_field!(name, after: -1, value: nil)
+        fields.detect { |field|
+          field.index > after &&
+            field.name == name &&
+            (value.nil? || field.value == value)
+        } || fail(FieldNotFoundError, "Field `#{name}` not found, after index #{after}")
+      end
+
+      def get_value!(name, after: -1)
+        get_field!(name, after: after).value
+      end
+
+      def parse_date(str)
+        fail MissingDateFormatError, "Date format not set" if date_format.nil?
+
+        begin
+          Time.strptime(str, date_format)
+        rescue ArgumentError
+          raise InvalidDateError, "Date `#{str}` does not match format #{date_format}"
+        end
+      end
+
+      def comment_include?(str)
+        entries.any? { |e|
+          e.comment? && e.text? && e.text.include?(str)
+        }
+      end
+
+      def raise_not_found
+        fail DomainNotFoundError, "Domain #{domain} not found in the registry database."
+      end
+
+      private
+
+      def build_entries(raw)
+        builder = EntryBuilder.new(
+          field_regex: self.class::FIELD_REGEX,
+          comment_regex: self.class::COMMENT_REGEX,
+        )
+
+        raw.split("\n").map.each_with_index { |line, index|
+          builder.build_from_line(line, index)
+        }.sort_by(&:index)
+      end
+
+      def fields
+        @fields ||= entries.select(&:field?)
+      end
+    end
+  end
+end

app/services/whois/parser/entry/base.rb

@@ -0,0 +1,34 @@
+module Whois
+  module Parser
+    module Entry
+      class Base
+        attr_reader :index
+
+        def initialize(index)
+          @index = index
+          @comment = false
+        end
+
+        def comment!
+          @comment = true
+        end
+
+        def comment?
+          @comment == true
+        end
+
+        def blank?
+          false
+        end
+
+        def field?
+          false
+        end
+
+        def text?
+          false
+        end
+      end
+    end
+  end
+end

app/services/whois/parser/entry/blank.rb

@@ -0,0 +1,13 @@
+require_relative "base"
+
+module Whois
+  module Parser
+    module Entry
+      class Blank < Base
+        def blank?
+          true
+        end
+      end
+    end
+  end
+end

app/services/whois/parser/entry/field.rb

@@ -0,0 +1,23 @@
+require_relative "base"
+
+module Whois
+  module Parser
+    module Entry
+      class Field < Base
+        attr_reader :index
+        attr_reader :name
+        attr_reader :value
+
+        def initialize(index, name, value)
+          super index
+          @name = name.strip
+          @value = value.strip
+        end
+
+        def field?
+          true
+        end
+      end
+    end
+  end
+end

app/services/whois/parser/entry/text.rb

@@ -0,0 +1,20 @@
+require_relative "base"
+
+module Whois
+  module Parser
+    module Entry
+      class Text < Base
+        attr_reader :text
+
+        def initialize(index, text)
+          super index
+          @text = text.strip
+        end
+
+        def text?
+          true
+        end
+      end
+    end
+  end
+end

app/services/whois/parser/entry_builder.rb

@@ -0,0 +1,55 @@
+require_relative "entry/blank"
+require_relative "entry/field"
+require_relative "entry/text"
+
+module Whois
+  module Parser
+    class EntryBuilder
+      attr_reader :field_regex
+      attr_reader :comment_regex
+
+      def initialize(field_regex:, comment_regex:)
+        @field_regex = field_regex
+        @comment_regex = comment_regex
+      end
+
+      def build_from_line(line, index)
+        text = normalize_text(line)
+
+        return Entry::Blank.new(index) if line.empty?
+
+        build(index, text).tap do |entry|
+          entry.comment! if comment?(line)
+        end
+      end
+
+      private
+
+      def build(index, text)
+        parts = field_regex.match(text)
+
+        if parts.nil?
+          Entry::Text.new(index, text)
+        else
+          Entry::Field.new(index, parts[:name], parts[:value])
+        end
+      end
+
+      def normalize_text(line)
+        line.strip!
+
+        comment_data = comment_regex.match(line)
+
+        if comment_data.nil?
+          line
+        else
+          comment_data[:text]
+        end
+      end
+
+      def comment?(line)
+        comment_regex.match?(line)
+      end
+    end
+  end
+end

app/services/whois/parser/fr.rb

@@ -0,0 +1,52 @@
+require "domain_helper"
+require "whois/errors"
+require_relative "base"
+
+module Whois
+  module Parser
+    class Fr < Base
+      SUPPORTED_TLD = %w[.fr].freeze
+      COMMENT_REGEX = /^%+ +(?<text>.+)$/
+      FIELD_REGEX = /^(?<name>[^:]+)\s*:\s+(?<value>.+)$/
+
+      def self.supports?(domain)
+        SUPPORTED_TLD.include?(tld(domain))
+      end
+
+      protected
+
+      def do_parse
+        raise_not_found if comment_include?("No entries found")
+
+        set_date_format
+
+        extract_values
+      end
+
+      private
+
+      def extract_values
+        domain_index = get_field!("domain", value: domain).index
+
+        created_date = get_value!("created", after: domain_index)
+        response.created_at = parse_date(created_date)
+
+        expire_date = get_value!("Expiry Date", after: domain_index)
+        response.expire_at = parse_date(expire_date)
+
+        updated_date = get_value!("last-update", after: domain_index)
+        response.updated_at = parse_date(updated_date)
+      end
+
+      def parse_date(str)
+        super "#{str} UTC"
+      end
+
+      def set_date_format
+        afnic_format = get_field!("complete date format").value
+
+        @date_format = "%d/%m/%Y %Z" if afnic_format == "DD/MM/YYYY"
+      end
+    end
+  end
+end

app/services/whois/response.rb

@@ -0,0 +1,15 @@
+module Whois
+  class Response
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :expire_at
+
+    def initialize(domain)
+      @domain = domain
+    end
+
+    def valid?
+      created_at.present?
+    end
+  end
+end

app/views/checks/_form.html.erb

@@ -5,7 +5,6 @@
     <%= f.input :kind, as: :radio_buttons, collection: Check.kinds.keys if check.new_record? %>
   <% end %>
 
-  <%= f.input :domain_created_at, as: :date, start_year: 1990, end_year: Date.today.year %>
   <%= f.input :comment %>
   <%= f.input :vendor %>
 

app/views/checks/_table.html.erb

@@ -2,7 +2,9 @@
   <div class="mb-4">
     <div>Domain: <%= check.domain %></div>
     <div>Kind: <%= check.kind %></div>
-    <div>Date de création: <%= check.domain_created_at.to_date %></div>
+    <div>Created date: <%= l(check.domain_created_at.to_date) if check.domain_created_at.present? %></div>
+    <div>Update date: <%= l(check.domain_updated_at.to_date) if check.domain_updated_at.present? %></div>
+    <div>Expire date: <%= l(check.domain_expire_at.to_date) if check.domain_expire_at.present? %></div>
 
     <% if check.comment? %>
       <div>Comment: <%= check.comment %></div>

app/views/checks/edit.html.erb

@@ -8,7 +8,7 @@
   </div>
 
   <div class="row mt-5 justify-content-center">
-    <div class="col-12 col-lg-8">
+    <div class="col-12 col-lg-10">
       <%= button_to("Delete", check_path(@check), class: "btn btn-danger", method: :delete,
             data: { confirm: "Are you sure ?" }) %>
     </div>

config/environments/development.rb

@@ -67,4 +67,6 @@ Rails.application.configure do
   # Use an evented file watcher to asynchronously detect changes in source code,
   # routes, locales, etc. This feature depends on the listen gem.
   config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  config.active_job.queue_adapter = :inline
 end

db/migrate/20180530123611_create_check_logs.rb

@@ -0,0 +1,14 @@
+class CreateCheckLogs < ActiveRecord::Migration[5.2]
+  def change
+    create_table :check_logs do |t|
+      t.references :check, foreign_key: true
+      t.text :raw_response
+      t.integer :exit_status
+      t.text :parsed_response
+      t.text :error
+      t.integer :status
+
+      t.timestamps
+    end
+  end
+end

db/schema.rb

@@ -10,7 +10,19 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2018_05_29_092950) do
+ActiveRecord::Schema.define(version: 2018_05_30_123611) do
+
+  create_table "check_logs", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
+    t.bigint "check_id"
+    t.text "raw_response"
+    t.integer "exit_status"
+    t.text "parsed_response"
+    t.text "error"
+    t.integer "status"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["check_id"], name: "index_check_logs_on_check_id"
+  end
 
   create_table "checks", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t|
     t.bigint "user_id"
@@ -53,5 +65,6 @@ ActiveRecord::Schema.define(version: 2018_05_29_092950) do
     t.index ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true
   end
 
+  add_foreign_key "check_logs", "checks"
   add_foreign_key "checks", "users"
 end

lib/null_logger.rb

@@ -0,0 +1,3 @@
+require "naught"
+
+NullLogger = Naught.build

test/fixtures/check_logs.yml

@@ -0,0 +1,24 @@
+# == Schema Information
+#
+# Table name: check_logs
+#
+#  id              :bigint(8)        not null, primary key
+#  error           :text(65535)
+#  exit_status     :integer
+#  parsed_response :text(65535)
+#  raw_response    :text(65535)
+#  status          :integer
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  check_id        :bigint(8)
+#
+# Indexes
+#
+#  index_check_logs_on_check_id  (check_id)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (check_id => checks.id)
+#
+
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html

test/fixtures/files/whois/domain.fr.txt

@@ -0,0 +1,150 @@
+% IANA WHOIS server
+% for more information on IANA, visit http://www.iana.org
+% This query returned 1 object
+
+refer:        whois.nic.fr
+
+domain:       FR
+
+organisation: Association Française pour le Nommage Internet en Coopération (A.F.N.I.C.)
+address:      Immeuble Le Stephenson
+address:      1 rue Stephenson
+address:      78180 Montigny-le-Bretonneux
+address:      France
+
+contact:      administrative
+name:         TLD Admin Contact
+organisation: Association Française pour le Nommage Internet en Coopération (A.F.N.I.C.)
+address:      Immeuble Le Stephenson
+address:      1 rue Stephenson
+address:      78180 Montigny-le-Bretonneux
+address:      France
+phone:        +33 1 39 30 83 05
+fax-no:       +33 1 39 30 83 01
+e-mail:       tld-admin@nic.fr
+
+contact:      technical
+name:         TLD Tech Contact
+organisation: Association Française pour le Nommage Internet en Coopération (A.F.N.I.C.)
+address:      Immeuble Le Stephenson
+address:      1 rue Stephenson
+address:      78180 Montigny-le-Bretonneux
+address:      France
+phone:        +33 1 39 30 83 81
+fax-no:       +33 1 39 30 83 01
+e-mail:       tld-tech@nic.fr
+
+nserver:      D.EXT.NIC.FR 192.5.4.2 2001:500:2e:0:0:0:0:2
+nserver:      D.NIC.FR 194.0.9.1 2001:678:c:0:0:0:0:1
+nserver:      E.EXT.NIC.FR 193.176.144.22 2a00:d78:0:102:193:176:144:22
+nserver:      F.EXT.NIC.FR 194.146.106.46 2001:67c:1010:11:0:0:0:53
+nserver:      G.EXT.NIC.FR 194.0.36.1 2001:678:4c:0:0:0:0:1
+ds-rdata:     35095 8 2 23c6caadc9927ee98061f2b52c9b8da6b53f3f648f814a4a86a0faf9854bfa8e
+ds-rdata:     42104 8 2 8D913A49C3FA2A39BA0065B4E18BA793E3AD128F7C6C8AA008AEFE0A17985DF5
+
+whois:        whois.nic.fr
+
+status:       ACTIVE
+remarks:      Registration information: http://www.nic.fr/
+
+created:      1986-09-02
+changed:      2018-01-22
+source:       IANA
+
+%%
+%% This is the AFNIC Whois server.
+%%
+%% complete date format : DD/MM/YYYY
+%% short date format    : DD/MM
+%% version              : FRNIC-2.5
+%%
+%% Rights restricted by copyright.
+%% See https://www.afnic.fr/en/products-and-services/services/whois/whois-special-notice/
+%%
+%% Use '-h' option to obtain more information about this service.
+%%
+%% [5ca0:1e73:fedf:ed4:2af1:f4a6:56e6:8308 REQUEST] >> domain.fr
+%%
+%% RL Net [##########] - RL IP [#########.]
+%%
+
+domain:      domain.fr
+status:      ACTIVE
+hold:        NO
+holder-c:    E1768-FRNIC
+admin-c:     GC647-FRNIC
+tech-c:      OVH5-FRNIC
+zone-c:      NFC1-FRNIC
+nsl-id:      NSL60350-FRNIC
+registrar:   OVH
+Expiry Date: 17/02/2019
+created:     18/02/2004
+last-update: 28/01/2017
+source:      FRNIC
+
+ns-list:     NSL60350-FRNIC
+nserver:     ns4.dnsserver.fr
+nserver:     ns0.dnsserver.com
+source:      FRNIC
+
+registrar:   OVH
+type:        Isp Option 1
+address:     2 Rue Kellermann
+address:     59100 ROUBAIX
+country:     FR
+phone:       +33 8 99 88 77 66
+fax-no:      +33 3 20 20 20 20
+e-mail:      support@registrar.fr
+website:     http://www.registrar.fr
+anonymous:   NO
+registered:  21/10/1999
+source:      FRNIC
+
+nic-hdl:     SB999-FRNIC
+type:        PERSON
+contact:     Rex Lorne
+address:     Chexpire
+address:     Impasse Pastourelle
+address:     13001 Marseille
+country:     FR
+phone:       +33 1 23 45 67 89
+registrar:   OVH
+changed:     18/02/2004 frnic-dbm-updates@nic.fr
+anonymous:   NO
+obsoleted:   NO
+source:      FRNIC
+
+nic-hdl:     OVH5-FRNIC
+type:        ROLE
+contact:     OVH NET
+address:     OVH
+address:     140, quai du Sartel
+address:     59100 Roubaix
+country:     FR
+phone:       +33 8 99 88 77 66
+e-mail:      tech@registrar.fr
+trouble:     Information: http://www.registrar.fr
+trouble:     Questions:  mailto:tech@registrar.fr
+trouble:     Spam: mailto:abuse@registrar.fr
+admin-c:     OK217-FRNIC
+tech-c:      OK217-FRNIC
+notify:      tech@registrar.fr
+registrar:   OVH
+changed:     11/10/2006 tech@registrar.fr
+anonymous:   NO
+obsoleted:   NO
+source:      FRNIC
+
+nic-hdl:     E9999-FRNIC
+type:        ORGANIZATION
+contact:     Chexpire
+address:     Impasse Pastourelle
+address:     13001 Marseille
+country:     FR
+phone:       +33 1 23 45 67 89
+e-mail:      info@domain.fr
+registrar:   OVH
+changed:     11/03/2012 nic@nic.fr
+anonymous:   NO
+obsoleted:   NO
+source:      FRNIC

test/fixtures/files/whois/willneverexist.fr.txt

@@ -0,0 +1,71 @@
+% IANA WHOIS server
+% for more information on IANA, visit http://www.iana.org
+% This query returned 1 object
+
+refer:        whois.nic.fr
+
+domain:       FR
+
+organisation: Association Française pour le Nommage Internet en Coopération (A.F.N.I.C.)
+address:      Immeuble Le Stephenson
+address:      1 rue Stephenson
+address:      78180 Montigny-le-Bretonneux
+address:      France
+
+contact:      administrative
+name:         TLD Admin Contact
+organisation: Association Française pour le Nommage Internet en Coopération (A.F.N.I.C.)
+address:      Immeuble Le Stephenson
+address:      1 rue Stephenson
+address:      78180 Montigny-le-Bretonneux
+address:      France
+phone:        +33 1 39 30 83 05
+fax-no:       +33 1 39 30 83 01
+e-mail:       tld-admin@nic.fr
+
+contact:      technical
+name:         TLD Tech Contact
+organisation: Association Française pour le Nommage Internet en Coopération (A.F.N.I.C.)
+address:      Immeuble Le Stephenson
+address:      1 rue Stephenson
+address:      78180 Montigny-le-Bretonneux
+address:      France
+phone:        +33 1 39 30 83 81
+fax-no:       +33 1 39 30 83 01
+e-mail:       tld-tech@nic.fr
+
+nserver:      D.EXT.NIC.FR 192.5.4.2 2001:500:2e:0:0:0:0:2
+nserver:      D.NIC.FR 194.0.9.1 2001:678:c:0:0:0:0:1
+nserver:      E.EXT.NIC.FR 193.176.144.22 2a00:d78:0:102:193:176:144:22
+nserver:      F.EXT.NIC.FR 194.146.106.46 2001:67c:1010:11:0:0:0:53
+nserver:      G.EXT.NIC.FR 194.0.36.1 2001:678:4c:0:0:0:0:1
+ds-rdata:     35095 8 2 23c6caadc9927ee98061f2b52c9b8da6b53f3f648f814a4a86a0faf9843e2c4e
+ds-rdata:     42104 8 2 8D913A49C3FA2A39BA0065B4E18BA793E3AD128F7C6C8AA008AEFE0A14435DD5
+
+whois:        whois.nic.fr
+
+status:       ACTIVE
+remarks:      Registration information: http://www.nic.fr/
+
+created:      1986-09-02
+changed:      2018-01-22
+source:       IANA
+
+%%
+%% This is the AFNIC Whois server.
+%%
+%% complete date format : DD/MM/YYYY
+%% short date format    : DD/MM
+%% version              : FRNIC-2.5
+%%
+%% Rights restricted by copyright.
+%% See https://www.afnic.fr/en/products-and-services/services/whois/whois-special-notice/
+%%
+%% Use '-h' option to obtain more information about this service.
+%%
+%% [11.22.33.44 REQUEST] >> willneverexist.fr
+%%
+%% RL Net [##########] - RL IP [#########.]
+%%
+
+%% No entries found in the AFNIC Database.

test/helpers/domain_helper_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+require "domain_helper"
+
+class DomainHelperTest < ActiveSupport::TestCase
+  include DomainHelper
+
+  test "should normalize a domain name" do
+    assert_equal "example.org", normalize_domain(" example.org ")
+    assert_equal "example.org", normalize_domain("eXaMple.oRg")
+  end
+
+  test "tld should return the domain tld" do
+    assert_equal ".org", tld("exaMple.ORG")
+    assert_equal ".fr", tld("www.example.fr")
+    assert_equal ".com", tld("www.example-dashed.com")
+    assert_equal ".uk", tld("www.example.co.uk")
+
+    assert_raises(ArgumentError) do
+      tld("not a domain")
+    end
+  end
+end

test/jobs/whois_sync_job_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class WhoisSyncJobTest < ActiveJob::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

test/models/check_log_test.rb

@@ -0,0 +1,30 @@
+# == Schema Information
+#
+# Table name: check_logs
+#
+#  id              :bigint(8)        not null, primary key
+#  error           :text(65535)
+#  exit_status     :integer
+#  parsed_response :text(65535)
+#  raw_response    :text(65535)
+#  status          :integer
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  check_id        :bigint(8)
+#
+# Indexes
+#
+#  index_check_logs_on_check_id  (check_id)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (check_id => checks.id)
+#
+
+require "test_helper"
+
+class CheckLogTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

test/services/check_logger_test.rb

@@ -0,0 +1,81 @@
+require "test_helper"
+require "check_logger"
+require "system_command"
+
+class CheckLoggerTest < ActiveSupport::TestCase
+  setup do
+    @check = checks(:domain_example_org)
+    @logger = CheckLogger.new(@check)
+  end
+
+  test "should create a pending CheckLog" do
+    assert_difference -> { CheckLog.where(check: @check).count }, +1 do
+      CheckLogger.new(@check)
+    end
+
+    assert last_log.pending?
+  end
+
+  test "should log a success raw result command" do
+    result = SystemCommandResult.new("command", 0, "the result", "")
+
+    assert_no_difference -> { CheckLog.where(check: @check).count } do
+      @logger.log :after_command, result
+    end
+
+    assert_equal "the result", @logger.check_log.raw_response
+    assert_nil @logger.check_log.error
+    assert_equal 0, @logger.check_log.exit_status
+    assert @logger.check_log.pending?
+  end
+
+  test "should log a raw result command with an error" do
+    result = SystemCommandResult.new("command", 1, "optional stdout", "an error occured")
+    @logger.log :after_command, result
+
+    assert_equal "optional stdout", @logger.check_log.raw_response
+    assert_equal "an error occured", @logger.check_log.error
+    assert_equal 1, @logger.check_log.exit_status
+    assert @logger.check_log.failed?
+  end
+
+  test "should log a successful parsed command" do
+    response = OpenStruct.new(
+      domain: "example.fr",
+      extracted: "some data",
+      valid?: true,
+    )
+    @logger.log :parsed_response, response
+
+    assert_equal response.to_json, @logger.check_log.parsed_response
+    assert_nil @logger.check_log.error
+    assert @logger.check_log.succeed?
+  end
+
+  test "should log parser error with a backtrace" do
+    @logger.log :parser_error, mock_exception
+
+    assert_includes @logger.check_log.error, "my error occured"
+    assert_includes @logger.check_log.error, "minitest.rb"
+    assert @logger.check_log.failed?
+  end
+
+  test "should log service error" do
+    @logger.log :service_error, mock_exception
+
+    assert_not_nil @logger.check_log.error
+    assert @logger.check_log.failed?
+  end
+
+  private
+
+  def last_log
+    CheckLog.where(check: @check).last
+  end
+
+  def mock_exception
+    exception = ArgumentError.new("my error occured")
+    exception.set_backtrace(caller)
+    exception
+  end
+end

test/services/system_command_test.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+require "system_command"
+
+class SystemCommandTest < ActiveSupport::TestCase
+  test "should execute and log a command" do
+    mock_logger = Minitest::Mock.new
+    expected_cmd = 'whois "example.org"'
+
+    expected_result = SystemCommandResult.new(
+      expected_cmd,
+      0,
+      "my result",
+      "",
+    )
+
+    mock_logger.expect(:log, nil, [:before_command, expected_cmd])
+    mock_logger.expect(:log, nil, [:after_command, expected_result])
+
+    command = SystemCommand.new("whois", "example.org", logger: mock_logger)
+    assert_equal expected_cmd, command.syscmd
+
+    command.stub(:call, expected_result) do
+      assert_equal expected_result, command.execute
+    end
+
+    mock_logger.verify
+  end
+end

test/services/whois/parser/fr_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+require "whois/parser/fr"
+require "whois/response"
+require "whois/errors"
+
+module Whois
+  class FrTest < ActiveSupport::TestCase
+    test "should parse a whois response" do
+      parser = Parser::Fr.new("domain.fr")
+      domain_fr = file_fixture("whois/domain.fr.txt").read
+      response = parser.parse(domain_fr)
+      assert_kind_of Response, response
+
+      assert_equal Time.new(2004, 2, 18, 0, 0, 0, 0), response.created_at
+      assert response.created_at.utc?
+
+      assert_equal Time.new(2017, 1, 28, 0, 0, 0, 0), response.updated_at
+      assert_equal Time.new(2019, 2, 17, 0, 0, 0, 0), response.expire_at
+    end
+
+    test "should raises DomainNotFoundError when domain is not registered" do
+      parser = Parser::Fr.new("willneverexist.fr")
+      not_found_fr = file_fixture("whois/willneverexist.fr.txt").read
+
+      assert_raises DomainNotFoundError do
+        parser.parse(not_found_fr)
+      end
+    end
+  end
+end

test/services/whois/parser_test.rb

@@ -0,0 +1,15 @@
+require "test_helper"
+require "whois/parser"
+require "whois/errors"
+
+module Whois
+  class ParserTest < ActiveSupport::TestCase
+    test "should instanciate a parser class matching the tld" do
+      assert_kind_of Parser::Fr, Parser.for("example.fr")
+
+      assert_raises UnsupportedDomainError do
+        Parser.for("example.xyz")
+      end
+    end
+  end
+end

test/services/whois_test.rb

@@ -0,0 +1,53 @@
+require "test_helper"
+require "whois"
+require "system_command"
+
+module Whois
+  class ServiceTest < ActiveSupport::TestCase
+    test "should run the command, return the result" do
+      result = OpenStruct.new(exit_status: 0)
+
+      mock_system_klass("whois", "example.org", result) do |system_klass|
+        service = Service.new("example.org", system_klass: system_klass)
+        assert_equal result, service.run_command
+      end
+    end
+
+    test "should raise an exception if exit status > 0" do
+      result = OpenStruct.new(exit_status: 1)
+
+      mock_system_klass("whois", "example.org", result) do |system_klass|
+        service = Service.new("example.org", system_klass: system_klass)
+
+        assert_raises WhoisCommandError do
+          service.run_command
+        end
+      end
+    end
+
+    test "should parse from a command result" do
+      result = OpenStruct.new(
+        exit_status: 0,
+        stdout: file_fixture("whois/domain.fr.txt").read,
+      )
+
+      service = Service.new("domain.fr")
+      assert_kind_of Response, service.parse(result)
+    end
+
+    def mock_system_klass(program, command_args, result)
+      system_klass = Minitest::Mock.new
+      system_command = Minitest::Mock.new.expect(:execute, result)
+      system_klass.expect(:new, system_command) do |arg1, arg2, logger:|
+        arg1 == program &&
+          arg2 == command_args &&
+          logger.class == NullLogger
+      end
+
+      yield system_klass
+
+      system_klass.verify
+      system_command.verify
+    end
+  end
+end

test/test_helper.rb

@@ -2,6 +2,8 @@ ENV["RAILS_ENV"] ||= "test"
 require_relative "../config/environment"
 require "rails/test_help"
 
+require "minitest/mock"
+
 class ActiveSupport::TestCase
   # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
   fixtures :all