Skip to content

Commit

Permalink
Update the doc tests on the README.md by replacing Skeptic with
Browse files Browse the repository at this point in the history
a regular `cargo test` command
  • Loading branch information
tatsuya6502 committed Feb 10, 2024
1 parent 68c64df commit 9a6a856
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .ci_extras/pin-crate-vers-msrv.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
set -eux

# Pin some dependencies to specific versions for the MSRV.
cargo update -p cargo-platform --precise 0.1.5
# cargo update -p <crate> --precise <version>
2 changes: 1 addition & 1 deletion .github/workflows/LinuxCrossCompileTest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:
- name: Remove integration tests and force enable rustc_version crate
run: |
rm -rf tests
sed -i '/actix-rt\|async-std\|reqwest\|skeptic/d' Cargo.toml
sed -i '/actix-rt\|async-std\|reqwest/d' Cargo.toml
sed -i 's/target.*rustver.*\.//' Cargo.toml
sed -i 's/build = "build.rs"/build = ".ci_extras\/build_linux_cross.rs"/' Cargo.toml
cat Cargo.toml
Expand Down
17 changes: 1 addition & 16 deletions .github/workflows/Skeptic.yml → .github/workflows/Trybuild.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Skeptic and Trybuild
name: Trybuild

on:
push:
Expand Down Expand Up @@ -44,21 +44,6 @@ jobs:
with:
toolchain: ${{ matrix.rust }}

- name: Run tests (sync feature)
run: cargo test --release --features sync
env:
RUSTFLAGS: '--cfg skeptic'

- name: Run tests (release, sync and future)
run: cargo test --release --features 'sync, future'
env:
RUSTFLAGS: '--cfg skeptic'

- name: Run tests (sync and future, without atomic64 and quanta)
run: cargo test --release --no-default-features --features 'sync, future'
env:
RUSTFLAGS: '--cfg skeptic'

- name: Run compile error tests (sync and future features, trybuild)
if: ${{ matrix.rust == 'stable' }}
run: cargo test ui_trybuild --release --features 'sync, future'
Expand Down
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
"Descheduled",
"devcontainer",
"docsrs",
"doctest",
"doctests",
"Einziger",
"else's",
"ENHANCEME",
Expand Down
4 changes: 0 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,11 @@ env_logger = "0.10.0"
getrandom = "0.2"
paste = "1.0.9"
reqwest = { version = "0.11.11", default-features = false, features = ["rustls-tls"] }
skeptic = "0.13"
tokio = { version = "1.19", features = ["fs", "io-util", "macros", "rt-multi-thread", "sync", "time" ] }

[target.'cfg(trybuild)'.dev-dependencies]
trybuild = "1.0"

[target.'cfg(skeptic)'.build-dependencies]
skeptic = "0.13.5"

[target.'cfg(rustver)'.build-dependencies]
rustc_version = "0.4.0"

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -497,13 +497,13 @@ To run all tests including `future` feature and doc tests on the README, use the
following command:

```console
$ RUSTFLAGS='--cfg skeptic --cfg trybuild' cargo test --all-features
$ RUSTFLAGS='--cfg trybuild' cargo test --all-features
```

**Running All Tests without Default Features**

```console
$ RUSTFLAGS='--cfg skeptic --cfg trybuild' cargo test \
$ RUSTFLAGS='--cfg trybuild' cargo test \
--no-default-features --features 'future, sync'
```

Expand Down
8 changes: 1 addition & 7 deletions build.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
#[cfg(skeptic)]
fn main() {
// generates doc tests for `README.md`.
skeptic::generate_doc_tests(&["README.md"]);
}

#[cfg(rustver)]
fn main() {
use rustc_version::version;
Expand All @@ -14,5 +8,5 @@ fn main() {
);
}

#[cfg(not(any(skeptic, rustver)))]
#[cfg(not(rustver))]
fn main() {}
7 changes: 7 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,3 +151,10 @@ mod tests {
t.compile_fail("tests/compile_tests/future/clone/*.rs");
}
}

#[cfg(all(doctest, sync))]
mod doctests {
// https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#include-items-only-when-collecting-doctests
#[doc = include_str!("../README.md")]
struct ReadMeDoctests;
}
2 changes: 0 additions & 2 deletions tests/skeptic.rs

This file was deleted.

0 comments on commit 9a6a856

Please sign in to comment.