diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..f1cf9b7 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,17 @@ +# Please see the documentation for all configuration options: +# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file + +version: 2 +updates: + - package-ecosystem: "cargo" + directory: "/" + schedule: + interval: "weekly" + ignore: + # These are peer deps of Cargo and should not be automatically bumped + - dependency-name: "semver" + - dependency-name: "crates-io" + rebase-strategy: "disabled" + labels: + - "C-automated-creation" + - "A-dependencies" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..c5e7efb --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,41 @@ +name: Cargo Build & Test + +on: + push: + pull_request: + +env: + CARGO_TERM_COLOR: always + RUSTFLAGS: -Dwarnings + +jobs: + build_and_test: + name: unhindered-ec - stochest - latest + runs-on: ubuntu-latest + strategy: + # This ensures that all three toolchains will run even if one of + # them fails. This, for example, prevents a `nightly` failure + # from blocking `stable` and `beta` from running. + fail-fast: false + matrix: + toolchain: + - stable + - beta + - nightly + steps: + - uses: actions/checkout@v3 + - uses: dtolnay/rust-toolchain@master + with: + components: clippy, rustfmt + toolchain: ${{ matrix.toolchain }} + - run: cargo build --verbose + - run: cargo test --verbose + - run: cargo clippy --all-targets + - run: cargo install rustfmt-unstable + # Currently (v1.x) rustfmt accepts unstable features as + # arguments only, this wrapper reads the file and passes + # them as arguments. Rustfmt v2.x won't have this limitation + # anymore and then this wrapper can be removed. + - run: rustfmt-unstable --config-file rustfmt.toml -- cargo fmt --check -- --config error_on_line_overflow=true + - run: cargo install example-runner-cli + - run: example-runner-cli --error-on-unconfigured --error-on-unknown --parallel diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..03175ab --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +/target + +packages/rust-lexicase/.env/ + +tarpaulin-report.html + +flamegraph.svg + +report.html + +/mutants.out* \ No newline at end of file diff --git a/.helix/languages.toml b/.helix/languages.toml new file mode 100644 index 0000000..c8e9859 --- /dev/null +++ b/.helix/languages.toml @@ -0,0 +1,5 @@ +[language-server.rust-analyzer.config.rustfmt] +overrideCommand = ["rustfmt-unstable", "--", "rustfmt", "--edition", "2021"] + +[language-server.rust-analyzer.config.check] +overrideCommand = ["cargo","+nightly","clippy","--all-targets","--workspace","--message-format=json-diagnostic-rendered-ansi"] diff --git a/.mailmap b/.mailmap new file mode 100644 index 0000000..25793ff --- /dev/null +++ b/.mailmap @@ -0,0 +1,2 @@ +Justus Flügel +Nic McPhee diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9a5f881 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,47 @@ +{ + "cSpell.words": [ + "Bitstring", + "Bitstrings", + "Clojush", + "Conv", + "Dataless", + "esitsu", + "GECCO", + "Goues", + "Helmuth", + "hiff", + "lexicase", + "Mizard", + "proptest", + "Pysh", + "recombinate", + "Recombinator", + "recombinators", + "rngs", + "Scorable", + "scottmcm's", + "Spector", + "thiserror", + "typestate", + "UMAD", + "underflowed", + "underflows", + "Wrappable" + ], + "todo-tree.tree.showCountsInTree": true, + "rust-analyzer.rustfmt.overrideCommand": [ + "rustfmt-unstable", + "--", + "rustfmt", + "--edition", + "2021" + ], + "rust-analyzer.check.overrideCommand": [ + "cargo", + "+nightly", + "clippy", + "--all-targets", + "--workspace", + "--message-format=json-diagnostic-rendered-ansi" + ], +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ee61c86 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# IDE setup +We are currently using unstable rustfmt features in our rustfmt.toml, which isn't supported through rustfmt stable natively, as rustfmt v1 stable only supports unstable options via the command line. As such we are currently using a small wrapper around rustfmt, called `rustfmt-unstable`, which essentially passes the arguments in the config file via the cli. + +To be consistent in ci & in our local development experience, we also overwrote the rustfmt command for rust-analyzer in both vscode and helix. +If you are using one of these editors you will need to install rustfmt-unstable via `cargo install rustfmt-unstable` to get formatting working. diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000..3dfc65e --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,73 @@ +Short version for non-lawyers: + +The Unhindered-EC Project, which includes the `stochest` library, +is dual-licensed under Apache 2.0 and MIT terms. + + +Longer version: + +Copyrights in the Unhindered-EC project are retained by their contributors. No +copyright assignment is required to contribute to the Unhindered-EC project. + +Some files include explicit copyright notices and/or license notices. +For full authorship information, see the version control history + +Except as otherwise noted (below and/or in individual files), Unhindered-EC is +licensed under the Apache License, Version 2.0 or + or the MIT license + or , at your option. + + +The Unhindered-EC project includes packages written by third parties. +The following third party packages are included, and carry +their own copyright notices and license terms: + +* Portions of internationalization code use code or data from Unicode, which + carry the following license: + + UNICODE, INC. LICENSE AGREEMENT - DATA FILES AND SOFTWARE + + See Terms of Use + for definitions of Unicode Inc.’s Data Files and Software. + + NOTICE TO USER: Carefully read the following legal agreement. + BY DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING UNICODE INC.'S + DATA FILES ("DATA FILES"), AND/OR SOFTWARE ("SOFTWARE"), + YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE + TERMS AND CONDITIONS OF THIS AGREEMENT. + IF YOU DO NOT AGREE, DO NOT DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE + THE DATA FILES OR SOFTWARE. + + COPYRIGHT AND PERMISSION NOTICE + + Copyright © 1991-2022 Unicode, Inc. All rights reserved. + Distributed under the Terms of Use in https://www.unicode.org/copyright.html. + + Permission is hereby granted, free of charge, to any person obtaining + a copy of the Unicode data files and any associated documentation + (the "Data Files") or Unicode software and any associated documentation + (the "Software") to deal in the Data Files or Software + without restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, and/or sell copies of + the Data Files or Software, and to permit persons to whom the Data Files + or Software are furnished to do so, provided that either + (a) this copyright and permission notice appear with all copies + of the Data Files or Software, or + (b) this copyright and permission notice appear in associated + Documentation. + + THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF + ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT OF THIRD PARTY RIGHTS. + IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS + NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL + DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, + DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER + TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR + PERFORMANCE OF THE DATA FILES OR SOFTWARE. + + Except as contained in this notice, the name of a copyright holder + shall not be used in advertising or otherwise to promote the sale, + use or other dealings in these Data Files or Software without prior + written authorization of the copyright holder. diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..6b1f0d2 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,69 @@ +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[workspace] +resolver = "2" + +members = ["packages/*"] + +[workspace.package] +version = "0.1.0" +authors = ["Justus Flügel"] +description = "A testing framework for stochastical algorithms" +documentation = "https://github.com/unhindered-ec/stochest" +repository = "https://github.com/unhindered-ec/stockest.git" +edition = "2021" +license = "MIT OR Apache-2.0" + +[workspace.dependencies] + +[workspace.lints.clippy] +# Lint groups +# These have a priority of -1 to ensure that individual +# Lints override them, if present. +pedantic = { level = "warn", priority = -1 } +nursery = { level = "warn", priority = -1 } +cargo = { level = "warn", priority = -1 } +perf = { level = "warn", priority = -1 } +complexity = { level = "warn", priority = -1 } +correctness = { level = "deny", priority = -1 } +style = { level = "warn", priority = -1 } + + +# Individual lints +dbg_macro = "warn" +clone_on_ref_ptr = "warn" +empty_enum_variants_with_brackets = "warn" +empty_structs_with_brackets = "warn" +error_impl_error = "warn" +format_push_string = "warn" +if_then_some_else_none = "warn" +infinite_loop = "warn" +rc_buffer = "warn" +rc_mutex = "warn" +redundant_type_annotations = "warn" +rest_pat_in_fully_bound_structs = "warn" +self_named_module_files = "deny" +suspicious_xor_used_as_pow = "warn" +tests_outside_test_module = "deny" +todo = "warn" +try_err = "warn" +unnecessary_safety_comment = "warn" +unnecessary_safety_doc = "warn" +unnecessary_self_imports = "warn" +unneeded_field_pattern = "warn" +use_debug = "warn" +arithmetic_side_effects = "warn" + +unwrap_used = "warn" +expect_used = "warn" +panic = "warn" +module_name_repetitions = "allow" +as_conversions = "deny" + +# these lints rely on the lint reasons rfc +# https://github.com/rust-lang/rust/issues/54503 +# and will become active once that is in stable. +# We should get ample warning with the nightly & beta +# ci builds if we need to change anything +allow_attributes_without_reason = "warn" +allow_attributes = "deny" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE-APACHE @@ -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/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..322f202 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022-2024 Unhindered-EC Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ef6c156 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# stochest + +A testing framework for stochastical algorithms + +The goal of this crate is to provide a simple proc-macro, `#[stochest]`, which provides +infrastructure to test randomized algorithms and systems. + +The main goal of this crate for now is to provide for the needs of the `unhindered-ec` project, which +this is a part of. +(See [here](https://github.com/unhindered-ec/unhindered-ec) for more information on that). + +Although if you wish to use this project for another purpose, and features for that are missing, +contributions are always welcome :) Feel free to open a issue to discuss your Idea before spending a +bunch of time on creating your pr. + +## License + +Licensed under either of + + * Apache License, Version 2.0 + ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license + ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details. + +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/clippy.toml b/clippy.toml new file mode 100644 index 0000000..e8d1b46 --- /dev/null +++ b/clippy.toml @@ -0,0 +1 @@ +allowed-duplicate-crates = [] diff --git a/packages/stochest-macros/Cargo.toml b/packages/stochest-macros/Cargo.toml new file mode 100644 index 0000000..0b8e703 --- /dev/null +++ b/packages/stochest-macros/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "stochest-macros" +version.workspace = true +authors.workspace = true +description.workspace = true +documentation.workspace = true +repository.workspace = true +edition.workspace = true +license.workspace = true + +[lib] +proc-macro = true + +[dependencies] + +[lints] +workspace = true diff --git a/packages/stochest-macros/src/lib.rs b/packages/stochest-macros/src/lib.rs new file mode 100644 index 0000000..b93cf3f --- /dev/null +++ b/packages/stochest-macros/src/lib.rs @@ -0,0 +1,14 @@ +pub fn add(left: u64, right: u64) -> u64 { + left + right +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn it_works() { + let result = add(2, 2); + assert_eq!(result, 4); + } +} diff --git a/rustfmt.toml b/rustfmt.toml new file mode 100644 index 0000000..244256b --- /dev/null +++ b/rustfmt.toml @@ -0,0 +1,7 @@ +unstable_features=true +wrap_comments=true +format_code_in_doc_comments=true +format_strings=true +imports_granularity="Crate" +group_imports="StdExternalCrate" +version="Two"