multiformats / multiformats/multiaddr

Allow compliance testing of implementations

Open
#148 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
482
Forks
87
PR merge metrics
No merged PRs in 30d

Description

It would be good if we can offer an easy way for people to integration test that their implementations are working correctly.

I'd propose to add a test suite and a GitHub action to this repository that allows implementations to easily verify whether they are compliant.

Concretely, I am thinking of specifying a simple stdin/stdout protocol where the implementations need to provide an application that reads from stdin (each line representing a test case), exiting with an appropriate exit code.

For example:

/path/to/implementation parse-valid-str
> /ip4/127.0.0.1/tcp/1234
< exit 0
/path/to/implementation parse-invalid-str
> /foobar/1234
< exit 0
/path/to/implementation parse-valid-hex
> 047f000001910204d2
> exit 0

By providing a GitHub action, we can make sure that changes to the table (as long as accompanied with a test) are run against new implementations (assuming they run their CI regularly).

Thoughts?

Contributor guide

No contributing guide indexed for this repository

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

Start by reviewing the repository's existing compliance table and test layout, then clarify the proposed stdin/stdout protocol and how implementations would be invoked. Done means an agreed protocol, a compliance test suite, and a GitHub Action that runs it against implementations.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, go
Domain
ci-cd, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.