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