Adds Ruby script to generate a report of tested/untested endpoints

Author: picandocodigo

.gitignore

@@ -0,0 +1 @@
+report/tmp

report/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

report/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'debug'
+end

report/Rakefile

@@ -0,0 +1,15 @@
+require 'erb'
+require './download_artifacts'
+require './reporter'
+
+desc "Generate report"
+task :report do
+  @reporter = Elastic::Reporter.new
+  template = ERB.new(File.read('./template.erb'), trim_mode = true)
+  File.write('../apis_report.md', template.result(binding))
+end
+
+desc "Download artifacts"
+task :download do
+  Elastic::download_artifacts(ENV['STACK_VERSION'] || '8.13.0-SNAPSHOT')
+end

report/download_artifacts.rb

@@ -0,0 +1,65 @@
+require 'pathname'
+require 'open-uri'
+require 'json'
+
+module Elastic
+  CURRENT_PATH = Pathname(File.expand_path(__dir__))
+  class << self
+    def download_artifacts(version)
+      json_filename = CURRENT_PATH.join('tmp/artifacts.json')
+
+      # Create ./tmp if it doesn't exist
+      Dir.mkdir(CURRENT_PATH.join('tmp'), 0700) unless File.directory?(CURRENT_PATH.join('tmp'))
+
+      # Download json file with package information for version:
+      json_url = "https://artifacts-api.elastic.co/v1/versions/#{version}"
+      download_file!(json_url, json_filename)
+
+      # Parse the downloaded JSON
+      begin
+        artifacts = JSON.parse(File.read(json_filename))
+      rescue StandardError => e
+        STDERR.puts "[!] Couldn't read JSON file #{json_filename}"
+        exit 1
+      end
+
+      # Either find the artifacts for the exact same build hash from the current running cluster or
+      # use the first one from the list of builds:
+      build_hash_artifact = artifacts['version']['builds'].first
+      zip_url = build_hash_artifact.dig('projects', 'elasticsearch', 'packages').select { |k, _| k =~ /rest-resources-zip/ }.map { |_, v| v['url'] }.first
+
+      # Dig into the elasticsearch packages, search for the rest-resources-zip package and return the URL:
+      build_hash_artifact.dig('projects', 'elasticsearch', 'packages').select { |k, _| k =~ /rest-resources-zip/ }.map { |_, v| v['url'] }.first
+
+      # Download the zip file
+      filename = CURRENT_PATH.join("tmp/#{zip_url.split('/').last}")
+      download_file!(zip_url, filename)
+
+      spec = CURRENT_PATH.join('tmp/rest-api-spec')
+      FileUtils.remove_dir(spec) if File.directory?(spec)
+
+      puts "Unzipping file #{filename}"
+      `unzip -o #{filename} -d tmp/`
+      `rm #{filename}`
+      puts "Artifacts downloaded in ./tmp, build hash #{@build_hash}"
+      File.write(CURRENT_PATH.join('tmp/rest-api-spec/build_hash'), @build_hash)
+    end
+
+    def download_file!(url, filename)
+      puts "Downloading #{filename} from #{url}"
+      File.open(filename, "w") do |downloaded_file|
+        URI.open(url, "rb") do |artifact_file|
+          downloaded_file.write(artifact_file.read)
+        end
+      end
+      puts "Successfully downloaded #{filename}"
+
+      unless File.exist?(filename)
+        warn "[!] Couldn't download #{filename}"
+        exit 1
+      end
+    rescue StandardError => e
+      abort e.message
+    end
+  end
+end

report/reporter.rb

@@ -0,0 +1,38 @@
+module Elastic
+  class Reporter
+    JSON_FILES = "#{File.expand_path('./tmp/rest-api-spec/api')}/*.json".freeze
+    TESTS_PATH = File.expand_path('../tests/**/*.yml')
+
+    attr_reader :apis, :tested, :untested
+
+    def initialize
+      @apis = gather_apis
+      @tested = []
+      @untested = []
+      report!
+    end
+
+    def gather_apis
+      endpoints = Dir[JSON_FILES].map do |path|
+        path.split('/').last.gsub('.json','')
+      end.reject { |a| a.split('/').last.gsub('.json','').start_with?('_') }
+    end
+
+    def report!
+      @apis.each do |api|
+        if find_in_tests(api)
+          @tested << api
+        else
+          @untested << api
+        end
+      end
+    end
+
+    def find_in_tests(endpoint)
+      Dir[TESTS_PATH].map do |path|
+        return true if File.readlines(path).grep(/#{endpoint}/).any?
+      end
+      false
+    end
+  end
+end

report/template.erb

@@ -0,0 +1,17 @@
+# Tests report
+
+Endpoints: <%= @reporter.apis.count %>
+[Tested](#tested): <%= @reporter.tested.count %>
+[Untested](#untested): <%= @reporter.untested.count %>
+
+## Tested
+
+<% @reporter.tested.each do |test| %>
+- [x] <%= test %>
+<% end %>
+
+## Untested
+
+<% @reporter.untested.each do |test| %>
+- [ ] <%= test %>
+<% end %>