Skip to main content

Project Architecture and Environment

1. What is NOT a trashfile?​

Besides the mandatory files cited in the project architecture, here are a few that are NOT considered trashfiles:

  • README
  • README.md
  • NEWS
  • AUTHORS
  • ChangeLog
  • m4/**/*
  • tests/*/
  • src//tests//*
  • doc/*/
  • .git/*/
  • .clang-format
  • .clang-tidy
  • .gitignore
  • .gitlab-ci.yml
  • flake.nix
  • flake.lock

If you have any doubts, ask through news.

2. Available Packages for Testsuites​

  • Python

    • termcolor
    • pytest
    • pytest-timeout
    • pytest-check
    • pyyaml
    • xmlrunner
    • setuptools (xmlrunner dependency)

  • C

    • Criterion

  • bash

    • colordiff
    • grep
    • sed
    • cut
    • base64
    • env
    • yq

This list is NOT exhaustive.

For any other package, post a news to suggest its addition to the environment.

3. Python venv Creation for Tests​

You cannot create a venv or use pip. All of the available packages are installed globally in the testing environment.

Note that the make check rule must ONLY launch your testsuite.