cpplint/cpplint_clitest.py at develop · cpplint/cpplint · GitHub

History

executable file

275 lines (229 loc) · 10.4 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

#!/usr/bin/env python3

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions are

# met:

# * Redistributions of source code must retain the above copyright

# notice, this list of conditions and the following disclaimer.

# * Redistributions in binary form must reproduce the above

# copyright notice, this list of conditions and the following disclaimer

# in the documentation and/or other materials provided with the

# distribution.

# * Neither the name of Google Inc. nor the names of its

# contributors may be used to endorse or promote products derived from

# this software without specific prior written permission.

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""Command Line interface integration test for cpplint.py."""

import glob

import os

import shutil

import subprocess

import sys

import textwrap

import pytest

from testfixtures import compare # type: ignore[import-untyped]

import cpplint # noqa: F401

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

def run_shell_command(cmd: str, args: str, cwd: str = ".") -> tuple[int, bytes, bytes]:

"""Executes a command

Args:

cmd: A string to execute.

args: A string with arguments to the command.

cwd: from which folder to run.

"""

cmd, args = cmd.split(), args.replace('"', "").split() # type: ignore[assignment]

proc = subprocess.run(cmd + args, cwd=cwd, capture_output=True, check=False)

out, err = proc.stdout, proc.stderr

# Make output system-agnostic, aka support Windows

if os.sep == "\\":

# TODO(aaronliu0130): Support scenario with multiple input names

# We currently only support the last arguments as the input name

# to prevent accidentally replacing sed tests.

# Fixing would likely need coding an internal "replace slashes" option for cpplint itself.

win_path = (os.path.dirname(args[-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")

# print(err) # to get the output at time of test

return proc.returncode, out, err

def test_help():

(status, out, err) = run_shell_command(BASE_CMD, "--help")

assert status == 0

assert out == b""

assert err.startswith(b"\nSyntax: cpplint")

class TemporaryFolderClassSetup:

@pytest.fixture(autouse=True, scope="class")

@classmethod

def set_up_temp_root(cls, request, tmp_path_factory) -> str:

root = os.fspath(tmp_path_factory.mktemp(request.cls.__name__))

request.cls._root = root

return root

class DefCheckBase(TemporaryFolderClassSetup):

"""

Regression tests: The test starts a filetreewalker scanning for files name *.def

Such files are expected to have as first line the argument

to a cpplint invocation from within the same directory, as second line the

expected status code, then the line count of stdout lines,

then the stdout lines, and all other lines the expected

systemerr output (two blank lines at end).

"""

@pytest.fixture(autouse=True, scope="class")

@classmethod

def set_up(cls, request, set_up_temp_root):

"""setup tmp folder for testing with samples and custom additions by subclasses"""

root = request.cls._root

shutil.copytree("samples", os.path.join(root, "samples"))

request.cls.prepare_directory(root)

@classmethod

def prepare_directory(cls, root):

"""Override in subclass to manipulate temporary samples root folder before tests"""

pass

def get_extra_command_args(self, cwd):

"""Override in subclass to add arguments to command"""

return ""

def check_all_in_folder(self, folder_name, expected_defs):

# uncomment to show complete diff

# self.maxDiff = None

count = 0

for dirpath, _, fnames in os.walk(folder_name):

for f in fnames:

if f.endswith(".def"):

count += 1

self.check_def(os.path.join(dirpath, f))

assert count == expected_defs

def check_def(self, path):

"""runs command and compares to expected output from def file"""

# self.maxDiff = None # to see full diff

with open(path, "rb") as file_handle:

data = file_handle.readlines()

stdout_lines = int(data[2])

filenames = data[0].decode("utf8").strip()

args, _, filenames = filenames.rpartition(" ")

if "*" in filenames:

rel_cwd = os.path.dirname(path)

filenames = " ".join(

filename[len(rel_cwd) + 1 :]

for filename in glob.glob(rel_cwd + "/" + filenames)

)

args += " " + filenames

self._run_and_compare(

path,

args,

int(data[1]),

[line.decode("utf8").strip() for line in data[3 : 3 + stdout_lines]],

[line.decode("utf8").strip() for line in data[3 + stdout_lines :]],

)

def _run_and_compare(self, definition_file, args, expected_status, expected_out, expected_err):

rel_cwd = os.path.dirname(definition_file)

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 + " " + args + " 2> <filename>")

(status, out, err) = run_shell_command(cmd, args, cwd)

assert expected_status == status, f"bad command status {status}"

prefix = f"Failed check in {cwd} comparing to {definition_file} for command: {cmd}"

compare("\n".join(expected_err), err.decode("utf8"), prefix=prefix, show_whitespace=True)

compare("\n".join(expected_out), out.decode("utf8"), prefix=prefix, show_whitespace=True)

class TestNoRepoSignature(DefCheckBase):

"""runs in a temporary folder (under /tmp in linux) without any .git/.hg/.svn file"""

def get_extra_command_args(self, cwd):

return f" --repository {self._root} "

@pytest.mark.parametrize(

("folder", "case"),

[

(folder, case[:-4])

for folder in ["chromium", "vlc", "silly", "boost", "protobuf", "codelite", "v8"]

for case in os.listdir(f"./samples/{folder}-sample")

if case.endswith(".def")

)

@pytest.mark.timeout(180)

def test_samples(self, folder, case):

self.check_def(os.path.join(f"./samples/{folder}-sample", case + ".def"))

class TestGitRepoSignature(DefCheckBase):

"""runs in a temporary folder with .git file"""

@classmethod

def prepare_directory(cls, root):

with open(os.path.join(root, ".git"), "a"):

pass

def test_codelite_sample(self):

self.check_all_in_folder("./samples/codelite-sample", 1)

class TestMercurialRepoSignature(DefCheckBase):

"""runs in a temporary folder with .hg file"""

@classmethod

def prepare_directory(cls, root):

with open(os.path.join(root, ".hg"), "a"):

pass

def test_codelite_sample(self):

self.check_all_in_folder("./samples/codelite-sample", 1)

class TestSvnRepoSignature(DefCheckBase):

"""runs in a temporary folder with .svn file"""

@classmethod

def prepare_directory(cls, root):

with open(os.path.join(root, ".svn"), "a"):

pass

def test_codelite_sample(self):

self.check_all_in_folder("./samples/codelite-sample", 1)

# Tests for third_party_headers option

def test_third_party_headers_default(tmp_path):

# By default, headers with uppercase letters are treated as third-party and not flagged

cpp = tmp_path / "test.cpp"

cpp.write_text(

textwrap.dedent("""

#include "Foo.h"

int main() { return 0; }

""")

)

status, out, err = run_shell_command(BASE_CMD, f"{cpp.name}", cwd=str(tmp_path))

assert status == 0, f"stdout\n{out.decode('utf-8')}\nstderr\n{err.decode('utf-8')}"

# No include_subdir warning

assert b"build/include_subdir" not in err

def test_third_party_headers_override(tmp_path):

# Override third_party_headers so Foo.h is not recognized as third-party

cpp = tmp_path / "test.cpp"

cpp.write_text(

textwrap.dedent("""

#include "Foo.h"

""")

)

# Use a pattern that matches nothing

flag = "--third_party_headers=^Bar.h$"

status, out, err = run_shell_command(BASE_CMD, f"{flag} {cpp.name}", cwd=str(tmp_path))

# Expect a warning about include_subdir

assert status == 1, f"stdout\n{out.decode('utf-8')}\nstderr\n{err.decode('utf-8')}"

assert b"build/include_subdir" in err

def test_third_party_headers_config(tmp_path):

# Override third_party_headers via config file so Foo.h is not recognized as third-party

cpp = tmp_path / "test.cpp"

cpp.write_text(

textwrap.dedent("""

#include "Foo.h"

""")

)

# Write configuration file to override third_party_headers

config = tmp_path / "CPPLINT.cfg"

config.write_text("third_party_headers=^Bar.h$\n")

status, out, err = run_shell_command(BASE_CMD, f"{cpp.name}", cwd=str(tmp_path))

# Expect a warning about include_subdir due to override

assert status == 1, f"stdout\n{out.decode('utf-8')}\nstderr\n{err.decode('utf-8')}"

assert b"build/include_subdir" in err

if __name__ == "__main__":

pytest.main([__file__])

cpplint/cpplint_clitest.py at develop · cpplint/cpplint · GitHub

Uh oh!

Expand file tree

Breadcrumbs

cpplint_clitest.py

Latest commit

History

Breadcrumbs

cpplint_clitest.py

File metadata and controls