dir-test-0.4.1/.cargo_vcs_info.json0000644000000001460000000000100125720ustar { "git": { "sha1": "cad02fb09a3d49df591a3bb6cb03e9ecc0250a65" }, "path_in_vcs": "dir-test" }dir-test-0.4.1/Cargo.toml0000644000000022370000000000100105730ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" name = "dir-test" version = "0.4.1" authors = ["The Fe Project Developers"] build = false autolib = false autobins = false autoexamples = false autotests = false autobenches = false description = "Provides a macro to generate tests from files in a directory" readme = "README.md" keywords = [ "test", "dir", "directory", "macro", ] categories = [ "development-tools", "filesystem", ] license = "Apache-2.0" repository = "https://github.com/fe-lang/dir-test" [lib] name = "dir_test" path = "src/lib.rs" [[test]] name = "main" path = "tests/main.rs" [dependencies.dir-test-macros] version = "0.4.1" [dev-dependencies.trybuild] version = "1.0" features = ["diff"] dir-test-0.4.1/Cargo.toml.orig000064400000000000000000000010131046102023000142430ustar 00000000000000[package] name = "dir-test" authors = ["The Fe Project Developers"] version = "0.4.1" readme = "README.md" edition = "2021" license = "Apache-2.0" repository = "https://github.com/fe-lang/dir-test" description = "Provides a macro to generate tests from files in a directory" keywords = ["test", "dir", "directory", "macro"] categories = ["development-tools", "filesystem"] [dependencies] dir-test-macros = { version = "0.4.1", path = "../macros" } [dev-dependencies] trybuild = { version = "1.0", features = ["diff"] } dir-test-0.4.1/LICENSE000064400000000000000000000261351046102023000123750ustar 00000000000000 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. dir-test-0.4.1/README.md000064400000000000000000000067241046102023000126510ustar 00000000000000[![CI](https://github.com/fe-lang/dir-test/workflows/CI/badge.svg)](https://github.com/fe-lang/dir-test/actions/workflows/ci.yml) [![Crates.io](https://img.shields.io/crates/v/dir-test.svg)](https://crates.io/crates/dir-test) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) `dir-test` provides a macro to generate single test cases from files in a directory. ## Usage Add the following dependency to your `Cargo.toml`. ``` toml [dev-dependencies] dir-test = "0.4" ``` ### Basic Usage ```rust, no_run use dir_test::{dir_test, Fixture}; #[dir_test( dir: "$CARGO_MANIFEST_DIR/fixtures", glob: "**/*.txt", )] fn mytest(fixture: Fixture<&str>) { // The file content and the absolute path of the file are available as follows. let content = fixture.content(); let path = fixture.path(); // Write your test code here. // ... } ``` Assuming your crate is as follows, then the above code generates two test cases `mytest__foo()` and `mytest__fixtures_a_bar()`. ```text my-crate/ ├─ fixtures/ │ ├─ foo.txt │ ├─ fixtures_a/ │ │ ├─ bar.txt ├─ src/ │ ├─ ... │ ├─ lib.rs ├─ Cargo.toml ├─ README.md ``` 🔽 ```rust, no_run #[test] fn mytest__foo() { mytest(fixture); } #[test] fn mytest__fixtures_a_bar() { mytest(fixture); } ``` **NOTE**: The `dir` argument must be specified in an absolute path because of the limitation of the current procedural macro system. Consider using environment variables, `dir-test` crate resolves environment variables internally. ### Custom Loader You can specify a custom loader function to load the file content from the file path. The loader will be passed `&'static str` file path and can return an arbitrary type. ```rust, no_run use dir_test::{dir_test, Fixture}; #[dir_test( dir: "$CARGO_MANIFEST_DIR/fixtures", glob: "**/*.txt", loader: std::fs::read_to_string, )] fn test(fixture: Fixture>) { let content = fixture.content().unwrap(); // ... } ``` If the loader function is not specified, the default content type is `&'static str`. ### Custom Test Name Test names can be customized by specifying the `postfix` argument. `postfix` is appended to the test name. ```rust, no_run use dir_test::{dir_test, Fixture}; #[dir_test( dir: "$CARGO_MANIFEST_DIR/fixtures", glob: "**/*.txt", postfix: "custom", // `_custom` is appended to the test name. )] fn test(fixture: Fixture>) { // ... } ``` ### Test Attributes Test attributes can specified by the `dir_test_attr` attribute. The attributes inside `dir_test_atrr` are applied to the all generated test. ```rust, no_run use dir_test::{dir_test, Fixture}; #[dir_test( dir: "$CARGO_MANIFEST_DIR/fixtures", glob: "**/*.txt", )] #[dir_test_attr( #[wasm_bindgen_test] #[cfg(target_family = "wasm")] )] fn wasm_test(fixture: Fixture>) { // ... } ``` **NOTE**: The `dir_test_attr` attribute must be specified after the `dir_test`. ### Return Types Tests may have a return type, allowing for the [`Result`] type to be used in the test. See the relevant book link [here](https://doc.rust-lang.org/book/ch11-01-writing-tests.html#using-resultt-e-in-tests). ```rust, no_run use dir_test::{dir_test, Fixture}; #[dir_test( dir: "$CARGO_MANIFEST_DIR/fixtures", glob: "**/*.txt", )] fn test(fixture: Fixture<&str>) -> std::io::Result<()> { // ... } ``` dir-test-0.4.1/src/lib.rs000064400000000000000000000112401046102023000132620ustar 00000000000000#![allow(clippy::test_attr_in_doctest)] #![cfg(not(doctest))] //! `dir-test` provides a macro to generate single test cases from files in a //! directory. //! //! ## Usage //! Add the following dependency to your `Cargo.toml`. //! //! ``` toml //! [dev-dependencies] //! dir-test = "0.4" //! ``` //! //! ### Basic Usage //! ```rust, no_run //! use dir_test::{dir_test, Fixture}; //! //! #[dir_test( //! dir: "$CARGO_MANIFEST_DIR/fixtures", //! glob: "**/*.txt", //! )] //! fn mytest(fixture: Fixture<&str>) { //! // The file content and the absolute path of the file are available as follows. //! let content = fixture.content(); //! let path = fixture.path(); //! //! // Write your test code here. //! // ... //! } //! ``` //! //! Assuming your crate is as follows, then the above code generates two test //! cases `mytest__foo()` and `mytest__fixtures_a_bar()`. //! //! ```text //! my-crate/ //! ├─ fixtures/ //! │ ├─ foo.txt //! │ ├─ fixtures_a/ //! │ │ ├─ bar.txt //! ├─ src/ //! │ ├─ ... //! │ ├─ lib.rs //! ├─ Cargo.toml //! ├─ README.md //! ``` //! //! 🔽 //! //! ```rust, no_run //! #[test] //! fn mytest__foo() { //! mytest(fixture); //! } //! //! #[test] //! fn mytest__fixtures_a_bar() { //! mytest(fixture); //! } //! ``` //! //! **NOTE**: The `dir` argument must be specified in an absolute path because //! of the limitation of the current procedural macro system. Consider using //! environment variables, `dir-test` crate resolves environment variables //! internally. //! //! ### Custom Loader //! You can specify a custom loader function to load the file content from the //! file path. The loader will be passed `&'static str` file path and can return //! an arbitrary type. //! ```rust, no_run //! use dir_test::{dir_test, Fixture}; //! //! #[dir_test( //! dir: "$CARGO_MANIFEST_DIR/fixtures", //! glob: "**/*.txt", //! loader: std::fs::read_to_string, //! )] //! fn test(fixture: Fixture>) { //! let content = fixture.content().unwrap(); //! //! // ... //! } //! ``` //! //! If the loader function is not specified, the default content type is //! `&'static str`. //! //! ### Custom Test Name //! Test names can be customized by specifying the `postfix` argument. //! `postfix` is appended to the test name. //! //! ```rust, no_run //! use dir_test::{dir_test, Fixture}; //! //! #[dir_test( //! dir: "$CARGO_MANIFEST_DIR/fixtures", //! glob: "**/*.txt", //! postfix: "custom", // `_custom` is appended to the test name. //! )] //! fn test(fixture: Fixture>) { //! // ... //! } //! ``` //! //! ### Test Attributes //! Test attributes can specified by the `dir_test_attr` attribute. The //! attributes inside `dir_test_atrr` are applied to the all generated test. //! //! ```rust, no_run //! use dir_test::{dir_test, Fixture}; //! //! #[dir_test( //! dir: "$CARGO_MANIFEST_DIR/fixtures", //! glob: "**/*.txt", //! )] //! #[dir_test_attr( //! #[wasm_bindgen_test] //! #[cfg(target_family = "wasm")] //! )] //! fn wasm_test(fixture: Fixture>) { //! // ... //! } //! ``` //! //! **NOTE**: The `dir_test_attr` attribute must be specified after the //! `dir_test`. //! //! ### Return Types //! Tests may have a return type, allowing for the [`Result`] type to be //! used in the test. See the relevant book link //! [here](https://doc.rust-lang.org/book/ch11-01-writing-tests.html#using-resultt-e-in-tests). //! //! ```rust, no_run //! use dir_test::{dir_test, Fixture}; //! //! #[dir_test( //! dir: "$CARGO_MANIFEST_DIR/fixtures", //! glob: "**/*.txt", //! )] //! fn test(fixture: Fixture<&str>) -> std::io::Result<()> { //! // ... //! } //! ``` /// A fixture contains a file content and its absolute path. /// Content type is determined by the loader function specified in /// `dir_test` macro. If the loader is not specified, the default /// content type is `&'static str`. pub struct Fixture { content: T, path: &'static str, } impl Fixture { #[doc(hidden)] /// Creates a new fixture from the given content and path. pub fn new(content: T, path: &'static str) -> Self { Self { content, path } } /// Returns a reference to the content of the fixture. pub fn content(&self) -> &T { &self.content } /// Consumes the fixture and returns the content. pub fn into_content(self) -> T { self.content } /// Returns the absolute path of the fixture. pub const fn path(&self) -> &'static str { self.path } } /// A procedural macro to generate test cases from files in a directory. pub use dir_test_macros::dir_test; dir-test-0.4.1/tests/fixtures/fail/invalid_arg.rs000064400000000000000000000003721046102023000201360ustar 00000000000000use dir_test::dir_test; #[dir_test( dir: "/foo/bar", loader: std::fs::read_to_string dir: "Dup" )] fn foo(fixture: Fixture<&str>) {} #[dir_test( dir: "/foo/bar", foo: "fooBar", )] fn foo(fixture: Fixture<&str>) {} fn main() {} dir-test-0.4.1/tests/fixtures/fail/invalid_arg.stderr000064400000000000000000000003351046102023000210140ustar 00000000000000error: duplicated arg `dir` --> tests/fixtures/fail/invalid_arg.rs:6:5 | 6 | dir: "Dup" | ^^^ error: unknown arg `foo` --> tests/fixtures/fail/invalid_arg.rs:12:5 | 12 | foo: "fooBar", | ^^^ dir-test-0.4.1/tests/main.rs000064400000000000000000000001641046102023000140160ustar 00000000000000#[test] fn compile_fail() { let t = trybuild::TestCases::new(); t.compile_fail("tests/fixtures/fail/*rs") }