mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-03 15:15:33 +00:00
[red-knot] Property tests (#14178)
## Summary This PR adds a new `property_tests` module with quickcheck-based tests that verify certain properties of types. The following properties are currently checked: * `is_equivalent_to`: * is reflexive: `T` is equivalent to itself * `is_subtype_of`: * is reflexive: `T` is a subtype of `T` * is antisymmetric: if `S <: T` and `T <: S`, then `S` is equivalent to `T` * is transitive: `S <: T` & `T <: U` => `S <: U` * `is_disjoint_from`: * is irreflexive: `T` is not disjoint from `T` * is symmetric: `S` disjoint from `T` => `T` disjoint from `S` * `is_assignable_to`: * is reflexive * `negate`: * is an involution: `T.negate().negate()` is equivalent to `T` There are also some tests that validate higher-level properties like: * `S <: T` implies that `S` is not disjoint from `T` * `S <: T` implies that `S` is assignable to `T` * A singleton type must also be single-valued These tests found a few bugs so far: - #14177 - #14195 - #14196 - #14210 - #14731 Some additional notes: - Quickcheck-based property tests are non-deterministic and finding counter-examples might take an arbitrary long time. This makes them bad candidates for running in CI (for every PR). We can think of running them in a cron-job way from time to time, similar to fuzzing. But for now, it's only possible to run them locally (see instructions in source code). - Some tests currently find false positive "counterexamples" because our understanding of equivalence of types is not yet complete. We do not understand that `int | str` is the same as `str | int`, for example. These tests are in a separate `property_tests::flaky` module. - Properties can not be formulated in every way possible, due to the fact that `is_disjoint_from` and `is_subtype_of` can produce false negative answers. - The current shrinking implementation is very naive, which leads to counterexamples that are very long (`str & Any & ~tuple[Any] & ~tuple[Unknown] & ~Literal[""] & ~Literal["a"] | str & int & ~tuple[Any] & ~tuple[Unknown]`), requiring the developer to simplify manually. It has not been a major issue so far, but there is a comment in the code how this can be improved. - The tests are currently implemented using a macro. This is a single commit on top which can easily be reverted, if we prefer the plain code instead. With the macro: ```rs // `S <: T` implies that `S` can be assigned to `T`. type_property_test!( subtype_of_implies_assignable_to, db, forall types s, t. s.is_subtype_of(db, t) => s.is_assignable_to(db, t) ); ``` without the macro: ```rs /// `S <: T` implies that `S` can be assigned to `T`. #[quickcheck] fn subtype_of_implies_assignable_to(s: Ty, t: Ty) -> bool { let db = get_cached_db(); let s = s.into_type(&db); let t = t.into_type(&db); !s.is_subtype_of(&*db, t) || s.is_assignable_to(&*db, t) } ``` ## Test Plan ```bash while cargo test --release -p red_knot_python_semantic --features property_tests types::property_tests; do :; done ```
This commit is contained in:
David Peter
GitHub
parent
a255d79087
commit
74309008fd
4 changed files with 309 additions and 34 deletions
95
Cargo.lock
generated
95
Cargo.lock
generated
|
|
@ -413,7 +413,7 @@ dependencies = [
|
||||||
"heck",
|
"heck",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -693,7 +693,7 @@ dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"strsim 0.10.0",
|
"strsim 0.10.0",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -704,7 +704,7 @@ checksum = "a668eda54683121533a393014d8692171709ff57a7d61f187b6e782719f8933f"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"darling_core",
|
"darling_core",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -774,7 +774,7 @@ dependencies = [
|
||||||
"glob",
|
"glob",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -826,7 +826,7 @@ checksum = "97369cbbc041bc366949bc74d34658d6cda5621039731c6310521892a3a20ae0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -1246,7 +1246,7 @@ checksum = "1ec89e9337638ecdc08744df490b221a7399bf8d164eb52a665454e60e075ad6"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -1420,7 +1420,7 @@ dependencies = [
|
||||||
"heck",
|
"heck",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -1547,7 +1547,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "a2ae40017ac09cd2c6a53504cb3c871c7f2b41466eac5bc66ba63f39073b467b"
|
checksum = "a2ae40017ac09cd2c6a53504cb3c871c7f2b41466eac5bc66ba63f39073b467b"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -2013,7 +2013,7 @@ dependencies = [
|
||||||
"pest_meta",
|
"pest_meta",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -2173,6 +2173,26 @@ dependencies = [
|
||||||
"memchr",
|
"memchr",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "quickcheck"
|
||||||
|
version = "1.0.3"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "588f6378e4dd99458b60ec275b4477add41ce4fa9f64dcba6f15adccb19b50d6"
|
||||||
|
dependencies = [
|
||||||
|
"rand",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "quickcheck_macros"
|
||||||
|
version = "1.0.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "b22a693222d716a9587786f37ac3f6b4faedb5b80c23914e7303ff5a1d8016e9"
|
||||||
|
dependencies = [
|
||||||
|
"proc-macro2",
|
||||||
|
"quote",
|
||||||
|
"syn 1.0.109",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "quote"
|
name = "quote"
|
||||||
version = "1.0.37"
|
version = "1.0.37"
|
||||||
|
|
@ -2273,6 +2293,8 @@ dependencies = [
|
||||||
"itertools 0.13.0",
|
"itertools 0.13.0",
|
||||||
"memchr",
|
"memchr",
|
||||||
"ordermap",
|
"ordermap",
|
||||||
|
"quickcheck",
|
||||||
|
"quickcheck_macros",
|
||||||
"red_knot_test",
|
"red_knot_test",
|
||||||
"red_knot_vendored",
|
"red_knot_vendored",
|
||||||
"ruff_db",
|
"ruff_db",
|
||||||
|
|
@ -2777,7 +2799,7 @@ dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"ruff_python_trivia",
|
"ruff_python_trivia",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3197,7 +3219,7 @@ dependencies = [
|
||||||
"heck",
|
"heck",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
"synstructure",
|
"synstructure",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
@ -3231,7 +3253,7 @@ dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"serde_derive_internals",
|
"serde_derive_internals",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3280,7 +3302,7 @@ checksum = "ad1e866f866923f252f05c889987993144fb74e722403468a4ebd70c3cd756c0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3291,7 +3313,7 @@ checksum = "330f01ce65a3a5fe59a60c82f3c9a024b573b8a6e875bd233fe5f934e71d54e3"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3314,7 +3336,7 @@ checksum = "6c64451ba24fc7a6a2d60fc75dd9c83c90903b19028d4eff35e88fc1e86564e9"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3355,7 +3377,7 @@ dependencies = [
|
||||||
"darling",
|
"darling",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3463,7 +3485,7 @@ dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"rustversion",
|
"rustversion",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3472,6 +3494,17 @@ version = "2.5.0"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "81cdd64d312baedb58e21336b31bc043b77e01cc99033ce76ef539f78e965ebc"
|
checksum = "81cdd64d312baedb58e21336b31bc043b77e01cc99033ce76ef539f78e965ebc"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "syn"
|
||||||
|
version = "1.0.109"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
|
||||||
|
dependencies = [
|
||||||
|
"proc-macro2",
|
||||||
|
"quote",
|
||||||
|
"unicode-ident",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "syn"
|
name = "syn"
|
||||||
version = "2.0.90"
|
version = "2.0.90"
|
||||||
|
|
@ -3491,7 +3524,7 @@ checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3554,7 +3587,7 @@ dependencies = [
|
||||||
"cfg-if",
|
"cfg-if",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3565,7 +3598,7 @@ checksum = "5c89e72a01ed4c579669add59014b9a524d609c0c88c6a585ce37485879f6ffb"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
"test-case-core",
|
"test-case-core",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
@ -3595,7 +3628,7 @@ checksum = "b607164372e89797d78b8e23a6d67d5d1038c1c65efd52e1389ef8b77caba2a6"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3606,7 +3639,7 @@ checksum = "f077553d607adc1caf65430528a576c757a71ed73944b66ebb58ef2bbd243568"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -3728,7 +3761,7 @@ checksum = "395ae124c09f9e6918a2310af6038fba074bcf474ac352496d5910dd59a2226d"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -4001,7 +4034,7 @@ checksum = "6b91f57fe13a38d0ce9e28a03463d8d3c2468ed03d75375110ec71d93b449a08"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -4096,7 +4129,7 @@ dependencies = [
|
||||||
"once_cell",
|
"once_cell",
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
"wasm-bindgen-shared",
|
"wasm-bindgen-shared",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
@ -4131,7 +4164,7 @@ checksum = "98c9ae5a76e46f4deecd0f0255cc223cfa18dc9b261213b8aa0c7b36f61b3f1d"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
"wasm-bindgen-backend",
|
"wasm-bindgen-backend",
|
||||||
"wasm-bindgen-shared",
|
"wasm-bindgen-shared",
|
||||||
]
|
]
|
||||||
|
|
@ -4165,7 +4198,7 @@ checksum = "222ebde6ea87fbfa6bdd2e9f1fd8a91d60aee5db68792632176c4e16a74fc7d8"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -4468,7 +4501,7 @@ checksum = "28cc31741b18cb6f1d5ff12f5b7523e3d6eb0852bbbad19d73905511d9849b95"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
"synstructure",
|
"synstructure",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
@ -4489,7 +4522,7 @@ checksum = "9ce1b18ccd8e73a9321186f97e46f9f04b778851177567b1975109d26a08d2a6"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -4509,7 +4542,7 @@ checksum = "0ea7b4a3637ea8669cedf0f1fd5c286a17f3de97b8dd5a70a6c167a1730e63a5"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
"synstructure",
|
"synstructure",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
@ -4538,7 +4571,7 @@ checksum = "6eafa6dfb17584ea3e2bd6e76e0cc15ad7af12b09abdd1ca55961bed9b1063c6"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"proc-macro2",
|
"proc-macro2",
|
||||||
"quote",
|
"quote",
|
||||||
"syn",
|
"syn 2.0.90",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
|
||||||
|
|
@ -49,6 +49,8 @@ anyhow = { workspace = true }
|
||||||
dir-test = { workspace = true }
|
dir-test = { workspace = true }
|
||||||
insta = { workspace = true }
|
insta = { workspace = true }
|
||||||
tempfile = { workspace = true }
|
tempfile = { workspace = true }
|
||||||
|
quickcheck = { version = "1.0.3", default-features = false }
|
||||||
|
quickcheck_macros = { version = "1.0.0" }
|
||||||
|
|
||||||
[lints]
|
[lints]
|
||||||
workspace = true
|
workspace = true
|
||||||
|
|
|
||||||
|
|
@ -40,6 +40,9 @@ mod signatures;
|
||||||
mod string_annotation;
|
mod string_annotation;
|
||||||
mod unpacker;
|
mod unpacker;
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod property_tests;
|
||||||
|
|
||||||
#[salsa::tracked(return_ref)]
|
#[salsa::tracked(return_ref)]
|
||||||
pub fn check_types(db: &dyn Db, file: File) -> TypeCheckDiagnostics {
|
pub fn check_types(db: &dyn Db, file: File) -> TypeCheckDiagnostics {
|
||||||
let _span = tracing::trace_span!("check_types", file=?file.path(db)).entered();
|
let _span = tracing::trace_span!("check_types", file=?file.path(db)).entered();
|
||||||
|
|
@ -3083,8 +3086,8 @@ pub(crate) mod tests {
|
||||||
|
|
||||||
/// A test representation of a type that can be transformed unambiguously into a real Type,
|
/// A test representation of a type that can be transformed unambiguously into a real Type,
|
||||||
/// given a db.
|
/// given a db.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone, PartialEq)]
|
||||||
enum Ty {
|
pub(crate) enum Ty {
|
||||||
Never,
|
Never,
|
||||||
Unknown,
|
Unknown,
|
||||||
None,
|
None,
|
||||||
|
|
@ -3108,7 +3111,7 @@ pub(crate) mod tests {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Ty {
|
impl Ty {
|
||||||
fn into_type(self, db: &TestDb) -> Type<'_> {
|
pub(crate) fn into_type(self, db: &TestDb) -> Type<'_> {
|
||||||
match self {
|
match self {
|
||||||
Ty::Never => Type::Never,
|
Ty::Never => Type::Never,
|
||||||
Ty::Unknown => Type::Unknown,
|
Ty::Unknown => Type::Unknown,
|
||||||
|
|
|
||||||
237
crates/red_knot_python_semantic/src/types/property_tests.rs
Normal file
237
crates/red_knot_python_semantic/src/types/property_tests.rs
Normal file
|
|
@ -0,0 +1,237 @@
|
||||||
|
//! This module contains quickcheck-based property tests for `Type`s.
|
||||||
|
//!
|
||||||
|
//! These tests are disabled by default, as they are non-deterministic and slow. You can
|
||||||
|
//! run them explicitly using:
|
||||||
|
//!
|
||||||
|
//! ```sh
|
||||||
|
//! cargo test -p red_knot_python_semantic -- --ignored types::property_tests::stable
|
||||||
|
//! ```
|
||||||
|
//!
|
||||||
|
//! The number of tests (default: 100) can be controlled by setting the `QUICKCHECK_TESTS`
|
||||||
|
//! environment variable. For example:
|
||||||
|
//!
|
||||||
|
//! ```sh
|
||||||
|
//! QUICKCHECK_TESTS=10000 cargo test …
|
||||||
|
//! ```
|
||||||
|
//!
|
||||||
|
//! If you want to run these tests for a longer period of time, it's advisable to run them
|
||||||
|
//! in release mode. As some tests are slower than others, it's advisable to run them in a
|
||||||
|
//! loop until they fail:
|
||||||
|
//!
|
||||||
|
//! ```sh
|
||||||
|
//! export QUICKCHECK_TESTS=100000
|
||||||
|
//! while cargo test --release -p red_knot_python_semantic -- \
|
||||||
|
//! --ignored types::property_tests::stable; do :; done
|
||||||
|
//! ```
|
||||||
|
|
||||||
|
use std::sync::{Arc, Mutex, MutexGuard, OnceLock};
|
||||||
|
|
||||||
|
use super::tests::{setup_db, Ty};
|
||||||
|
use crate::db::tests::TestDb;
|
||||||
|
use crate::types::KnownClass;
|
||||||
|
use quickcheck::{Arbitrary, Gen};
|
||||||
|
|
||||||
|
fn arbitrary_core_type(g: &mut Gen) -> Ty {
|
||||||
|
// We could select a random integer here, but this would make it much less
|
||||||
|
// likely to explore interesting edge cases:
|
||||||
|
let int_lit = Ty::IntLiteral(*g.choose(&[-2, -1, 0, 1, 2]).unwrap());
|
||||||
|
let bool_lit = Ty::BooleanLiteral(bool::arbitrary(g));
|
||||||
|
g.choose(&[
|
||||||
|
Ty::Never,
|
||||||
|
Ty::Unknown,
|
||||||
|
Ty::None,
|
||||||
|
Ty::Any,
|
||||||
|
int_lit,
|
||||||
|
bool_lit,
|
||||||
|
Ty::StringLiteral(""),
|
||||||
|
Ty::StringLiteral("a"),
|
||||||
|
Ty::LiteralString,
|
||||||
|
Ty::BytesLiteral(""),
|
||||||
|
Ty::BytesLiteral("\x00"),
|
||||||
|
Ty::KnownClassInstance(KnownClass::Object),
|
||||||
|
Ty::KnownClassInstance(KnownClass::Str),
|
||||||
|
Ty::KnownClassInstance(KnownClass::Int),
|
||||||
|
Ty::KnownClassInstance(KnownClass::Bool),
|
||||||
|
Ty::KnownClassInstance(KnownClass::List),
|
||||||
|
Ty::KnownClassInstance(KnownClass::Tuple),
|
||||||
|
Ty::KnownClassInstance(KnownClass::FunctionType),
|
||||||
|
Ty::KnownClassInstance(KnownClass::SpecialForm),
|
||||||
|
Ty::KnownClassInstance(KnownClass::TypeVar),
|
||||||
|
Ty::KnownClassInstance(KnownClass::TypeAliasType),
|
||||||
|
Ty::KnownClassInstance(KnownClass::NoDefaultType),
|
||||||
|
Ty::TypingLiteral,
|
||||||
|
Ty::BuiltinClassLiteral("str"),
|
||||||
|
Ty::BuiltinClassLiteral("int"),
|
||||||
|
Ty::BuiltinClassLiteral("bool"),
|
||||||
|
Ty::BuiltinClassLiteral("object"),
|
||||||
|
])
|
||||||
|
.unwrap()
|
||||||
|
.clone()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Constructs an arbitrary type.
|
||||||
|
///
|
||||||
|
/// The `size` parameter controls the depth of the type tree. For example,
|
||||||
|
/// a simple type like `int` has a size of 0, `Union[int, str]` has a size
|
||||||
|
/// of 1, `tuple[int, Union[str, bytes]]` has a size of 2, etc.
|
||||||
|
fn arbitrary_type(g: &mut Gen, size: u32) -> Ty {
|
||||||
|
if size == 0 {
|
||||||
|
arbitrary_core_type(g)
|
||||||
|
} else {
|
||||||
|
match u32::arbitrary(g) % 4 {
|
||||||
|
0 => arbitrary_core_type(g),
|
||||||
|
1 => Ty::Union(
|
||||||
|
(0..*g.choose(&[2, 3]).unwrap())
|
||||||
|
.map(|_| arbitrary_type(g, size - 1))
|
||||||
|
.collect(),
|
||||||
|
),
|
||||||
|
2 => Ty::Tuple(
|
||||||
|
(0..*g.choose(&[0, 1, 2]).unwrap())
|
||||||
|
.map(|_| arbitrary_type(g, size - 1))
|
||||||
|
.collect(),
|
||||||
|
),
|
||||||
|
3 => Ty::Intersection {
|
||||||
|
pos: (0..*g.choose(&[0, 1, 2]).unwrap())
|
||||||
|
.map(|_| arbitrary_type(g, size - 1))
|
||||||
|
.collect(),
|
||||||
|
neg: (0..*g.choose(&[0, 1, 2]).unwrap())
|
||||||
|
.map(|_| arbitrary_type(g, size - 1))
|
||||||
|
.collect(),
|
||||||
|
},
|
||||||
|
_ => unreachable!(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Arbitrary for Ty {
|
||||||
|
fn arbitrary(g: &mut Gen) -> Ty {
|
||||||
|
const MAX_SIZE: u32 = 2;
|
||||||
|
arbitrary_type(g, MAX_SIZE)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn shrink(&self) -> Box<dyn Iterator<Item = Self>> {
|
||||||
|
// This is incredibly naive. We can do much better here by
|
||||||
|
// trying various subsets of the elements in unions, tuples,
|
||||||
|
// and intersections. For now, we only try to shrink by
|
||||||
|
// reducing unions/tuples/intersections to a single element.
|
||||||
|
match self.clone() {
|
||||||
|
Ty::Union(types) => Box::new(types.into_iter()),
|
||||||
|
Ty::Tuple(types) => Box::new(types.into_iter()),
|
||||||
|
Ty::Intersection { pos, neg } => Box::new(pos.into_iter().chain(neg)),
|
||||||
|
_ => Box::new(std::iter::empty()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static CACHED_DB: OnceLock<Arc<Mutex<TestDb>>> = OnceLock::new();
|
||||||
|
|
||||||
|
fn get_cached_db() -> MutexGuard<'static, TestDb> {
|
||||||
|
let db = CACHED_DB.get_or_init(|| Arc::new(Mutex::new(setup_db())));
|
||||||
|
db.lock().unwrap()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A macro to define a property test for types.
|
||||||
|
///
|
||||||
|
/// The `$test_name` identifier specifies the name of the test function. The `$db` identifier
|
||||||
|
/// is used to refer to the salsa database in the property to be tested. The actual property is
|
||||||
|
/// specified using the syntax:
|
||||||
|
///
|
||||||
|
/// forall types t1, t2, ..., tn . <property>`
|
||||||
|
///
|
||||||
|
/// where `t1`, `t2`, ..., `tn` are identifiers that represent arbitrary types, and `<property>`
|
||||||
|
/// is an expression using these identifiers.
|
||||||
|
///
|
||||||
|
macro_rules! type_property_test {
|
||||||
|
($test_name:ident, $db:ident, forall types $($types:ident),+ . $property:expr) => {
|
||||||
|
#[quickcheck_macros::quickcheck]
|
||||||
|
#[ignore]
|
||||||
|
fn $test_name($($types: crate::types::tests::Ty),+) -> bool {
|
||||||
|
let db_cached = super::get_cached_db();
|
||||||
|
let $db = &*db_cached;
|
||||||
|
$(let $types = $types.into_type($db);)+
|
||||||
|
|
||||||
|
$property
|
||||||
|
}
|
||||||
|
};
|
||||||
|
// A property test with a logical implication.
|
||||||
|
($name:ident, $db:ident, forall types $($types:ident),+ . $premise:expr => $conclusion:expr) => {
|
||||||
|
type_property_test!($name, $db, forall types $($types),+ . !($premise) || ($conclusion));
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
mod stable {
|
||||||
|
// `T` is equivalent to itself.
|
||||||
|
type_property_test!(
|
||||||
|
equivalent_to_is_reflexive, db,
|
||||||
|
forall types t. t.is_equivalent_to(db, t)
|
||||||
|
);
|
||||||
|
|
||||||
|
// `T` is a subtype of itself.
|
||||||
|
type_property_test!(
|
||||||
|
subtype_of_is_reflexive, db,
|
||||||
|
forall types t. t.is_subtype_of(db, t)
|
||||||
|
);
|
||||||
|
|
||||||
|
// `S <: T` and `T <: U` implies that `S <: U`.
|
||||||
|
type_property_test!(
|
||||||
|
subtype_of_is_transitive, db,
|
||||||
|
forall types s, t, u. s.is_subtype_of(db, t) && t.is_subtype_of(db, u) => s.is_subtype_of(db, u)
|
||||||
|
);
|
||||||
|
|
||||||
|
// `T` is not disjoint from itself, unless `T` is `Never`.
|
||||||
|
type_property_test!(
|
||||||
|
disjoint_from_is_irreflexive, db,
|
||||||
|
forall types t. t.is_disjoint_from(db, t) => t.is_never()
|
||||||
|
);
|
||||||
|
|
||||||
|
// `S` is disjoint from `T` implies that `T` is disjoint from `S`.
|
||||||
|
type_property_test!(
|
||||||
|
disjoint_from_is_symmetric, db,
|
||||||
|
forall types s, t. s.is_disjoint_from(db, t) == t.is_disjoint_from(db, s)
|
||||||
|
);
|
||||||
|
|
||||||
|
// `S <: T` implies that `S` is not disjoint from `T`, unless `S` is `Never`.
|
||||||
|
type_property_test!(
|
||||||
|
subtype_of_implies_not_disjoint_from, db,
|
||||||
|
forall types s, t. s.is_subtype_of(db, t) => !s.is_disjoint_from(db, t) || s.is_never()
|
||||||
|
);
|
||||||
|
|
||||||
|
// `T` can be assigned to itself.
|
||||||
|
type_property_test!(
|
||||||
|
assignable_to_is_reflexive, db,
|
||||||
|
forall types t. t.is_assignable_to(db, t)
|
||||||
|
);
|
||||||
|
|
||||||
|
// `S <: T` implies that `S` can be assigned to `T`.
|
||||||
|
type_property_test!(
|
||||||
|
subtype_of_implies_assignable_to, db,
|
||||||
|
forall types s, t. s.is_subtype_of(db, t) => s.is_assignable_to(db, t)
|
||||||
|
);
|
||||||
|
|
||||||
|
// If `T` is a singleton, it is also single-valued.
|
||||||
|
type_property_test!(
|
||||||
|
singleton_implies_single_valued, db,
|
||||||
|
forall types t. t.is_singleton(db) => t.is_single_valued(db)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// This module contains property tests that currently lead to many false positives.
|
||||||
|
///
|
||||||
|
/// The reason for this is our insufficient understanding of equivalence of types. For
|
||||||
|
/// example, we currently consider `int | str` and `str | int` to be different types.
|
||||||
|
/// Similar issues exist for intersection types. Once this is resolved, we can move these
|
||||||
|
/// tests to the `stable` section. In the meantime, it can still be useful to run these
|
||||||
|
/// tests (using [`types::property_tests::flaky`]), to see if there are any new obvious bugs.
|
||||||
|
mod flaky {
|
||||||
|
// `S <: T` and `T <: S` implies that `S` is equivalent to `T`.
|
||||||
|
type_property_test!(
|
||||||
|
subtype_of_is_antisymmetric, db,
|
||||||
|
forall types s, t. s.is_subtype_of(db, t) && t.is_subtype_of(db, s) => s.is_equivalent_to(db, t)
|
||||||
|
);
|
||||||
|
|
||||||
|
// Negating `T` twice is equivalent to `T`.
|
||||||
|
type_property_test!(
|
||||||
|
double_negation_is_identity, db,
|
||||||
|
forall types t. t.negate(db).negate(db).is_equivalent_to(db, t)
|
||||||
|
);
|
||||||
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue