Skip to content

Commit 5e56903

Browse files
sunshowerssunshowers
committed
switch to libtest-mimic + update readme
1 parent 120ce96 commit 5e56903

File tree

10 files changed

+308
-341
lines changed

10 files changed

+308
-341
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ jobs:
1616
RUSTFLAGS: -D warnings
1717
steps:
1818
- uses: actions/checkout@v2
19-
with:
20-
# Checkout the code as-is from the pull request, rather than a merge commit.
21-
ref: ${{ github.event.pull_request.head.sha }}
2219
- uses: actions-rs/toolchain@v1
2320
with:
2421
toolchain: stable
@@ -46,8 +43,6 @@ jobs:
4643
RUSTFLAGS: -D warnings
4744
steps:
4845
- uses: actions/checkout@v2
49-
with:
50-
ref: ${{ github.event.pull_request.head.sha }}
5146
- uses: actions-rs/toolchain@v1
5247
with:
5348
toolchain: stable

‎Cargo.toml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ categories = ["development-tools::testing"]
1111
keywords = ["datatest", "data-driven-tests", "test-harness"]
1212

1313
[dependencies]
14+
libtest-mimic = "0.4.0"
1415
regex = "1.5.4"
1516
walkdir = "2.3.2"
16-
structopt = "0.3.26"
17-
termcolor = "1.1.2"
1817

1918
[[test]]
2019
name = "example"

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

‎README.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
[![License](https://img.shields.io/badge/license-MIT-green.svg)](../LICENSE-MIT)
88

99
`datatest-stable` is a very simple test harness intended to write data-driven tests, where
10-
individual test cases are specified as data and not as code. Given:
10+
individual test cases are specified as files and not as code. Given:
1111
* a test `my_test` that accepts a path as input
1212
* a directory to look for files in
1313
* a pattern to match files on
1414

15-
`datatest_stable` will call the `my_test` function once per matching file in the directory.
15+
`datatest-stable` will call the `my_test` function once per matching file in the directory.
1616

17-
This meets some of the needs provided by the `datatest` crate when using a stable rust compiler
18-
without using the `RUSTC_BOOTSTRAP` hack to use nightly features on the stable compiler.
17+
`datatest-stable` works with [cargo nextest](https://nexte.st/), and is part of the [nextest-rs
18+
organization](https://github.com/nextest-rs/) on GitHub.
1919

20-
In order to setup data-driven tests for a particular test target you must do the following:
20+
## Usage
2121

22-
1. Configure the test target by setting the following in the `Cargo.toml`
22+
1. Configure the test target by setting `harness = false` in `Cargo.toml`:
2323

2424
```toml
2525
[[test]]
@@ -60,14 +60,10 @@ datatest_stable::harness!(my_test, "path/to/fixtures", r"^.*/*");
6060
with a better UI and more features but targeting nightly Rust
6161
* [Data-driven testing](https://en.wikipedia.org/wiki/Data-driven_testing)
6262

63-
## Contributing
64-
65-
See the [CONTRIBUTING](../CONTRIBUTING.md) file for how to help out.
66-
6763
## License
6864

69-
This project is available under the terms of either the [Apache 2.0 license](../LICENSE-APACHE) or the [MIT
70-
license](../LICENSE-MIT).
65+
This project is available under the terms of either the [Apache 2.0 license](LICENSE-APACHE) or the [MIT
66+
license](LICENSE-MIT).
7167

7268
<!--
7369
README.md is generated from README.tpl by cargo readme. To regenerate:

‎README.tpl‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,10 @@
88

99
{{readme}}
1010

11-
## Contributing
12-
13-
See the [CONTRIBUTING](../CONTRIBUTING.md) file for how to help out.
14-
1511
## License
1612

17-
This project is available under the terms of either the [Apache 2.0 license](../LICENSE-APACHE) or the [MIT
18-
license](../LICENSE-MIT).
13+
This project is available under the terms of either the [Apache 2.0 license](LICENSE-APACHE) or the [MIT
14+
license](LICENSE-MIT).
1915

2016
<!--
2117
README.md is generated from README.tpl by cargo readme. To regenerate:

‎scripts/fix-readmes.awk‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Fix up readmes:
2+
# * Replace ## with # in code blocks.
3+
# * Remove [] without a following () from output.
4+
5+
BEGIN {
6+
true = 1
7+
false = 0
8+
in_block = false
9+
}
10+
11+
{
12+
if (!in_block && $0 ~ /^```/) {
13+
in_block = true
14+
} else if (in_block && $0 ~ /^```$/) {
15+
in_block = false
16+
}
17+
18+
if (in_block) {
19+
sub(/## /, "# ")
20+
print $0
21+
} else {
22+
# Strip [] without a () that immediately follows them from
23+
# the output.
24+
subbed = gensub(/\[([^\[]+)]([^\(]|$)/, "\\1\\2", "g")
25+
print subbed
26+
}
27+
}

‎scripts/regenerate-readmes.sh‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/usr/bin/env bash
2+
3+
# Copyright (c) The cargo-guppy Contributors
4+
# SPDX-License-Identifier: MIT OR Apache-2.0
5+
6+
# Regenerate readme files in this repository.
7+
8+
set -eo pipefail
9+
10+
cd "$(git rev-parse --show-toplevel)"
11+
git ls-files | grep README.tpl$ | while read -r readme; do
12+
dir=$(dirname "$readme")
13+
cargo readme --project-root "$dir" > "$dir/README.md.tmp"
14+
gawk -f "scripts/fix-readmes.awk" "$dir/README.md.tmp" > "$dir/README.md"
15+
rm "$dir/README.md.tmp"
16+
done

‎src/lib.rs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44
#![forbid(unsafe_code)]
55

66
//! `datatest-stable` is a very simple test harness intended to write data-driven tests, where
7-
//! individual test cases are specified as data and not as code. Given:
7+
//! individual test cases are specified as files and not as code. Given:
88
//! * a test `my_test` that accepts a path as input
99
//! * a directory to look for files in
1010
//! * a pattern to match files on
1111
//!
12-
//! `datatest_stable` will call the `my_test` function once per matching file in the directory.
12+
//! `datatest-stable` will call the `my_test` function once per matching file in the directory.
1313
//!
14-
//! This meets some of the needs provided by the `datatest` crate when using a stable rust compiler
15-
//! without using the `RUSTC_BOOTSTRAP` hack to use nightly features on the stable compiler.
14+
//! `datatest-stable` works with [cargo nextest](https://nexte.st/), and is part of the [nextest-rs
15+
//! organization](https://github.com/nextest-rs/) on GitHub.
1616
//!
17-
//! In order to setup data-driven tests for a particular test target you must do the following:
17+
//! # Usage
1818
//!
19-
//! 1. Configure the test target by setting the following in the `Cargo.toml`
19+
//! 1. Configure the test target by setting `harness = false` in `Cargo.toml`:
2020
//!
2121
//! ```toml
2222
//! [[test]]
@@ -39,7 +39,7 @@
3939
//!
4040
//! This is an example test. Use it with `harness = false`.
4141
//!
42-
//! ```
42+
//! ```rust
4343
//! use std::path::Path;
4444
//!
4545
//! fn my_test(path: &Path) -> datatest_stable::Result<()> {

0 commit comments

Comments
 (0)