boxed / mutmut

Mutation testing system
https://mutmut.readthedocs.io
BSD 3-Clause "New" or "Revised" License
932 stars 112 forks source link

FileNotFoundError even though the exact command required is fed to the terminal #348

Closed VincentPelletier1 closed 6 days ago

VincentPelletier1 commented 6 days ago

What Was Done

Now, the above yielded FileNotFoundError: Could not figure out where the code to mutate is. Please specify it by adding "paths_to_mutate=code_dir" in setup.cfg to the [mutmut] section.

I tried various adjustments:

The Issue

The command should work, as the paths for the test directory and source code directory are correct. However, the error mentions a configuration file, which is not clearly documented.

The documentation does reference a config file but lacks critical information:

Closing Thoughts

I'll be direct: libraries like this have the potential for professional use. However, insufficient documentation diminishes confidence in the package.

I would like to use this package and hope that future documentation provides more actionable guidance, especially for troubleshooting and required setup.

boxed commented 6 days ago

mutmut run --paths-to-mutate "path/to/my/test/folder" --tests-dir "path/to/my/test/dir"

This is not how you run mutmut 3. This is not in any of the documentation. The error message furthermore clearly tells you what to do, and you even copy pasted the error message telling you what to do.

The documentation does reference a config file but lacks critical information: Where should this file be located?

setup.cfg is a standard config file for Python. This is not mutmut specific.

However, insufficient documentation diminishes confidence in the package.

Oh come on. You didn't read the documentation for the current version OR the very clear error message.

boxed commented 6 days ago

I pushed a little change to the README to make this a bit clearer.

VincentPelletier1 commented 6 days ago

Thank you for providing clearer documentation.

I do want to note that while configuration files are indeed standard, their location is not always at the project root, and it’s not uncommon for multiple config files to exist in a project.

Regarding the terminal commands, it seems the documentation I was referencing was outdated. I’ll review the updated version and test the package again. I genuinely appreciate the effort behind this package and am excited to get it working—despite sounding a bit frustrated earlier.