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