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