cppcheck/test/fixture.cpp at main · cppcheck-opensource/cppcheck · GitHub

History

549 lines (486 loc) · 18.3 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

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

* Cppcheck - A tool for static C/C++ code analysis

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <http://www.gnu.org/licenses/>.

#include "fixture.h"

#include "errortypes.h"

#include "helpers.h"

#include "library.h"

#include "options.h"

#include "redirect.h"

#include "timer.h"

#include <algorithm>

#include <cstdio>

#include <cctype>

#include <exception>

#include <iostream>

#include <set>

#include <sstream>

#include <string>

#include "xml.h"

/**

* TestRegistry

**/

namespace {

struct CompareFixtures {

bool operator()(const TestInstance* lhs, const TestInstance* rhs) const {

return lhs->classname < rhs->classname;

}

};

}

using TestSet = std::set<TestInstance*, CompareFixtures>;

namespace {

class TestRegistry {

TestSet _tests;

public:

static TestRegistry &theInstance() {

static TestRegistry testreg;

return testreg;

}

void addTest(TestInstance *t) {

_tests.insert(t);

}

const TestSet &tests() const {

return _tests;

}

};

}

TestInstance::TestInstance(const char * _name)

: classname(_name)

{

TestRegistry::theInstance().addTest(this);

}

/**

* TestFixture

**/

std::ostringstream TestFixture::errmsg;

unsigned int TestFixture::countTests;

std::size_t TestFixture::fails_counter = 0;

std::size_t TestFixture::todos_counter = 0;

std::size_t TestFixture::succeeded_todos_counter = 0;

TestFixture::TestFixture(const char * const _name)

: classname(_name)

{}

TestFixture::~TestFixture() = default;

bool TestFixture::prepareTest(const char testname[])

{

mTemplateFormat.clear();

mTemplateLocation.clear();

prepareTestInternal();

// Check if tests should be executed

if (!testsToRun.empty()) {

const bool match = testsToRun.count(testname);

if ((match && exclude_tests) || (!match && !exclude_tests))

return false;

}

// Tests will be executed - prepare them

mTestname = testname;

++countTests;

std::string fullTestName = classname + "::" + mTestname;

if (quiet_tests) {

std::putchar('.'); // Use putchar to write through redirection of std::cout/cerr

std::fflush(stdout);

} else {

std::cout << fullTestName << std::endl;

}

if (timer_results)

mTimer.reset(new Timer(fullTestName, timer_results));

return !dry_run;

}

void TestFixture::teardownTest()

{

teardownTestInternal();

if (mTimer)

mTimer->stop();

{

const std::string s = errout_str();

if (!s.empty())

throw std::runtime_error("unconsumed ErrorLogger err: " + s);

}

{

const std::string s = output_str();

if (!s.empty())

throw std::runtime_error("unconsumed ErrorLogger out: " + s);

}

std::string TestFixture::getLocationStr(const char * const filename, const unsigned int linenr) const

{

return std::string(filename) + ':' + std::to_string(linenr) + '(' + classname + "::" + mTestname + ')';

}

static std::string writestr(const std::string &str, bool gccStyle = false)

{

std::ostringstream ostr;

if (gccStyle)

ostr << '\"';

for (auto i = str.cbegin(); i != str.cend(); ++i) {

if (*i == '\n') {

ostr << "\\n";

if ((i+1) != str.end() && !gccStyle)

ostr << std::endl;

} else if (*i == '\t')

ostr << "\\t";

else if (*i == '\"')

ostr << "\\\"";

else if (std::isprint(static_cast<unsigned char>(*i)))

ostr << *i;

else

ostr << "\\x" << std::hex << short{*i};

}

if (!str.empty() && !gccStyle)

ostr << std::endl;

else if (gccStyle)

ostr << '\"';

return ostr.str();

}

void TestFixture::assert_(const char * const filename, const unsigned int linenr, const bool condition, const std::string& msg) const

{

if (!condition) {

++fails_counter;

errmsg << getLocationStr(filename, linenr) << ": Assertion failed." << std::endl << "_____" << std::endl;

if (!msg.empty())

errmsg << "Hint:" << std::endl << msg << std::endl;

throw AssertFailedError();

}

void TestFixture::assertFailure(const char* const filename, const unsigned int linenr, const std::string& expected, const std::string& actual, const std::string& msg) const

{

++fails_counter;

errmsg << getLocationStr(filename, linenr) << ": Assertion failed. " << std::endl

<< "Expected: " << std::endl

<< writestr(expected) << std::endl

<< "Actual: " << std::endl

<< writestr(actual) << std::endl;

if (!msg.empty())

errmsg << "Hint:" << std::endl << msg << std::endl;

errmsg << "_____" << std::endl;

throw AssertFailedError();

}

void TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const std::string &expected, const std::string &actual, const std::string &msg) const

{

if (expected != actual) {

assertFailure(filename, linenr, expected, actual, msg);

}

std::string TestFixture::deleteLineNumber(const std::string &message)

{

std::string result(message);

// delete line number in "...:NUMBER:..."

std::string::size_type pos = 0;

while ((pos = result.find(':', pos)) != std::string::npos) {

// get number

if (pos + 1 == result.find_first_of("0123456789", pos + 1)) {

const std::string::size_type after = result.find_first_not_of("0123456789", pos + 1);

if (after != std::string::npos

&& result.at(after) == ':') {

// erase NUMBER

result.erase(pos + 1, after - pos - 1);

pos = after;

} else {

++pos;

}

} else {

++pos;

}

return result;

}

void TestFixture::assertEqualsWithoutLineNumbers(const char * const filename, const unsigned int linenr, const std::string &expected, const std::string &actual, const std::string &msg) const

{

assertEquals(filename, linenr, deleteLineNumber(expected), deleteLineNumber(actual), msg);

}

void TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const char expected[], const std::string& actual, const std::string &msg) const

{

assertEquals(filename, linenr, std::string(expected), actual, msg);

}

void TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const char expected[], const char actual[], const std::string &msg) const

{

assertEquals(filename, linenr, std::string(expected), std::string(actual), msg);

}

void TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const std::string& expected, const char actual[], const std::string &msg) const

{

assertEquals(filename, linenr, expected, std::string(actual), msg);

}

void TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const long long expected, const long long actual, const std::string &msg) const

{

if (expected != actual) {

assertEquals(filename, linenr, std::to_string(expected), std::to_string(actual), msg);

}

void TestFixture::assertEqualsDouble(const char * const filename, const unsigned int linenr, const double expected, const double actual, const double tolerance, const std::string &msg) const

{

if (expected < (actual - tolerance) || expected > (actual + tolerance)) {

std::ostringstream ostr1;

ostr1 << expected;

std::ostringstream ostr2;

ostr2 << actual;

assertEquals(filename, linenr, ostr1.str(), ostr2.str(), msg);

}

void TestFixture::todoAssertEquals(const char * const filename, const unsigned int linenr,

const std::string &wanted,

const std::string &current,

const std::string &actual) const

{

if (wanted == actual) {

errmsg << getLocationStr(filename, linenr) << ": Assertion succeeded unexpectedly. "

<< "Result: " << writestr(wanted, true) << std::endl << "_____" << std::endl;

++succeeded_todos_counter;

} else {

assertEquals(filename, linenr, current, actual);

++todos_counter;

}

void TestFixture::todoAssertEquals(const char* const filename, const unsigned int linenr,

const char wanted[],

const char current[],

const std::string& actual) const

{

todoAssertEquals(filename, linenr, std::string(wanted), std::string(current), actual);

}

void TestFixture::todoAssertEquals(const char * const filename, const unsigned int linenr, const long long wanted, const long long current, const long long actual) const

{

todoAssertEquals(filename, linenr, std::to_string(wanted), std::to_string(current), std::to_string(actual));

}

void TestFixture::assertThrow(const char * const filename, const unsigned int linenr) const

{

++fails_counter;

errmsg << getLocationStr(filename, linenr) << ": Assertion succeeded. "

<< "The expected exception was thrown" << std::endl << "_____" << std::endl;

throw AssertFailedError();

}

void TestFixture::assertThrowFail(const char * const filename, const unsigned int linenr) const

{

++fails_counter;

errmsg << getLocationStr(filename, linenr) << ": Assertion failed. "

<< "The expected exception was not thrown" << std::endl << "_____" << std::endl;

throw AssertFailedError();

}

void TestFixture::assertNoThrowFail(const char * const filename, const unsigned int linenr, bool bailout) const

{

std::string ex_msg;

try {

// cppcheck-suppress rethrowNoCurrentException

throw;

}

catch (const AssertFailedError&) {

return;

}

catch (const InternalError& e) {

ex_msg = e.errorMessage;

}

catch (const std::exception& e) {

ex_msg = e.what();

}

catch (...) {

ex_msg = "unknown exception";

}

++fails_counter;

errmsg << getLocationStr(filename, linenr) << ": Assertion failed. "

<< "Unexpected exception was thrown: " << ex_msg << std::endl << "_____" << std::endl;

if (bailout)

throw AssertFailedError();

}

void TestFixture::printHelp()

{

std::cout << "Testrunner - run Cppcheck tests\n"

"\n"

"Syntax:\n"

" testrunner [OPTIONS] [TestClass::TestCase...]\n"

" run all test cases:\n"

" testrunner\n"

" run all test cases in TestClass:\n"

" testrunner TestClass\n"

" run TestClass::TestCase:\n"

" testrunner TestClass::TestCase\n"

" run all test cases in TestClass1 and TestClass2::TestCase:\n"

" testrunner TestClass1 TestClass2::TestCase\n"

"\n"

"Options:\n"

" -q Do not print the test cases that have run.\n"

" -h, --help Print this help.\n"

" -n Print no summaries.\n"

" -d Do not execute any tests (dry run).\n"

" -x Exclude the specified tests.\n";

}

void TestFixture::run(const std::set<std::string> &tests)

{

testsToRun = tests;

try {

if (quiet_tests) {

std::cout << '\n' << classname << ':';

SUPPRESS;

run();

}

else

run();

}

catch (const InternalError& e) {

++fails_counter;

errmsg << classname << "::" << mTestname << " - InternalError: " << e.errorMessage << std::endl;

}

catch (const std::exception& error) {

++fails_counter;

errmsg << classname << "::" << mTestname << " - Exception: " << error.what() << std::endl;

}

catch (...) {

++fails_counter;

errmsg << classname << "::" << mTestname << " - Unknown exception" << std::endl;

}

void TestFixture::processOptions(const options& args)

{

quiet_tests = args.quiet();

dry_run = args.dry_run();

exclude_tests = args.exclude_tests();

exename = args.exe();

timer_results = args.timer_results();

}

std::size_t TestFixture::runTests(const options& args)

{

countTests = 0;

errmsg.str("");

const auto& which_tests = args.which_tests();

const auto exclude_tests = args.exclude_tests();

// TODO: bail out when given class/test is not found?

for (TestInstance * test : TestRegistry::theInstance().tests())

{

std::set<std::string> tests;

if (!which_tests.empty()) {

const auto it = which_tests.find(test->classname);

const bool match = it != which_tests.cend();

if (match && exclude_tests && it->second.empty()) // only bailout when the whole fixture is excluded

continue;

if (!match && !exclude_tests)

continue;

if (match)

tests = it->second;

}

TestFixture* fixture;

const auto f = [&](){

fixture = test->create();

};

Timer::run(test->classname + " - create", args.timer_results(), f);

fixture->processOptions(args);

fixture->run(tests);

}

if (args.summary() && !args.dry_run()) {

std::cout << "\n\nTesting Complete\nNumber of tests: " << countTests << std::endl;

std::cout << "Number of todos: " << todos_counter;

if (succeeded_todos_counter > 0)

std::cout << " (" << succeeded_todos_counter << " succeeded)";

std::cout << std::endl;

}

// calling flush here, to do all output before the error messages (in case the output is buffered)

std::cout.flush();

if (args.summary() && !args.dry_run()) {

std::cerr << "Tests failed: " << fails_counter << std::endl << std::endl;

}

std::cerr << errmsg.str();

std::cerr.flush();

return fails_counter + succeeded_todos_counter;

}

void TestFixture::reportOut(const std::string & outmsg, Color /*c*/)

{

mOutput << outmsg << std::endl;

}

void TestFixture::reportErr(const ErrorMessage &msg)

{

if (msg.severity == Severity::internal)

return;

if (msg.severity == Severity::information && msg.id == "normalCheckLevelMaxBranches")

return;

std::string errormessage;

if (!mTemplateFormat.empty()) {

errormessage = msg.toString(false, mTemplateFormat, mTemplateLocation);

}

else {

if (!msg.callStack.empty()) {

errormessage += ErrorLogger::callStackToString(msg.callStack, mNewTemplate);

errormessage += ": ";

}

if (msg.severity != Severity::none) {

errormessage += '(';

errormessage += severityToString(msg.severity);

if (msg.certainty == Certainty::inconclusive)

errormessage += ", inconclusive";

errormessage += ") ";

}

errormessage += msg.shortMessage();

if (mNewTemplate) {

errormessage += " [";

errormessage += msg.id;

errormessage += "]";

}

mErrout << errormessage << std::endl;

}

void TestFixture::setTemplateFormat(const std::string &templateFormat)

{

if (templateFormat == "multiline") {

mTemplateFormat = "[{file}:{line}:{column}]: {severity}:{inconclusive:inconclusive:} {message} [{id}]";

mTemplateLocation = "[{file}:{line}:{column}]: note: {info}";

}

else if (templateFormat == "simple") { // TODO: use the existing one in CmdLineParser

mTemplateFormat = "{file}:{line}:{column}: {severity}:{inconclusive:inconclusive:} {message} [{id}]";

mTemplateLocation = "";

}

else {

mTemplateFormat = templateFormat;

mTemplateLocation = "";

}

TestFixture::SettingsBuilder& TestFixture::SettingsBuilder::checkLevel(Settings::CheckLevel level) {

settings.setCheckLevel(level);

return *this;

}

TestFixture::SettingsBuilder& TestFixture::SettingsBuilder::library(const char lib[]) {

if (REDUNDANT_CHECK && std::find(settings.libraries.cbegin(), settings.libraries.cend(), lib) != settings.libraries.cend())

throw std::runtime_error("redundant setting: libraries (" + std::string(lib) + ")");

// TODO: exename is not yet set

const Library::ErrorCode lib_error = settings.library.load(fixture.exename.c_str(), lib).errorcode;

if (lib_error != Library::ErrorCode::OK)

throw std::runtime_error("loading library '" + std::string(lib) + "' failed - " + std::to_string(static_cast<int>(lib_error)));

// strip extension

std::string lib_s(lib);

const std::string ext(".cfg");

const auto pos = lib_s.find(ext);

if (pos != std::string::npos)

lib_s.erase(pos, ext.size());

settings.libraries.emplace_back(lib_s);

return *this;

}

TestFixture::SettingsBuilder& TestFixture::SettingsBuilder::platform(Platform::Type type)

{

const std::string platformStr = Platform::toString(type);

if (REDUNDANT_CHECK && settings.platform.type == type)

throw std::runtime_error("redundant setting: platform (" + platformStr + ")");

std::string errstr;

// TODO: exename is not yet set

if (!settings.platform.set(platformStr, errstr, {fixture.exename}))

throw std::runtime_error("platform '" + platformStr + "' not found");

return *this;

}

TestFixture::SettingsBuilder& TestFixture::SettingsBuilder::libraryxml(const char xmldata[], std::size_t len)

{

tinyxml2::XMLDocument doc;

const tinyxml2::XMLError xml_error = doc.Parse(xmldata, len);

if (tinyxml2::XML_SUCCESS != xml_error)

throw std::runtime_error(std::string("loading library XML data failed - ") + tinyxml2::XMLDocument::ErrorIDToName(xml_error));

const Library::ErrorCode lib_error = LibraryHelper::loadxmldoc(settings.library, doc).errorcode;

if (lib_error != Library::ErrorCode::OK)

throw std::runtime_error("loading library XML failed - " + std::to_string(static_cast<int>(lib_error)));

return *this;

}

cppcheck/test/fixture.cpp at main · cppcheck-opensource/cppcheck · GitHub

Uh oh!

Expand file tree

Breadcrumbs

fixture.cpp

Latest commit

History

Breadcrumbs

fixture.cpp

File metadata and controls