From 37f717f5e3a6562de9162e12e9374ce5d75530c7 Mon Sep 17 00:00:00 2001
From: nicoo <nicoo@debian.org>
Date: Mon, 3 Aug 2020 14:01:08 +0200
Subject: [PATCH] factor: Add tests against (random) numbers with known
 factorisations (#1573) (#1578)

* factor::Factors: Derive implementations of Eq and PartialEq

* factors::Factors: Implement quickcheck::Arbitrary

This generates uniformly-distributed integers with known factorisations,
and will enable further testing.

* factor: Test against random numbers with known factorisations

* factor::Factors::arbitrary: Simplify method signature
---
 src/uu/factor/src/factor.rs | 39 +++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

diff --git a/src/uu/factor/src/factor.rs b/src/uu/factor/src/factor.rs
index a1c7bf231..dca485f37 100644
--- a/src/uu/factor/src/factor.rs
+++ b/src/uu/factor/src/factor.rs
@@ -13,7 +13,7 @@ use std::fmt;
 use crate::numeric::{Arithmetic, Montgomery};
 use crate::{miller_rabin, rho, table};
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Eq, PartialEq)]
 pub struct Factors {
     f: BTreeMap<u64, u8>,
 }
@@ -114,7 +114,7 @@ pub fn factor(mut n: u64) -> Factors {
 
 #[cfg(test)]
 mod tests {
-    use super::factor;
+    use super::{factor, Factors};
     use quickcheck::quickcheck;
 
     #[test]
@@ -148,5 +148,40 @@ mod tests {
         fn factor_recombines(i: u64) -> bool {
             i == 0 || factor(i).product() == i
         }
+
+        fn recombines_factors(f: Factors) -> bool {
+            factor(f.product()) == f
+        }
+    }
+}
+
+#[cfg(test)]
+impl quickcheck::Arbitrary for Factors {
+    fn arbitrary<G: quickcheck::Gen>(gen: &mut G) -> Self {
+        use rand::Rng;
+        let mut f = Factors::one();
+        let mut g = 1u64;
+        let mut n = u64::MAX;
+
+        // Adam Kalai's algorithm for generating uniformly-distributed
+        // integers and their factorisation.
+        //
+        // See Generating Random Factored Numbers, Easily, J. Cryptology (2003)
+        'attempt: loop {
+            while n > 1 {
+                n = gen.gen_range(1, n);
+                if miller_rabin::is_prime(n) {
+                    if let Some(h) = g.checked_mul(n) {
+                        f.push(n);
+                        g = h;
+                    } else {
+                        // We are overflowing u64, retry
+                        continue 'attempt;
+                    }
+                }
+            }
+
+            return f;
+        }
     }
 }