probot.github.io/test/lint_test.rb

require "bundler/setup"
require "safe_yaml"
require "minitest/autorun"
require "net/http"

describe "lint test" do
  FRONTMATTER = SafeYAML.load_file("test/frontmatter.yml")

  BANNED_WORDS = Regexp.new('\b(' +
    FRONTMATTER["banned_words"].join('|') +
    ')\b', Regexp::IGNORECASE | Regexp::MULTILINE)

  EXCEPTIONS = {
    "bot" => ["sentiment-bot"]
  }

  Dir.glob("_apps/*.md").each do |path|
    describe path do
      # Load frontmatter
      data = SafeYAML.load_file(path)

      it "does not have extraneous fields" do
        extra_fields = data.keys - FRONTMATTER["fields"].keys
        assert extra_fields.empty?, "Unexpected metadata: #{extra_fields.inspect}"
      end

      FRONTMATTER["fields"].each do |name, attrs|
        if attrs["required"]
          it "${name} is required" do
            assert data.key?(name), "#{name} is required"
          end
        end

        if attrs["type"] && data[name]
          it "${name} must be a #{attrs["type"]}" do
            assert_kind_of Kernel.const_get(attrs["type"]), data[name]
          end
        end
      end

      it "description should be sentence case" do
        first_letter = data["description"][0]
        assert_equal first_letter.upcase, first_letter, "Description should be in sentence case"
      end

      it "does not use banned words" do
        %w(title description slug).each do |field|
          match = data[field].match(BANNED_WORDS)
          if match && !Array(FRONTMATTER["exceptions"][match[1].downcase]).include?(data["slug"])
            assert !match, "`#{match[1]}` should not be used in #{field}"
          end
        end
      end

      it "host returns 200" do
        uri_end = data["host"].end_with?('/') ? 'ping' : '/ping'
        uri = URI(data["host"] + uri_end)
        res = Net::HTTP.get_response(uri)
        assert_equal "200", res.code, "Expected 200 response from #{uri}"
      end
    end
  end
end