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', 'lc'))
 155     reporter.check_field(config_file, 'configuration', config, 'title')
 156     reporter.check_field(config_file, 'configuration', config, 'contact')
 157
 158     reporter.check({'values': {'root': '..'}} in config.get('defaults', []),
 159                    'configuration',
 160                    '"root" not set to ".." in configuration')
 161
 162
 163 def read_all_markdown(source_dir, parser):
 164     """Read source files, returning
 165     {path : {'metadata':yaml, 'metadata_len':N, 'text':text, 'lines':[(i, line, len)], 'doc':doc}}
 166     """
 167
 168     all_dirs = [os.path.join(source_dir, d) for d in SOURCE_DIRS]
 169     all_patterns = [os.path.join(d, '*.md') for d in all_dirs]
 170     result = {}
 171     for pat in all_patterns:
 172         for filename in glob.glob(pat):
 173             data = read_markdown(parser, filename)
 174             if data:
 175                 result[filename] = data
 176     return result
 177
 178
 179 def check_fileset(source_dir, reporter, filenames_present):
 180     """Are all required files present? Are extraneous files present?"""
 181
 182     # Check files with predictable names.
 183     required = [p.replace('%', source_dir) for p in REQUIRED_FILES]
 184     missing = set(required) - set(filenames_present)
 185     for m in missing:
 186         reporter.add(None, 'Missing required file {0}', m)
 187
 188     # Check episode files' names.
 189     seen = []
 190     for filename in filenames_present:
 191         if '_episodes' not in filename:
 192             continue
 193         m = P_EPISODE_FILENAME.search(filename)
 194         if m and m.group(1):
 195             seen.append(m.group(1))
 196         else:
 197             reporter.add(None, 'Episode {0} has badly-formatted filename', filename)
 198
 199     # Check for duplicate episode numbers.
 200     reporter.check(len(seen) == len(set(seen)),
 201                         None,
 202                         'Duplicate episode numbers {0} vs {1}',
 203                         sorted(seen), sorted(set(seen)))
 204
 205     # Check that numbers are consecutive.
 206     seen = [int(s) for s in seen]
 207     seen.sort()
 208     clean = True
 209     for i in range(len(seen) - 1):
 210         clean = clean and ((seen[i+1] - seen[i]) == 1)
 211     reporter.check(clean,
 212                    None,
 213                    'Missing or non-consecutive episode numbers {0}',
 214                    seen)
 215
 216
 217 def check_figures(source_dir, reporter):
 218     """Check that all figures are present and referenced."""
 219
 220     # Get references.
 221     try:
 222         all_figures_html = os.path.join(source_dir, '_includes', 'all_figures.html')
 223         with open(all_figures_html, 'r') as reader:
 224             text = reader.read()
 225         figures = P_FIGURE_REFS.findall(text)
 226         referenced = [os.path.split(f)[1] for f in figures if '/fig/' in f]
 227     except FileNotFoundError as e:
 228         reporter.add(all_figures_html,
 229                      'File not found')
 230         return
 231
 232     # Get actual image files (ignore non-image files).
 233     fig_dir_path = os.path.join(source_dir, 'fig')
 234     actual = [f for f in os.listdir(fig_dir_path) if os.path.splitext(f)[1] in IMAGE_FILE_SUFFIX]
 235
 236     # Report differences.
 237     unexpected = set(actual) - set(referenced)
 238     reporter.check(not unexpected,
 239                    None,
 240                    'Unexpected image files: {0}',
 241                    ', '.join(sorted(unexpected)))
 242     missing = set(referenced) - set(actual)
 243     reporter.check(not missing,
 244                    None,
 245                    'Missing image files: {0}',
 246                    ', '.join(sorted(missing)))
 247
 248
 249 def create_checker(args, filename, info):
 250     """Create appropriate checker for file."""
 251
 252     for (pat, cls) in CHECKERS:
 253         if pat.search(filename):
 254             return cls(args, filename, **info)
 255
 256
 257 class CheckBase(object):
 258     """Base class for checking Markdown files."""
 259
 260     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 261         """Cache arguments for checking."""
 262
 263         super(CheckBase, self).__init__()
 264         self.args = args
 265         self.reporter = self.args.reporter # for convenience
 266         self.filename = filename
 267         self.metadata = metadata
 268         self.metadata_len = metadata_len
 269         self.text = text
 270         self.lines = lines
 271         self.doc = doc
 272
 273         self.layout = None
 274
 275
 276     def check(self):
 277         """Run tests on metadata."""
 278
 279         self.check_metadata()
 280         self.check_line_lengths()
 281         self.check_trailing_whitespace()
 282         self.check_blockquote_classes()
 283         self.check_codeblock_classes()
 284         self.check_defined_link_references()
 285
 286
 287     def check_metadata(self):
 288         """Check the YAML metadata."""
 289
 290         self.reporter.check(self.metadata is not None,
 291                             self.filename,
 292                             'Missing metadata entirely')
 293
 294         if self.metadata and (self.layout is not None):
 295             self.reporter.check_field(self.filename, 'metadata', self.metadata, 'layout', self.layout)
 296
 297
 298     def check_line_lengths(self):
 299         """Check the raw text of the lesson body."""
 300
 301         if self.args.line_lengths:
 302             over = [i for (i, l, n) in self.lines if (n > MAX_LINE_LEN) and (not l.startswith('!'))]
 303             self.reporter.check(not over,
 304                                 self.filename,
 305                                 'Line(s) are too long: {0}',
 306                                 ', '.join([str(i) for i in over]))
 307
 308
 309     def check_trailing_whitespace(self):
 310         """Check for whitespace at the ends of lines."""
 311
 312         if self.args.trailing_whitespace:
 313             trailing = [i for (i, l, n) in self.lines if P_TRAILING_WHITESPACE.match(l)]
 314             self.reporter.check(not trailing,
 315                                 self.filename,
 316                                 'Line(s) end with whitespace: {0}',
 317                                 ', '.join([str(i) for i in trailing]))
 318
 319
 320     def check_blockquote_classes(self):
 321         """Check that all blockquotes have known classes."""
 322
 323         for node in self.find_all(self.doc, {'type' : 'blockquote'}):
 324             cls = self.get_val(node, 'attr', 'class')
 325             self.reporter.check(cls in KNOWN_BLOCKQUOTES,
 326                                 (self.filename, self.get_loc(node)),
 327                                 'Unknown or missing blockquote type {0}',
 328                                 cls)
 329
 330
 331     def check_codeblock_classes(self):
 332         """Check that all code blocks have known classes."""
 333
 334         for node in self.find_all(self.doc, {'type' : 'codeblock'}):
 335             cls = self.get_val(node, 'attr', 'class')
 336             self.reporter.check(cls in KNOWN_CODEBLOCKS,
 337                                 (self.filename, self.get_loc(node)),
 338                                 'Unknown or missing code block type {0}',
 339                                 cls)
 340
 341
 342     def check_defined_link_references(self):
 343         """Check that defined links resolve in the file.
 344
 345         Internally-defined links match the pattern [text][label].  If
 346         the label contains '{{...}}', it is hopefully a references to
 347         a configuration value - we should check that, but don't right
 348         now.
 349         """
 350
 351         result = set()
 352         for node in self.find_all(self.doc, {'type' : 'text'}):
 353             for match in P_INTERNALLY_DEFINED_LINK.findall(node['value']):
 354                 if '{{' not in match:
 355                     result.add(match)
 356         self.reporter.check(not result,
 357                             self.filename,
 358                             'Internally-defined links may be missing definitions: {0}',
 359                             ', '.join(sorted(result)))
 360
 361
 362     def find_all(self, node, pattern, accum=None):
 363         """Find all matches for a pattern."""
 364
 365         assert type(pattern) == dict, 'Patterns must be dictionaries'
 366         if accum is None:
 367             accum = []
 368         if self.match(node, pattern):
 369             accum.append(node)
 370         for child in node.get('children', []):
 371             self.find_all(child, pattern, accum)
 372         return accum
 373
 374
 375     def match(self, node, pattern):
 376         """Does this node match the given pattern?"""
 377
 378         for key in pattern:
 379             if key not in node:
 380                 return False
 381             val = pattern[key]
 382             if type(val) == str:
 383                 if node[key] != val:
 384                     return False
 385             elif type(val) == dict:
 386                 if not self.match(node[key], val):
 387                     return False
 388         return True
 389
 390
 391     def get_val(self, node, *chain):
 392         """Get value one or more levels down."""
 393
 394         curr = node
 395         for selector in chain:
 396             curr = curr.get(selector, None)
 397             if curr is None:
 398                 break
 399         return curr
 400
 401
 402     def get_loc(self, node):
 403         """Convenience method to get node's line number."""
 404
 405         result = self.get_val(node, 'options', 'location')
 406         if self.metadata_len is not None:
 407             result += self.metadata_len
 408         return result
 409
 410
 411 class CheckNonJekyll(CheckBase):
 412     """Check a file that isn't translated by Jekyll."""
 413
 414     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 415         super(CheckNonJekyll, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 416
 417
 418     def check_metadata(self):
 419         self.reporter.check(self.metadata is None,
 420                             self.filename,
 421                             'Unexpected metadata')
 422
 423
 424 class CheckIndex(CheckBase):
 425     """Check the main index page."""
 426
 427     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 428         super(CheckIndex, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 429         self.layout = 'lesson'
 430
 431     def check_metadata(self):
 432         super(CheckIndex, self).check_metadata()
 433         self.reporter.check(self.metadata.get('root', '') == '.',
 434                             self.filename,
 435                             'Root not set to "."')
 436
 437
 438 class CheckEpisode(CheckBase):
 439     """Check an episode page."""
 440
 441     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 442         super(CheckEpisode, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 443
 444     def check_metadata(self):
 445         super(CheckEpisode, self).check_metadata()
 446         if self.metadata:
 447             if 'layout' in self.metadata:
 448                 if self.metadata['layout'] == 'break':
 449                     self.check_metadata_fields(BREAK_METADATA_FIELDS)
 450                 else:
 451                     self.reporter.add(self.filename,
 452                                       'Unknown episode layout "{0}"',
 453                                       self.metadata['layout'])
 454             else:
 455                 self.check_metadata_fields(TEACHING_METADATA_FIELDS)
 456
 457
 458     def check_metadata_fields(self, expected):
 459         for (name, type_) in expected:
 460             if name not in self.metadata:
 461                 self.reporter.add(self.filename,
 462                                   'Missing metadata field {0}',
 463                                   name)
 464             elif type(self.metadata[name]) != type_:
 465                 self.reporter.add(self.filename,
 466                                   '"{0}" has wrong type in metadata ({1} instead of {2})',
 467                                   name, type(self.metadata[name]), type_)
 468
 469
 470 class CheckReference(CheckBase):
 471     """Check the reference page."""
 472
 473     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 474         super(CheckReference, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 475         self.layout = 'reference'
 476
 477
 478 class CheckGeneric(CheckBase):
 479     """Check a generic page."""
 480
 481     def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
 482         super(CheckGeneric, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
 483         self.layout = 'page'
 484
 485
 486 CHECKERS = [
 487     (re.compile(r'CONTRIBUTING\.md'), CheckNonJekyll),
 488     (re.compile(r'README\.md'), CheckNonJekyll),
 489     (re.compile(r'index\.md'), CheckIndex),
 490     (re.compile(r'reference\.md'), CheckReference),
 491     (re.compile(r'_episodes/.*\.md'), CheckEpisode),
 492     (re.compile(r'.*\.md'), CheckGeneric)
 493 ]
 494
 495
 496 if __name__ == '__main__':
 497     main()