From 7f8c4c3fe70b823a9d25e583ef7c6074ba11787c Mon Sep 17 00:00:00 2001 From: zihang Date: Wed, 25 Dec 2024 17:20:32 +0800 Subject: [PATCH] doc(quickcheck): initial commit --- next/language/tests.md | 6 +- next/sources/quickcheck/.gitignore | 3 + next/sources/quickcheck/LICENSE | 202 ++++++++++++++++++ next/sources/quickcheck/README.md | 3 + next/sources/quickcheck/moon.mod.json | 13 ++ next/sources/quickcheck/src/lib/hello.mbt | 3 + .../sources/quickcheck/src/lib/hello_test.mbt | 5 + next/sources/quickcheck/src/lib/moon.pkg.json | 1 + next/sources/quickcheck/src/moon.pkg.json | 5 + next/sources/quickcheck/src/top.mbt | 3 + next/toolchain/quickcheck.md | 40 ++++ 11 files changed, 283 insertions(+), 1 deletion(-) create mode 100644 next/sources/quickcheck/.gitignore create mode 100644 next/sources/quickcheck/LICENSE create mode 100644 next/sources/quickcheck/README.md create mode 100644 next/sources/quickcheck/moon.mod.json create mode 100644 next/sources/quickcheck/src/lib/hello.mbt create mode 100644 next/sources/quickcheck/src/lib/hello_test.mbt create mode 100644 next/sources/quickcheck/src/lib/moon.pkg.json create mode 100644 next/sources/quickcheck/src/moon.pkg.json create mode 100644 next/sources/quickcheck/src/top.mbt create mode 100644 next/toolchain/quickcheck.md diff --git a/next/language/tests.md b/next/language/tests.md index 978bfdde..a39106fd 100644 --- a/next/language/tests.md +++ b/next/language/tests.md @@ -84,4 +84,8 @@ When developing libraries, it is important to verify if the user can use it corr The WhiteBox test files (`_wbtest.mbt`) imports the packages defined in the `import` and `wbtest-import` sections of the package configuration (`moon.pkg.json`). -The BlackBox test files (`_test.mbt`) imports the current package and the packages defined in the `import` and `test-import` sections of the package configuration (`moon.pkg.json`). \ No newline at end of file +The BlackBox test files (`_test.mbt`) imports the current package and the packages defined in the `import` and `test-import` sections of the package configuration (`moon.pkg.json`). + +## Property Testing + +MoonBit has a QuickCheck library that supports writing property testing. See [Property Testing in Quickcheck](/toolchain/quickcheck.md) for details. \ No newline at end of file diff --git a/next/sources/quickcheck/.gitignore b/next/sources/quickcheck/.gitignore new file mode 100644 index 00000000..ec52756d --- /dev/null +++ b/next/sources/quickcheck/.gitignore @@ -0,0 +1,3 @@ +target/ +.mooncakes/ +.DS_Store diff --git a/next/sources/quickcheck/LICENSE b/next/sources/quickcheck/LICENSE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/next/sources/quickcheck/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/next/sources/quickcheck/README.md b/next/sources/quickcheck/README.md new file mode 100644 index 00000000..345fe65d --- /dev/null +++ b/next/sources/quickcheck/README.md @@ -0,0 +1,3 @@ +# moonbitlang-community/quickcheck + +Check `toolchains/quickcheck`. \ No newline at end of file diff --git a/next/sources/quickcheck/moon.mod.json b/next/sources/quickcheck/moon.mod.json new file mode 100644 index 00000000..1c183df4 --- /dev/null +++ b/next/sources/quickcheck/moon.mod.json @@ -0,0 +1,13 @@ +{ + "name": "username/hello", + "version": "0.1.0", + "deps": { + "moonbitlang/quickcheck": "0.6.9" + }, + "readme": "README.md", + "repository": "", + "license": "Apache-2.0", + "keywords": [], + "description": "", + "source": "src" +} \ No newline at end of file diff --git a/next/sources/quickcheck/src/lib/hello.mbt b/next/sources/quickcheck/src/lib/hello.mbt new file mode 100644 index 00000000..9012592a --- /dev/null +++ b/next/sources/quickcheck/src/lib/hello.mbt @@ -0,0 +1,3 @@ +pub fn hello() -> String { + "Hello, world!" +} diff --git a/next/sources/quickcheck/src/lib/hello_test.mbt b/next/sources/quickcheck/src/lib/hello_test.mbt new file mode 100644 index 00000000..e0e3a7d1 --- /dev/null +++ b/next/sources/quickcheck/src/lib/hello_test.mbt @@ -0,0 +1,5 @@ +test "hello" { + if @lib.hello() != "Hello, world!" { + fail!("@lib.hello() != \"Hello, world!\"") + } +} diff --git a/next/sources/quickcheck/src/lib/moon.pkg.json b/next/sources/quickcheck/src/lib/moon.pkg.json new file mode 100644 index 00000000..9e26dfee --- /dev/null +++ b/next/sources/quickcheck/src/lib/moon.pkg.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/next/sources/quickcheck/src/moon.pkg.json b/next/sources/quickcheck/src/moon.pkg.json new file mode 100644 index 00000000..6a1074db --- /dev/null +++ b/next/sources/quickcheck/src/moon.pkg.json @@ -0,0 +1,5 @@ +{ + "import": [ + "username/hello/lib" + ] +} diff --git a/next/sources/quickcheck/src/top.mbt b/next/sources/quickcheck/src/top.mbt new file mode 100644 index 00000000..7a554d06 --- /dev/null +++ b/next/sources/quickcheck/src/top.mbt @@ -0,0 +1,3 @@ +pub fn greeting() -> Unit { + println(@lib.hello()) +} diff --git a/next/toolchain/quickcheck.md b/next/toolchain/quickcheck.md new file mode 100644 index 00000000..b5ae80c1 --- /dev/null +++ b/next/toolchain/quickcheck.md @@ -0,0 +1,40 @@ +# Property testing in QuickCheck + +## Property testing + +Property testing is about testing a given property based on random inputs. + +For example, the following is a property that holds for `Array` + +> For any `n` that is non-negative (and within range of `Int` due to implementation limit): +after `n` insertions, the `length` method should return exactly `n`. + +Using normal testing, we may just test several cases for `n`, often neglecting the corner cases. With property testing, however, +random test data are generated, making it possible to generate unexpected input. + +## QuickCheck + +QuickCheck was originally introduced in paper [QuickCheck: a lightweight tool for random testing of Haskell programs](https://doi.org/10.1145/351240.351266), +which became [the Haskell library](https://github.com/nick8325/quickcheck) that popularized the property testing. + +MoonBit has introduced QuickCheck and made some modifications to it. + +## Using QuickCheck + +To use the library, you need to add `moonbitlang/quickcheck` as dependency. We assume you are familiar with the module / package system in MoonBit. Otherwise check out [package manage tour](/toolchain/moon/package-manage-tour.md). + +### Implementing `Arbitrary` + +The framework needs to know how to generate data for a given type. + +To do so, we need to implement the `Arbitrary` trait for our data. + +### Writing Tests + +We need to define a property and let it execute. + +### Shrinking + +## Reference + +[README of QuickCheck](https://github.com/moonbitlang/quickcheck) \ No newline at end of file