bin/lesson_check.py

   1 #!/usr/bin/env python
   2
   3 """
   4 Check lesson files and their contents.
   5 """
   6
   7 import sys
   8 import os
   9 import glob
  10 import json
  11 import re
  12 from optparse import OptionParser
  13
  14 from util import Reporter, read_markdown, load_yaml, check_unwanted_files
  15
  16 __version__ = '0.2'
  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 specially.
  26 # This list must include all the Markdown files listed in the 'bin/initialize' script.
  27 REQUIRED_FILES = {
  28     '%/CONDUCT.md': True,
  29     '%/CONTRIBUTING.md': False,
  30     '%/LICENSE.md': True,
  31     '%/README.md': False,
  32     '%/_extras/discuss.md': True,
  33     '%/_extras/figures.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 # What kinds of blockquotes are allowed?
  50 KNOWN_BLOCKQUOTES = {
  51     'callout',
  52     'challenge',
  53     'checklist',
  54     'discussion',
  55     'keypoints',
  56     'objectives',
  57     'prereq',
  58     'quotation',
  59     'solution',
  60     'testimonial'
  61 }
  62
  63 # What kinds of code fragments are allowed?
  64 KNOWN_CODEBLOCKS = {
  65     'error',
  66     'output',
  67     'source',
  68     'bash',
  69     'make',
  70     'python',
  71     'r',
  72     'sql'
  73 }
  74
  75 # What fields are required in teaching episode metadata?
  76 TEACHING_METADATA_FIELDS = {
  77     ('title', str),
  78     ('teaching', int),
  79     ('exercises', int),
  80     ('questions', list),
  81     ('objectives', list),
  82     ('keypoints', list)
  83 }
  84
  85 # What fields are required in break episode metadata?
  86 BREAK_METADATA_FIELDS = {
  87     ('layout', str),
  88     ('title', str),
  89     ('break', int)
  90 }
  91
  92 # How long are lines allowed to be?
  93 MAX_LINE_LEN = 100
  94
  95 def main():
  96     """Main driver."""
  97
  98     args = parse_args()
  99     args.reporter = Reporter()
 100     check_config(args.reporter, args.source_dir)
 101     docs = read_all_markdown(args.source_dir, args.parser)
 102     check_fileset(args.source_dir, args.reporter, docs.keys())
 103     check_unwanted_files(args.source_dir, args.reporter)
 104     for filename in docs.keys():
 105         checker = create_checker(args, filename, docs[filename])
 106         checker.check()
 107     check_figures(args.source_dir, args.reporter)
 108     args.reporter.report()
 109
 110
 111 def parse_args():
 112     """Parse command-line arguments."""
 113
 114     parser = OptionParser()
 115     parser.add_option('-l', '--linelen',
 116                       default=False,
 117                       action="store_true",
 118                       dest='line_lengths',
 119                       help='Check line lengths')
 120     parser.add_option('-p', '--parser',
 121                       default=None,
 122                       dest='parser',
 123                       help='path to Markdown parser')
 124     parser.add_option('-s', '--source',
 125                       default=os.curdir,
 126                       dest='source_dir',
 127                       help='source directory')
 128     parser.add_option('-w', '--whitespace',
 129                       default=False,
 130                       action="store_true",
 131                       dest='trailing_whitespace',
 132                       help='Check for trailing whitespace')
 133
 134     args, extras = parser.parse_args()
 135     require(args.parser is not None,
 136             'Path to Markdown parser not provided')
 137     require(not extras,
 138             'Unexpected trailing command-line arguments "{0}"'.format(extras))
 139
 140     return args
 141
 142
 143 def check_config(reporter, source_dir):
 144     """Check configuration file."""
 145
 146     config_file = os.path.join(source_dir, '_config.yml')
 147     config = load_yaml(config_file)
 148     reporter.check_field(config_file, 'configuration', config, 'kind', 'lesson')
 149
 150
 151 def read_all_markdown(source_dir, parser):
 152     """Read source files, returning
 153     {path : {'metadata':yaml, 'metadata_len':N, 'text':text, 'lines':[(i, line, len)], 'doc':doc}}
 154     """
 155
 156     all_dirs = [os.path.join(source_dir, d) for d in SOURCE_DIRS]
 157     all_patterns = [os.path.join(d, '*.md') for d in all_dirs]
 158     result = {}
 159     for pat in all_patterns:
 160         for filename in glob.glob(pat):
 161             data = read_markdown(parser, filename)
 162             if data:
 163                 result[filename] = data
 164     return result
 165
 166
 167 def check_fileset(source_dir, reporter, filenames_present):
 168     """Are all required files present? Are extraneous files present?"""
 169
 170     # Check files with predictable names.
 171     required = [p.replace('%', source_dir) for p in REQUIRED_FILES]
 172     missing = set(required) - set(filenames_present)
 173     for m in missing:
 174         reporter.add(None, 'Missing required file {0}', m)
 175
 176     # Check episode files' names.
 177     seen = []
 178     for filename in filenames_present:
 179         if '_episodes' not in filename:
 180             continue
 181         m = P_EPISODE_FILENAME.search(filename)
 182         if m and m.group(1):
 183             seen.append(m.group(1))
 184         else:
 185             reporter.add(None, 'Episode {0} has badly-formatted filename', filename)
 186
 187     # Check for duplicate episode numbers.
 188     reporter.check(len(seen) == len(set(seen)),
 189                         None,
 190                         'Duplicate episode numbers {0} vs {1}',
 191                         sorted(seen), sorted(set(seen)))
 192
 193     # Check that numbers are consecutive.
 194     seen = [int(s) for s in seen]
 195     seen.sort()
 196     clean = True
 197     for i in range(len(seen) - 1):
 198         clean = clean and ((seen[i+1] - seen[i]) == 1)
 199     reporter.check(clean,
 200                    None,
 201                    'Missing or non-consecutive episode numbers {0}',
 202                    seen)
 203
 204
 205 def check_figures(source_dir, reporter):
 206     """Check that all figures are present and referenced."""
 207
 208     # Get references.
 209     try:
 210         all_figures_html = os.path.join(source_dir, '_includes', 'all_figures.html')
 211         with open(all_figures_html, 'r') as reader:
 212             text = reader.read()
 213         figures = P_FIGURE_REFS.findall(text)
 214         referenced = [os.path.split(f)[1] for f in figures if '/fig/' in f]
 215     except FileNotFoundError as e:
 216         reporter.add(all_figures_html,
 217                      'File not found')
 218         return
 219
 220     # Get actual files.
 221     fig_dir_path = os.path.join(source_dir, 'fig')
 222     actual = [f for f in os.listdir(fig_dir_path) if not f.startswith('.')]
 223
 224     # Report differences.
 225     unexpected = set(actual) - set(referenced)
 226     reporter.check(not unexpected,
 227                    None,
 228                    'Unexpected image files: {0}',
 229                    ', '.join(sorted(unexpected)))
 230     missing = set(referenced) - set(actual)
 231     reporter.check(not missing,
 232                    None,
 233                    'Missing image files: {0}',
 234                    ', '.join(sorted(missing)))
 235
 236
 237 def create_checker(args, filename, info):
 238     """Create appropriate checker for file."""
 239
 240     for (pat, cls) in CHECKERS:
 241         if pat.search(filename):
 242             return cls(args, filename, **info)
 243
 244
 245 def require(condition, message):
 246     """Fail if condition not met."""
 247
 248     if not condition:
 249         print(message, file=sys.stderr)
 250         sys.exit(1)
 251
 252
 253 class CheckBase(object):
 254     """Base class for checking Markdown files."""
 255
 256     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 257         """Cache arguments for checking."""
 258
 259         super(CheckBase, self).__init__()
 260         self.args = args
 261         self.reporter = self.args.reporter # for convenience
 262         self.filename = filename
 263         self.metadata = metadata
 264         self.metadata_len = metadata_len
 265         self.text = text
 266         self.lines = lines
 267         self.doc = doc
 268
 269         self.layout = None
 270
 271
 272     def check(self):
 273         """Run tests on metadata."""
 274
 275         self.check_metadata()
 276         self.check_line_lengths()
 277         self.check_trailing_whitespace()
 278         self.check_blockquote_classes()
 279         self.check_codeblock_classes()
 280
 281
 282     def check_metadata(self):
 283         """Check the YAML metadata."""
 284
 285         self.reporter.check(self.metadata is not None,
 286                             self.filename,
 287                             'Missing metadata entirely')
 288
 289         if self.metadata and (self.layout is not None):
 290             self.reporter.check_field(self.filename, 'metadata', self.metadata, 'layout', self.layout)
 291
 292
 293     def check_line_lengths(self):
 294         """Check the raw text of the lesson body."""
 295
 296         if self.args.line_lengths:
 297             over = [i for (i, l, n) in self.lines if (n > MAX_LINE_LEN) and (not l.startswith('!'))]
 298             self.reporter.check(not over,
 299                                 self.filename,
 300                                 'Line(s) are too long: {0}',
 301                                 ', '.join([str(i) for i in over]))
 302
 303
 304     def check_trailing_whitespace(self):
 305         """Check for whitespace at the ends of lines."""
 306
 307         if self.args.trailing_whitespace:
 308             trailing = [i for (i, l, n) in self.lines if P_TRAILING_WHITESPACE.match(l)]
 309             self.reporter.check(not trailing,
 310                                 self.filename,
 311                                 'Line(s) end with whitespace: {0}',
 312                                 ', '.join([str(i) for i in trailing]))
 313
 314
 315     def check_blockquote_classes(self):
 316         """Check that all blockquotes have known classes."""
 317
 318         for node in self.find_all(self.doc, {'type' : 'blockquote'}):
 319             cls = self.get_val(node, 'attr', 'class')
 320             self.reporter.check(cls in KNOWN_BLOCKQUOTES,
 321                                 (self.filename, self.get_loc(node)),
 322                                 'Unknown or missing blockquote type {0}',
 323                                 cls)
 324
 325
 326     def check_codeblock_classes(self):
 327         """Check that all code blocks have known classes."""
 328
 329         for node in self.find_all(self.doc, {'type' : 'codeblock'}):
 330             cls = self.get_val(node, 'attr', 'class')
 331             self.reporter.check(cls in KNOWN_CODEBLOCKS,
 332                                 (self.filename, self.get_loc(node)),
 333                                 'Unknown or missing code block type {0}',
 334                                 cls)
 335
 336
 337     def find_all(self, node, pattern, accum=None):
 338         """Find all matches for a pattern."""
 339
 340         assert type(pattern) == dict, 'Patterns must be dictionaries'
 341         if accum is None:
 342             accum = []
 343         if self.match(node, pattern):
 344             accum.append(node)
 345         for child in node.get('children', []):
 346             self.find_all(child, pattern, accum)
 347         return accum
 348
 349
 350     def match(self, node, pattern):
 351         """Does this node match the given pattern?"""
 352
 353         for key in pattern:
 354             if key not in node:
 355                 return False
 356             val = pattern[key]
 357             if type(val) == str:
 358                 if node[key] != val:
 359                     return False
 360             elif type(val) == dict:
 361                 if not self.match(node[key], val):
 362                     return False
 363         return True
 364
 365
 366     def get_val(self, node, *chain):
 367         """Get value one or more levels down."""
 368
 369         curr = node
 370         for selector in chain:
 371             curr = curr.get(selector, None)
 372             if curr is None:
 373                 break
 374         return curr
 375
 376
 377     def get_loc(self, node):
 378         """Convenience method to get node's line number."""
 379
 380         result = self.get_val(node, 'options', 'location')
 381         if self.metadata_len is not None:
 382             result += self.metadata_len
 383         return result
 384
 385
 386 class CheckNonJekyll(CheckBase):
 387     """Check a file that isn't translated by Jekyll."""
 388
 389     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 390         super(CheckNonJekyll, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 391
 392
 393     def check_metadata(self):
 394         self.reporter.check(self.metadata is None,
 395                             self.filename,
 396                             'Unexpected metadata')
 397
 398
 399 class CheckIndex(CheckBase):
 400     """Check the main index page."""
 401
 402     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 403         super(CheckIndex, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 404         self.layout = 'lesson'
 405
 406
 407 class CheckEpisode(CheckBase):
 408     """Check an episode page."""
 409
 410     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 411         super(CheckEpisode, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 412
 413     def check_metadata(self):
 414         super(CheckEpisode, self).check_metadata()
 415         if self.metadata:
 416             if 'layout' in self.metadata:
 417                 if self.metadata['layout'] == 'break':
 418                     self.check_metadata_fields(BREAK_METADATA_FIELDS)
 419                 else:
 420                     self.reporter.add(self.filename,
 421                                       'Unknown episode layout "{0}"',
 422                                       self.metadata['layout'])
 423             else:
 424                 self.check_metadata_fields(TEACHING_METADATA_FIELDS)
 425
 426
 427     def check_metadata_fields(self, expected):
 428         for (name, type_) in expected:
 429             if name not in self.metadata:
 430                 self.reporter.add(self.filename,
 431                                   'Missing metadata field {0}',
 432                                   name)
 433             elif type(self.metadata[name]) != type_:
 434                 self.reporter.add(self.filename,
 435                                   '"{0}" has wrong type in metadata ({1} instead of {2})',
 436                                   name, type(self.metadata[name]), type_)
 437
 438
 439 class CheckReference(CheckBase):
 440     """Check the reference page."""
 441
 442     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 443         super(CheckReference, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 444         self.layout = 'reference'
 445
 446
 447 class CheckGeneric(CheckBase):
 448     """Check a generic page."""
 449
 450     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 451         super(CheckGeneric, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 452         self.layout = 'page'
 453
 454
 455 CHECKERS = [
 456     (re.compile(r'CONTRIBUTING\.md'), CheckNonJekyll),
 457     (re.compile(r'README\.md'), CheckNonJekyll),
 458     (re.compile(r'index\.md'), CheckIndex),
 459     (re.compile(r'reference\.md'), CheckReference),
 460     (re.compile(r'_episodes/.*\.md'), CheckEpisode),
 461     (re.compile(r'.*\.md'), CheckGeneric)
 462 ]
 463
 464
 465 if __name__ == '__main__':
 466     main()