Skip to content

Commit 0d428c4

Browse files
authored
fix: reject control characters in job names (#263)
* fix: reject control characters in job names Signed-off-by: Stephen Crowe <6042774+crowecawcaw@users.noreply.github.com>
1 parent 9aa4d6a commit 0d428c4

2 files changed

Lines changed: 47 additions & 0 deletions

File tree

‎src/openjd/model/v2023_09/_model.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,8 @@ class JobTemplateName(FormatString):
203203
_min_length = 1
204204
# Max length is validated after resolution in Job model, not here
205205
# because the template name can contain format strings
206+
# All unicode except the [Cc] (control characters) category
207+
_regex = f"(?-m:^[^{_Cc_characters}]+\\Z)"
206208

207209
def __new__(cls, value: str, *, context: ModelParsingContextInterface = ModelParsingContext()):
208210
return super().__new__(cls, value, context=context)

‎test/openjd/model/v2023_09/test_job_template.py‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,51 @@ def test_parse_success(self, data: dict[str, Any]) -> None:
195195
1,
196196
id="unknown key",
197197
),
198+
pytest.param(
199+
{
200+
"specificationVersion": "jobtemplate-2023-09",
201+
"name": "Job\x1fName",
202+
"steps": [STEP_TEMPLATE],
203+
},
204+
1,
205+
id="name with control char 0x1F",
206+
),
207+
pytest.param(
208+
{
209+
"specificationVersion": "jobtemplate-2023-09",
210+
"name": "Job\x7fName",
211+
"steps": [STEP_TEMPLATE],
212+
},
213+
1,
214+
id="name with control char 0x7F",
215+
),
216+
pytest.param(
217+
{
218+
"specificationVersion": "jobtemplate-2023-09",
219+
"name": "Job\x9fName",
220+
"steps": [STEP_TEMPLATE],
221+
},
222+
1,
223+
id="name with control char 0x9F",
224+
),
225+
pytest.param(
226+
{
227+
"specificationVersion": "jobtemplate-2023-09",
228+
"name": "JobName\n",
229+
"steps": [STEP_TEMPLATE],
230+
},
231+
1,
232+
id="name with trailing newline",
233+
),
234+
pytest.param(
235+
{
236+
"specificationVersion": "jobtemplate-2023-09",
237+
"name": "Job\nName",
238+
"steps": [STEP_TEMPLATE],
239+
},
240+
1,
241+
id="name with embedded newline",
242+
),
198243
pytest.param(
199244
{
200245
"name": "Foo",

0 commit comments

Comments
 (0)