~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_source.py

• browse files at revision 4253.4.1
• compare with another revision
• download diff
• download tarball
• view history from revision 4253.4.1

• reverse the comparison (4253.4.1 to 5452)
• stop comparing with revision 5452

Show diffs side-by-side

added

removed

bzrlib/tests/test_source.py

1

 

# Copyright (C) 2005-2010 Canonical Ltd

 

1

# Copyright (C) 2005, 2006, 2008 Canonical Ltd

 

2

#   Authors: Robert Collins <robert.collins@canonical.com>

 

3

#            and others

2

4

#

3

5

# This program is free software; you can redistribute it and/or modify

4

6

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

33

35

    )

34

36

import bzrlib.branch

35

37

from bzrlib.tests import (

 

38

    KnownFailure,

36

39

    TestCase,

37

40

    TestSkipped,

38

41

    )

40

43

 

41

44

# Files which are listed here will be skipped when testing for Copyright (or

42

45

# GPL) statements.

43

 

COPYRIGHT_EXCEPTIONS = [

44

 

    'bzrlib/_bencode_py.py',

45

 

    'bzrlib/doc_generate/conf.py',

46

 

    'bzrlib/lsprof.py',

47

 

    ]

 

46

COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py']

48

47

 

49

 

LICENSE_EXCEPTIONS = [

50

 

    'bzrlib/_bencode_py.py',

51

 

    'bzrlib/doc_generate/conf.py',

52

 

    'bzrlib/lsprof.py',

53

 

    ]

 

48

LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py']

54

49

# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',

55

50

# (we do not check bzrlib/util/, since that is code bundled from elsewhere)

56

51

# but for compatibility with previous releases, we don't want to move it.

57

 

#

58

 

# sphinx_conf is semi-autogenerated.

59

52

 

60

53

 

61

54

class TestSourceHelper(TestCase):

291

284

    def test_coding_style(self):

292

285

        """Check if bazaar code conforms to some coding style conventions.

293

286

 

294

 

        Currently we assert that the following is not present:

 

287

        Currently we check for:

295

288

         * any tab characters

 

289

         * trailing white space

296

290

         * non-unix newlines

297

291

         * no newline at end of files

298

 

 

299

 

        Print how many files have

300

 

         * trailing white space

301

292

         * lines longer than 79 chars

 

293

           (only print how many files and lines are in violation)

302

294

        """

303

295

        tabs = {}

304

296

        trailing_ws = {}

329

321

                'Tab characters were found in the following source files.'

330

322

                '\nThey should either be replaced by "\\t" or by spaces:'))

331

323

        if trailing_ws:

332

 

            print ("There are %i lines with trailing white space in %i files."

333

 

                % (sum([len(lines) for f, lines in trailing_ws.items()]),

334

 

                    len(trailing_ws)))

 

324

            problems.append(self._format_message(trailing_ws,

 

325

                'Trailing white space was found in the following source files:'

 

326

                ))

335

327

        if illegal_newlines:

336

328

            problems.append(self._format_message(illegal_newlines,

337

329

                'Non-unix newlines were found in the following source files:'))

346

338

               '\n\n    %s'

347

339

               % ('\n    '.join(no_newline_at_eof)))

348

340

        if problems:

 

341

            raise KnownFailure("test_coding_style has failed")

349

342

            self.fail('\n\n'.join(problems))

350

343

 

351

344

    def test_no_asserts(self):

365

358

                    return True

366

359

            return False

367

360

        badfiles = []

368

 

        assert_re = re.compile(r'\bassert\b')

369

361

        for fname, text in self.get_source_file_contents():

370

362

            if not self.is_our_code(fname):

371

363

                continue

372

 

            if not assert_re.search(text):

373

 

                continue

374

 

            ast = parser.ast2tuple(parser.suite(text))

 

364

            ast = parser.ast2tuple(parser.suite(''.join(text)))

375

365

            if search(ast):

376

366

                badfiles.append(fname)

377

367

        if badfiles:

378

368

            self.fail(

379

369

                "these files contain an assert statement and should not:\n%s"

380

370

                % '\n'.join(badfiles))

381

 

 

382

 

    def test_extension_exceptions(self):

383

 

        """Extension functions should propagate exceptions.

384

 

 

385

 

        Either they should return an object, have an 'except' clause, or have a

386

 

        "# cannot_raise" to indicate that we've audited them and defined them as not

387

 

        raising exceptions.

388

 

        """

389

 

        both_exc_and_no_exc = []

390

 

        missing_except = []

391

 

        class_re = re.compile(r'^(cdef\s+)?(public\s+)?'

392

 

                              r'(api\s+)?class (\w+).*:', re.MULTILINE)

393

 

        extern_class_re = re.compile(r'## extern cdef class (\w+)',

394

 

                                     re.MULTILINE)

395

 

        except_re = re.compile(r'cdef\s+' # start with cdef

396

 

                               r'([\w *]*?)\s*' # this is the return signature

397

 

                               r'(\w+)\s*\(' # the function name

398

 

                               r'[^)]*\)\s*' # parameters

399

 

                               r'(.*)\s*:' # the except clause

400

 

                               r'\s*(#\s*cannot[- _]raise)?' # cannot raise comment

401

 

                              )

402

 

        for fname, text in self.get_source_file_contents(

403

 

                extensions=('.pyx',)):

404

 

            known_classes = set([m[-1] for m in class_re.findall(text)])

405

 

            known_classes.update(extern_class_re.findall(text))

406

 

            cdefs = except_re.findall(text)

407

 

            for sig, func, exc_clause, no_exc_comment in cdefs:

408

 

                if sig.startswith('api '):

409

 

                    sig = sig[4:]

410

 

                if not sig or sig in known_classes:

411

 

                    sig = 'object'

412

 

                if 'nogil' in exc_clause:

413

 

                    exc_clause = exc_clause.replace('nogil', '').strip()

414

 

                if exc_clause and no_exc_comment:

415

 

                    both_exc_and_no_exc.append((fname, func))

416

 

                if sig != 'object' and not (exc_clause or no_exc_comment):

417

 

                    missing_except.append((fname, func))

418

 

        error_msg = []

419

 

        if both_exc_and_no_exc:

420

 

            error_msg.append('The following functions had "cannot raise" comments'

421

 

                             ' but did have an except clause set:')

422

 

            for fname, func in both_exc_and_no_exc:

423

 

                error_msg.append('%s:%s' % (fname, func))

424

 

            error_msg.extend(('', ''))

425

 

        if missing_except:

426

 

            error_msg.append('The following functions have fixed return types,'

427

 

                             ' but no except clause.')

428

 

            error_msg.append('Either add an except or append "# cannot_raise".')

429

 

            for fname, func in missing_except:

430

 

                error_msg.append('%s:%s' % (fname, func))

431

 

            error_msg.extend(('', ''))

432

 

        if error_msg:

433

 

            self.fail('\n'.join(error_msg))

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1