Skip to content

Raw yaml

blackline.utils.testing.raw_yaml

dataset_yaml(table)

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/utils/testing/raw_yaml.py 
 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def dataset_yaml(table: str) -> str:
    return f"""
    dataset:
      - name: Demo Users Dataset
        description: Data collected about users for our analytics system.
        third_country_transfers:
          - USA
          - CAN
        joint_controller:
          name: Dave L. Epper
          address: 1 Acme Pl. New York, NY
          email: controller@acmeinc.com
          phone: +1 555 555 5555
          retention: 1 year post account deletion
        collections:
          {table}:
            name: {table}
            description: User information
            data_categories:
              - user
            datetime_field:
                name: created_at
            where:
              OR deactivation_date IS NOT NULL
            fields:
              - name: name
                description: User's first name
                data_categories:
                  - user.name
                deidentifier:
                  type: redact
                period: P365D # [±]P[DD]DT[HH]H[MM]M[SS]S
              - name: email
                description: User's Email
                data_categories:
                  - user.contact.email
                deidentifier:
                  type: replace
                  value: fake@email.com
                period: P365D # [±]P[DD]DT[HH]H[MM]M[SS]S
              - name: ip
                description: User's IP address
                data_categories:
                  - user.device.ip_address
                deidentifier:
                  type: mask
                  value: "#"
                period: "280 00" # [-][DD ][HH:MM]SS[.ffffff]
          session:
            name: session
            description: User sessions
            data_categories:
              - user.device.ip_address
            datetime_field:
              name: session_started_at
            dependencies:
              - {table}
            fields:
              - name: ip
                description: User's IP address
                data_categories:
                  - user.device.ip_address
                deidentifier:
                  type: mask
                  value: "#"
                period: "183 00"
              - name: cookie_id
                description: User's cookie ID
                data_categories:
                  - user.device.cookie_id
                deidentifier:
                  type: redact
                period: "183 00"
    """

organization_yaml()

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/utils/testing/raw_yaml.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def organization_yaml() -> str:
    return """
    organization:
      - key: organization_foo
        name: Acme Incorporated
        description: An Organization that represents all of Acme Inc.
        security_policy: https://example.org/privacy
        controller:
          name: Dave L. Epper
          address: 1 Acme Pl. New York, NY
          email: controller@acmeinc.com
          phone: +1 555 555 5555
        data_protection_officer:
          name: Preet Ector
          address: 1 Acme Pl. New York, NY
          email: dpo@acmeinc.com
          phone: +1 555 555 5555
        representative:
          name: Ann Othername
          address: 1 Acme Pl. New York, NY
          email: representative@acmeinc.com
          phone: +1 555 555 5555
    """

project_yaml()

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/utils/testing/raw_yaml.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
def project_yaml() -> str:
    return """
    name: test_project
    config-version: 1
    version: 0.0.1

    default-profile: dev

    catalogue-path: ./catalogue
    adapters-path: ./adapters
    """

resource_yaml()

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/utils/testing/raw_yaml.py 
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
def resource_yaml() -> str:
    return """
    resource:
      - key: demo_analytics_resource
        name: Demo Analytics Resource
        description: A resource used for analyzing customer behaviour.
        resource_type: Service
        data_responsibility_title: Controller
        administrating_department: Engineering
        third_country_transfers:
        - USA
        - CAN
        joint_controller:
          name: Dave L. Epper
          address: 1 Acme Pl. New York, NY
          email: controller@acmeinc.com
          phone: +1 555 555 5555
        data_protection_impact_assessment:
          is_required: True
          progress: Complete
          link: https://example.org/analytics_system_data_protection_impact_assessment
        privacy_declarations:
          - name: Analyze customer behaviour for improvements.
            data_categories:
              - user.contact
              - user.device.cookie_id
            data_use: improve.system
            data_subjects:
              - customer
            data_qualifier: identified_data
            egress:
              - another_demo_system
            ingress:
              - yet_another_demo_system
      """

sqlite_adapter_yaml()

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/utils/testing/raw_yaml.py 
14
15
16
17
18
19
20
21
22
23
def sqlite_adapter_yaml():
    return """
    env_prefix: TEST_
    profiles:
      dev:
        type: sqlite
        config:
          connection:
            database: "file::memory:?cache=shared"
            uri: true"""

system_yaml()

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/utils/testing/raw_yaml.py 
51
52
53
54
55
56
57
def system_yaml() -> str:
    return """
    system:
      - key: system_foo
        name: User Systems System
        description: A System for all of the user-related resources.
    """