53 lines
2.8 KiB
Python
53 lines
2.8 KiB
Python
import subprocess
|
|
|
|
from qa.base import BaseTestCase
|
|
from qa.shell import echo, gitlint
|
|
from qa.utils import FILE_ENCODING, TERMINAL_ENCODING
|
|
|
|
|
|
class StdInTests(BaseTestCase):
|
|
"""Integration tests for various STDIN scenarios for gitlint"""
|
|
|
|
def test_stdin_pipe(self):
|
|
"""Test piping input into gitlint.
|
|
This is the equivalent of doing:
|
|
$ echo "foo" | gitlint
|
|
"""
|
|
# NOTE: There is no use in testing this with _tty_in=True, because if you pipe something into a command
|
|
# there never is a TTY connected to stdin (per definition). We're setting _tty_in=False here to be explicit
|
|
# but note that this is always true when piping something into a command.
|
|
output = gitlint(echo("WIP: Pïpe test."), _cwd=self.tmp_git_repo, _tty_in=False, _err_to_out=True, _ok_code=[3])
|
|
self.assertEqualStdout(output, self.get_expected("test_stdin/test_stdin_pipe_1"))
|
|
|
|
def test_stdin_pipe_empty(self):
|
|
"""Test the scenario where no TTY is attached and nothing is piped into gitlint. This occurs in
|
|
CI runners like Jenkins and Gitlab, see https://github.com/jorisroovers/gitlint/issues/42 for details.
|
|
This is the equivalent of doing:
|
|
$ echo -n "" | gitlint
|
|
"""
|
|
commit_msg = "WIP: This ïs a title.\nContent on the sëcond line"
|
|
self.create_simple_commit(commit_msg)
|
|
|
|
# We need to set _err_to_out explicitly for sh to merge stdout and stderr output in case there's
|
|
# no TTY attached to STDIN
|
|
# http://amoffat.github.io/sh/sections/special_arguments.html?highlight=_tty_in#err-to-out
|
|
output = gitlint(echo("-n", ""), _cwd=self.tmp_git_repo, _tty_in=False, _err_to_out=True, _ok_code=[3])
|
|
|
|
self.assertEqualStdout(output, self.get_expected("test_stdin/test_stdin_pipe_empty_1"))
|
|
|
|
def test_stdin_file(self):
|
|
"""Test the scenario where STDIN is a regular file (stat.S_ISREG = True)
|
|
This is the equivalent of doing:
|
|
$ gitlint < myfile
|
|
"""
|
|
tmp_commit_msg_file = self.create_tmpfile("WIP: STDIN ïs a file test.")
|
|
|
|
with open(tmp_commit_msg_file, encoding=FILE_ENCODING) as file_handle: # noqa: SIM117
|
|
# We need to use subprocess.Popen() here instead of sh because when passing a file_handle to sh, it will
|
|
# deal with reading the file itself instead of passing it on to gitlint as a STDIN. Since we're trying to
|
|
# test for the condition where stat.S_ISREG == True that won't work for us here.
|
|
with subprocess.Popen(
|
|
"gitlint", stdin=file_handle, cwd=self.tmp_git_repo, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
|
|
) as p:
|
|
output, _ = p.communicate()
|
|
self.assertEqual(output.decode(TERMINAL_ENCODING), self.get_expected("test_stdin/test_stdin_file_1"))
|