Skip to content

Commit 87c7c07

Browse files
authored
Add instructions for chef-cli validation (#4)
Add more clear instructions on how to make validation with chef-cli for IDM and EDM work item: https://app.devrev.ai/devrev/works/ISS-193822
1 parent 0fdf781 commit 87c7c07

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

devrev-trello-snapin.plain

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@
8888

8989
- Store The External Domain Metadata JSON object as a separate JSON file.
9090

91+
92+
***Test Requirements:***
93+
94+
- The Conformance Tests should not modify nor do any transformations on The External Domain Metadata JSON object at all. If The Conformance Tests indicates a problem with The External Domain Metadata JSON object, The External Domain Metadata JSON object in the implementation code should be adjusted to fix the problem. The tests should only validate the JSON object in its original form.
95+
9196
***Functional Requirements:***
9297

9398
- Implement The Function that generates and returns The External Domain Metadata JSON object. The record types that should be included in the The External Domain Metadata are The List of Cards ('cards') and The List of Users ('users').
@@ -99,6 +104,7 @@
99104
- The path to The Chef CLI executable is provided in the environment variables `CHEF_CLI_PATH`.
100105
- For the test to be successful The Chef CLI must return an empty output.
101106
- The test should always fail if The Chef CLI is not available.
107+
- The Acceptance Tests should not modify nor do any transformations on The External Domain Metadata JSON object at all. The Acceptance Tests should just read The External Domain Metadata JSON object and pass it to The Chef CLI.
102108

103109

104110
## Generate 'initial_domain_mapping.json'
@@ -112,22 +118,27 @@
112118
- Please note that mappings are split into separate ‘shards’ - one for each record type - for easier manipulation and storage.
113119
- Please note that a leaf type or a concrete id has to be selected for use_devrev_record, but not both.
114120

121+
115122
***Non-Functional Requirements:***
116123

117124
- Store The Initial Domain Mapping JSON object as a separate JSON file.
118125

126+
***Test Requirements:***
127+
128+
- The Conformance Tests should not modify nor do any transformations on The Initial Domain Mapping JSON object at all. If The Conformance Tests indicates a problem with The Initial Domain Mapping JSON object, The Initial Domain Mapping JSON object in the implementation code should be adjusted to fix the problem. The tests should only validate the JSON object in its original form.
129+
119130
***Functional Requirements:***
120131

121132
- Implement The Function that generates and returns The Initial Domain Mapping JSON object.
122133

123-
124134
***Acceptance Tests:***
125135

126136
- Validate generated The Initial Domain Mapping JSON object with the chef-cli tool (The Chef CLI) using the command "chef-cli initial-mapping check -m <The External Domain Metadata JSON object file>":
127137
- The Chef CLI reads The Initial Domain Mapping JSON object from stdin.
128138
- The path to The Chef CLI executable is provided in the environment variables `CHEF_CLI_PATH`.
129139
- The test should always fail if The Chef CLI returns a non-empty output.
130140
- The test should always fail if The Chef CLI is not available.
141+
- The Acceptance Tests should not modify nor do any transformations on The Initial Domain Mapping JSON object at all. The Acceptance Tests should just read The Initial Domain Mapping JSON object and pass it to The Chef CLI.
131142

132143

133144
## Pushing data to DevRev servers

0 commit comments

Comments
 (0)