json-schema-org / json-schema-org/JSON-Schema-Test-Suite

[Coverage] output-tests/ is missing structure/ subdirectory documented in README

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

Nobody has claimed this yet.

Dominant language
Python
Stars
750
Forks
307
Avg merge
3d 17h
Merged PRs (30d)
24

Description

The output-tests/README.md explicitly describes two categories of output tests , content and structure, and states:

"Structure tests verify that the structures of the various formats (i.e. flag, basic, detailed, verbose for 2019-09/2020-12…) are correct."

However, output-tests/draft2020-12/ and output-tests/draft2019-09/ only contain a content/ subdirectory. The structure/ subdirectory is entirely absent for both drafts. The README even contains a TODO comment acknowledging the gap:

<!-- This general.json file may be added to the structure tests later, but I haven't gotten to them yet, so I don't know. -->

This means there is currently no test coverage verifying that implementations produce structurally correct output for any of the four formats (flag, basic, detailed, verbose). Any implementation could emit a malformed output structure and the suite would not catch it.

Expected: output-tests/draft2020-12/structure/ and output-tests/draft2019-09/structure/ each contain test files for flag, basic, detailed, and verbose output formats.

Actual: Neither structure/ directory exists.

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

Start with output-tests/README.md and compare the existing content/ directories under output-tests/draft2020-12/ and output-tests/draft2019-09/. Follow the documented output-test layout to add structure/ test files for flag, basic, detailed, and verbose in both drafts. Done means both structure/ directories exist and cover all four formats.

Written by the indexing model from the issue text.

Assessment

Domain
testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.