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