diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Revision history for quickcheck-silent + +## 0 -- 2026-08-06 + +* First version. Released on an unsuspecting world. + +## References + +* Use of a fourth component [Version scheme][haskell-stack-ver]. + +[haskell-stack-ver]: https://docs.haskellstack.org/en/stable/maintainers/version_scheme/#use-of-a-fourth-component diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +quickcheck-silent +====== + +[![Hackage](https://img.shields.io/hackage/v/quickcheck-silent.svg)](https://hackage.haskell.org/package/quickcheck-silent) + +Testing with [QuickCheck][hackage-quickcheck] in silence. + +[hackage-quickcheck]: https://hackage.haskell.org/package/QuickCheck + +Project structure +================= + +```sh +|-- src +| `-- Test +| `-- QuickCheck +| `-- Silent.hs +|-- CHANGELOG.md +|-- LICENSE.txt +|-- README.md +|-- Setup.hs +`-- quickcheck-silent.cabal +``` diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,18 @@ +{-# OPTIONS_GHC -Wall -Werror #-} + +-------------------------------------------------------------------------------- + +-- | +-- Copyright : (c) 2026 SPISE MISU ApS +-- License : LGPL-3.0-only +-- Maintainer : SPISE MISU +-- Stability : experimental + +-------------------------------------------------------------------------------- + +import Distribution.Simple ( defaultMain ) + +-------------------------------------------------------------------------------- + +main :: IO () +main = defaultMain diff --git a/quickcheck-silent.cabal b/quickcheck-silent.cabal new file mode 100644 --- /dev/null +++ b/quickcheck-silent.cabal @@ -0,0 +1,141 @@ +cabal-version: 3.6 + +-------------------------------------------------------------------------------- +-- +-- quickcheck-silent, +-- (c) 2026 SPISE MISU ApS, https://spdx.org/licenses/LGPL-3.0-only +-- +-------------------------------------------------------------------------------- + +build-type: Simple + +name: quickcheck-silent +version: 0.11.0.0 + +synopsis: Testing with QuickCheck in silence +description: Testing with QuickCheck in silence. For more info see README.md + +license: LGPL-3.0-only +license-file: LICENSE.txt + +author: SPISE MISU +maintainer: SPISE MISU +copyright: (c) 2026 SPISE MISU ApS + +stability: experimental + +category: Testing + +extra-doc-files: README.md, CHANGELOG.md + +tested-with: + GHC == 9.4.8 + GHC == 9.6.7 + GHC == 9.8.4 + GHC == 9.10.3 + GHC == 9.12.4 + +source-repository head + type: + git + location: + https://gitlab.com/spisemisu/quickcheck-silent + +-------------------------------------------------------------------------------- +-- COMMON +-------------------------------------------------------------------------------- + +common base + default-extensions: + Safe + default-language: + Haskell2010 + build-depends: + -- Prelude + base >= 4 && < 5 + -- Test + , QuickCheck >= 2.1 && < 3 + ghc-options: + -------------------------------------------------------------------------- + -- GHC 9.10.3 Users Guide + -- 9. Using GHC > 9.2. Warnings and sanity-checking + -- * Base: https://downloads.haskell.org/~ghc/9.10.3/docs/users_guide/ + -- * File: using-warnings.html + -- Warnings that are not enabled by -Wall: + -------------------------------------------------------------------------- + -Wall + -Wincomplete-record-updates + -- -Wmonomorphism-restriction + -- -Wimplicit-prelude + -- -Wmissing-local-signatures + -Wmissing-exported-signatures + -- -Wmissing-export-lists + -- -Wmissing-import-lists + -Wmissing-home-modules + -Widentities + -- -Wredundant-constraints + -- Added since GHC 8.4 + -Wpartial-fields + -- -Wmissed-specialisations + -- -Wall-missed-specialisations + -------------------------------------------------------------------------- + -- Added to allow instance definition in other files, in order to keep the + -- Effect module SAFE so it can be imported by the Process + -------------------------------------------------------------------------- + -Wno-orphans + -- Makes any warning into a fatal error. + -- -Werror + -------------------------------------------------------------------------- + -- Deterministic builds (Uniques): + -- * https://gitlab.haskell.org/ghc/ghc/wikis/deterministic-builds#progress + -- * https://www.youtube.com/watch?v=FNzTk4P4fL4 (08 GHC Determinism ICFP) + -------------------------------------------------------------------------- + -- -dinitial-unique=0 + -- -dunique-increment=1 + -------------------------------------------------------------------------- + -- GHC 9.10.3 Users Guide + -- 19. Known bugs and infelicities > + -- 19.1. Haskell standards vs. Glasgow Haskell: language non-compliance > + -- 19.1.1.3. Expressions and pointers + -- * Base: https://downloads.haskell.org/~ghc/9.10.3/docs/users_guide/ + -- * File: bugs.html + -------------------------------------------------------------------------- + -fpedantic-bottoms + -- To use when GHC uses to many ticks: + -- -ddump-simpl-stats + -- -fsimpl-tick-factor=100 + -------------------------------------------------------------------------- + -- GHC 9.10.3 Users Guide + -- 12.40. Safe Haskell > ... > 12.40.1.1. Strict type-safety (good style) + -- * Enforce good style, similar to the function of -Wall. + -- Only Trustworthy packages can be trusted + -- * Base: https://downloads.haskell.org/~ghc/9.10.3/docs/users_guide/ + -- * File: safe_haskell.html + -------------------------------------------------------------------------- + -fpackage-trust + -- Base + -trust=base + -- Test + -trust=QuickCheck + -trust=array + -trust=deepseq + -trust=ghc-prim + -trust=random + -trust=splitmix + if impl(ghc >= 9.10 && < 9.13) + ghc-options: + -- Base + -- NOTE: Issue with Hackage that builds with 9.8.4. 9.10.x requies this: + -trust=ghc-internal + +library + import: + base + hs-source-dirs: + src + exposed-modules: + Test.QuickCheck.Silent + +-- Reference +-- +-- - https://cabal.readthedocs.io/en/latest/cabal-package-description-file.html#pkg-field-tested-with diff --git a/src/Test/QuickCheck/Silent.hs b/src/Test/QuickCheck/Silent.hs new file mode 100644 --- /dev/null +++ b/src/Test/QuickCheck/Silent.hs @@ -0,0 +1,83 @@ +{-# OPTIONS_GHC -Wall -Werror #-} + +{-# LANGUAGE NoGeneralizedNewtypeDeriving #-} +{-# LANGUAGE Safe #-} + +-------------------------------------------------------------------------------- + +-- | +-- Copyright : (c) 2026 SPISE MISU ApS +-- License : LGPL-3.0-only +-- Maintainer : SPISE MISU +-- Stability : experimental +-- +-- Testing with QuickCheck in silence + +-------------------------------------------------------------------------------- + +module Test.QuickCheck.Silent + ( -- * Property without IO + SilentProp () + , silent + , Test.QuickCheck.Silent.withNumTests + -- * Running tests + , quickCheckSilent + ) +where + +-------------------------------------------------------------------------------- + +import Test.QuickCheck + ( Property + , Result + , Testable + , chatty + , property + , quickCheckWithResult + , stdArgs + , withNumTests + ) + +-------------------------------------------------------------------------------- + +-- | A `Testable` silent property. +newtype SilentProp = SilentProp { prop :: Property } + +-------------------------------------------------------------------------------- + +-- | Convert a `Testable` thing, without 'System.IO.IO' effects, to a silent +-- property. +silent + :: Testable prop + => prop + -> SilentProp +silent = + SilentProp . property + +-- | Configures how many times a silent property will be tested. +-- +-- For example, +-- +-- > quickCheckSilent [withNumTests 1000 p] +-- +-- will test @p@ up to 1000 times. +withNumTests + :: Testable prop + => Int + -> prop + -> SilentProp +withNumTests n = + SilentProp . Test.QuickCheck.withNumTests n + +-------------------------------------------------------------------------------- + +-- | Tests a sequence of silent properties, producing a list of results, without +-- printing them to 'System.IO.stdout'. +quickCheckSilent + :: [SilentProp] + -> IO [Result] +quickCheckSilent = + mapM (aux . prop) + where + aux = + quickCheckWithResult $ stdArgs { chatty = False }