bin/lesson_check.py

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