Commit 8cf2db4

author

Christian Riedel

committed

improve tag searching in commit message

Prior only the first of the tag was checked. Now all occurances are iterated over until a fullmatch is found, which then is optionally online verified.

1 parent 4d2483e commit 8cf2db4Copy full SHA for 8cf2db4

File tree

2 files changed

+35

-4

lines changed

src/commit_msg_jira_hook
- check_jira_tag.py
tests
- test_check_jira_tag.py

2 files changed

+35

-4

lines changed

`‎src/commit_msg_jira_hook/check_jira_tag.py‎`

Lines changed: 14 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -87,21 +87,31 @@ def main(ctx, jira_tag: str, jira_url: str, verify: bool, commit_msg_file: str)`
`87`	`87`
`88`	`88`	`c_msg_cleaned = "\n".join(c_msg_lines)`
`89`	`89`
	`90`	`+ regex_str = r"(" + jira_tag.upper() + r")-?([0-9]+)?"`
	`91`	`+`
`90`	`92`	`#: Extract tag from commit msg`
`91`		`- extract = re.search(r"("+jira_tag.upper() +r")-?([0-9]+)?", c_msg_cleaned)`
	`93`	`+ extract = re.search(regex_str, c_msg_cleaned)`
`92`	`94`
`93`	`95`	`#: Check if tag is in commit msg`
`94`	`96`	`if extract is None:`
`95`	`97`	`click.echo(f"'{jira_tag.upper()}' tag not found in commit message.")`
`96`	`98`	`ctx.abort()`
`97`	`99`
`98`		`- #: Check if tag has a number`
`99`	`100`	`if extract.group(2) is None: # type: ignore`
`100`	`101`	`click.echo(f"'{jira_tag.upper()}' tag but no number found in commit message.")`
`101`	`102`	`ctx.abort()`
`102`	`103`
`103`		`- #: Get tag from extract`
`104`		`- issue = str(extract.group(0)) # type: ignore`
	`104`	`+ for match in re.finditer(regex_str, c_msg_cleaned):`
	`105`	`+ #: Check if tag has a number`
	`106`	`+ if match.group(2) is None: # type: ignore`
	`107`	`+ #: This tag has no number, try next`
	`108`	`+ continue`
	`109`	`+ #: Get tag from extract`
	`110`	`+ issue = str(match.group(0)) # type: ignore`
	`111`	`+ break`
	`112`	`+ else:`
	`113`	`+ click.echo(f"'{jira_tag.upper()}' tag but no number found in commit message.")`
	`114`	`+ ctx.abort()`
`105`	`115`
`106`	`116`	`#: Exit with 0 when online check is disabled`
`107`	`117`	`if not verify:`

`‎tests/test_check_jira_tag.py‎`

Lines changed: 21 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -209,3 +209,24 @@ def test_no_verify(mock_ini, mock_commit_msg_file, cli_runner):`
`209`	`209`	`)`
`210`	`210`
`211`	`211`	`assert result.exit_code == 0`
	`212`	`+`
	`213`	`+`
	`214`	`+@pytest.mark.parametrize(`
	`215`	`+ "commit_msg",`
	`216`	`+ [`
	`217`	`+ "TAG message TAG123",`
	`218`	`+ "TAG message TAG-123",`
	`219`	`+ "message #TAG #TAG-123 #TAG",`
	`220`	`+ ],`
	`221`	`+)`
	`222`	`+def test_all_tag_finds_are_search_for_fullmatch(`
	`223`	`+ commit_msg, mock_ini, mock_commit_msg_file, cli_runner`
	`224`	`+):`
	`225`	`+ """Assert next tag occurance is checked if prior one is missing number."""`
	`226`	`+ mock_commit_msg_file.write_text(commit_msg)`
	`227`	`+`
	`228`	`+ result = cli_runner.invoke(`
	`229`	`+ main, ["--jira-tag=TAG", "--no-verify", str(mock_commit_msg_file)]`
	`230`	`+ )`
	`231`	`+`
	`232`	`+ assert result.exit_code == 0`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 8cf2db4

File tree

2 files changed

2 files changed

`‎src/commit_msg_jira_hook/check_jira_tag.py‎`

`‎tests/test_check_jira_tag.py‎`

0 commit comments