fair-research / bdbag / 5703917834

91%

push

github

Fix issue with packaging.parse throwing InvalidVersion in the upgrade_config() function when trying to parse the informational version string VERSION set by bdbag when it is running in a "frozen" (e.g., with cx_Freeze) environment. In such cases, VERSION is set to something like 1.7.1-frozen, which is not PEP-440 compliant. This was not an issue in previous releases due to the fact that the implementation used pkg_resources.parse_version which was not as strict.

The code in upgrade_config() has been changed to parse the PEP-440 compliant version returned by packaging.parse rather than use the global string VERSION, which can still be (and is) used elsewhere for purely informational and descriptive purposes.

Unfortunately this wasn't caught be unit testing before the release because of the complexity of unit testing pre-built frozen environments. It wasn't until other automation that freezes `bdbag` into a pre-built installable software package generated an installer that was tested manually did it get exposed.

1187 of 1381 branches covered (85.95%)

Branch coverage included in aggregate %.

6 of 6 new or added lines in 2 files covered. (100.0%)

1729 of 1807 relevant lines covered (95.68%)

4.77 hits per line