Notification for SSL checks.

This commit is contained in:
Colin Darie 2018-07-02 18:40:09 +02:00
parent 9f364c65cf
commit f18b2fbeba
No known key found for this signature in database
GPG Key ID: 4FB865FDBCA4BCC4
16 changed files with 398 additions and 16 deletions

View File

@ -19,4 +19,16 @@ class NotificationsMailer < ApplicationMailer
subject = t(".subject", domain: @check.domain)
mail subject: subject
end
def ssl_expires_soon
@expire_in_days = Integer(@check.domain_expires_at.to_date - Date.today)
subject = t(".subject", domain: @check.domain, count: @expire_in_days)
mail subject: subject
end
def ssl_recurrent_failures
subject = t(".subject", domain: @check.domain)
mail subject: subject
end
end

View File

@ -11,6 +11,10 @@ module Notifier
domain_notify_expires_soon(notification)
when [:domain, :recurrent_failures]
domain_notify_recurrent_failures(notification)
when [:ssl, :expires_soon]
ssl_notify_expires_soon(notification)
when [:ssl, :recurrent_failures]
ssl_notify_recurrent_failures(notification)
else
fail ArgumentError,
"Invalid notification reason `#{reason}` for check kind `#{notification.check.kind}`."
@ -25,15 +29,16 @@ module Notifier
"#{self.class.name} channel did not implemented method #{__callee__}"
end
# domain notifications
def domain_notify_expires_soon(_notification)
fail NotImplementedError,
"Channel #{self.class.name} does not implement #{__callee__}"
end
def domain_notify_recurrent_failures(_notification)
fail NotImplementedError,
"Channel #{self.class.name} does not implement #{__callee__}"
%i[
domain_notify_expires_soon
domain_notify_recurrent_failures
ssl_notify_expires_soon
ssl_notify_recurrent_failures
].each do |method|
define_method(method) do
fail NotImplementedError,
"Channel #{self.class.name} does not implement method #{method}."
end
end
# :nocov:
end

View File

@ -16,6 +16,14 @@ module Notifier
def domain_notify_recurrent_failures(notification)
NotificationsMailer.with(notification: notification).domain_recurrent_failures.deliver_now
end
def ssl_notify_expires_soon(notification)
NotificationsMailer.with(notification: notification).ssl_expires_soon.deliver_now
end
def ssl_notify_recurrent_failures(notification)
NotificationsMailer.with(notification: notification).ssl_recurrent_failures.deliver_now
end
end
end
end

View File

@ -0,0 +1,12 @@
<p>
Hi,
<br />
<br />
the SSL certificate for <strong><%= @check.domain %></strong> will expire
<strong><%= format_utc(@check.domain_expires_at) %></strong>.
</p>
<br />
<%= render "check_comment_vendor" %>
<%= render "footer_expires_soon", interval: @notification.interval, check: @check %>

View File

@ -0,0 +1,9 @@
Hi,
the SSL certificate for <%= @check.domain %> will expire <%= format_utc(@check.domain_expires_at) %>.
<%= render "check_comment_vendor" %>
<%= render "footer_expires_soon", interval: @notification.interval, check: @check %>

View File

@ -0,0 +1,12 @@
<p>
Salut,
<br />
<br />
le certificat SSL pour <strong><%= @check.domain %></strong> va expirer le
<strong><%= format_utc(@check.domain_expires_at) %></strong>.
</p>
<br />
<%= render "check_comment_vendor" %>
<%= render "footer_expires_soon", interval: @notification.interval, check: @check %>

View File

@ -0,0 +1,9 @@
Salut,
le certificat SSL pour <%= @check.domain %> va expirer le <%= format_utc(@check.domain_expires_at) %>.
<%= render "check_comment_vendor" %>
<%= render "footer_expires_soon", interval: @notification.interval, check: @check %>

View File

@ -0,0 +1,31 @@
<p>
Hi,
<br />
<br />
We had <strong>recurrent failures</strong> while checking the SSL certificate for
<strong><%= @check.domain %></strong>. As of today, we can no longer verify the certificate
expiry date.
</p>
<p>
<%- if @check.domain_expires_at.present? %>
Our last known expiry date is <%= format_utc(@check.domain_expires_at) %>.
<br />
<%- end %>
<%- if @check.last_success_at.present? %>
Our last successful check occured <%= format_utc(@check.last_success_at) %>.
<%- end %>
</p>
<p>
If there is no more SSL endpoint for this domain, please disable
or delete the check by following this link: <br /><br />
<%= link_to nil, edit_check_url(@check) %>
</p>
<br />
<%= render "check_comment_vendor" %>
<%= render "footer_recurrent_failures", interval: @notification.interval, check: @check %>

View File

@ -0,0 +1,22 @@
Hi,
We had recurrent failures while checking the SSL certificate for
<%= @check.domain %>. As of today, we can no longer verify the certificate
expiry date.
<%- if @check.domain_expires_at.present? %>
The last known expiry date is <%= format_utc(@check.domain_expires_at) %>.
<%- end %>
<%- if @check.last_success_at.present? %>
The last successful check occured <%= format_utc(@check.last_success_at) %>.
<%- end %>
If there is no more SSL endpoint for this domain, please disable
or delete the check by following this link:
<%= edit_check_url(@check) %>
<%= render "check_comment_vendor" %>
<%= render "footer_recurrent_failures", interval: @notification.interval, check: @check %>

View File

@ -0,0 +1,35 @@
<p>
Salut,
<br />
<br />
Nous avons rencontré de <strong>multiples erreurs</strong>
pendant l'exécution des vérifications du certificat SSL
du site <strong><%= @check.domain %></strong>.
Nous ne pouvons plus vérifier la date d'expiration du certificat
en nous connectant au site.
</p>
<p>
<%- if @check.domain_expires_at.present? %>
La dernière date d'expiration connue est le <%= format_utc(@check.domain_expires_at) %>.
<br />
<% end %>
<%- if @check.last_success_at.present? %>
Notre dernière vérification réussie a eu lieu le <%= format_utc(@check.last_success_at) %>.
<% end %>
</p>
<p>
S'il n'y a plus de terminaison SSL pour ce site ou s'il n'existe plus,
merci de désactiver la vérification associée, avec ce lien :
<br />
<br />
<%= link_to nil, edit_check_url(@check) %>
</p>
<br />
<%= render "check_comment_vendor" %>
<%= render "footer_recurrent_failures", interval: @notification.interval, check: @check %>

View File

@ -0,0 +1,22 @@
Salut,
Nous avons rencontré de multiples erreurs pendant l'exécution des vérifications
du certificat SSL pour le site <strong><%= @check.domain %></strong>.
Nous ne pouvons plus vérifier la date d'expiration du certificat
en nous connectant au site.
<%- if @check.domain_expires_at.present? %>
La dernière date d'expiration connue est le <%= format_utc(@check.domain_expires_at) %>.
<% end %>
<%- if @check.last_success_at.present? %>
Notre dernière vérification réussie a eu lieu le <%= format_utc(@check.last_success_at) %>.
<% end %>
S'il n'y a plus de terminaison SSL pour ce site ou s'il n'existe plus,
merci de désactiver la vérification associée, avec ce lien :
<%= edit_check_url(@check) %>
<%= render "check_comment_vendor" %>
<%= render "footer_recurrent_failures", interval: @notification.interval, check: @check %>

View File

@ -38,6 +38,15 @@ en:
domain_recurrent_failures:
subject: "Recurrent failures in %{domain} domain expiry check"
ssl_expires_soon:
subject:
zero: "SSL certificate for %{domain} expires TODAY!"
one: "SSL certificate for %{domain} expires TOMORROW!"
other: "SSL certificate for %{domain} expires in %{count} days"
ssl_recurrent_failures:
subject: "Recurrent failures in %{domain} SSL certificate expiry check"
shared:
locales:

View File

@ -12,6 +12,14 @@ fr:
check:
past: "ne peut être dans le futur"
time:
am: am
formats:
default: "%a %d %b %Y %H:%M:%S %z"
long: "%A %d %B %Y %H:%M"
short: "%d %b %H:%M"
pm: pm
devise:
registrations:
new:
@ -36,7 +44,16 @@ fr:
other: "Le domaine %{domain} expire dans %{count} jours"
domain_recurrent_failures:
subject: "Multiples erreur dans la vérification d'expiration du domaine %{domain}"
subject: "Erreurs dans la vérification d'expiration du domaine %{domain}"
ssl_expires_soon:
subject:
zero: "Le certificat SSL pour %{domain} expire AUJOURD'HUI !"
one: "Le certificat SSL pour %{domain} expire DEMAIN !"
other: "Le certificat SSL pour %{domain} expire dans %{count} jours"
ssl_recurrent_failures:
subject: "Erreurs dans la vérification d'expiration du certificat SSL %{domain}"
shared:

View File

@ -1,3 +1,4 @@
CheckLog.destroy_all
Notification.destroy_all
Check.destroy_all
User.destroy_all
@ -33,6 +34,31 @@ check_chexpire_org_error = Check.create!(
last_success_at: 4.days.ago,
)
ssl_check_chexpire_org = Check.create!(
user: user1,
kind: :ssl,
domain: "www.chexpire.org",
domain_expires_at: 1.week.from_now,
domain_updated_at: 6.months.ago,
domain_created_at: Time.new(2016, 8, 4, 12, 15, 1),
comment: "The date are fake, this is a seed !",
vendor: "Some random registrar",
)
ssl_check_chexpire_org_error = Check.create!(
user: user1,
kind: :ssl,
domain: "chexpire.org",
domain_expires_at: 1.week.from_now,
domain_updated_at: 6.months.ago,
domain_created_at: Time.new(2016, 8, 4, 12, 15, 1),
comment: "The date are fake, this is a seed !",
vendor: "Some random registrar",
last_run_at: 20.minutes.ago,
last_success_at: 4.days.ago,
)
Notification.create!(
check: check_chexpire_org,
interval: 15,
@ -49,6 +75,22 @@ Notification.create!(
status: :pending,
)
Notification.create!(
check: ssl_check_chexpire_org,
interval: 15,
channel: :email,
recipient: "colin@example.org",
status: :pending,
)
Notification.create!(
check: ssl_check_chexpire_org_error,
interval: 15,
channel: :email,
recipient: "colin@example.org",
status: :pending,
)
puts "\e[0;32mDone 👌\e[0m"
puts " "
puts "--------------------"

View File

@ -1,6 +1,6 @@
require "test_helper"
class NotificationsMailerTest < ActionMailer::TestCase
class NotificationsMailerTest < ActionMailer::TestCase # rubocop:disable Metrics/ClassLength
test "domain_expires_soon" do
check = create(:check, domain_expires_at: Time.new(2018, 6, 10, 12, 0, 5, "+02:00"))
notification = build(:notification, interval: 10, check: check, recipient: "colin@example.org")
@ -17,7 +17,7 @@ class NotificationsMailerTest < ActionMailer::TestCase
assert_equal ["colin@example.org"], mail.to
assert_equal [Rails.configuration.chexpire.fetch("mailer_default_from")], mail.from
parts = [mail.text_part.body.to_s, mail.html_part.to_s]
parts = [mail.text_part.decode_body, mail.html_part.decode_body]
parts.each do |part|
assert_match "domain.fr", part
@ -70,7 +70,7 @@ class NotificationsMailerTest < ActionMailer::TestCase
mail = NotificationsMailer.with(notification: notification).domain_expires_soon
parts = [mail.text_part.body.to_s, mail.html_part.to_s]
parts = [mail.text_part.decode_body, mail.html_part.decode_body]
parts.each do |part|
assert_match "My comment", part
@ -114,7 +114,7 @@ class NotificationsMailerTest < ActionMailer::TestCase
assert_equal ["recipient@domain.fr"], mail.to
assert_equal [Rails.configuration.chexpire.fetch("mailer_default_from")], mail.from
parts = [mail.text_part.body.to_s, mail.html_part.to_s]
parts = [mail.text_part.decode_body, mail.html_part.decode_body]
parts.each do |part|
assert_match "invalid-domain.fr", part
@ -156,4 +156,128 @@ class NotificationsMailerTest < ActionMailer::TestCase
end
end
end
test "ssl_expires_soon" do
check = create(:check, :ssl, domain_expires_at: Time.new(2018, 6, 10, 12, 0, 5, "+02:00"))
notification = build(:notification, interval: 10, check: check, recipient: "colin@example.org")
Date.stub :today, Date.new(2018, 6, 2) do
mail = NotificationsMailer.with(notification: notification).ssl_expires_soon
assert_emails 1 do
mail.deliver_now
end
assert_match "domain.fr", mail.subject
assert_match "SSL", mail.subject
assert_match "in 8 days", mail.subject
assert_equal ["colin@example.org"], mail.to
assert_equal [Rails.configuration.chexpire.fetch("mailer_default_from")], mail.from
parts = [mail.text_part.decode_body, mail.html_part.decode_body]
parts.each do |part|
assert_match "domain.fr", part
assert_match "Sun, 10 Jun 2018 10:00:05 +0000", part
assert_match "10 days", part
assert_match "/checks/#{check.id}/edit", part
assert_no_match "comment", part
assert_no_match "vendor", part
end
end
end
test "ssl_expires_soon - FR" do
check = create(:check, :ssl, domain_expires_at: Time.new(2018, 6, 10, 12, 0, 5, "+02:00"))
notification = build(:notification, interval: 10, check: check, recipient: "colin@example.org")
I18n.with_locale :fr do
Date.stub :today, Date.new(2018, 6, 2) do
mail = NotificationsMailer.with(notification: notification).ssl_expires_soon
assert_emails 1 do
mail.deliver_now
end
assert_match "domain.fr", mail.subject
assert_match "SSL", mail.subject
assert_match "dans 8 jours", mail.subject
assert_equal ["colin@example.org"], mail.to
assert_equal [Rails.configuration.chexpire.fetch("mailer_default_from")], mail.from
parts = [mail.text_part.decode_body, mail.html_part.decode_body]
parts.each do |part|
assert_match "domain.fr", part
assert_match "dim 10 juin 2018 10:00:05 +0000", part
assert_match "10 jours", part
assert_match "/checks/#{check.id}/edit", part
assert_no_match "commentaire", part
assert_no_match "fournisseur", part
end
end
end
end
test "ssl_recurrent_failures" do
last_success_at = Time.new(2018, 5, 30, 6, 10, 0, "+00:00")
domain_expires_at = Time.new(2018, 10, 10, 7, 20, 0, "+04:00")
check = build(:check, :ssl, :last_runs_failed,
domain: "invalid-domain.fr",
last_success_at: last_success_at,
domain_expires_at: domain_expires_at,
comment: "My comment")
notification = create(:notification, check: check)
mail = NotificationsMailer.with(notification: notification).ssl_recurrent_failures
assert_match "failures", mail.subject
assert_match "invalid-domain.fr", mail.subject
assert_match "SSL", mail.subject
assert_equal ["recipient@domain.fr"], mail.to
assert_equal [Rails.configuration.chexpire.fetch("mailer_default_from")], mail.from
parts = [mail.text_part.decode_body, mail.html_part.decode_body]
parts.each do |part|
assert_match "invalid-domain.fr", part
assert_match "recurrent failures", part
assert_match(/success[a-z ]+ Wed, 30 May 2018 06:10:00 \+0000/, part)
assert_match(/expiry[a-z ]+ Wed, 10 Oct 2018 03:20:00 \+0000/, part)
assert_match "My comment", part
assert_match "/checks/#{check.id}/edit", part
end
end
test "ssl_recurrent_failures - FR" do
last_success_at = Time.new(2018, 5, 30, 6, 10, 0, "+00:00")
domain_expires_at = Time.new(2018, 10, 10, 7, 20, 0, "+04:00")
check = build(:check, :ssl, :last_runs_failed,
domain: "invalid-domain.fr",
last_success_at: last_success_at,
domain_expires_at: domain_expires_at,
comment: "My comment")
notification = create(:notification, check: check)
I18n.with_locale :fr do
mail = NotificationsMailer.with(notification: notification).ssl_recurrent_failures
assert_match "Erreurs", mail.subject
assert_match "invalid-domain.fr", mail.subject
assert_match "SSL", mail.subject
assert_equal ["recipient@domain.fr"], mail.to
assert_equal [Rails.configuration.chexpire.fetch("mailer_default_from")], mail.from
parts = [mail.text_part.decode_body, mail.html_part.decode_body]
parts.each do |part|
assert_match "invalid-domain.fr", part
assert_match "erreurs", part
assert_match(/réussie[a-z ]+ mer 30 mai 2018 06:10:00 \+0000/, part)
assert_match(/expiration[a-z ]+ mer 10 oct. 2018 03:20:00 \+0000/, part)
assert_match "commentaire", part
assert_match "/checks/#{check.id}/edit", part
end
end
end
end

View File

@ -2,12 +2,25 @@
class NotificationsMailerPreview < ActionMailer::Preview
# Preview this email at http://localhost:3000/rails/mailers/notifications_mailer/domain_expires_soon
def domain_expires_soon
NotificationsMailer.with(notification: Notification.first).domain_expires_soon
check = Check.domain.first
NotificationsMailer.with(notification: check.notifications.first).domain_expires_soon
end
# Preview this email at http://localhost:3000/rails/mailers/notifications_mailer/domain_recurrent_failures
def domain_recurrent_failures
check = Check.where("last_run_at != last_success_at").limit(1).first
check = Check.domain.where("last_run_at != last_success_at").first
NotificationsMailer.with(notification: check.notifications.first).domain_recurrent_failures
end
# Preview this email at http://localhost:3000/rails/mailers/notifications_mailer/ssl_expires_soon
def ssl_expires_soon
check = Check.ssl.first
NotificationsMailer.with(notification: check.notifications.first).ssl_expires_soon
end
# Preview this email at http://localhost:3000/rails/mailers/notifications_mailer/ssl_recurrent_failures
def ssl_recurrent_failures
check = Check.ssl.where("last_run_at != last_success_at").first
NotificationsMailer.with(notification: check.notifications.first).ssl_recurrent_failures
end
end