'mdbook test' fails in GitLab CI/CD

[geohei]

Question

Hi.
I use a GitLab CI/CD pipeline to automatically build and deploy an mdbook.
All works fine, except mdbook test.
mdbook test works however on developer machine.
What am I missing?

$ wget -q https://github.com/rust-lang/mdBook/releases/download/v0.4.44/mdbook-v0.4.44-x86_64-unknown-linux-gnu.tar.gz
$ tar -xzf mdbook-v0.4.44-x86_64-unknown-linux-gnu.tar.gz
$ ./mdbook build
$ ./mdbook test
2025-02-02 05:37:05 [INFO] (mdbook::book): Testing chapter 'Chapter 1': "chapter_1.md"
2025-02-02 05:37:05 [ERROR] (mdbook::utils): Error: No such file or directory (os error 2)

Version

mdbook v0.4.44

[ehuss]

Can you show what content you are trying to test?

[geohei]

It's the basic/empty book after saying mdbook init test.
When I run the test (same repo) on my development ubuntu machine, all goes fine.

$ pwd
/builds/geohei/test
$ ls -l
total 16816
-rw-rw-rw- 1 root root     6150 Jan 31 15:37 README.md
-rw-rw-rw- 1 root root       98 Jan 31 15:37 book.toml
-rwxr-xr-x 1 1001  128 12368792 Jan 28 18:17 mdbook
-rw-r--r-- 1 root root  4829715 Jan 28 18:17 mdbook-v0.4.44-x86_64-unknown-linux-gnu.tar.gz
drwxrwxrwx 2 root root     4096 Jan 31 15:37 src
$ ./mdbook build
2025-02-02 05:25:08 [INFO] (mdbook::book): Book building has started
2025-02-02 05:25:08 [INFO] (mdbook::book): Running the html backend
$ ls -l src
total 8
-rw-rw-rw- 1 root root 41 Jan 31 15:37 SUMMARY.md
-rw-rw-rw- 1 root root 12 Jan 31 15:37 chapter_1.md
$ cat src/SUMMARY.md
# Summary
- [Chapter 1](./chapter_1.md)
$ ./mdbook test
2025-02-02 05:25:08 [INFO] (mdbook::book): Testing chapter 'Chapter 1': "chapter_1.md"
2025-02-02 05:25:08 [ERROR] (mdbook::utils): Error: No such file or directory (os error 2)

[ehuss]

I think I see what might be wrong. The rustdoc binary is likely missing from your PATH. You may need to install it or set up the PATH to include it. I have opened #2545 to give a better error message.

[geohei]

Then I know what's wrong.
I didn't install Rust in the pipeline (docker, ubuntu:latest).
So no rustdoc either.
When I try to install Rust, I get ...

$ curl --proto '=https' --tlsv1.3 -sSf https://sh.rustup.rs/ | sh
info: downloading installer
rustup: Unable to run interactively. Run with -y to accept defaults, --help for additional options

[ehuss]

The installer script needs the -y argument to assume "yes" to all the installation prompts. That might look like curl --proto '=https' --tlsv1.3 -sSf https://sh.rustup.rs/ | sh -s -- -y

[geohei]

Many thanks.
curl --proto '=https' --tlsv1.3 -sSf https://sh.rustup.rs/ | sh -s -- -y worked fine and Rust installation succeeded.
After that, I noticed that rustdoc was indeed not in the $PATH.
After adding PATH=~/.cargo/bin, mdbook test ran fine !!!

I have the following as GitLab CI/CD script now. It works fine, but I'm not sure if this is the "right" way to do it?

    - apt update
    - apt install -y openssh-client
    - apt install -y rsync
    - apt install -y curl
    - install -m 600 -D /dev/null ~/.ssh/id_ed25519
    - echo $SSH_PRIVATE_KEY | base64 -d > ~/.ssh/id_ed25519
    - ssh-keyscan -H $SSH_HOST > ~/.ssh/known_hosts
    - curl --proto '=https' --tlsv1.3 -sSf https://sh.rustup.rs | sh -s -- -y
    - PATH=~/.cargo/bin:$PATH
    - curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.44/mdbook-v0.4.44-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=.
    - ./mdbook build
    - ./mdbook test
    - cp ./data/favicon.* ./book/
    - rsync -r --delete ./book/ $SSH_USER@$SSH_HOST:$MDBOOK_PATH

I'd prefer to use apt, but mdbook 0.44.4 requires rust >= 1.77 and apt only provides rust 1.75 (Ubuntu 24.04).