Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

We should document what external dependencies we assume for our test suites #125585

Open
jieyouxu opened this issue May 26, 2024 · 1 comment
Open
Labels
A-compiletest Area: The compiletest test runner A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-testsuite Area: The testsuite used to check the correctness of rustc C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@jieyouxu
Copy link
Member

Location

The test suites, especially tests/run-make and tests/run-make-fulldeps.

Summary

It'd be nice for people to be able to reliably run test suites without necessarily having to rely on Docker environments, or at least know what external dependencies are assumed to be available (and what version/flavor as well) by the test suites. This is also relevant for people trying to work on or maintain new targets if they want to run the test suites. Example dependencies (non-exhaustive, have not fully surveyed):

  • Utilities: e.g. nm, grep.
  • C/C++ compilers, e.g. what cc points to is a massive pain.
  • Python: again, which python version is also a massive pain.
  • Make and makefiles: we're trying to escape from this
  • Shell: bash? or what do the various bash scripts assume?

For example, the run-make test suite has a bunch of assumed external dependencies (like nm) which are not documented AFAICT.

@jieyouxu jieyouxu added C-cleanup Category: PRs that clean code up or issues documenting cleanup. A-testsuite Area: The testsuite used to check the correctness of rustc T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels May 26, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label May 26, 2024
@jieyouxu jieyouxu removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label May 26, 2024
@jieyouxu jieyouxu added the A-compiletest Area: The compiletest test runner label May 29, 2024
@lolbinarycat
Copy link
Contributor

src/tools/run-make-support/src/external_deps/ would be a good place to start.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-compiletest Area: The compiletest test runner A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-testsuite Area: The testsuite used to check the correctness of rustc C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants