overseer-testing-protocol 0.1.0

data/lib/overseer/testing_control/conformance/report.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'json_schemer'
+
+module Overseer
+  module TestingControl
+    module Conformance
+      module Report
+        SCHEMA_PATH = File.expand_path(
+          '../../../../protocol/testing-control/v3/conformance-report.schema.json',
+          __dir__
+        )
+
+        class Error < StandardError; end
+
+        module_function
+
+        def validate!(report)
+          errors = schemer.validate(report).take(5)
+          return report if errors.empty?
+
+          details = errors.map { |error| "#{error.fetch('data_pointer', '/')} #{error.fetch('type')}" }.join('; ')
+          raise Error, "Invalid testing-control conformance report: #{details}"
+        end
+
+        def render(report)
+          target = report.fetch('target')
+          capabilities = report['capabilities']
+          lines = [
+            "Testing-control v#{report.fetch('protocolVersion')} conformance: #{report.fetch('aggregateStatus')}",
+            "Target: #{target.fetch('label')}",
+            "Source: #{target.fetch('sourceVersion') || 'unavailable'}",
+            "Origin: #{target.fetch('origin') || 'unavailable'}"
+          ]
+          lines.concat(optional_provenance_lines(target['provenance']))
+          lines.concat(identity_lines(report['identity']))
+          lines.concat(capability_lines(capabilities))
+          lines << 'Checks:'
+          report.fetch('checks').each do |check|
+            lines << check_line(check)
+          end
+          lifecycle = report.fetch('lifecycle')
+          lines << "Lifecycle: #{lifecycle.fetch('ownership')}; cleanup #{lifecycle.fetch('cleanup')}"
+          lines << ''
+          lines.join("\n")
+        end
+
+        def optional_provenance_lines(provenance)
+          provenance ? provenance_lines(provenance) : []
+        end
+        private_class_method :optional_provenance_lines
+
+        def identity_lines(identity)
+          return [] unless identity
+
+          ["Runtime identity: #{identity.fetch('applicationId')} #{identity.fetch('applicationVersion')} " \
+           "(#{identity.fetch('environmentId')})"]
+        end
+        private_class_method :identity_lines
+
+        def capability_lines(capabilities)
+          return [] unless capabilities
+
+          ["Capabilities: #{capabilities.fetch('arrangements').length} arrangements, " \
+           "#{capabilities.fetch('observations').length} observations, " \
+           "#{capabilities.fetch('sinks').length} sinks; reset #{capabilities.fetch('resetStrategy')}"]
+        end
+        private_class_method :capability_lines
+
+        def check_line(check)
+          scenario = check['scenarioId'] ? " [#{check.fetch('scenarioId')}]" : ''
+          "  #{check.fetch('status').upcase} #{check.fetch('id')}#{scenario}: #{check.fetch('message')}"
+        end
+        private_class_method :check_line
+
+        def provenance_lines(provenance)
+          project = provenance.fetch('project')
+          manifest = provenance.fetch('backendManifest')
+          runtime = provenance.fetch('runtime')
+          lines = [
+            "Project target: #{project.fetch('id')} revision #{project.fetch('revision')} / " \
+            "#{provenance.fetch('targetKey')}",
+            "Backend: #{provenance.dig('backend', 'applicationId')} " \
+            "(registry #{provenance.dig('backend', 'registryId')})",
+            "Manifest: v#{manifest.fetch('version')} sha256:#{manifest.fetch('sha256')}",
+            "Runtime: #{runtime.fetch('mode')}; profile #{runtime.fetch('profileName')} " \
+            "policy v#{runtime.fetch('profilePolicyVersion')}"
+          ]
+          return lines unless provenance['conformanceCase']
+
+          selected_case = provenance.fetch('conformanceCase')
+          lines << "Conformance case: #{selected_case.fetch('id')} sha256:#{selected_case.fetch('sha256')}"
+        end
+        private_class_method :provenance_lines
+
+        def schemer
+          @schemer ||= JSONSchemer.schema(JSON.parse(File.read(SCHEMA_PATH, encoding: 'UTF-8')))
+        end
+        private_class_method :schemer
+      end
+    end
+  end
+end