ipfs / ipfs/gateway-conformance

feat: easier testing of a specific specification/IPIP

Open
#237 0 comments 0 reactions 0 assignees View on GitHub
kind/discussion need/maintainers-input
Dominant language
Go
Stars
19
Forks
15
Avg merge
1d 4h
Merged PRs (30d)
5

Description

## Overview

Some of our tests mention/link to a specification, e.g. https://github.com/ipfs/gateway-conformance/blob/e782d03f9b637e32bb908558725e501523046fae/tests/path_gateway_tar_test.go#L79, but not all of them.

## Goal

We should make it easier for folks who are reading specs, to run conformance tests for that specific test, and potentialy even target specific sections of those specs.

### Examples

Trying to test https://specs.ipfs.tech/http-gateways/trustless-gateway could be as easy as:

```
gateway-conformance test <...> --specs http-gateways/trustless-gateway
```

You could target a subsection of that test (i.e. https://specs.ipfs.tech/http-gateways/trustless-gateway/#dag-scope-request-query-parameter) with something like:

```
gateway-conformance test <...> --specs http-gateways/trustless-gateway/dag-scope-request-query-parameter
```

## Concerns and other thoughts

Tight coupling these like this will cause some pain, but it will also keep our specifications and conformance tests accurate and up to date.

## Related

Potentially related? https://github.com/ipfs/gateway-conformance/issues/120

Similar to https://github.com/ipfs/gateway-conformance/issues/86, but for keeping conformance tests closer to specifications.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.