mesonbuild/meson

Document how to run the project tests, the unit tests, and both together

Open

#2818 opened on Dec 22, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (4,978 stars) (1,465 forks)batch import
CIdocumentationgood first issuehelp wantedmeson tests

Description

Must document:

  • That CI runs on Appveyor (and what platforms, with a link to https://ci.appveyor.com/project/jpakkane/meson/history) and Travis (link to https://travis-ci.org/mesonbuild/meson/builds)
  • ./run_tests.py runs all tests, including cross-tests on Ubuntu (which we need to extend to other distros)
  • ./run_project_tests.py runs project tests, what their purpose is, and the fact that right now you cannot run each individually (we should also fix that)
  • ./run_unittests.py runs unit tests, which ones run on which platform (so people know where to put new tests), how to run individual unit tests

More.

Contributor guide

Tech stack
python
Domain
build systemdocumentationtesting
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of PythonFamiliarity with Meson build system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the repository's test infrastructure: look at `./run tests.py`, `./run project tests.py`, `./run unittests.py` scripts to understand their purpose and invocation. Review CI configuration files (e.g., `.appveyor.yml`, `.travis.yml`) to understand which tests run on which platforms. Check the linked CI pages for additional context. Then produce a new documentation file (e.g., `docs/Testing.md`) covering each item listed in the issue description.