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, stat
  12
  13 TEST_DIR = os.path.abspath(
  14     os.path.join(os.path.dirname(__file__), '../test/ui/derives/'))
  15
  16 TEMPLATE = """\
  17 // This file was auto-generated using 'src/etc/generate-deriving-span-tests.py'
  18
  19 {error_deriving}
  20 struct Error;
  21 {code}
  22 fn main() {{}}
  23 """
  24
  25 ENUM_STRING = """
  26 #[derive({traits})]
  27 enum Enum {{
  28    A(
  29      Error {errors}
  30      )
  31 }}
  32 """
  33 ENUM_STRUCT_VARIANT_STRING = """
  34 #[derive({traits})]
  35 enum Enum {{
  36    A {{
  37      x: Error {errors}
  38    }}
  39 }}
  40 """
  41 STRUCT_STRING = """
  42 #[derive({traits})]
  43 struct Struct {{
  44     x: Error {errors}
  45 }}
  46 """
  47 STRUCT_TUPLE_STRING = """
  48 #[derive({traits})]
  49 struct Struct(
  50     Error {errors}
  51 );
  52 """
  53
  54 ENUM_TUPLE, ENUM_STRUCT, STRUCT_FIELDS, STRUCT_TUPLE = range(4)
  55
  56 def create_test_case(type, trait, super_traits, error_count):
  57     string = [ENUM_STRING, ENUM_STRUCT_VARIANT_STRING, STRUCT_STRING, STRUCT_TUPLE_STRING][type]
  58     all_traits = ','.join([trait] + super_traits)
  59     super_traits = ','.join(super_traits)
  60     error_deriving = '#[derive(%s)]' % super_traits if super_traits else ''
  61
  62     errors = '\n'.join('//~%s ERROR' % ('^' * n) for n in range(error_count))
  63     code = string.format(traits = all_traits, errors = errors)
  64     return TEMPLATE.format(error_deriving=error_deriving, code = code)
  65
  66 def write_file(name, string):
  67     test_file = os.path.join(TEST_DIR, 'derives-span-%s.rs' % name)
  68
  69     # set write permission if file exists, so it can be changed
  70     if os.path.exists(test_file):
  71         os.chmod(test_file, stat.S_IWUSR)
  72
  73     with open(test_file, 'w') as f:
  74         f.write(string)
  75
  76     # mark file read-only
  77     os.chmod(test_file, stat.S_IRUSR|stat.S_IRGRP|stat.S_IROTH)
  78
  79
  80 ENUM = 1
  81 STRUCT = 2
  82 ALL = STRUCT | ENUM
  83
  84 traits = {
  85     'Default': (STRUCT, [], 1),
  86     'FromPrimitive': (0, [], 0), # only works for C-like enums
  87
  88     'Decodable': (0, [], 0), # FIXME: quoting gives horrible spans
  89     'Encodable': (0, [], 0), # FIXME: quoting gives horrible spans
  90 }
  91
  92 for (trait, supers, errs) in [('Clone', [], 1),
  93                               ('PartialEq', [], 2),
  94                               ('PartialOrd', ['PartialEq'], 1),
  95                               ('Eq', ['PartialEq'], 1),
  96                               ('Ord', ['Eq', 'PartialOrd', 'PartialEq'], 1),
  97                               ('Debug', [], 1),
  98                               ('Hash', [], 1)]:
  99     traits[trait] = (ALL, supers, errs)
 100
 101 for (trait, (types, super_traits, error_count)) in traits.items():
 102     mk = lambda ty: create_test_case(ty, trait, super_traits, error_count)
 103     if types & ENUM:
 104         write_file(trait + '-enum', mk(ENUM_TUPLE))
 105         write_file(trait + '-enum-struct-variant', mk(ENUM_STRUCT))
 106     if types & STRUCT:
 107         write_file(trait + '-struct', mk(STRUCT_FIELDS))
 108         write_file(trait + '-tuple-struct', mk(STRUCT_TUPLE))