binaryen/check.py at waitqueue-api · WebAssembly/binaryen · GitHub

History

executable file

493 lines (397 loc) · 18.9 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

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

#!/usr/bin/env python3

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

import functools

import glob

import io

import os

import subprocess

import sys

import unittest

from contextlib import contextmanager

from multiprocessing.pool import ThreadPool

from pathlib import Path

from scripts.test import binaryenjs, finalize, shared, support, wasm2js, wasm_opt

from scripts.test.shared import print_heading

assert sys.version_info >= (3, 10), 'requires Python 3.10'

def get_changelog_version():

with open(os.path.join(shared.options.binaryen_root, 'CHANGELOG.md')) as f:

lines = f.readlines()

lines = [line for line in lines if len(line.split()) == 1]

lines = [line for line in lines if line.startswith('v')]

version = lines[0][1:]

print(f"Parsed CHANGELOG.md version: {version}")

return int(version)

def run_version_tests():

print_heading('checking --version ...')

not_executable_suffix = ['.DS_Store', '.txt', '.js', '.ilk', '.pdb', '.dll', '.wasm', '.manifest']

executable_prefix = ['wasm']

bin_files = [os.path.join(shared.options.binaryen_bin, f) for f in os.listdir(shared.options.binaryen_bin)]

executables = [f for f in bin_files if os.path.isfile(f) and

not any(f.endswith(s) for s in not_executable_suffix) and

any(os.path.basename(f).startswith(s) for s in executable_prefix)]

executables = sorted(executables)

assert executables

changelog_version = get_changelog_version()

for e in executables:

print(f'.. {e} --version')

proc = subprocess.run([e, '--version'], capture_output=True, text=True)

assert len(proc.stderr) == 0, f'Expected no stderr, got:\n{proc.stderr}'

out = proc.stdout

assert os.path.basename(e).replace('.exe', '') in out, f'Expected version to contain program name, got:\n{out}'

assert len(out.strip().splitlines()) == 1, f'Expected only version info, got:\n{out}'

parts = out.split()

assert parts[1] == 'version'

version = int(parts[2])

assert version == changelog_version

def run_wasm_dis_tests():

print_heading('checking wasm-dis on provided binaries...')

for t in shared.get_tests(shared.options.binaryen_test, ['.wasm']):

print('..', os.path.basename(t))

cmd = shared.WASM_DIS + [t]

if os.path.isfile(t + '.map'):

cmd += ['--source-map', t + '.map']

actual = support.run_command(cmd)

shared.fail_if_not_identical_to_file(actual, t + '.fromBinary')

# also verify there are no validation errors

with shared.with_pass_debug():

cmd = shared.WASM_OPT + [t, '-all', '-q']

support.run_command(cmd)

def run_crash_tests():

print_heading("checking we don't crash on tricky inputs...")

for t in shared.get_tests(shared.get_test_dir('crash'), ['.wast', '.wasm']):

print('..', os.path.basename(t))

cmd = shared.WASM_OPT + [t]

# expect a parse error to be reported

support.run_command(cmd, expected_err='parse exception:', err_contains=True, expected_status=1)

def run_dylink_tests():

print_heading('we emit dylink sections properly...')

dylink_tests = glob.glob(os.path.join(shared.options.binaryen_test, 'dylib*.wasm'))

for t in sorted(dylink_tests):

print('..', os.path.basename(t))

cmd = shared.WASM_OPT + [t, '-o', 'a.wasm']

support.run_command(cmd)

with open('a.wasm', 'rb') as output:

index = output.read().find(b'dylink')

print(' ', index)

assert index == 11, 'dylink section must be first, right after the magic number etc.'

def run_ctor_eval_tests():

print_heading('checking wasm-ctor-eval...')

for t in shared.get_tests(shared.get_test_dir('ctor-eval'), ['.wast', '.wasm']):

print('..', os.path.basename(t))

ctors = open(t + '.ctors').read().strip()

cmd = shared.WASM_CTOR_EVAL + [t, '-all', '-o', 'a.wat', '-S', '--ctors', ctors]

if 'ignore-external-input' in t:

cmd += ['--ignore-external-input']

if 'results' in t:

cmd += ['--kept-exports', 'test1,test3']

support.run_command(cmd)

actual = open('a.wat').read()

out = t + '.out'

shared.fail_if_not_identical_to_file(actual, out)

def run_wasm_metadce_tests():

print_heading('checking wasm-metadce')

for t in shared.get_tests(shared.get_test_dir('metadce'), ['.wast', '.wasm']):

print('..', os.path.basename(t))

graph = t + '.graph.txt'

cmd = shared.WASM_METADCE + [t, '--graph-file=' + graph, '-o', 'a.wat', '-S', '-all']

stdout = support.run_command(cmd)

expected = t + '.dced'

with open('a.wat') as seen:

shared.fail_if_not_identical_to_file(seen.read(), expected)

shared.fail_if_not_identical_to_file(stdout, expected + '.stdout')

def run_wasm_reduce_tests():

if not shared.has_shell_timeout():

print_heading('skipping wasm-reduce testcases')

return

print_heading('checking wasm-reduce testcases')

# fixed testcases

for t in shared.get_tests(shared.get_test_dir('reduce'), ['.wast']):

print('..', os.path.basename(t))

# convert to wasm

support.run_command(shared.WASM_AS + [t, '-o', 'a.wasm', '-all'])

cmd = shared.WASM_OPT[0]

support.run_command(shared.WASM_REDUCE + ['a.wasm', f'--command={cmd} b.wasm --fuzz-exec -all ', '-t', 'b.wasm', '-w', 'c.wasm', '--timeout=4'])

expected = t + '.txt'

support.run_command(shared.WASM_DIS + ['c.wasm', '-o', 'a.wat'])

with open('a.wat') as seen:

shared.fail_if_not_identical_to_file(seen.read(), expected)

# run on a nontrivial fuzz testcase, for general coverage

# this is very slow in ThreadSanitizer, so avoid it there

if 'fsanitize=thread' not in str(os.environ):

print_heading('checking wasm-reduce fuzz testcase')

# TODO: re-enable multivalue once it is better optimized

support.run_command(shared.WASM_OPT + [os.path.join(shared.options.binaryen_test, 'lit/basic/signext.wast'), '-ttf', '-Os', '-o', 'a.wasm', '--detect-features', '--disable-multivalue'])

before = os.stat('a.wasm').st_size

cmd = shared.WASM_OPT[0]

support.run_command(shared.WASM_REDUCE + ['a.wasm', f'--command={cmd} b.wasm --fuzz-exec --detect-features', '-t', 'b.wasm', '-w', 'c.wasm'])

after = os.stat('c.wasm').st_size

# This number is a custom threshold to check if we have shrunk the

# output sufficiently

assert after < 0.85 * before, [before, after]

def run_spec_test(wast, stdout=None):

cmd = shared.WASM_SHELL + [wast]

output = support.run_command(cmd, stdout=stdout, stderr=subprocess.PIPE)

# filter out binaryen interpreter logging that the spec suite

# doesn't expect

filtered = [line for line in output.splitlines() if not line.startswith('[trap')]

return '\n'.join(filtered) + '\n'

def run_opt_test(wast, stdout=None):

# check optimization validation

cmd = shared.WASM_OPT + [wast, '-O', '-all', '-q']

support.run_command(cmd, stdout=stdout)

def check_expected(actual, expected, stdout=None):

if expected and os.path.exists(expected):

expected = open(expected).read()

shared.verbose_log(' (using expected output)', file=stdout)

actual = actual.strip()

expected = expected.strip()

if actual != expected:

shared.fail(actual, expected)

UNSPLITTABLE_TESTS = [Path(x) for x in [

"spec/testsuite/instance.wast",

"spec/instance.wast",

# TODO: support module splitting for (thread ...) blocks

"spec/threads/*"]]

def is_splittable(wast: Path):

return not any(wast.match(unsplittable_test) for unsplittable_test in UNSPLITTABLE_TESTS)

def run_one_spec_test(wast: Path, stdout=None):

test_name = wast.name

# /path/to/binaryen/test/spec/foo.wast -> test-spec-foo

base_name = "-".join(wast.relative_to(Path(shared.options.binaryen_root)).with_suffix("").parts)

print('..', test_name, file=stdout)

# windows has some failures that need to be investigated

if test_name == 'names.wast' and shared.skip_if_on_windows('spec: ' + test_name):

return

expected = os.path.join(shared.get_test_dir('spec'), 'expected-output', test_name + '.log')

# some spec tests should fail (actual process failure, not just assert_invalid)

try:

actual = run_spec_test(str(wast), stdout=stdout)

except Exception as e:

if ('wasm-validator error' in str(e) or 'error: ' in str(e)) and '.fail.' in test_name:

shared.verbose_log('<< test failed as expected >>', file=stdout)

return # don't try all the binary format stuff TODO

else:

shared.fail_with_error(str(e))

raise

check_expected(actual, expected, stdout=stdout)

if not is_splittable(wast):

return

# check binary format. here we can verify execution of the final

# result, no need for an output verification

actual = ''

transformed_path = base_name + ".transformed"

with open(transformed_path, 'w') as transformed_spec_file:

for i, (module, asserts) in enumerate(support.split_wast(str(wast))):

if not module:

# Skip any initial assertions that don't have a module

continue

shared.verbose_log(f' testing split module {i}', file=stdout)

split_name = base_name + f'_split{i}.wast'

support.write_wast(split_name, module)

run_opt_test(split_name, stdout=stdout) # also that our optimizer doesn't break on it

result_wast_file = shared.binary_format_check(split_name, verify_final_result=False, base_name=base_name, stdout=stdout)

with open(result_wast_file) as f:

result_wast = f.read()

# add the asserts, and verify that the test still passes

transformed_spec_file.write(result_wast + '\n' + '\n'.join(asserts))

# compare all the outputs to the expected output

actual = run_spec_test(transformed_path, stdout=stdout)

check_expected(actual, os.path.join(shared.get_test_dir('spec'), 'expected-output', test_name + '.log'), stdout=stdout)

def run_spec_test_with_wrapped_stdout(wast: Path):

"""Run a single spec test while capturing stdout.

Return (bool, str) where the first element is whether the test was

successful and the second is the combined stdout and stderr of the test.

"""

out = io.StringIO()

try:

run_one_spec_test(wast, stdout=out)

except Exception as e:

shared.num_failures += 1

# Serialize exceptions into the output string buffer

# so they can be reported on the main thread.

print(e, file=out)

return False, out.getvalue()

return True, out.getvalue()

@contextmanager

def red_output(file=sys.stdout):

print("\033[31m", end="", file=file)

try:

yield

finally:

print("\033[0m", end="", file=file)

def red_stderr():

return red_output(file=sys.stderr)

def run_spec_tests():

print_heading('checking wasm-shell spec testcases...')

worker_count = os.cpu_count()

print("Running with", worker_count, "workers")

test_paths = (Path(x) for x in shared.options.spec_tests)

failed_stdouts = []

with ThreadPool(processes=worker_count) as pool:

try:

for success, stdout in pool.imap_unordered(run_spec_test_with_wrapped_stdout, test_paths):

if success:

print(stdout, end="")

continue

failed_stdouts.append(stdout)

if shared.options.abort_on_first_failure:

with red_stderr():

print("Aborted spec test suite execution after first failure. Set --no-fail-fast to disable this.", file=sys.stderr)

break

except KeyboardInterrupt:

# Hard exit to avoid threads continuing to run after Ctrl-C.

# There's no concern of deadlocking during shutdown here.

os._exit(1)

if failed_stdouts:

with red_stderr():

print("Failed tests:", file=sys.stderr)

for failed in failed_stdouts:

print(failed, end="", file=sys.stderr)

def run_validator_tests():

print_heading('running validation tests...')

# Ensure the tests validate by default

cmd = shared.WASM_AS + [os.path.join(shared.get_test_dir('validator'), 'invalid_export.wast'), '-o', 'a.wasm']

support.run_command(cmd)

cmd = shared.WASM_AS + [os.path.join(shared.get_test_dir('validator'), 'invalid_import.wast'), '-o', 'a.wasm']

support.run_command(cmd)

cmd = shared.WASM_AS + ['--validate=web', os.path.join(shared.get_test_dir('validator'), 'invalid_export.wast'), '-o', 'a.wasm']

support.run_command(cmd, expected_status=1)

cmd = shared.WASM_AS + ['--validate=web', os.path.join(shared.get_test_dir('validator'), 'invalid_import.wast'), '-o', 'a.wasm']

support.run_command(cmd, expected_status=1)

cmd = shared.WASM_AS + ['--validate=none', os.path.join(shared.get_test_dir('validator'), 'invalid_return.wast'), '-o', 'a.wasm']

support.run_command(cmd)

cmd = shared.WASM_AS + [os.path.join(shared.get_test_dir('validator'), 'invalid_number.wast'), '-o', 'a.wasm']

support.run_command(cmd, expected_status=1)

def run_example_tests():

print_heading('checking native example testcases...')

if not shared.NATIVECC or not shared.NATIVEXX:

shared.fail_with_error('Native compiler (e.g. gcc/g++) was not found in PATH!')

return

# windows + gcc will need some work

if shared.skip_if_on_windows('example'):

return

for t in shared.get_tests(shared.get_test_dir('example')):

if not t.endswith(('.c', '.cpp')):

continue

src = os.path.join(shared.get_test_dir('example'), t)

expected = os.path.join(shared.get_test_dir('example'), '.'.join(t.split('.')[:-1]) + '.txt')

# build the C file separately

libpath = shared.options.binaryen_lib

output_file = os.path.basename(os.path.splitext(t)[0])

objfile = output_file + '.o'

compile = [shared.NATIVECC, src, '-c', '-o', objfile,

'-I' + os.path.join(shared.options.binaryen_root, 'src'), '-g', '-L' + libpath, '-pthread']

if src.endswith('.cpp'):

compile += ['-std=c++' + str(shared.cxx_standard)]

if os.environ.get('COMPILER_FLAGS'):

for f in os.environ.get('COMPILER_FLAGS').split(' '):

compile.append(f)

print('build: ', ' '.join(compile))

subprocess.check_call(compile)

cmd = ['-I' + os.path.join(shared.options.binaryen_root, 't'), '-g', '-pthread', '-o', output_file]

# Link against the binaryen C library DSO, using an executable-relative rpath

cmd = [objfile, '-L' + libpath, '-lbinaryen'] + cmd + ['-Wl,-rpath,' + libpath]

print(' ', t, src, expected)

if os.environ.get('COMPILER_FLAGS'):

for f in os.environ.get('COMPILER_FLAGS').split(' '):

cmd.append(f)

cmd = [shared.NATIVEXX, '-std=c++' + str(shared.cxx_standard)] + cmd

print('link: ', ' '.join(cmd))

subprocess.check_call(cmd)

print('run...', output_file)

actual = subprocess.check_output([os.path.abspath(output_file)], text=True)

shared.fail_if_not_identical_to_file(actual, expected)

def run_unittest():

print_heading('checking unit tests...')

# equivalent to `python -m unittest discover -s ./test -v`

suite = unittest.defaultTestLoader.discover(os.path.dirname(shared.options.binaryen_test))

result = unittest.TextTestRunner(verbosity=2, failfast=shared.options.abort_on_first_failure).run(suite)

shared.num_failures += len(result.errors) + len(result.failures)

@shared.with_pass_debug()

def run_lit():

lit_script = os.path.join(shared.options.binaryen_bin, 'binaryen-lit')

lit_tests = os.path.join(shared.options.binaryen_root, 'test', 'lit')

# lit expects to be run as its own executable

cmd = [sys.executable, lit_script, lit_tests, '-vv']

result = subprocess.run(cmd)

if result.returncode != 0:

shared.num_failures += 1

@shared.with_pass_debug()

def run_gtest():

gtest = os.path.join(shared.options.binaryen_bin, 'binaryen-unittests')

if not os.path.isfile(gtest):

shared.warn('gtest binary not found - skipping tests')

else:

result = subprocess.run(gtest)

if result.returncode != 0:

shared.num_failures += 1

def test_suite(name, func):

@functools.wraps(func)

def wrapper(*args, **kwargs):

assert not (shared.options.abort_on_first_failure and shared.num_failures)

result = func(*args, **kwargs)

if shared.options.abort_on_first_failure and shared.num_failures:

raise Exception(f'test suite failed: {name}')

return result

return wrapper

TEST_SUITES = {

'version': run_version_tests,

'wasm-opt': wasm_opt.test_wasm_opt,

'wasm-dis': run_wasm_dis_tests,

'crash': run_crash_tests,

'dylink': run_dylink_tests,

'ctor-eval': run_ctor_eval_tests,

'wasm-metadce': run_wasm_metadce_tests,

'wasm-reduce': run_wasm_reduce_tests,

'spec': run_spec_tests,

'finalize': finalize.test_wasm_emscripten_finalize,

'wasm2js': wasm2js.test_wasm2js,

'validator': run_validator_tests,

'example': run_example_tests,

'unit': run_unittest,

'binaryenjs': binaryenjs.test_binaryen_js,

'lit': run_lit,

'gtest': run_gtest,

}

TEST_SUITES = {name: test_suite(name, func) for name, func in TEST_SUITES.items()}

# Run all the tests

def main():

all_suites = TEST_SUITES.keys()

skip_by_default = ['binaryenjs']

if shared.options.list_suites:

for suite in all_suites:

print(suite)

return 0

for r in shared.requested:

if r not in all_suites:

print(f'invalid test suite: {r} (see --list-suites)\n')

return 1

if not shared.requested:

shared.requested = [s for s in all_suites if s not in skip_by_default]

for test in shared.requested:

TEST_SUITES[test]()

print()

# Check/display the results

if shared.num_failures == 0:

print_heading('success!')

if shared.warnings:

print('\n' + '\n'.join(shared.warnings))

if shared.num_failures > 0:

print_heading(f'{shared.num_failures} failures!')

return 1

return 0

if __name__ == '__main__':

sys.exit(main())

binaryen/check.py at waitqueue-api · WebAssembly/binaryen · GitHub

Uh oh!

Expand file tree

Breadcrumbs

check.py

Latest commit

History

Breadcrumbs

check.py

File metadata and controls