bin/lesson_check.py

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