bin/lesson_check.py

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