Zen

Source string Source string

239/10000 · 239

The string is read only.

English Actions
_"unit tests"_: These tests are included alongside library / application source code in the `src/` directory, and can reference private APIs (similar to "glass-box" tests).
_"integration tests"_: These tests are usually separate files under the `tests/` directory, and they can only rely on public API of the tested crate (similar to "black-box" tests).
_"doctests"_: These tests are automatically extracted from code blocks in Markdown documentation, which is often used as a mechanism to ensure that code snippets in documentation for public methods are correct and continue to compile.
By default, running `cargo test` (i.e. by calling the `%cargo_test` macro), all three kinds of tests are run. They can also be invoked separately (for example, because parts of the test suite or large data files are not included in published sources) by passing through filtering arguments to the underlying `cargo test` command:
`%cargo_test -- --lib`: only run _"unit tests"_ for the library interface
`%cargo_test -- --bin`: only run _"unit tests"_ for binaries
`%cargo_test -- --doc`: only run _"doctests"_
`%cargo_test -- --tests`: only run _"integration tests"_
This can be combined with additional flags to skip tests with specific names (or that contain a specific string in their name) by passing the `--skip` argument through to the test harness (can be specified multiple times):
%cargo_test -- --lib -- --skip foo::bar::tests::test1
By default, cargo uses substring matching to match `--skip` arguments and actual names of tests, which can be turned off by using the `--exact` flag.
If any tests are skipped or disabled, the package *SHOULD* include comments that explain why this is the case, and include links to upstream issues, if available.
Rust applications (non-crates.io crates)
Most rules that apply to Rust crates that are published in https://crates.io[crates.io] also apply to Rust projects that _are_ built with cargo but _not_ published on https://crates.io[crates.io].
https://pagure.io/fedora-rust/rust2rpm[rust2rpm] has basic support for generating spec files for this type of package by running `rust2rpm path/to/Cargo.toml` in unpacked upstream sources.
Packages that fall into this category *MUST NOT* ship crate sources in `%{cargo_registry}`, i.e. they cannot ship `-devel` subpackages that contain crate sources or have subpackages that have virtual provides for `crate(...) = %{version}`.
To prevent the `+%cargo_install+` macro from installing library sources into `%{cargo_registry}`, the `%cargo_install_lib` macro can be defined to `0`. When using rust2rpm with a path to a Cargo.toml file this macro definition is injected automatically.
Rust applications that are "crates" but which are not published on https://crates.io[crates.io] *MUST* be named according to the generic https://docs.fedoraproject.org/en-US/packaging-guidelines/Naming/[Naming Guidelines], i.e. they *MUST NOT* use a `rust-` prefix for the source package name.
The generic guidelines for https://docs.fedoraproject.org/en-US/packaging-guidelines/SourceURL/[referencing sources] apply. Notably, the `%{crates_source}` macro cannot be used for packages like this.
Rust applications (cargo workspace projects)
Some Rust projects are organized as "cargo workspaces", which are collections of Rust crates that are often considered "internal implementation details". In most cases, these "internal" crates are not published individually on https://crates.io[crates.io].
Projects that use this setup can be handled similarly to Rust projects that are organized as a single crate but not published on https://crates.io[crates.io].
https://pagure.io/fedora-rust/rust2rpm[rust2rpm] has basic support for generating spec files for this type of package by running `rust2rpm path/to/Cargo.toml` in unpacked upstream sources, (where `./Cargo.toml` must be the path to the "workspace root", i.e. the `Cargo.toml` file that contains the `[workspace]` table).
Packages that fall into this category *MUST NOT* ship crate sources in `%{cargo_registry}`, i.e. they cannot ship `-devel` subpackages that contain crate sources or have any subpackages that have virtual provides for `crate(...) = %{version}`.
Rust projects that are organized as "cargo workspaces" *MUST* be named according to the generic https://docs.fedoraproject.org/en-US/packaging-guidelines/Naming/[Naming Guidelines], i.e. they *MUST NOT* use a `rust-` prefix for the source package name.
The generic guidelines for https://docs.fedoraproject.org/en-US/packaging-guidelines/SourceURL/[referencing sources] apply.
All `%cargo_*` macros have support for cargo workspaces as of `cargo-rpm-macros >= 24`. Any unexpected results that occur when using these macros for projects that are set up as a cargo workspace should be reported against https://pagure.io/fedora-rust/cargo2rpm[cargo2rpm].
Note that currently, any `-a` and `-n` flags or `-f` arguments that are passed to `%cargo_generate_buildrequires` are applied to _all_ workspace members during dependency resolution.
Python projects
Python packages that use https://github.com/PyO3/setuptools-rust[setuptools_rust] or https://github.com/PyO3/maturin[maturin] to build a "native" Python extension also need to apply the link:#_generic_rules[generic rules] for Rust packages in addition to following the https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/[Python Packaging Guidelines].
Both https://github.com/PyO3/setuptools-rust[setuptools_rust] and https://github.com/PyO3/maturin[maturin] build the native Python extension by calling cargo internally, so the basic setup for projects that build with cargo is required for packages like this as well.

Loading…

User avatar None

String added in the repository

  1. fedora-docs-l10n/packaging-guidelines
  2. master/pages/Rust
  3. English
Packages that fall into this category *MUST NOT* ship crate sources in `%{cargo_registry}`, i.e. they cannot ship `-devel` subpackages that contain crate sources or have subpackages that have virtual provides for `crate(...) = %{version}`.
Packages that fall into this category *MUST NOT* ship crate sources in `%{cargo_registry}`, i.e. they cannot ship `-devel` subpackages that contain crate sources or have subpackages that have virtual provides for `crate(...) = %{version}`.
2 weeks ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Glossary

English English
No related strings found in the glossary.

String information

Source string description
type: Plain text
Flags
read-only
Source string location
./pages/Rust.adoc:779
String age
2 weeks ago
Last updated
2 weeks ago
Source string age
2 weeks ago
Translation file
pot/master/pages/Rust.pot, string 160