Replace os.path with pathlib and fix TOC bug - Githubissues

ComplianceAsCode / auditree-framework

The Auditree framework tool to run compliance control checks as unit tests.

https://auditree.github.io/

Apache License 2.0

59 stars 23 forks source link

Replace os.path with pathlib and fix TOC bug #118

Closed alfinkel closed 3 years ago

alfinkel commented 3 years ago

[x] Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1

What

Use the pathlib library for file path and operating system file interaction throughout the framework
Fix the bug where the table of contents adds a new line between the locker README main section and the TOC every time checks are run. Bug fix includes the removal of added blank lines since the bug was introduced.

Why

Because all the cool kids are using pathlib
Bugs are bad

How

Replace all instances of os.path functionality with pathlib.Path
Add a regex to the TOC generator to limit the number of blank lines to a max of 2.

Test

Locker downloads correctly
Locker pushes correctly
Fetchers run
Checks run
Notifiers work
Reports generate
Metadata is updated as expected
TOC works

Context

Closes #89
Fixes #117