rustls_version() integration test
#434
Conversation
| @@ -38,6 +38,7 @@ crate-type = ["lib", "staticlib"] | |||
|
|
|||
| [dev-dependencies] | |||
| regex = "1.9.6" | |||
| toml = { version = "0.6.0", default-features = false, features = ["parse"] } | |||
There was a problem hiding this comment.
note: the version here, and in the Cargo.lock was arranged based on this crate's MSRV. The toml stack of crates (toml, toml-edit, serde_spanned, etc) have aggressive MSRV reqs for newer versions. (Another reason I didn't want them to be primary dependencies!)
|
@ctz If you had a couple min to spare I'd love a +1 on this to get it out of my PR queue. Thanks! |
| @@ -3,6 +3,11 @@ use std::io::Write; | |||
| use std::{env, fs, path::PathBuf}; | |||
|
|
|||
| // Keep in sync with Cargo.toml. | |||
| // | |||
| // We don't populate this automatically from the Cargo.toml at build time | |||
There was a problem hiding this comment.
Shower thought:
If the rust crate's build.rs did println!("cargo:version_number={}", env!("CARGO_PKG_VERSION")); then we could simply use env!("DEP_RUSTLS_VERSION_NUMBER") here.
Haven't tried that, and it's probably a worse overall solution than what we have in this PR, and also I should have learned my lesson by now rather than relying on underused parts of cargo.
There was a problem hiding this comment.
Ooo, I forgot that build.rs can forward information like that. Seems worth playing with but we'd need a rustls release with that magic in-place to be usable here so I think I'll leave it for a "One Day" follow-up.
cpu
force-pushed
the
cpu-rustls-version-test
branch
from
7418eeb
to
bcb733a
Compare
This uses a dev-dependency on `toml` to parse `Cargo.toml`, matching pieces of metadata found there with expected values from calling `rustls_version()`. Notably this will help catch a failure to keep the `build.rs` `RUSTLS_CRATE_VERSION` constant in-sync with the Rustls dependency in `Cargo.toml`.
This will help avoid a `clippy::items_after_test_module` finding after the stand-alone `test_rustls_version` unit test is removed.
This is now redundant with the more specific `tests/rustls_version.rs` integration test.
This commit adds some commentary to the `build.rs` `RUSTLS_CRATE_VERSION` const, justifying why we keep it in-sync manually. Initially I was thinking about deducing the `RUSTLS_CRATE_VERSION` in the `build.rs` script automatically by parsing `Cargo.toml`, but after thinking through the sensitivity of `build.rs`, and realizing the parsing would require a new _non-development_ dependency, I abandoned the idea. The recently added integration test will catch anyone forgetting to sync the const and avoids extra deps or complexity in the build script.
cpu
force-pushed
the
cpu-rustls-version-test
branch
from
bcb733a
to
17fe35d
Compare
Figuring out something to do about the manually sync'd
RUSTLS_CRATE_VERSIONconstant inbuild.rshas been on my mind for a while.As explained in the new
build.rscomment I was originally thinking about populating theconstautomatically, but I decided against that because it seemed like it would require brittle by-hand parsing, or taking a new dep (unfortunately, it can't be a development dependency if used inbuild.rs). Both seemed like bad options so I landed on adding an integration test to catch if we forget to update the constant. This has the added advantage of also replacing an existing looser unit test with one that matches the full expected value fromrustls_version()without adding any new hardcoded constants to maintain.