bin/lesson_check.py

   1 #!/usr/bin/env python3
   2
   3 """
   4 Check lesson files and their contents.
   5 """
   6
   7
   8 import os
   9 import glob
  10 import re
  11 from argparse import ArgumentParser
  12
  13 from util import (Reporter, read_markdown, load_yaml, check_unwanted_files,
  14                   require)
  15
  16 __version__ = '0.3'
  17
  18 # Where to look for source Markdown files.
  19 SOURCE_DIRS = ['', '_episodes', '_extras']
  20
  21 # Where to look for source Rmd files.
  22 SOURCE_RMD_DIRS = ['_episodes_rmd']
  23
  24 # Required files: each entry is ('path': YAML_required).
  25 # FIXME: We do not yet validate whether any files have the required
  26 #   YAML headers, but should in the future.
  27 # The '%' is replaced with the source directory path for checking.
  28 # Episodes are handled specially, and extra files in '_extras' are also handled
  29 # specially. This list must include all the Markdown files listed in the
  30 # 'bin/initialize' script.
  31 REQUIRED_FILES = {
  32     '%/CODE_OF_CONDUCT.md': True,
  33     '%/CONTRIBUTING.md': False,
  34     '%/LICENSE.md': True,
  35     '%/README.md': False,
  36     '%/_extras/discuss.md': True,
  37     '%/_extras/guide.md': True,
  38     '%/index.md': True,
  39     '%/reference.md': True,
  40     '%/setup.md': True,
  41 }
  42
  43 # Episode filename pattern.
  44 P_EPISODE_FILENAME = re.compile(r'/_episodes/(\d\d)-[-\w]+.md$')
  45
  46 # Pattern to match lines ending with whitespace.
  47 P_TRAILING_WHITESPACE = re.compile(r'\s+$')
  48
  49 # Pattern to match figure references in HTML.
  50 P_FIGURE_REFS = re.compile(r'<img[^>]+src="([^"]+)"[^>]*>')
  51
  52 # Pattern to match internally-defined Markdown links.
  53 P_INTERNAL_LINK_REF = re.compile(r'\[([^\]]+)\]\[([^\]]+)\]')
  54
  55 # Pattern to match reference links (to resolve internally-defined references).
  56 P_INTERNAL_LINK_DEF = re.compile(r'^\[([^\]]+)\]:\s*(.+)')
  57
  58 # What kinds of blockquotes are allowed?
  59 KNOWN_BLOCKQUOTES = {
  60     'callout',
  61     'challenge',
  62     'checklist',
  63     'discussion',
  64     'keypoints',
  65     'objectives',
  66     'prereq',
  67     'quotation',
  68     'solution',
  69     'testimonial'
  70 }
  71
  72 # What kinds of code fragments are allowed?
  73 KNOWN_CODEBLOCKS = {
  74     'error',
  75     'output',
  76     'source',
  77     'language-bash',
  78     'html',
  79     'language-make',
  80     'language-matlab',
  81     'language-python',
  82     'language-r',
  83     'language-shell',
  84     'language-sql'
  85 }
  86
  87 # What fields are required in teaching episode metadata?
  88 TEACHING_METADATA_FIELDS = {
  89     ('title', str),
  90     ('teaching', int),
  91     ('exercises', int),
  92     ('questions', list),
  93     ('objectives', list),
  94     ('keypoints', list)
  95 }
  96
  97 # What fields are required in break episode metadata?
  98 BREAK_METADATA_FIELDS = {
  99     ('layout', str),
 100     ('title', str),
 101     ('break', int)
 102 }
 103
 104 # How long are lines allowed to be?
 105 # Please keep this in sync with .editorconfig!
 106 MAX_LINE_LEN = 100
 107
 108
 109 def main():
 110     """Main driver."""
 111
 112     args = parse_args()
 113     args.reporter = Reporter()
 114     check_config(args.reporter, args.source_dir)
 115     check_source_rmd(args.reporter, args.source_dir, args.parser)
 116     args.references = read_references(args.reporter, args.reference_path)
 117
 118     docs = read_all_markdown(args.source_dir, args.parser)
 119     check_fileset(args.source_dir, args.reporter, list(docs.keys()))
 120     check_unwanted_files(args.source_dir, args.reporter)
 121     for filename in list(docs.keys()):
 122         checker = create_checker(args, filename, docs[filename])
 123         checker.check()
 124
 125     args.reporter.report()
 126     if args.reporter.messages and not args.permissive:
 127         exit(1)
 128
 129
 130 def parse_args():
 131     """Parse command-line arguments."""
 132
 133     parser = ArgumentParser(description="""Check episode files in a lesson.""")
 134     parser.add_argument('-l', '--linelen',
 135                         default=False,
 136                         action="store_true",
 137                         dest='line_lengths',
 138                         help='Check line lengths')
 139     parser.add_argument('-p', '--parser',
 140                         default=None,
 141                         dest='parser',
 142                         help='path to Markdown parser')
 143     parser.add_argument('-r', '--references',
 144                         default=None,
 145                         dest='reference_path',
 146                         help='path to Markdown file of external references')
 147     parser.add_argument('-s', '--source',
 148                         default=os.curdir,
 149                         dest='source_dir',
 150                         help='source directory')
 151     parser.add_argument('-w', '--whitespace',
 152                         default=False,
 153                         action="store_true",
 154                         dest='trailing_whitespace',
 155                         help='Check for trailing whitespace')
 156     parser.add_argument('--permissive',
 157                         default=False,
 158                         action="store_true",
 159                         dest='permissive',
 160                         help='Do not raise an error even if issues are detected')
 161
 162     args, extras = parser.parse_known_args()
 163     require(args.parser is not None,
 164             'Path to Markdown parser not provided')
 165     require(not extras,
 166             'Unexpected trailing command-line arguments "{0}"'.format(extras))
 167
 168     return args
 169
 170
 171 def check_config(reporter, source_dir):
 172     """Check configuration file."""
 173
 174     config_file = os.path.join(source_dir, '_config.yml')
 175     config = load_yaml(config_file)
 176     reporter.check_field(config_file, 'configuration',
 177                          config, 'kind', 'lesson')
 178     reporter.check_field(config_file, 'configuration',
 179                          config, 'carpentry', ('swc', 'dc', 'lc', 'cp'))
 180     reporter.check_field(config_file, 'configuration', config, 'title')
 181     reporter.check_field(config_file, 'configuration', config, 'email')
 182
 183     for defaults in [
 184             {'values': {'root': '.', 'layout': 'page'}},
 185             {'values': {'root': '..', 'layout': 'episode'}, 'scope': {'type': 'episodes', 'path': ''}},
 186             {'values': {'root': '..', 'layout': 'page'}, 'scope': {'type': 'extras', 'path': ''}}
 187             ]:
 188         reporter.check(defaults in config.get('defaults', []),
 189                    'configuration',
 190                    '"root" not set to "." in configuration')
 191
 192 def check_source_rmd(reporter, source_dir, parser):
 193     """Check that Rmd episode files include `source: Rmd`"""
 194
 195     episode_rmd_dir = [os.path.join(source_dir, d) for d in SOURCE_RMD_DIRS]
 196     episode_rmd_files = [os.path.join(d, '*.Rmd') for d in episode_rmd_dir]
 197     results = {}
 198     for pat in episode_rmd_files:
 199         for f in glob.glob(pat):
 200             data = read_markdown(parser, f)
 201             dy = data['metadata']
 202             if dy:
 203                 reporter.check_field(f, 'episode_rmd',
 204                                      dy, 'source', 'Rmd')
 205
 206 def read_references(reporter, ref_path):
 207     """Read shared file of reference links, returning dictionary of valid references
 208     {symbolic_name : URL}
 209     """
 210
 211     result = {}
 212     urls_seen = set()
 213     if ref_path:
 214         with open(ref_path, 'r') as reader:
 215             for (num, line) in enumerate(reader):
 216                 line_num = num + 1
 217                 m = P_INTERNAL_LINK_DEF.search(line)
 218                 require(m,
 219                         '{0}:{1} not valid reference:\n{2}'.format(ref_path, line_num, line.rstrip()))
 220                 name = m.group(1)
 221                 url = m.group(2)
 222                 require(name,
 223                         'Empty reference at {0}:{1}'.format(ref_path, line_num))
 224                 reporter.check(name not in result,
 225                                ref_path,
 226                                'Duplicate reference {0} at line {1}',
 227                                name, line_num)
 228                 reporter.check(url not in urls_seen,
 229                                ref_path,
 230                                'Duplicate definition of URL {0} at line {1}',
 231                                url, line_num)
 232                 result[name] = url
 233                 urls_seen.add(url)
 234     return result
 235
 236
 237 def read_all_markdown(source_dir, parser):
 238     """Read source files, returning
 239     {path : {'metadata':yaml, 'metadata_len':N, 'text':text, 'lines':[(i, line, len)], 'doc':doc}}
 240     """
 241
 242     all_dirs = [os.path.join(source_dir, d) for d in SOURCE_DIRS]
 243     all_patterns = [os.path.join(d, '*.md') for d in all_dirs]
 244     result = {}
 245     for pat in all_patterns:
 246         for filename in glob.glob(pat):
 247             data = read_markdown(parser, filename)
 248             if data:
 249                 result[filename] = data
 250     return result
 251
 252
 253 def check_fileset(source_dir, reporter, filenames_present):
 254     """Are all required files present? Are extraneous files present?"""
 255
 256     # Check files with predictable names.
 257     required = [p.replace('%', source_dir) for p in REQUIRED_FILES]
 258     missing = set(required) - set(filenames_present)
 259     for m in missing:
 260         reporter.add(None, 'Missing required file {0}', m)
 261
 262     # Check episode files' names.
 263     seen = []
 264     for filename in filenames_present:
 265         if '_episodes' not in filename:
 266             continue
 267         m = P_EPISODE_FILENAME.search(filename)
 268         if m and m.group(1):
 269             seen.append(m.group(1))
 270         else:
 271             reporter.add(
 272                 None, 'Episode {0} has badly-formatted filename', filename)
 273
 274     # Check for duplicate episode numbers.
 275     reporter.check(len(seen) == len(set(seen)),
 276                    None,
 277                    'Duplicate episode numbers {0} vs {1}',
 278                    sorted(seen), sorted(set(seen)))
 279
 280     # Check that numbers are consecutive.
 281     seen = sorted([int(s) for s in seen])
 282     clean = True
 283     for i in range(len(seen) - 1):
 284         clean = clean and ((seen[i+1] - seen[i]) == 1)
 285     reporter.check(clean,
 286                    None,
 287                    'Missing or non-consecutive episode numbers {0}',
 288                    seen)
 289
 290
 291 def create_checker(args, filename, info):
 292     """Create appropriate checker for file."""
 293
 294     for (pat, cls) in CHECKERS:
 295         if pat.search(filename):
 296             return cls(args, filename, **info)
 297     return NotImplemented
 298
 299 class CheckBase:
 300     """Base class for checking Markdown files."""
 301
 302     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 303         """Cache arguments for checking."""
 304
 305         self.args = args
 306         self.reporter = self.args.reporter  # for convenience
 307         self.filename = filename
 308         self.metadata = metadata
 309         self.metadata_len = metadata_len
 310         self.text = text
 311         self.lines = lines
 312         self.doc = doc
 313
 314         self.layout = None
 315
 316     def check(self):
 317         """Run tests."""
 318
 319         self.check_metadata()
 320         self.check_line_lengths()
 321         self.check_trailing_whitespace()
 322         self.check_blockquote_classes()
 323         self.check_codeblock_classes()
 324         self.check_defined_link_references()
 325
 326     def check_metadata(self):
 327         """Check the YAML metadata."""
 328
 329         self.reporter.check(self.metadata is not None,
 330                             self.filename,
 331                             'Missing metadata entirely')
 332
 333         if self.metadata and (self.layout is not None):
 334             self.reporter.check_field(
 335                 self.filename, 'metadata', self.metadata, 'layout', self.layout)
 336
 337     def check_line_lengths(self):
 338         """Check the raw text of the lesson body."""
 339
 340         if self.args.line_lengths:
 341             over = [i for (i, l, n) in self.lines if (
 342                 n > MAX_LINE_LEN) and (not l.startswith('!'))]
 343             self.reporter.check(not over,
 344                                 self.filename,
 345                                 'Line(s) are too long: {0}',
 346                                 ', '.join([str(i) for i in over]))
 347
 348     def check_trailing_whitespace(self):
 349         """Check for whitespace at the ends of lines."""
 350
 351         if self.args.trailing_whitespace:
 352             trailing = [
 353                 i for (i, l, n) in self.lines if P_TRAILING_WHITESPACE.match(l)]
 354             self.reporter.check(not trailing,
 355                                 self.filename,
 356                                 'Line(s) end with whitespace: {0}',
 357                                 ', '.join([str(i) for i in trailing]))
 358
 359     def check_blockquote_classes(self):
 360         """Check that all blockquotes have known classes."""
 361
 362         for node in self.find_all(self.doc, {'type': 'blockquote'}):
 363             cls = self.get_val(node, 'attr', 'class')
 364             self.reporter.check(cls in KNOWN_BLOCKQUOTES,
 365                                 (self.filename, self.get_loc(node)),
 366                                 'Unknown or missing blockquote type {0}',
 367                                 cls)
 368
 369     def check_codeblock_classes(self):
 370         """Check that all code blocks have known classes."""
 371
 372         for node in self.find_all(self.doc, {'type': 'codeblock'}):
 373             cls = self.get_val(node, 'attr', 'class')
 374             self.reporter.check(cls in KNOWN_CODEBLOCKS,
 375                                 (self.filename, self.get_loc(node)),
 376                                 'Unknown or missing code block type {0}',
 377                                 cls)
 378
 379     def check_defined_link_references(self):
 380         """Check that defined links resolve in the file.
 381
 382         Internally-defined links match the pattern [text][label].
 383         """
 384
 385         result = set()
 386         for node in self.find_all(self.doc, {'type': 'text'}):
 387             for match in P_INTERNAL_LINK_REF.findall(node['value']):
 388                 text = match[0]
 389                 link = match[1]
 390                 if link not in self.args.references:
 391                     result.add('"{0}"=>"{1}"'.format(text, link))
 392         self.reporter.check(not result,
 393                             self.filename,
 394                             'Internally-defined links may be missing definitions: {0}',
 395                             ', '.join(sorted(result)))
 396
 397     def find_all(self, node, pattern, accum=None):
 398         """Find all matches for a pattern."""
 399
 400         assert isinstance(pattern, dict), 'Patterns must be dictionaries'
 401         if accum is None:
 402             accum = []
 403         if self.match(node, pattern):
 404             accum.append(node)
 405         for child in node.get('children', []):
 406             self.find_all(child, pattern, accum)
 407         return accum
 408
 409     def match(self, node, pattern):
 410         """Does this node match the given pattern?"""
 411
 412         for key in pattern:
 413             if key not in node:
 414                 return False
 415             val = pattern[key]
 416             if isinstance(val, str):
 417                 if node[key] != val:
 418                     return False
 419             elif isinstance(val, dict):
 420                 if not self.match(node[key], val):
 421                     return False
 422         return True
 423
 424     @staticmethod
 425     def get_val(node, *chain):
 426         """Get value one or more levels down."""
 427
 428         curr = node
 429         for selector in chain:
 430             curr = curr.get(selector, None)
 431             if curr is None:
 432                 break
 433         return curr
 434
 435     def get_loc(self, node):
 436         """Convenience method to get node's line number."""
 437
 438         result = self.get_val(node, 'options', 'location')
 439         if self.metadata_len is not None:
 440             result += self.metadata_len
 441         return result
 442
 443
 444 class CheckNonJekyll(CheckBase):
 445     """Check a file that isn't translated by Jekyll."""
 446
 447     def check_metadata(self):
 448         self.reporter.check(self.metadata is None,
 449                             self.filename,
 450                             'Unexpected metadata')
 451
 452
 453 class CheckIndex(CheckBase):
 454     """Check the main index page."""
 455
 456     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 457         super().__init__(args, filename, metadata, metadata_len, text, lines, doc)
 458         self.layout = 'lesson'
 459
 460     def check_metadata(self):
 461         super().check_metadata()
 462         self.reporter.check(self.metadata.get('root', '') == '.',
 463                             self.filename,
 464                             'Root not set to "."')
 465
 466
 467 class CheckEpisode(CheckBase):
 468     """Check an episode page."""
 469
 470     def check(self):
 471         """Run extra tests."""
 472
 473         super().check()
 474         self.check_reference_inclusion()
 475
 476     def check_metadata(self):
 477         super().check_metadata()
 478         if self.metadata:
 479             if 'layout' in self.metadata:
 480                 if self.metadata['layout'] == 'break':
 481                     self.check_metadata_fields(BREAK_METADATA_FIELDS)
 482                 else:
 483                     self.reporter.add(self.filename,
 484                                       'Unknown episode layout "{0}"',
 485                                       self.metadata['layout'])
 486             else:
 487                 self.check_metadata_fields(TEACHING_METADATA_FIELDS)
 488
 489     def check_metadata_fields(self, expected):
 490         """Check metadata fields."""
 491         for (name, type_) in expected:
 492             if name not in self.metadata:
 493                 self.reporter.add(self.filename,
 494                                   'Missing metadata field {0}',
 495                                   name)
 496             elif not isinstance(self.metadata[name], type_):
 497                 self.reporter.add(self.filename,
 498                                   '"{0}" has wrong type in metadata ({1} instead of {2})',
 499                                   name, type(self.metadata[name]), type_)
 500
 501     def check_reference_inclusion(self):
 502         """Check that links file has been included."""
 503
 504         if not self.args.reference_path:
 505             return
 506
 507         for (i, last_line, line_len) in reversed(self.lines):
 508             if last_line:
 509                 break
 510
 511         require(last_line,
 512                 'No non-empty lines in {0}'.format(self.filename))
 513
 514         include_filename = os.path.split(self.args.reference_path)[-1]
 515         if include_filename not in last_line:
 516             self.reporter.add(self.filename,
 517                               'episode does not include "{0}"',
 518                               include_filename)
 519
 520
 521 class CheckReference(CheckBase):
 522     """Check the reference page."""
 523
 524     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 525         super().__init__(args, filename, metadata, metadata_len, text, lines, doc)
 526         self.layout = 'reference'
 527
 528
 529 class CheckGeneric(CheckBase):
 530     """Check a generic page."""
 531
 532     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 533         super().__init__(args, filename, metadata, metadata_len, text, lines, doc)
 534
 535
 536 CHECKERS = [
 537     (re.compile(r'CONTRIBUTING\.md'), CheckNonJekyll),
 538     (re.compile(r'README\.md'), CheckNonJekyll),
 539     (re.compile(r'index\.md'), CheckIndex),
 540     (re.compile(r'reference\.md'), CheckReference),
 541     (re.compile(r'_episodes/.*\.md'), CheckEpisode),
 542     (re.compile(r'aio\.md'), CheckNonJekyll),
 543     (re.compile(r'.*\.md'), CheckGeneric)
 544 ]
 545
 546
 547 if __name__ == '__main__':
 548     main()