Refactor zinolib config parsing

[hmpf]

Closes #11 as a bonus.

• allow storing config file elsewhere than users' home directories
• add tests!

The normalize-function fixes a bug (placement of globals) in parse_tcl_config and is in preparation for the new stuff.

I would especially like feedback on the tests/file handling in the tests.

[github-actions]

Test results

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0 ❌

Results for commit f140df8.

♻️ This comment has been updated with latest results.

[codecov]

Codecov Report

Merging #22 (9d586d4) into main (d344a10) will increase coverage by 3.48%.
Report is 7 commits behind head on main.
The diff coverage is 93.42%.

❗ Current head 9d586d4 differs from pull request most recent head f140df8. Consider uploading reports for the commit f140df8 to get more accurate results

@@            Coverage Diff             @@
##             main      #22      +/-   ##
==========================================
+ Coverage   67.63%   71.12%   +3.48%     
==========================================
  Files           9       13       +4     
  Lines        1029     1136     +107     
==========================================
+ Hits          696      808     +112     
+ Misses        333      328       -5     

Files	Coverage Δ
src/zinolib/config/models.py	100.00% <100.00%> (ø)
src/zinolib/config/toml.py	100.00% <100.00%> (ø)
src/zinolib/controllers/base.py	96.77% <100.00%> (ø)
src/zinolib/controllers/zino1.py	70.86% <100.00%> (+0.19%)	⬆️
src/zinolib/event_types.py	99.41% <100.00%> (ø)
src/zinolib/ritz.py	57.63% <100.00%> (+1.44%)	⬆️
src/zinolib/config/tcl.py	97.82% <97.82%> (ø)
src/zinolib/config/utils.py	95.23% <95.23%> (ø)
src/zinolib/compat.py	76.47% <66.66%> (-12.42%)	⬇️
src/zinolib/config/zino1.py	81.48% <81.48%> (ø)

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
1 Security Hotspot
3 Code Smells

No Coverage information
0.3% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[lunkwill42]

I was asked to look particularly at the tests, but I could not resist suggesting type annotations to a lot of the code - until I gave up, because there were none at all; I'm sure you can figure out the annotations yourself 😆

I think this config parsing code really is a nice touch, and the tests seem to mostly cover what is needed.

Otherwise, SonarCloud has flagged 4 potential code smells that have some merit, I'm not going to repeat those here.

[lunkwill42]

I think the config parsing code is neatly done. I've created a separate issue for type annotations (and considering adding a techdebt label ;) )

My only concern is this: The tests don't seem to actually be running in the github workflows. The test results are empty. This is likely not caused by this PR, but should be fixed. I was surprised the tests didn't catch the missing import that @johannaengland pointed out, and now I see why...

[hmpf]

Joy. They run locally of course. They run on github actions too, what fails is only the last step.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.1% Duplication

[hmpf]

They run on github action stoo, what fails is only the last step.