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