rulemorph 0.3.2

YAML-based declarative data transformation engine for CSV/JSON to JSON
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

#[test]
fn redacted_mode_hides_secret_like_paths() {
    let yaml = r#"
version: 2
input:
  format: json
mappings:
  - target: "token"
    source: "api_token"
"#;
    let rule = parse_rule_file(yaml).expect("parse rule");
    let traced = transform_input_with_trace(
        &rule,
        InputData::Text(r#"[{"api_token":"secret-token"}]"#),
        None,
        &TransformTraceOptions::redacted(),
    )
    .expect("traced transform");

    assert_trace_does_not_contain_string(&traced.trace, "secret-token");
    assert_no_raw_leak_in_attributes_or_messages(&traced.trace, &["secret-token"]);
    let value = serde_json::to_value(&traced.trace).expect("trace json");
    assert!(value.to_string().contains("secret_like_path"));
}

#[test]
fn redacted_mode_hides_secret_source_written_to_public_target() {
    let yaml = r#"
version: 2
input:
  format: json
mappings:
  - target: "public_id"
    source: "api_token"
"#;
    let rule = parse_rule_file(yaml).expect("parse rule");
    let traced = transform_input_with_trace(
        &rule,
        InputData::Text(r#"[{"api_token":"secret-token"}]"#),
        None,
        &TransformTraceOptions::redacted(),
    )
    .expect("traced transform");

    assert_trace_does_not_contain_string(&traced.trace, "secret-token");
    assert_no_raw_leak_in_attributes_or_messages(&traced.trace, &["secret-token"]);
    let value = serde_json::to_value(&traced.trace).expect("trace json");
    assert!(value.to_string().contains("secret_like_path"));
}

#[test]
fn redacted_mode_hides_secret_expr_ref_written_to_public_target() {
    let yaml = r#"
version: 2
input:
  format: json
mappings:
  - target: "public_id"
    expr:
      - "@input.api_token"
      - trim
"#;
    let rule = parse_rule_file(yaml).expect("parse rule");
    let traced = transform_input_with_trace(
        &rule,
        InputData::Text(r#"[{"api_token":" secret-token "}]"#),
        None,
        &TransformTraceOptions::redacted(),
    )
    .expect("traced transform");

    assert_trace_does_not_contain_string(&traced.trace, "secret-token");
    assert_no_raw_leak_in_attributes_or_messages(&traced.trace, &["secret-token"]);
    let value = serde_json::to_value(&traced.trace).expect("trace json");
    assert!(value.to_string().contains("secret_like_path"));
}

#[test]
fn metadata_only_mode_never_serializes_raw_values() {
    let yaml = r#"
version: 2
input:
  format: json
mappings:
  - target: "name"
    source: "name"
"#;
    let rule = parse_rule_file(yaml).expect("parse rule");
    let traced = transform_input_with_trace(
        &rule,
        InputData::Text(r#"[{"name":"alice"}]"#),
        None,
        &TransformTraceOptions::metadata_only(),
    )
    .expect("traced transform");

    assert_trace_does_not_contain_string(&traced.trace, "alice");
    assert_no_raw_leak_in_attributes_or_messages(&traced.trace, &["alice"]);
    let value = serde_json::to_value(&traced.trace).expect("trace json");
    assert!(value.to_string().contains("metadata_only"));
    assert!(!traced.trace.contains_raw_values);
}

#[test]
fn transform_trace_error_debug_display_and_error_are_raw_safe() {
    let yaml = r#"
version: 2
input:
  format: json
mappings:
  - target: "token"
    source: "api_token"
  - target: "bad"
    expr:
      - "@input.age"
      - divide: 0
"#;
    let rule = parse_rule_file(yaml).expect("parse rule");
    let err = transform_input_with_trace(
        &rule,
        InputData::Text(r#"[{"api_token":"secret-token","age":10}]"#),
        None,
        &TransformTraceOptions::raw(),
    )
    .expect_err("traced transform should fail");

    let debug = format!("{err:?}");
    let display = format!("{err}");
    assert!(!debug.contains("secret-token"));
    assert!(!debug.contains("api_token"));
    assert!(debug.contains("expr_error"));
    assert!(!display.contains("secret-token"));
    assert!(!display.contains("api_token"));
    assert!(display.contains("expr_error"));
    let source = std::error::Error::source(&err);
    assert!(
        source.is_none(),
        "TransformTraceError must not expose raw TransformError as source"
    );
    assert!(err.trace.contains_raw_values);
}