bin/lesson_check.py

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