Skip to content

Fix sed support on Windows clitest #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaronliu0130 merged 1 commit into from
Feb 25, 2024
Merged

Fix sed support on Windows clitest #257

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions cpplint_clitest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@

import glob
import os
import platform
import sys
import subprocess
import unittest
Expand All @@ -44,7 +43,7 @@

BASE_CMD = sys.executable + ' ' + os.path.abspath('./cpplint.py ')

def RunShellCommand(cmd, cwd='.'):
def RunShellCommand(cmd: str, args: str, cwd='.'):
"""
executes a command
:param cmd: A string to execute.
Expand All @@ -54,17 +53,19 @@ def RunShellCommand(cmd, cwd='.'):
stdout_target = subprocess.PIPE
stderr_target = subprocess.PIPE

proc = subprocess.Popen(cmd,
proc = subprocess.Popen(cmd + ' ' + args,
shell=True,
cwd=cwd,
stdout=stdout_target,
stderr=stderr_target)
out, err = proc.communicate()

# TODO: These transforms break testing of Windows --output=sed.
# Make output system-agnostic, aka support Windows
if os.sep == '\\':
out, err = out.replace(b'\\', b'/'), err.replace(b'\\', b'/')
# TODO: Support scenario with multiple folder inputs
win_path = (os.path.dirname(args.split(' ')[-1]) + '\\').encode()
good_path = win_path.replace(b'\\', b'/')
out, err = out.replace(win_path, good_path), err.replace(win_path, good_path)
if os.linesep == '\r\n':
out, err = out.replace(b'\r\n', b'\n'), err.replace(b'\r\n', b'\n')

Expand All @@ -75,7 +76,7 @@ def RunShellCommand(cmd, cwd='.'):
class UsageTest(unittest.TestCase):

def testHelp(self):
(status, out, err) = RunShellCommand(BASE_CMD + ' --help')
(status, out, err) = RunShellCommand(BASE_CMD, '--help')
self.assertEqual(0, status)
self.assertEqual(b'', out)
self.assertTrue(err.startswith(b'\nSyntax: cpplint'))
Expand Down Expand Up @@ -138,10 +139,6 @@ def _checkDef(self, path):
stdoutLines = int(datalines[2])
filenames = datalines[0].decode('utf8').strip()
args, _, filenames = filenames.rpartition(" ")
if '--output=sed' in args and platform.system() == 'Windows':
# TODO: Testing of Windows --output=sed is either broken
# by the transforms in `RunShellCommand`.
return
if '*' in filenames:
rel_cwd = os.path.dirname(path)
filenames = ' '.join(
Expand All @@ -164,11 +161,11 @@ def _runAndCheck(
expected_err
):
rel_cwd = os.path.dirname(definition_file)
cmd = BASE_CMD + self.get_extra_command_args(rel_cwd) + args
cmd = BASE_CMD + self.get_extra_command_args(rel_cwd)
cwd = os.path.join(self._root, rel_cwd)
# command to reproduce, do not forget first two lines have special meaning
print("\ncd " + cwd + " && " + cmd + " 2> <filename>")
(status, out, err) = RunShellCommand(cmd, cwd)
print("\ncd " + cwd + " && " + cmd + ' ' + args + " 2> <filename>")
(status, out, err) = RunShellCommand(cmd, args, cwd)
self.assertEqual(expected_status, status, 'bad command status %s' % status)
prefix = 'Failed check in %s comparing to %s for command: %s' % (cwd, definition_file, cmd)
compare('\n'.join(expected_err), err.decode('utf8'), prefix=prefix, show_whitespace=True)
Expand Down