nextest_runner/config/core/

tool_config.rs

// Copyright (c) The nextest Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0

use super::ToolName;
use crate::errors::ToolConfigFileParseError;
use camino::{Utf8Path, Utf8PathBuf};
use std::str::FromStr;

/// A tool-specific config file.
///
/// Tool-specific config files are lower priority than repository configs, but higher priority than
/// the default config shipped with nextest.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ToolConfigFile {
    /// The name of the tool.
    pub tool: ToolName,

    /// The path to the config file.
    pub config_file: Utf8PathBuf,
}

impl FromStr for ToolConfigFile {
    type Err = ToolConfigFileParseError;

    fn from_str(input: &str) -> Result<Self, Self::Err> {
        match input.split_once(':') {
            Some((tool, config_file)) => {
                let tool = ToolName::new(tool.into()).map_err(|error| {
                    ToolConfigFileParseError::InvalidToolName {
                        input: input.to_owned(),
                        error,
                    }
                })?;
                if config_file.is_empty() {
                    Err(ToolConfigFileParseError::EmptyConfigFile {
                        input: input.to_owned(),
                    })
                } else {
                    let config_file = Utf8Path::new(config_file);
                    if config_file.is_absolute() {
                        Ok(Self {
                            tool,
                            config_file: Utf8PathBuf::from(config_file),
                        })
                    } else {
                        Err(ToolConfigFileParseError::ConfigFileNotAbsolute {
                            config_file: config_file.to_owned(),
                        })
                    }
                }
            }
            None => Err(ToolConfigFileParseError::InvalidFormat {
                input: input.to_owned(),
            }),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        config::{
            core::{
                ConfigFileSelection, ConfigPaths, ConfigSource, ConfigSourceKind, NextestConfig,
                NextestVersionConfig, NextestVersionReq, VersionOnlyConfig,
            },
            elements::{RetryPolicy, TestGroup},
            utils::test_helpers::*,
        },
        run_mode::NextestRunMode,
    };
    use camino_tempfile::tempdir;
    use camino_tempfile_ext::prelude::*;
    use guppy::graph::cargo::BuildPlatform;
    use nextest_filtering::{ParseContext, TestQuery};
    use nextest_metadata::TestCaseName;
    use std::collections::HashSet;

    fn tool_name(s: &str) -> ToolName {
        ToolName::new(s.into()).unwrap()
    }

    #[test]
    fn parse_tool_config_file() {
        use crate::errors::{InvalidToolName, ToolConfigFileParseError};

        cfg_if::cfg_if! {
            if #[cfg(windows)] {
                let valid = ["tool:C:\\foo\\bar", "tool:\\\\?\\C:\\foo\\bar"];
            } else {
                let valid = ["tool:/foo/bar"];
            }
        }

        for valid_input in valid {
            valid_input.parse::<ToolConfigFile>().unwrap_or_else(|err| {
                panic!("valid input {valid_input} should parse correctly: {err}")
            });
        }

        cfg_if::cfg_if! {
            if #[cfg(windows)] {
                let invalid: &[(&str, ToolConfigFileParseError)] = &[
                    ("no-colon-here", ToolConfigFileParseError::InvalidFormat {
                        input: "no-colon-here".to_owned(),
                    }),
                    ("tool:\\foo\\bar", ToolConfigFileParseError::ConfigFileNotAbsolute {
                        config_file: "\\foo\\bar".into(),
                    }),
                    ("tool:foo/bar", ToolConfigFileParseError::ConfigFileNotAbsolute {
                        config_file: "foo/bar".into(),
                    }),
                ];
            } else {
                let invalid: &[(&str, ToolConfigFileParseError)] = &[
                    ("/foo/bar", ToolConfigFileParseError::InvalidFormat {
                        input: "/foo/bar".to_owned(),
                    }),
                    ("tool:foo/bar", ToolConfigFileParseError::ConfigFileNotAbsolute {
                        config_file: "foo/bar".into(),
                    }),
                    ("tool:./foo", ToolConfigFileParseError::ConfigFileNotAbsolute {
                        config_file: "./foo".into(),
                    }),
                ];
            }
        }

        // Common invalid cases for all platforms.
        let common_invalid: &[(&str, ToolConfigFileParseError)] = &[
            (
                ":/foo/bar",
                ToolConfigFileParseError::InvalidToolName {
                    input: ":/foo/bar".to_owned(),
                    error: InvalidToolName::Empty,
                },
            ),
            (
                "_invalid:/foo/bar",
                ToolConfigFileParseError::InvalidToolName {
                    input: "_invalid:/foo/bar".to_owned(),
                    error: InvalidToolName::InvalidXid("_invalid".into()),
                },
            ),
            // Tool names starting with "@tool" are rejected with a specific error.
            (
                "@tool:/path",
                ToolConfigFileParseError::InvalidToolName {
                    input: "@tool:/path".to_owned(),
                    error: InvalidToolName::StartsWithToolPrefix("@tool".into()),
                },
            ),
            (
                "tool:",
                ToolConfigFileParseError::EmptyConfigFile {
                    input: "tool:".to_owned(),
                },
            ),
        ];

        for (input, expected) in invalid.iter().chain(common_invalid.iter()) {
            let actual = input.parse::<ToolConfigFile>().unwrap_err();
            assert_eq!(&actual, expected, "for input {input:?}");
        }
    }

    #[test]
    fn tool_config_basic() {
        let config_contents = r#"
        nextest-version = "0.9.50"

        [profile.default]
        retries = 3

        [[profile.default.overrides]]
        filter = 'test(test_foo)'
        retries = 20
        test-group = 'foo'

        [[profile.default.overrides]]
        filter = 'test(test_quux)'
        test-group = '@tool:tool1:group1'

        [test-groups.foo]
        max-threads = 2
        "#;

        let tool1_config_contents = r#"
        nextest-version = { required = "0.9.51", recommended = "0.9.52" }

        [profile.default]
        retries = 4

        [[profile.default.overrides]]
        filter = 'test(test_bar)'
        retries = 21

        [profile.tool]
        retries = 12

        [[profile.tool.overrides]]
        filter = 'test(test_baz)'
        retries = 22
        test-group = '@tool:tool1:group1'

        [[profile.tool.overrides]]
        filter = 'test(test_quux)'
        retries = 22
        test-group = '@tool:tool2:group2'

        [test-groups.'@tool:tool1:group1']
        max-threads = 2
        "#;

        let tool2_config_contents = r#"
        nextest-version = { recommended = "0.9.49" }

        [profile.default]
        retries = 5

        [[profile.default.overrides]]
        filter = 'test(test_)'
        retries = 23

        [profile.tool]
        retries = 16

        [[profile.tool.overrides]]
        filter = 'test(test_ba)'
        retries = 24
        test-group = '@tool:tool2:group2'

        [[profile.tool.overrides]]
        filter = 'test(test_)'
        retries = 25
        test-group = '@global'

        [profile.tool2]
        retries = 18

        [[profile.tool2.overrides]]
        filter = 'all()'
        retries = 26

        [test-groups.'@tool:tool2:group2']
        max-threads = 4
        "#;

        let workspace_dir = tempdir().unwrap();

        let graph = temp_workspace(&workspace_dir, config_contents);
        let tool1_path = workspace_dir.child(".config/tool1.toml");
        let tool2_path = workspace_dir.child(".config/tool2.toml");
        tool1_path.write_str(tool1_config_contents).unwrap();
        tool2_path.write_str(tool2_config_contents).unwrap();

        let workspace_root = graph.workspace().root();

        let tool_config_files = [
            ToolConfigFile {
                tool: tool_name("tool1"),
                config_file: tool1_path.to_path_buf(),
            },
            ToolConfigFile {
                tool: tool_name("tool2"),
                config_file: tool2_path.to_path_buf(),
            },
        ];

        let version_only_config =
            VersionOnlyConfig::from_sources(workspace_root, None, &tool_config_files).unwrap();
        let nextest_version = version_only_config.nextest_version();
        let sources = ConfigFileSelection::new(None)
            .sources(
                &ConfigPaths::capture(workspace_root).unwrap(),
                tool_config_files.iter().rev(),
            )
            .unwrap();
        let [_tool2_source, tool1_source, _repo_source] = <[ConfigSource; 3]>::try_from(sources)
            .expect("two tool sources followed by the repository source");
        match tool1_source.kind() {
            ConfigSourceKind::Tool(tool) => assert_eq!(tool, &tool_name("tool1")),
            ConfigSourceKind::ExplicitRepository | ConfigSourceKind::DiscoveredRepository => {
                panic!("expected tool1's source, got {tool1_source:?}")
            }
        }
        assert_eq!(
            nextest_version,
            &NextestVersionConfig {
                required: NextestVersionReq::Version {
                    version: "0.9.51".parse().unwrap(),
                    source: tool1_source.clone(),
                },
                recommended: NextestVersionReq::Version {
                    version: "0.9.52".parse().unwrap(),
                    source: tool1_source,
                },
            },
        );

        let pcx = ParseContext::new(&graph);
        let config = NextestConfig::from_sources(
            workspace_root,
            &pcx,
            None,
            &tool_config_files,
            &Default::default(),
        )
        .expect("config is valid");

        let default_profile = config
            .profile(NextestConfig::DEFAULT_PROFILE)
            .expect("default profile is present")
            .apply_build_platforms(&build_platforms());
        // This is present in .config/nextest.toml and is the highest priority
        assert_eq!(default_profile.retries(), RetryPolicy::new_without_delay(3));

        let repo_path = workspace_root.join(NextestConfig::CONFIG_PATH);
        let override_sources: Vec<_> = default_profile
            .compiled_data
            .overrides
            .iter()
            .map(|override_| {
                let id = override_.id();
                (
                    id.config_source.path().absolute_path(),
                    id.config_source.kind(),
                )
            })
            .collect();
        assert_eq!(
            override_sources,
            [
                (repo_path.as_path(), &ConfigSourceKind::DiscoveredRepository),
                (repo_path.as_path(), &ConfigSourceKind::DiscoveredRepository),
                (
                    tool1_path.as_path(),
                    &ConfigSourceKind::Tool(tool_name("tool1"))
                ),
                (
                    tool2_path.as_path(),
                    &ConfigSourceKind::Tool(tool_name("tool2"))
                ),
            ],
            "overrides record their source, highest priority first"
        );
        let override_ids: HashSet<_> = default_profile
            .compiled_data
            .overrides
            .iter()
            .map(|override_| override_.id())
            .collect();
        assert_eq!(
            override_ids.len(),
            default_profile.compiled_data.overrides.len(),
            "override ids are pairwise distinct"
        );

        let package_id = graph.workspace().iter().next().unwrap().id();

        let binary_query = binary_query(
            &graph,
            package_id,
            "lib",
            "my-binary",
            BuildPlatform::Target,
        );
        let test_foo = TestCaseName::new("test_foo");
        let test_foo_query = TestQuery {
            binary_query: binary_query.to_query(),
            test_name: &test_foo,
        };
        let test_bar = TestCaseName::new("test_bar");
        let test_bar_query = TestQuery {
            binary_query: binary_query.to_query(),
            test_name: &test_bar,
        };
        let test_baz = TestCaseName::new("test_baz");
        let test_baz_query = TestQuery {
            binary_query: binary_query.to_query(),
            test_name: &test_baz,
        };
        let test_quux = TestCaseName::new("test_quux");
        let test_quux_query = TestQuery {
            binary_query: binary_query.to_query(),
            test_name: &test_quux,
        };

        assert_eq!(
            default_profile
                .settings_for(NextestRunMode::Test, &test_foo_query)
                .retries(),
            RetryPolicy::new_without_delay(20),
            "retries for test_foo/default profile"
        );
        assert_eq!(
            default_profile
                .settings_for(NextestRunMode::Test, &test_foo_query)
                .test_group(),
            &test_group("foo"),
            "test_group for test_foo/default profile"
        );
        assert_eq!(
            default_profile
                .settings_for(NextestRunMode::Test, &test_bar_query)
                .retries(),
            RetryPolicy::new_without_delay(21),
            "retries for test_bar/default profile"
        );
        assert_eq!(
            default_profile
                .settings_for(NextestRunMode::Test, &test_bar_query)
                .test_group(),
            &TestGroup::Global,
            "test_group for test_bar/default profile"
        );
        assert_eq!(
            default_profile
                .settings_for(NextestRunMode::Test, &test_baz_query)
                .retries(),
            RetryPolicy::new_without_delay(23),
            "retries for test_baz/default profile"
        );
        assert_eq!(
            default_profile
                .settings_for(NextestRunMode::Test, &test_quux_query)
                .test_group(),
            &test_group("@tool:tool1:group1"),
            "test group for test_quux/default profile"
        );

        let tool_profile = config
            .profile("tool")
            .expect("tool profile is present")
            .apply_build_platforms(&build_platforms());
        assert_eq!(tool_profile.retries(), RetryPolicy::new_without_delay(12));

        let tool_override_sources: Vec<_> = tool_profile
            .compiled_data
            .overrides
            .iter()
            .map(|override_| {
                let id = override_.id();
                (
                    id.config_source.path().absolute_path(),
                    id.config_source.kind(),
                    id.profile_name.as_str(),
                )
            })
            .collect();
        let tool1_kind = ConfigSourceKind::Tool(tool_name("tool1"));
        let tool2_kind = ConfigSourceKind::Tool(tool_name("tool2"));
        let repo_kind = ConfigSourceKind::DiscoveredRepository;
        assert_eq!(
            tool_override_sources,
            [
                (tool1_path.as_path(), &tool1_kind, "tool"),
                (tool1_path.as_path(), &tool1_kind, "tool"),
                (tool2_path.as_path(), &tool2_kind, "tool"),
                (tool2_path.as_path(), &tool2_kind, "tool"),
                (repo_path.as_path(), &repo_kind, "default"),
                (repo_path.as_path(), &repo_kind, "default"),
                (tool1_path.as_path(), &tool1_kind, "default"),
                (tool2_path.as_path(), &tool2_kind, "default"),
            ],
            "tool profile overrides record their source, highest priority first"
        );
        assert_eq!(
            tool_profile
                .settings_for(NextestRunMode::Test, &test_foo_query)
                .retries(),
            RetryPolicy::new_without_delay(25),
            "retries for test_foo/default profile"
        );
        assert_eq!(
            tool_profile
                .settings_for(NextestRunMode::Test, &test_bar_query)
                .retries(),
            RetryPolicy::new_without_delay(24),
            "retries for test_bar/default profile"
        );
        assert_eq!(
            tool_profile
                .settings_for(NextestRunMode::Test, &test_baz_query)
                .retries(),
            RetryPolicy::new_without_delay(22),
            "retries for test_baz/default profile"
        );

        let tool2_profile = config
            .profile("tool2")
            .expect("tool2 profile is present")
            .apply_build_platforms(&build_platforms());
        assert_eq!(tool2_profile.retries(), RetryPolicy::new_without_delay(18));
        assert_eq!(
            tool2_profile
                .settings_for(NextestRunMode::Test, &test_foo_query)
                .retries(),
            RetryPolicy::new_without_delay(26),
            "retries for test_foo/default profile"
        );
        assert_eq!(
            tool2_profile
                .settings_for(NextestRunMode::Test, &test_bar_query)
                .retries(),
            RetryPolicy::new_without_delay(26),
            "retries for test_bar/default profile"
        );
        assert_eq!(
            tool2_profile
                .settings_for(NextestRunMode::Test, &test_baz_query)
                .retries(),
            RetryPolicy::new_without_delay(26),
            "retries for test_baz/default profile"
        );
    }
}