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