OAI / OAI/Arazzo-Specification

Conformance Testing

Open
#448 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
471
Forks
69
Avg merge
17h 58m
Merged PRs (30d)
19

Description

As more and more tooling is ramping up, we're going to need some sort of conformance tests to allow tooling to validate that their implementation of Arazzo is correct. It is especially important so that someone working with one tool to create the Arazzo description and another to execute the description can expect it to work as intended. Especially as more and more tools add execution capabilities, it will be imperative that descriptions execute in the same manner of determinism.

These tests should account for every scenario including the upcoming Async support in 1.1 and future support for actor-in-the-loop, function calling, mcp, etc. Naturally it may take time to build a strong repository of conformance tests and the tests themselves should be descriptive in the scenario they test and the version(s) of Arazzo supported as well as versions of OpenAPI, AsyncAPI and future source description formats.

We can start off with very simple conformance tests but the goal is to cover a wide range of possible workflows to maximize the conformance coverage.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name files, tests, or an entry point. Start by locating the project's existing test and specification structures, then define a small initial conformance scenario; done should include descriptive tests that identify supported Arazzo and source-description versions and validate deterministic workflow behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.