src/etc/generate-deriving-span-tests.py

   1 #!/usr/bin/env python
   2
   3 """
   4 This script creates a pile of compile-fail tests check that all the
   5 derives have spans that point to the fields, rather than the
   6 #[derive(...)] line.
   7
   8 sample usage: src/etc/generate-deriving-span-tests.py
   9 """
  10
  11 import os, datetime, stat, re
  12
  13 TEST_DIR = os.path.abspath(
  14     os.path.join(os.path.dirname(__file__), '../test/ui/derives/'))
  15
  16 YEAR = datetime.datetime.now().year
  17
  18 TEMPLATE = """
  19 // This file was auto-generated using 'src/etc/generate-deriving-span-tests.py'
  20
  21 {error_deriving}
  22 struct Error;
  23 {code}
  24 fn main() {{}}
  25 """
  26
  27 ENUM_STRING = """
  28 #[derive({traits})]
  29 enum Enum {{
  30    A(
  31      Error {errors}
  32      )
  33 }}
  34 """
  35 ENUM_STRUCT_VARIANT_STRING = """
  36 #[derive({traits})]
  37 enum Enum {{
  38    A {{
  39      x: Error {errors}
  40    }}
  41 }}
  42 """
  43 STRUCT_STRING = """
  44 #[derive({traits})]
  45 struct Struct {{
  46     x: Error {errors}
  47 }}
  48 """
  49 STRUCT_TUPLE_STRING = """
  50 #[derive({traits})]
  51 struct Struct(
  52     Error {errors}
  53 );
  54 """
  55
  56 ENUM_TUPLE, ENUM_STRUCT, STRUCT_FIELDS, STRUCT_TUPLE = range(4)
  57
  58 def create_test_case(type, trait, super_traits, error_count):
  59     string = [ENUM_STRING, ENUM_STRUCT_VARIANT_STRING, STRUCT_STRING, STRUCT_TUPLE_STRING][type]
  60     all_traits = ','.join([trait] + super_traits)
  61     super_traits = ','.join(super_traits)
  62     error_deriving = '#[derive(%s)]' % super_traits if super_traits else ''
  63
  64     errors = '\n'.join('//~%s ERROR' % ('^' * n) for n in range(error_count))
  65     code = string.format(traits = all_traits, errors = errors)
  66     return TEMPLATE.format(year = YEAR, error_deriving=error_deriving, code = code)
  67
  68 def write_file(name, string):
  69     test_file = os.path.join(TEST_DIR, 'derives-span-%s.rs' % name)
  70
  71     with open(test_file) as f:
  72         old_str = f.read()
  73         old_str_ignoring_date = re.sub(r'^// Copyright \d+',
  74                                         '// Copyright {year}'.format(year = YEAR), old_str)
  75         if old_str_ignoring_date == string:
  76             # if all we're doing is updating the copyright year, ignore it
  77             return 0
  78
  79     # set write permission if file exists, so it can be changed
  80     if os.path.exists(test_file):
  81         os.chmod(test_file, stat.S_IWUSR)
  82
  83     with open(test_file, 'w') as f:
  84         f.write(string)
  85
  86     # mark file read-only
  87     os.chmod(test_file, stat.S_IRUSR|stat.S_IRGRP|stat.S_IROTH)
  88
  89     return 1
  90
  91
  92 ENUM = 1
  93 STRUCT = 2
  94 ALL = STRUCT | ENUM
  95
  96 traits = {
  97     'Default': (STRUCT, [], 1),
  98     'FromPrimitive': (0, [], 0), # only works for C-like enums
  99
 100     'Decodable': (0, [], 0), # FIXME: quoting gives horrible spans
 101     'Encodable': (0, [], 0), # FIXME: quoting gives horrible spans
 102 }
 103
 104 for (trait, supers, errs) in [('Clone', [], 1),
 105                               ('PartialEq', [], 2),
 106                               ('PartialOrd', ['PartialEq'], 1),
 107                               ('Eq', ['PartialEq'], 1),
 108                               ('Ord', ['Eq', 'PartialOrd', 'PartialEq'], 1),
 109                               ('Debug', [], 1),
 110                               ('Hash', [], 1)]:
 111     traits[trait] = (ALL, supers, errs)
 112
 113 files = 0
 114
 115 for (trait, (types, super_traits, error_count)) in traits.items():
 116     mk = lambda ty: create_test_case(ty, trait, super_traits, error_count)
 117     if types & ENUM:
 118         files += write_file(trait + '-enum', mk(ENUM_TUPLE))
 119         files += write_file(trait + '-enum-struct-variant', mk(ENUM_STRUCT))
 120     if types & STRUCT:
 121         files += write_file(trait + '-struct', mk(STRUCT_FIELDS))
 122         files += write_file(trait + '-tuple-struct', mk(STRUCT_TUPLE))
 123
 124 print('Generated {files} deriving span test{}.'.format('s' if files != 1 else '', files = files))