typelevel / typelevel/scalacheck

Add edge cases to Gen.choose[BigInt]

Open
#993 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
2k
Forks
393
Avg merge
6h 42m
Merged PRs (30d)
4

Description

The following property test should clearly fail:

object ScalaCheckCheck extends Properties("Gen.choose[BigInt]"):

  override def overrideParameters( params: Parameters ): Parameters
    = params.withMinSuccessfulTests(1_000_000)

  property("covers all bit lengths") = forAll(
    Gen.choose[BigInt](0, BigInt(1) << 64)
  )( _.bitLength > 32 )

end ScalaCheckCheck

But since Gen.choose[BigInt] samples uniformly, the chances of the test above (correctly) failing are less than 3 in 10_000.
The documentation does not mandate that Gen.choose[BigInt] samples uniformly, so I propose adding the following edge cases and sampling methods to Choose[BigInt]:

  1. {0, ±1, ±2, ± Byte.MaxValue ± 1, ± Short.MaxValue ± 1, ...} (provided they are in range)
  2. Randomly chosen small primes or probable primes
  3. Products of 2 or 3 small/probable primes
  4. Random Powers of 2
  5. "Sparse" BigInt values with uniformly random bitLength and uniformly random number of 1-bits

If these additions are acceptable, I would be willing to work on an according PR.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Gen.choose[BigInt] and Choose[BigInt], then reproduce the supplied ScalaCheckCheck property using the stated one-million-test parameter. Review whether the proposed boundary values, primes, products, powers of two, and sparse values should be included, and define the accepted sampling behavior and edge-case coverage before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.