Commit 65ae829

committed

feat(cz_check): cz check can read from a string input

1 parent 750213c commit 65ae829Copy full SHA for 65ae829

File tree

+30

-1

lines changed

+30

-1

lines changed

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -195,6 +195,11 @@`
`195`	`195`	`"help": "a range of git rev to check. e.g, master..HEAD",`
`196`	`196`	`"exclusive_group": "group1",`
`197`	`197`	`},`
	`198`	`+ {`
	`199`	`+ "name": ["-m", "--message"],`
	`200`	`+ "help": "commit message that needs to be checked",`
	`201`	`+ "exclusive_group": "group1",`
	`202`	`+ },`
`198`	`203`	`],`
`199`	`204`	`},`
`200`	`205`	`{`

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ def __init__(self, config: BaseConfig, arguments: Dict[str, str], cwd=os.getcwd(`
`23`	`23`	`cwd: Current work directory`
`24`	`24`	`"""`
`25`	`25`	`self.commit_msg_file: Optional[str] = arguments.get("commit_msg_file")`
	`26`	`+ self.commit_msg: Optional[str] = arguments.get("message")`
`26`	`27`	`self.rev_range: Optional[str] = arguments.get("rev_range")`
`27`	`28`
`28`	`29`	`self._valid_command_argument()`
`@@ -31,7 +32,9 @@ def __init__(self, config: BaseConfig, arguments: Dict[str, str], cwd=os.getcwd(`
`31`	`32`	`self.cz = factory.commiter_factory(self.config)`
`32`	`33`
`33`	`34`	`def _valid_command_argument(self):`
`34`		`- if bool(self.commit_msg_file) is bool(self.rev_range):`
	`35`	`+ if not (`
	`36`	`+ bool(self.commit_msg_file) ^ bool(self.commit_msg) ^ bool(self.rev_range)`
	`37`	`+ ):`
`35`	`38`	`raise InvalidCommandArgumentError(`
`36`	`39`	`(`
`37`	`40`	`"One and only one argument is required for check command! "`
`@@ -77,6 +80,8 @@ def _get_commits(self):`
`77`	`80`	`commit_title = commit_file.readline()`
`78`	`81`	`commit_body = commit_file.read()`
`79`	`82`	`return [git.GitCommit(rev="", title=commit_title, body=commit_body)]`
	`83`	`+ elif self.commit_msg:`
	`84`	`+ return [git.GitCommit(rev="", title="", body=self.commit_msg)]`
`80`	`85`
`81`	`86`	`# Get commit messages from git log (--rev-range)`
`82`	`87`	`return git.get_commits(end=self.rev_range)`

Lines changed: 19 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -226,3 +226,22 @@ def test_check_a_range_of_failed_git_commits(config, mocker):`
`226`	`226`	`with pytest.raises(InvalidCommitMessageError) as excinfo:`
`227`	`227`	`check_cmd()`
`228`	`228`	`assert all([msg in str(excinfo.value) for msg in ill_formated_commits_msgs])`
	`229`	`+`
	`230`	`+`
	`231`	`+def test_check_command_with_valid_message(config, mocker):`
	`232`	`+ success_mock = mocker.patch("commitizen.out.success")`
	`233`	`+ check_cmd = commands.Check(`
	`234`	`+ config=config, arguments={"message": "fix(scope): some commit message"}`
	`235`	`+ )`
	`236`	`+`
	`237`	`+ check_cmd()`
	`238`	`+ success_mock.assert_called_once()`
	`239`	`+`
	`240`	`+`
	`241`	`+def test_check_command_with_invalid_message(config, mocker):`
	`242`	`+ error_mock = mocker.patch("commitizen.out.error")`
	`243`	`+ check_cmd = commands.Check(config=config, arguments={"message": "bad commit"})`
	`244`	`+`
	`245`	`+ with pytest.raises(InvalidCommitMessageError):`
	`246`	`+ check_cmd()`
	`247`	`+ error_mock.assert_called_once()`

Comments

(0)