Add quality checks for entries (2factorauth#6132)

* Add quality checks for entries files * Fix rubocop errors fix rubocop errors v2 fix typo * Change file permissions * Apply Suggestions
Crixu · Oct 3, 2021 · a8fadcc · a8fadcc
1 parent f47e0ae
commit a8fadcc
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.github/workflows/repository.yml b/.github/workflows/repository.yml
@@ -32,6 +32,8 @@ jobs:
         run: bundle exec ruby ./tests/validate-images.rb
       - name: Validate URL/Domain reachability
         run: bundle exec ruby ./tests/validate-urls.rb
+      - name: Quality Checks
+        run: bundle exec ruby ./tests/quality-checks.rb
       - name: Validate Ruby scripts
         run: bundle exec rubocop
 

diff --git a/tests/quality-checks.rb b/tests/quality-checks.rb
@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'json'
+
+# Fetch created (but not renamed) files in entries/**
+diff = `git diff --name-only --diff-filter=Ar origin/master...HEAD entries/`.split("\n")
+
+diff&.each do |path|
+  entry = JSON.parse(File.read(path)).values[0]
+  next unless entry.key? 'tfa'
+
+  # rubocop:disable Layout/LineLength
+  puts "::notice file=#{path} title=Missing Documentation:: Since there is no documentation available, please could you provide us with screenshots of the setup/login process as evidence of 2FA? Please remember to block out any personal information." unless entry['documentation']
+  puts "::warning file=#{path}:: A `custom-software` tag is needed since it has been included in the `tfa` array." if entry['tfa'].include?('custom-software') && !entry['custom-software']
+  puts "::warning file=#{path}:: A `custom-hardware` tag is needed since it has been included in the `tfa` array." if entry['tfa'].include?('custom-hardware') && !entry['custom-hardware']
+  # rubocop:enable Layout/LineLength
+end