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     'challenge',
  63     'checklist',
  64     'discussion',
  65     'keypoints',
  66     'objectives',
  67     'prereq',
  68     'quotation',
  69     'solution',
  70     'testimonial'
  71 }
  72
  73 # What kinds of code fragments are allowed?
  74 KNOWN_CODEBLOCKS = {
  75     'error',
  76     'output',
  77     'source',
  78     'language-bash',
  79     'html',
  80     'language-make',
  81     'language-matlab',
  82     'language-python',
  83     'language-r',
  84     'language-shell',
  85     'language-sql'
  86 }
  87
  88 # What fields are required in teaching episode metadata?
  89 TEACHING_METADATA_FIELDS = {
  90     ('title', str),
  91     ('teaching', int),
  92     ('exercises', int),
  93     ('questions', list),
  94     ('objectives', list),
  95     ('keypoints', list)
  96 }
  97
  98 # What fields are required in break episode metadata?
  99 BREAK_METADATA_FIELDS = {
 100     ('layout', str),
 101     ('title', str),
 102     ('break', int)
 103 }
 104
 105 # How long are lines allowed to be?
 106 # Please keep this in sync with .editorconfig!
 107 MAX_LINE_LEN = 100
 108
 109
 110 def main():
 111     """Main driver."""
 112
 113     args = parse_args()
 114     args.reporter = Reporter()
 115     check_config(args.reporter, args.source_dir)
 116     check_source_rmd(args.reporter, args.source_dir, args.parser)
 117     args.references = read_references(args.reporter, args.reference_path)
 118
 119     docs = read_all_markdown(args.source_dir, args.parser)
 120     check_fileset(args.source_dir, args.reporter, list(docs.keys()))
 121     check_unwanted_files(args.source_dir, args.reporter)
 122     for filename in list(docs.keys()):
 123         checker = create_checker(args, filename, docs[filename])
 124         checker.check()
 125
 126     args.reporter.report()
 127     if args.reporter.messages and not args.permissive:
 128         exit(1)
 129
 130
 131 def parse_args():
 132     """Parse command-line arguments."""
 133
 134     parser = ArgumentParser(description="""Check episode files in a lesson.""")
 135     parser.add_argument('-l', '--linelen',
 136                         default=False,
 137                         action="store_true",
 138                         dest='line_lengths',
 139                         help='Check line lengths')
 140     parser.add_argument('-p', '--parser',
 141                         default=None,
 142                         dest='parser',
 143                         help='path to Markdown parser')
 144     parser.add_argument('-r', '--references',
 145                         default=None,
 146                         dest='reference_path',
 147                         help='path to Markdown file of external references')
 148     parser.add_argument('-s', '--source',
 149                         default=os.curdir,
 150                         dest='source_dir',
 151                         help='source directory')
 152     parser.add_argument('-w', '--whitespace',
 153                         default=False,
 154                         action="store_true",
 155                         dest='trailing_whitespace',
 156                         help='Check for trailing whitespace')
 157     parser.add_argument('--permissive',
 158                         default=False,
 159                         action="store_true",
 160                         dest='permissive',
 161                         help='Do not raise an error even if issues are detected')
 162
 163     args, extras = parser.parse_known_args()
 164     require(args.parser is not None,
 165             'Path to Markdown parser not provided')
 166     require(not extras,
 167             'Unexpected trailing command-line arguments "{0}"'.format(extras))
 168
 169     return args
 170
 171
 172 def check_config(reporter, source_dir):
 173     """Check configuration file."""
 174
 175     config_file = os.path.join(source_dir, '_config.yml')
 176     config = load_yaml(config_file)
 177     reporter.check_field(config_file, 'configuration',
 178                          config, 'kind', 'lesson')
 179     reporter.check_field(config_file, 'configuration',
 180                          config, 'carpentry', ('swc', 'dc', 'lc', 'cp'))
 181     reporter.check_field(config_file, 'configuration', config, 'title')
 182     reporter.check_field(config_file, 'configuration', config, 'email')
 183
 184     for defaults in [
 185             {'values': {'root': '.', 'layout': 'page'}},
 186             {'values': {'root': '..', 'layout': 'episode'}, 'scope': {'type': 'episodes', 'path': ''}},
 187             {'values': {'root': '..', 'layout': 'page'}, 'scope': {'type': 'extras', 'path': ''}}
 188             ]:
 189         reporter.check(defaults in config.get('defaults', []),
 190                    'configuration',
 191                    '"root" not set to "." in configuration')
 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') 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     result = {}
 259     for d in SOURCE_DIRS:
 260         dpath = os.path.join(source_dir, d)
 261
 262         pattern = os.path.join(dpath, '*.md')
 263         for filename in glob.glob(pattern):
 264             data = read_markdown(parser, filename)
 265             if data:
 266                 result[filename] = data
 267
 268     return result
 269
 270
 271 def check_fileset(source_dir, reporter, filenames_present):
 272     """Are all required files present? Are extraneous files present?"""
 273
 274     # Check files with predictable names.
 275     required = [os.path.join(source_dir, p) for p in REQUIRED_FILES]
 276     missing = set(required) - set(filenames_present)
 277     for m in missing:
 278         reporter.add(None, 'Missing required file {0}', m)
 279
 280     # Check episode files' names.
 281     seen = []
 282     for filename in filenames_present:
 283         if '_episodes' not in filename:
 284             continue
 285
 286         # split path to check episode name
 287         base_name = os.path.basename(filename)
 288         m = P_EPISODE_FILENAME.search(base_name)
 289         if m and m.group(1):
 290             seen.append(m.group(1))
 291         else:
 292             reporter.add(
 293                 None, 'Episode {0} has badly-formatted filename', filename)
 294
 295     # Check for duplicate episode numbers.
 296     reporter.check(len(seen) == len(set(seen)),
 297                    None,
 298                    'Duplicate episode numbers {0} vs {1}',
 299                    sorted(seen), sorted(set(seen)))
 300
 301     # Check that numbers are consecutive.
 302     seen = sorted([int(s) for s in seen])
 303     clean = True
 304     for i in range(len(seen) - 1):
 305         clean = clean and ((seen[i+1] - seen[i]) == 1)
 306     reporter.check(clean,
 307                    None,
 308                    'Missing or non-consecutive episode numbers {0}',
 309                    seen)
 310
 311
 312 def create_checker(args, filename, info):
 313     """Create appropriate checker for file."""
 314
 315     for (pat, cls) in CHECKERS:
 316         if pat.search(filename):
 317             return cls(args, filename, **info)
 318     return NotImplemented
 319
 320 class CheckBase:
 321     """Base class for checking Markdown files."""
 322
 323     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 324         """Cache arguments for checking."""
 325
 326         self.args = args
 327         self.reporter = self.args.reporter  # for convenience
 328         self.filename = filename
 329         self.metadata = metadata
 330         self.metadata_len = metadata_len
 331         self.text = text
 332         self.lines = lines
 333         self.doc = doc
 334
 335         self.layout = None
 336
 337     def check(self):
 338         """Run tests."""
 339
 340         self.check_metadata()
 341         self.check_line_lengths()
 342         self.check_trailing_whitespace()
 343         self.check_blockquote_classes()
 344         self.check_codeblock_classes()
 345         self.check_defined_link_references()
 346
 347     def check_metadata(self):
 348         """Check the YAML metadata."""
 349
 350         self.reporter.check(self.metadata is not None,
 351                             self.filename,
 352                             'Missing metadata entirely')
 353
 354         if self.metadata and (self.layout is not None):
 355             self.reporter.check_field(
 356                 self.filename, 'metadata', self.metadata, 'layout', self.layout)
 357
 358     def check_line_lengths(self):
 359         """Check the raw text of the lesson body."""
 360
 361         if self.args.line_lengths:
 362             over = [i for (i, l, n) in self.lines if (
 363                 n > MAX_LINE_LEN) and (not l.startswith('!'))]
 364             self.reporter.check(not over,
 365                                 self.filename,
 366                                 'Line(s) too long: {0}',
 367                                 ', '.join([str(i) for i in over]))
 368
 369     def check_trailing_whitespace(self):
 370         """Check for whitespace at the ends of lines."""
 371
 372         if self.args.trailing_whitespace:
 373             trailing = [
 374                 i for (i, l, n) in self.lines if P_TRAILING_WHITESPACE.match(l)]
 375             self.reporter.check(not trailing,
 376                                 self.filename,
 377                                 'Line(s) end with whitespace: {0}',
 378                                 ', '.join([str(i) for i in trailing]))
 379
 380     def check_blockquote_classes(self):
 381         """Check that all blockquotes have known classes."""
 382
 383         for node in self.find_all(self.doc, {'type': 'blockquote'}):
 384             cls = self.get_val(node, 'attr', 'class')
 385             self.reporter.check(cls in KNOWN_BLOCKQUOTES,
 386                                 (self.filename, self.get_loc(node)),
 387                                 'Unknown or missing blockquote type {0}',
 388                                 cls)
 389
 390     def check_codeblock_classes(self):
 391         """Check that all code blocks have known classes."""
 392
 393         for node in self.find_all(self.doc, {'type': 'codeblock'}):
 394             cls = self.get_val(node, 'attr', 'class')
 395             self.reporter.check(cls in KNOWN_CODEBLOCKS,
 396                                 (self.filename, self.get_loc(node)),
 397                                 'Unknown or missing code block type {0}',
 398                                 cls)
 399
 400     def check_defined_link_references(self):
 401         """Check that defined links resolve in the file.
 402
 403         Internally-defined links match the pattern [text][label].
 404         """
 405
 406         result = set()
 407         for node in self.find_all(self.doc, {'type': 'text'}):
 408             for match in P_INTERNAL_LINK_REF.findall(node['value']):
 409                 text = match[0]
 410                 link = match[1]
 411                 if link not in self.args.references:
 412                     result.add('"{0}"=>"{1}"'.format(text, link))
 413         self.reporter.check(not result,
 414                             self.filename,
 415                             'Internally-defined links may be missing definitions: {0}',
 416                             ', '.join(sorted(result)))
 417
 418     def find_all(self, node, pattern, accum=None):
 419         """Find all matches for a pattern."""
 420
 421         assert isinstance(pattern, dict), 'Patterns must be dictionaries'
 422         if accum is None:
 423             accum = []
 424         if self.match(node, pattern):
 425             accum.append(node)
 426         for child in node.get('children', []):
 427             self.find_all(child, pattern, accum)
 428         return accum
 429
 430     def match(self, node, pattern):
 431         """Does this node match the given pattern?"""
 432
 433         for key in pattern:
 434             if key not in node:
 435                 return False
 436             val = pattern[key]
 437             if isinstance(val, str):
 438                 if node[key] != val:
 439                     return False
 440             elif isinstance(val, dict):
 441                 if not self.match(node[key], val):
 442                     return False
 443         return True
 444
 445     @staticmethod
 446     def get_val(node, *chain):
 447         """Get value one or more levels down."""
 448
 449         curr = node
 450         for selector in chain:
 451             curr = curr.get(selector, None)
 452             if curr is None:
 453                 break
 454         return curr
 455
 456     def get_loc(self, node):
 457         """Convenience method to get node's line number."""
 458
 459         result = self.get_val(node, 'options', 'location')
 460         if self.metadata_len is not None:
 461             result += self.metadata_len
 462         return result
 463
 464
 465 class CheckNonJekyll(CheckBase):
 466     """Check a file that isn't translated by Jekyll."""
 467
 468     def check_metadata(self):
 469         self.reporter.check(self.metadata is None,
 470                             self.filename,
 471                             'Unexpected metadata')
 472
 473
 474 class CheckIndex(CheckBase):
 475     """Check the main index page."""
 476
 477     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 478         super().__init__(args, filename, metadata, metadata_len, text, lines, doc)
 479         self.layout = 'lesson'
 480
 481     def check_metadata(self):
 482         super().check_metadata()
 483         self.reporter.check(self.metadata.get('root', '') == '.',
 484                             self.filename,
 485                             'Root not set to "."')
 486
 487
 488 class CheckEpisode(CheckBase):
 489     """Check an episode page."""
 490
 491     def check(self):
 492         """Run extra tests."""
 493
 494         super().check()
 495         self.check_reference_inclusion()
 496
 497     def check_metadata(self):
 498         super().check_metadata()
 499         if self.metadata:
 500             if 'layout' in self.metadata:
 501                 if self.metadata['layout'] == 'break':
 502                     self.check_metadata_fields(BREAK_METADATA_FIELDS)
 503                 else:
 504                     self.reporter.add(self.filename,
 505                                       'Unknown episode layout "{0}"',
 506                                       self.metadata['layout'])
 507             else:
 508                 self.check_metadata_fields(TEACHING_METADATA_FIELDS)
 509
 510     def check_metadata_fields(self, expected):
 511         """Check metadata fields."""
 512         for (name, type_) in expected:
 513             if name not in self.metadata:
 514                 self.reporter.add(self.filename,
 515                                   'Missing metadata field {0}',
 516                                   name)
 517             elif not isinstance(self.metadata[name], type_):
 518                 self.reporter.add(self.filename,
 519                                   '"{0}" has wrong type in metadata ({1} instead of {2})',
 520                                   name, type(self.metadata[name]), type_)
 521
 522     def check_reference_inclusion(self):
 523         """Check that links file has been included."""
 524
 525         if not self.args.reference_path:
 526             return
 527
 528         for (i, last_line, line_len) in reversed(self.lines):
 529             if last_line:
 530                 break
 531
 532         require(last_line,
 533                 'No non-empty lines in {0}'.format(self.filename))
 534
 535         include_filename = os.path.split(self.args.reference_path)[-1]
 536         if include_filename not in last_line:
 537             self.reporter.add(self.filename,
 538                               'episode does not include "{0}"',
 539                               include_filename)
 540
 541
 542 class CheckReference(CheckBase):
 543     """Check the reference page."""
 544
 545     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 546         super().__init__(args, filename, metadata, metadata_len, text, lines, doc)
 547         self.layout = 'reference'
 548
 549
 550 class CheckGeneric(CheckBase):
 551     """Check a generic page."""
 552
 553     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 554         super().__init__(args, filename, metadata, metadata_len, text, lines, doc)
 555
 556
 557 CHECKERS = [
 558     (re.compile(r'CONTRIBUTING\.md'), CheckNonJekyll),
 559     (re.compile(r'README\.md'), CheckNonJekyll),
 560     (re.compile(r'index\.md'), CheckIndex),
 561     (re.compile(r'reference\.md'), CheckReference),
 562     (re.compile(r'_episodes/.*\.md'), CheckEpisode),
 563     (re.compile(r'.*\.md'), CheckGeneric)
 564 ]
 565
 566
 567 if __name__ == '__main__':
 568     main()