verify.rb

# frozen_string_literal: true

require 'yaml'
require 'fastimage'
require 'kwalify'
require 'diffy'
@output = 0

# YAML tags related to TFA
@tfa_tags = {
  # YAML tags for TFA Yes
  true => %w[hardware software doc otp u2f multipleu2f passwordless],
  # YAML tags for TFA No
  false => %w[status twitter facebook email_address lang]
}.freeze

# Image max size (in bytes)
@img_max_size = 2500

# Image dimensions
@img_dimensions = [32, 32]

# Image format used for all images in the 'img/' directories.
@img_extension = '.png'

# Permissions set for all the images in the 'img/' directories.
@img_permissions = %w[644 664]

# Send error message
def error(msg)
  @output += 1
  puts "<------------ ERROR ------------>\n" if @output == 1
  puts "#{@output}. #{msg}"
end

def test_img(img, name, imgs)
  # Exception if image file not found
  raise "#{name} image not found." unless File.exist?(img)

  # Remove img from array unless it doesn't exist (double reference case)
  imgs.delete_at(imgs.index(img)) unless imgs.index(img).nil?

  # Check image dimensions
  error("#{img} is not #{@img_dimensions.join('x')} pixels.")\
    unless FastImage.size(img) == @img_dimensions

  test_img_file(img)
end

# rubocop:disable Metrics/MethodLength
def test_img_file(img)
  # Check image file extension and type
  error("#{img} is not using the #{@img_extension} format.")\
    unless File.extname(img) == @img_extension && FastImage.type(img) == :png

  # Check image file size
  img_size = File.size(img)
  unless img_size <= @img_max_size
    error("#{img} should not be larger than #{@img_max_size} bytes. It is"\
              " currently #{img_size} bytes.")
  end

  # Check image permissions
  perms = File.stat(img).mode.to_s(8).split(//).last(3).join
  # rubocop:disable Style/GuardClause
  unless @img_permissions.include?(perms)
    error("#{img} permissions must be one of: #{@img_permissions.join(',')}. "\
    "It is currently #{perms}.")
  end
  # rubocop:enable Style/GuardClause
end
# rubocop:enable Metrics/MethodLength

# Load each section, check for errors such as invalid syntax
# as well as if an image is missing
begin
  sections = YAML.load_file('_data/sections.yml')
  # Check sections.yml alphabetization
  error('section.yml is not alphabetized by name') \
    if sections != (sections.sort_by { |section| section['id'].downcase })
  schema = YAML.load_file('websites_schema.yml')
  validator = Kwalify::Validator.new(schema)
  sections.each do |section|
    data = YAML.load_file("_data/#{section['id']}.yml")
    websites = data['websites']
    errors = validator.validate(data)

    errors.each do |e|
      error("#{websites.at(e.path.split('/')[2].to_i)['name']}: #{e.message}")
    end

    # Check section alphabetization
    if websites != (sites_sort = websites.sort_by { |s| s['name'].downcase })
      error("_data/#{section['id']}.yml not ordered by name. Correct order:" \
        "\n" + Diffy::Diff.new(websites.to_yaml, sites_sort.to_yaml, \
                               context: 10).to_s(:color))
    end

    # Collect list of all images for section
    imgs = Dir["img/#{section['id']}/*"]

    websites.each do |website|
      test_img("img/#{section['id']}/#{website['img']}", website['name'],
               imgs)

      # prevent travis fail when hardware is not present
      # tested tags are desired in this case for dongleauth.com
      next if website['hardware'].nil?

      @tfa_tags[!website['tfa']].each do |tag|
        next if website[tag].nil?

        error("\'#{tag}\' should NOT be "\
            "present when hardware: #{website['tfa'] ? 'true' : 'false'}.")
      end
    end

    # After removing images associated with entries in test_img, alert
    # for unused or orphaned images
    imgs.each { |img| next unless img.nil? error("#{img} is not used") }
  end

  # Test the very same for the dongleauth.com's provider.yml as well
  data = YAML.load_file('_data/providers.yml')
  providers = data['providers']

  # Check section alphabetization
  error('_data/providers.yml is not alphabetized by name') \
    if providers != (providers.sort_by { |provider| provider['name'].downcase })

  # Collect list of all images for section
  imgs = Dir['img/providers/*']

  providers.each do |provider|
    test_img("img/providers/#{provider['img']}", provider['name'],
             imgs)
  end

  imgs.each { |img| next unless img.nil? error("#{img} is not used") }

  exit 1 if @output.positive?
rescue Psych::SyntaxError => e
  puts "<------------ ERROR in a YAML file ------------>\n"
  puts e
  exit 1
rescue StandardError => e
  puts e
  exit 1
else
  puts "<------------ No errors. You\'re good to go! ------------>\n"
end