Skip to content

Mask empty strings if PreserveLength is false #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 23, 2023
Merged

Mask empty strings if PreserveLength is false #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bae28dc
Mask empty strings if PreserveLength is false
sungam3r Oct 4, 2021
1bba5e8
Merge branch 'dev' into mask
sungam3r Oct 4, 2021
b7965bf
Merge branch 'dev' of github.com:destructurama/attributed into mask
sungam3r Nov 2, 2021
e82c545
test
sungam3r Nov 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Destructurama.Attributed/Attributed/LogMaskedAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ private bool IsDefaultMask()
private object FormatMaskedValue(string val)
{
if (string.IsNullOrEmpty(val))
return val;
return PreserveLength ? val : Text;

if (ShowFirst == 0 && ShowLast == 0)
{
Expand Down
33 changes: 33 additions & 0 deletions test/Destructurama.Attributed.Tests/MaskedAttributeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ public class CustomizedMaskedLogs
[LogMasked(PreserveLength = true)]
public string? DefaultMaskedPreserved { get; set; }

/// <summary>
/// "" results in "***"
/// </summary>
[LogMasked]
public string? DefaultMaskedNotPreservedOnEmptyString { get; set; }

/// <summary>
/// 123456789 results in "#"
/// </summary>
Expand Down Expand Up @@ -207,6 +213,33 @@ public void LogMaskedAttribute_Replaces_Value_With_DefaultStars_Mask_And_Preserv
Assert.AreEqual("*********", props["DefaultMaskedPreserved"].LiteralValue());
}

[Test]
public void LogMaskedAttribute_Replaces_Value_With_DefaultStars_Mask_And_Not_Preserve_Length_On_Empty_String()
{
// [LogMasked]
// "" -> "***"

LogEvent evt = null!;

var log = new LoggerConfiguration()
.Destructure.UsingAttributes()
.WriteTo.Sink(new DelegatingSink(e => evt = e))
.CreateLogger();

var customized = new CustomizedMaskedLogs
{
DefaultMaskedNotPreservedOnEmptyString = ""
};

log.Information("Here is {@Customized}", customized);

var sv = (StructureValue)evt.Properties["Customized"];
var props = sv.Properties.ToDictionary(p => p.Name, p => p.Value);

Assert.IsTrue(props.ContainsKey("DefaultMaskedNotPreservedOnEmptyString"));
Assert.AreEqual("***", props["DefaultMaskedNotPreservedOnEmptyString"].LiteralValue());
}

[Test]
public void LogMaskedAttribute_Replaces_Value_With_Provided_Mask()
{
Expand Down