Fully Redact Password

[jacobshaw42]

In main.py

• line 108: there was actually no problem here in my current environment, but this seems like a safe bet, just in case
• line 116: The url encoded connection string is currently logging the password in plain text between encodings. This change will redact passwords in a connection string message variable to be logged.

In utils.py

• line 127: in a linux environment, if a special character is in the password, the quote_this function will put the password in double quotes and single quotes. So, the password becomes 'password' and this line fails to redact the password
• line 128: will log the non-redacted password in the case mentioned for 127

The solution in all cases:

• using regular expressions to redact a password from the url_encoded connection string and two other places, to ensure password is redacted from logs

[codecov]

Codecov Report

Merging #138 (e2cf90f) into master (bd61a32) will increase coverage by 0.10%.
The diff coverage is 100.00%.

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

@@            Coverage Diff             @@
##           master     #138      +/-   ##
==========================================
+ Coverage   94.02%   94.13%   +0.10%     
==========================================
  Files           4        4              
  Lines         268      273       +5     
==========================================
+ Hits          252      257       +5     
  Misses         16       16              

Impacted Files	Coverage Δ
bcpandas/main.py	97.74% <100.00%> (+0.05%)	⬆️
bcpandas/utils.py	89.65% <100.00%> (+0.24%)	⬆️

[jacobshaw42]

This will fix issue #118

[yehoshuadimarsky]

Thanks so much for the contribution! This looks good to merge, just one small request - are you able to also write a (small) unit test that verifies this? Something simple that creates a credentials object, and verifies that the logs redact it - I recommend using pytests's caplog fixture https://docs.pytest.org/en/7.1.x/how-to/logging.html

[jacobshaw42]

Certainly, I will create the unit test for SqlCreds

This will also have an impact on the to_sql function, but I am not aware of how to create a unit test for something that would be inserting into a database.

[jacobshaw42]

@yehoshuadimarsky
Please see the update with the unit test

[yehoshuadimarsky]

Merged, thank you for your contribution!