precice / precice/tutorials

YAML schema for system test cases

Open
#403 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #722 by @kishansinghifs1 — closed without merging
enhancement student systemtests
Dominant language
C
Stars
142
Forks
167
Avg merge
20h 24m
Merged PRs (30d)
11

Description

Editing the YAML files on VSCode, I get this very interesting warning:

Screenshot from 2023-11-18 11-29-55

It would be nice to have a defined schema, which would then help the developers define new tests. Relevant for:

  • tests.yaml
  • components.yaml
  • component templates (should be Docker Compose schema)

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 by inspecting tests.yaml, components.yaml, and the component templates to identify their current structures. Check how VSCode schema warnings apply to these YAML files and how Docker Compose schemas apply to the templates. Done means the relevant files have defined schemas that help validate and author new system test cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, yaml
Domain
developer-experience, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.