|
| 1 | +require "test_helper" |
| 2 | +require "net/http" |
| 3 | +require "yaml" |
| 4 | +require "json_schemer" |
| 5 | + |
| 6 | +class ContractTest < Minitest::Test |
| 7 | + SPEC_URL = "https://djbender.github.io/lizard/openapi.yaml" |
| 8 | + |
| 9 | + def setup |
| 10 | + @spec = fetch_spec |
| 11 | + if @spec.nil? |
| 12 | + msg = "OpenAPI spec not reachable at #{SPEC_URL}" |
| 13 | + ENV["SKIP_CONTRACT_TESTS"] ? skip(msg) : raise(msg) |
| 14 | + end |
| 15 | + @schemas = @spec.dig("components", "schemas") |
| 16 | + end |
| 17 | + |
| 18 | + def test_rspec_payload_matches_request_schema |
| 19 | + payload = build_rspec_payload |
| 20 | + schemer = schemer_for("CreateTestRunRequest") |
| 21 | + |
| 22 | + errors = schemer.validate(payload).to_a |
| 23 | + assert_empty errors, "RSpec payload failed validation:\n#{format_errors(errors)}" |
| 24 | + end |
| 25 | + |
| 26 | + def test_rspec_payload_with_metadata_matches_request_schema |
| 27 | + payload = build_rspec_payload( |
| 28 | + github_run_id: "23419710055", |
| 29 | + github_repository: "djbender/lizard-ruby" |
| 30 | + ) |
| 31 | + schemer = schemer_for("CreateTestRunRequest") |
| 32 | + |
| 33 | + errors = schemer.validate(payload).to_a |
| 34 | + assert_empty errors, "RSpec payload with metadata failed validation:\n#{format_errors(errors)}" |
| 35 | + end |
| 36 | + |
| 37 | + def test_minitest_payload_matches_request_schema |
| 38 | + payload = build_minitest_payload |
| 39 | + schemer = schemer_for("CreateTestRunRequest") |
| 40 | + |
| 41 | + errors = schemer.validate(payload).to_a |
| 42 | + assert_empty errors, "Minitest payload failed validation:\n#{format_errors(errors)}" |
| 43 | + end |
| 44 | + |
| 45 | + def test_success_response_matches_schema |
| 46 | + response = {"status" => "success", "id" => 1} |
| 47 | + schemer = schemer_for("SuccessResponse") |
| 48 | + |
| 49 | + errors = schemer.validate(response).to_a |
| 50 | + assert_empty errors, "Success response failed validation:\n#{format_errors(errors)}" |
| 51 | + end |
| 52 | + |
| 53 | + def test_error_response_matches_schema |
| 54 | + response = {"error" => "Invalid API key"} |
| 55 | + schemer = schemer_for("ErrorResponse") |
| 56 | + |
| 57 | + errors = schemer.validate(response).to_a |
| 58 | + assert_empty errors, "Error response failed validation:\n#{format_errors(errors)}" |
| 59 | + end |
| 60 | + |
| 61 | + private |
| 62 | + |
| 63 | + def fetch_spec |
| 64 | + uri = URI(SPEC_URL) |
| 65 | + response = Net::HTTP.get_response(uri) |
| 66 | + return nil unless response.is_a?(Net::HTTPSuccess) |
| 67 | + YAML.safe_load(response.body) |
| 68 | + rescue SocketError, Errno::ECONNREFUSED, Timeout::Error |
| 69 | + nil |
| 70 | + end |
| 71 | + |
| 72 | + def build_rspec_payload(github_run_id: nil, github_repository: nil) |
| 73 | + metadata = {} |
| 74 | + metadata["github_run_id"] = github_run_id if github_run_id |
| 75 | + metadata["github_repository"] = github_repository if github_repository |
| 76 | + |
| 77 | + { |
| 78 | + "test_run" => { |
| 79 | + "commit_sha" => "abc123def456", |
| 80 | + "branch" => "main", |
| 81 | + "ruby_specs" => 42, |
| 82 | + "js_specs" => 0, |
| 83 | + "runtime" => 12.345, |
| 84 | + "coverage" => 95.5, |
| 85 | + "ran_at" => Time.now.iso8601, |
| 86 | + "metadata" => metadata |
| 87 | + } |
| 88 | + } |
| 89 | + end |
| 90 | + |
| 91 | + def build_minitest_payload(github_run_id: nil, github_repository: nil) |
| 92 | + metadata = {} |
| 93 | + metadata["github_run_id"] = github_run_id if github_run_id |
| 94 | + metadata["github_repository"] = github_repository if github_repository |
| 95 | + |
| 96 | + { |
| 97 | + "test_run" => { |
| 98 | + "commit_sha" => "abc123def456", |
| 99 | + "branch" => "main", |
| 100 | + "ruby_specs" => 10, |
| 101 | + "js_specs" => 0, |
| 102 | + "runtime" => 3.21, |
| 103 | + "coverage" => 88.0, |
| 104 | + "ran_at" => Time.now.iso8601, |
| 105 | + "metadata" => metadata |
| 106 | + } |
| 107 | + } |
| 108 | + end |
| 109 | + |
| 110 | + def schemer_for(schema_name) |
| 111 | + schema = @schemas.fetch(schema_name) |
| 112 | + resolved = resolve_refs(schema) |
| 113 | + JSONSchemer.schema(resolved) |
| 114 | + end |
| 115 | + |
| 116 | + def resolve_refs(node) |
| 117 | + case node |
| 118 | + when Hash |
| 119 | + if node.key?("$ref") |
| 120 | + ref_name = node["$ref"].split("/").last |
| 121 | + resolve_refs(@schemas.fetch(ref_name)) |
| 122 | + else |
| 123 | + node.transform_values { |v| resolve_refs(v) } |
| 124 | + end |
| 125 | + when Array |
| 126 | + node.map { |v| resolve_refs(v) } |
| 127 | + else |
| 128 | + node |
| 129 | + end |
| 130 | + end |
| 131 | + |
| 132 | + def format_errors(errors) |
| 133 | + errors.map { |e| " #{e["data_pointer"]}: #{e["type"]} — #{e["details"]}" }.join("\n") |
| 134 | + end |
| 135 | +end |
0 commit comments