Skip to content
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

test(scrubbing): Add tests for PII scrubbing in breadcrumb.data #1955

Merged
merged 2 commits into from
Mar 22, 2023
Merged

test(scrubbing): Add tests for PII scrubbing in breadcrumb.data #1955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
246d887
test(scrubbing): Add tests for PII scrubbing in breadcrumb.data
iker-barriocanal Mar 21, 2023
60228c9
Add test snapshots
iker-barriocanal Mar 21, 2023
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
112 changes: 110 additions & 2 deletions relay-general/src/pii/processor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,8 +393,8 @@ mod tests {
use crate::pii::{DataScrubbingConfig, PiiConfig, ReplaceRedaction};
use crate::processor::process_value;
use crate::protocol::{
Addr, DataElement, DebugImage, DebugMeta, Event, ExtraValue, Headers, HttpElement,
LogEntry, NativeDebugImage, Request, Span, TagEntry, Tags,
Addr, Breadcrumb, DataElement, DebugImage, DebugMeta, Event, ExtraValue, Headers,
HttpElement, LogEntry, NativeDebugImage, Request, Span, TagEntry, Tags,
};
use crate::testutils::assert_annotated_snapshot;
use crate::types::{Annotated, FromValue, Object, Value};
Expand Down Expand Up @@ -1119,4 +1119,112 @@ mod tests {
process_value(&mut span, &mut pii_processor, ProcessingState::root()).unwrap();
assert_annotated_snapshot!(span);
}

#[test]
fn test_scrub_breadcrumb_data_http_not_scrubbed() {
let mut breadcrumb: Annotated<Breadcrumb> = Annotated::from_json(
r#"{
"data": {
"http": {
"query": "dance=true"
}
}
}"#,
)
.unwrap();

let ds_config = DataScrubbingConfig {
scrub_data: true,
scrub_defaults: true,
..Default::default()
};
let pii_config = ds_config.pii_config().unwrap().as_ref().unwrap();
let mut pii_processor = PiiProcessor::new(pii_config.compiled());
process_value(&mut breadcrumb, &mut pii_processor, ProcessingState::root()).unwrap();
assert_annotated_snapshot!(breadcrumb);
}

#[test]
fn test_scrub_breadcrumb_data_http_strings_are_scrubbed() {
let mut breadcrumb: Annotated<Breadcrumb> = Annotated::from_json(
r#"{
"data": {
"http": {
"query": "ccnumber=5105105105105100&process_id=123",
"fragment": "ccnumber=5105105105105100,process_id=123"
}
}
}"#,
)
.unwrap();

let ds_config = DataScrubbingConfig {
scrub_data: true,
scrub_defaults: true,
..Default::default()
};
let pii_config = ds_config.pii_config().unwrap().as_ref().unwrap();
let mut pii_processor = PiiProcessor::new(pii_config.compiled());
process_value(&mut breadcrumb, &mut pii_processor, ProcessingState::root()).unwrap();
assert_annotated_snapshot!(breadcrumb);
}

#[test]
fn test_scrub_breadcrumb_data_http_objects_are_scrubbed() {
let mut breadcrumb: Annotated<Breadcrumb> = Annotated::from_json(
r#"{
"data": {
"http": {
"query": {
"ccnumber": "5105105105105100",
"process_id": "123"
},
"fragment": {
"ccnumber": "5105105105105100",
"process_id": "123"
}
}
}
}"#,
)
.unwrap();

let ds_config = DataScrubbingConfig {
scrub_data: true,
scrub_defaults: true,
..Default::default()
};
let pii_config = ds_config.pii_config().unwrap().as_ref().unwrap();
let mut pii_processor = PiiProcessor::new(pii_config.compiled());

process_value(&mut breadcrumb, &mut pii_processor, ProcessingState::root()).unwrap();
assert_annotated_snapshot!(breadcrumb);
}

#[test]
fn test_scrub_breadcrumb_data_untyped_props_are_scrubbed() {
let mut breadcrumb: Annotated<Breadcrumb> = Annotated::from_json(
r#"{
"data": {
"untyped": "ccnumber=5105105105105100",
"more_untyped": {
"typed": "no",
"scrubbed": "yes",
"ccnumber": "5105105105105100"
}
}
}"#,
)
.unwrap();

let ds_config = DataScrubbingConfig {
scrub_data: true,
scrub_defaults: true,
..Default::default()
};
let pii_config = ds_config.pii_config().unwrap().as_ref().unwrap();
let mut pii_processor = PiiProcessor::new(pii_config.compiled());
process_value(&mut breadcrumb, &mut pii_processor, ProcessingState::root()).unwrap();
assert_annotated_snapshot!(breadcrumb);
}
}
11 changes: 11 additions & 0 deletions ...pshots/relay_general__pii__processor__tests__scrub_breadcrumb_data_http_not_scrubbed.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
source: relay-general/src/pii/processor.rs
expression: breadcrumb
---
{
"data": {
"http": {
"query": "dance=true"
}
}
}
54 changes: 54 additions & 0 deletions ...elay_general__pii__processor__tests__scrub_breadcrumb_data_http_objects_are_scrubbed.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
source: relay-general/src/pii/processor.rs
expression: breadcrumb
---
{
"data": {
"http": {
"fragment": {
"ccnumber": "[Filtered]",
"process_id": "123"
},
"query": {
"ccnumber": "[Filtered]",
"process_id": "123"
}
}
},
"_meta": {
"data": {
"http": {
"fragment": {
"ccnumber": {
"": {
"rem": [
[
"@creditcard:filter",
"s",
0,
10
]
],
"len": 16
}
}
},
"query": {
"ccnumber": {
"": {
"rem": [
[
"@creditcard:filter",
"s",
0,
10
]
],
"len": 16
}
}
}
}
}
}
}
44 changes: 44 additions & 0 deletions ...elay_general__pii__processor__tests__scrub_breadcrumb_data_http_strings_are_scrubbed.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
source: relay-general/src/pii/processor.rs
expression: breadcrumb
---
{
"data": {
"http": {
"fragment": "ccnumber=[Filtered],process_id=123",
"query": "ccnumber=[Filtered]&process_id=123"
}
},
"_meta": {
"data": {
"http": {
"fragment": {
"": {
"rem": [
[
"@creditcard:filter",
"s",
9,
19
]
],
"len": 40
}
},
"query": {
"": {
"rem": [
[
"@creditcard:filter",
"s",
9,
19
]
],
"len": 40
}
}
}
}
}
}
46 changes: 46 additions & 0 deletions ...lay_general__pii__processor__tests__scrub_breadcrumb_data_untyped_props_are_scrubbed.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
source: relay-general/src/pii/processor.rs
expression: breadcrumb
---
{
"data": {
"more_untyped": {
"ccnumber": "[Filtered]",
"scrubbed": "yes",
"typed": "no"
},
"untyped": "ccnumber=[Filtered]"
},
"_meta": {
"data": {
"more_untyped": {
"ccnumber": {
"": {
"rem": [
[
"@creditcard:filter",
"s",
0,
10
]
],
"len": 16
}
}
},
"untyped": {
"": {
"rem": [
[
"@creditcard:filter",
"s",
9,
19
]
],
"len": 25
}
}
}
}
}