Comply with TOML string requirements

Drops string handling from pre-commit entirely.
rustfmt --config option can't be used with the parameters
'as is' (string values as unquoted). Instead use
rustfmt --config-path that takes the whole fmt.toml file.

To be able to use --config-path requires the nightly toolchain
to be added to the docker dev container as well.

This change additionally drops the license-template-path
formatting parameter as it is no longer supported by the
rust toolchain. See github discussion:
rust-lang/rustfmt#3352

Signed-off-by: Matthew Schlebusch <[email protected]>

Author: mattschlebusch

pre-commit

@@ -22,12 +22,11 @@ for i in $(git diff --name-only --cached); do
     filename=$(basename -- "$i")
     extension="${filename##*.}"
     if [ "$extension" = "rs" ]; then
-        # Read rustfmt config, replace '\n' with ','
-        rustfmt_config="$(sed -z "s/\n/,/g;s/,$/\n/" ./tests/fmt.toml)"
         # We first do a check run, this will fail when it finds a non-matching license.
-        rustfmt $i --check --config $rustfmt_config
-        # Run `cargo fmt` for this file
-        rustfmt $i --config $rustfmt_config
+        rustfmt $i +nightly --check --config-path ./tests/fmt.toml
+
+        # Run `cargo fmt` for this source file using the fmt.toml config
+        rustfmt $i +nightly --config-path ./tests/fmt.toml
     fi
     if [ "$extension" = "py" ]; then
         # Run `black` for this file

tests/fmt.toml

@@ -1,9 +1,12 @@
+# This file can be used as a whole TOML file via rustfmt's --config-path option
+# The individual key-pairs can also used with the rustfmt --config option,
+# but requires removing the quotes to work
+
 comment_width=100
 wrap_comments=true
 format_code_in_doc_comments=true
 format_strings=true
-license_template_path=./tests/license.txt
-imports_granularity=Module
+imports_granularity="Module"
 normalize_comments=true
 normalize_doc_attributes=true
-group_imports=StdExternalCrate
+group_imports="StdExternalCrate"

tests/integration_tests/style/test_rust.py

@@ -12,10 +12,8 @@ def test_rust_style():
     @type: style
     """
 
-    #  ../src/io_uring/src/bindings.rs
-    config = open("fmt.toml", encoding="utf-8").read().replace("\n", ",")
     # Check that the output is empty.
-    _, stdout, _ = utils.run_cmd(f"cargo fmt --all -- --check --config {config}")
+    _, stdout, _ = utils.run_cmd("cargo fmt --all -- --check --config-path fmt.toml")
 
     # rustfmt prepends `"Diff in"` to the reported output.
     assert "Diff in" not in stdout

tools/devctr/Dockerfile.aarch64

@@ -100,6 +100,8 @@ RUN cd "$TMP_POETRY_DIR" \
 RUN mkdir "$TMP_BUILD_DIR" \
     && curl https://sh.rustup.rs -sSf | sh -s -- -y --profile minimal --default-toolchain "$RUST_TOOLCHAIN" \
         && rustup target add aarch64-unknown-linux-musl \
+        && rustup install nightly \
+        && rustup install --profile minimal "stable" \
         && rustup component add clippy \
         && cd "$TMP_BUILD_DIR" \
                     && cargo install cargo-kcov \

tools/devctr/Dockerfile.x86_64

@@ -108,6 +108,7 @@ RUN mkdir "$TMP_BUILD_DIR" \
     && curl https://sh.rustup.rs -sSf | sh -s -- -y --profile minimal --default-toolchain "$RUST_TOOLCHAIN" \
         && rustup target add x86_64-unknown-linux-musl \
         && rustup component add rustfmt clippy clippy-preview \
+        && rustup install nightly \
         && rustup install --profile minimal "stable" \
         && cd "$TMP_BUILD_DIR" \
             && cargo install cargo-kcov \