Skip to content

Commit d90ed4c

Browse files
foresterreforesterre
authored
Merge pull request #4 from foresterre/foresterre/publishable
Refine bits to make package ready for publishing on crates.io
2 parents 41048a0 + 6b15075 commit d90ed4c

File tree

8 files changed

+334
-28
lines changed

8 files changed

+334
-28
lines changed

‎Cargo.toml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
[package]
22
name = "parameterized"
33
version = "0.1.0"
4-
authors = ["foresterre <[email protected]>"]
4+
authors = ["Martijn Gribnau <[email protected]>"]
55
edition = "2018"
66
license = "MIT OR Apache-2.0"
7-
description = "Run a single test with multiple different inputs"
8-
repository = "https://github.com/foresterre/parameterized"
7+
description = "Procedural macro which allows you to define a test which can be run with multiple arguments. Test cases are defined using the 'parameterized' attribute instead of the 'test' attribute. This crate was inspired by JUnit's `@ParameterizedTest`."
98
documentation = "https://docs.rs/parameterized"
9+
repository = "https://github.com/foresterre/parameterized"
1010
readme = "README.md"
11+
keywords = ["parameterized", "attribute", "test", "unit-test", "junit"]
12+
categories = ["development-tools", "development-tools::testing"]
13+
14+
[badges]
15+
maintenance = { status = "actively-developed" }
1116

1217
[dependencies]
13-
parameterized-macro = { path = "macro" }
18+
parameterized-macro = { path = "macro", version = "0.1" }
1419

1520
[workspace]
1621
members = ["macro", "expand"]

‎LICENSE-APACHE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎LICENSE-MIT

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Copyright (c) 2019 Martijn Gribnau
2+
3+
Permission is hereby granted, free of charge, to any
4+
person obtaining a copy of this software and associated
5+
documentation files (the "Software"), to deal in the
6+
Software without restriction, including without
7+
limitation the rights to use, copy, modify, merge,
8+
publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software
10+
is furnished to do so, subject to the following
11+
conditions:
12+
13+
The above copyright notice and this permission notice
14+
shall be included in all copies or substantial portions
15+
of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
18+
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19+
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
21+
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
24+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25+
DEALINGS IN THE SOFTWARE.

‎README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# parameterized
2+
3+
Procedural macro which allows you to define a test to be run with multiple (optionally different) arguments.
4+
Test cases are defined using the 'parameterized' attribute instead of the 'test' attribute.
5+
This crate was inspired by JUnit `@ParameterizedTest`.
6+
7+
## Example:
8+
9+
```rust
10+
enum Fruit {
11+
Apple,
12+
Bramble(BrambleFruit),
13+
Pear,
14+
}
15+
16+
trait NameOf {
17+
fn name_of(&self) -> &str;
18+
}
19+
20+
impl NameOf for Fruit {
21+
fn name_of(&self) -> &str {
22+
match self {
23+
Fruit::Apple => "apple",
24+
Fruit::Bramble(fruit) => fruit.name_of(),
25+
Fruit::Pear => "pear",
26+
}
27+
}
28+
}
29+
30+
enum BrambleFruit {
31+
Blackberry,
32+
}
33+
34+
impl NameOf for BrambleFruit {
35+
fn name_of(&self) -> &str {
36+
match self {
37+
BrambleFruit::Blackberry => "blackberry",
38+
}
39+
}
40+
}
41+
42+
#[cfg(test)]
43+
mod tests {
44+
use parameterized::parameterized;
45+
46+
47+
#[parameterized(fruit = {
48+
Fruit::Apple, Fruit::Pear, Fruit::Bramble(BrambleFruit::Blackberry)
49+
}, name = {
50+
"apple", "pear", "blackberry"
51+
})]
52+
fn a_fruity_test(fruit: Fruit, name: &str) {
53+
assert_eq!(fruit.name_of(), name)
54+
}
55+
}
56+
```
57+
58+
<br>
59+
60+
Additional examples can be found <a href="https://github.com/foresterre/parameterized-examples">here</a> (parameterized-examples repo)
61+
and in the <a href="macro/tests">tests</a> folder.
62+
63+
64+
<br>
65+
66+
#### License
67+
68+
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
69+
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
70+
71+
<br>
72+
73+
Unless you explicitly state otherwise, any contribution intentionally submitted
74+
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
75+
be dual licensed as above, without any additional terms or conditions.

‎macro/Cargo.toml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
[package]
22
name = "parameterized-macro"
33
version = "0.1.0"
4-
authors = ["foresterre <[email protected]>"]
4+
authors = ["Martijn Gribnau <[email protected]>"]
55
edition = "2018"
66
license = "MIT OR Apache-2.0"
7-
description = "Run a single test with multiple different inputs"
7+
description = "Attribute macro crate for parameterized tests."
8+
documentation = "https://docs.rs/parameterized-macro"
89
repository = "https://github.com/foresterre/parameterized"
10+
readme = "readme.md"
11+
keywords = ["parameterized", "attribute", "test", "unit-test", "junit"]
12+
categories = ["development-tools", "development-tools::testing"]
13+
914
autotests = false
1015

16+
1117
[lib]
1218
proc-macro = true
1319

‎macro/readme.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ With this macro we generate the following code (1) from the given parameterized
99
```rust
1010
// 0
1111

12-
#[parameterized(values = {1, 2})]
13-
fn my_test(a: i32) {
14-
assert!(a > 0)
12+
#[parameterized(a = {1, 2}, b = { "wanderlust", "wanderer" })]
13+
fn my_test(a: i32, b: &str) {
14+
assert!(a > 0 && b.starts_with("w"))
1515
}
1616
```
1717

@@ -25,13 +25,15 @@ mod my_test {
2525
#[test]
2626
fn case_0() {
2727
let a: i32 = 1;
28-
assert!(a > 0)
28+
let b: &str = "wanderlust";
29+
assert!(a > 0 && b.starts_with("w"))
2930
}
3031

3132
#[test]
3233
fn case_1() {
3334
let a: i32 = 2;
34-
assert!(a > 0)
35+
let b: &str = "wanderer";
36+
assert!(a > 0 && b.starts_with("w"))
3537
}
3638
}
3739
```
@@ -51,9 +53,9 @@ More examples can be found in the `expand` crate, and the tests.
5153
Otherwise, if just `cargo test` is used, some generated test cases will run in an incorrect context setting.
5254

5355
#### todo's and fixme's:
54-
- see 'fixme' in code comments, tests
56+
- see 'fixme' in code comments
5557
- see 'tests/todo' test cases
5658

5759
- propagate other attributes to the generated test cases
5860
- use `heck` crate to fix casing
59-
- the current code base is a first version; the code is not particularly pretty.
61+
- the current code base is a first version; the code is not always particularly pretty.

0 commit comments

Comments
 (0)