Top Level Namespace

Defined Under Namespace

Classes: CoreEnumerationAlgo, FatalError, NormalProgramTermination, Progress, ProgressBar, Regexp_to_SMTLIB, SolverSession, Z3Solver

Constant Summary collapse

CHUNK_SIZE = 
10000
DEFAULT_Z3_PATH = 
"z3"
CONFIG_FILE = 
"config.yml"
OUTPUT_FILE = 
"result.xml"
CONTINUATION_FILE = 
'continuation.log'
COMBINATION_LOG = 
'combinations.log'
VARS_LOG = 
'vars.log'
OUTPUT_DIR = 
"result"
LISTS_DIR = 
"lists"
QUERY_DIR = 
"queries"
PARAMETERIZED_QUERY_DIR = 
"parameterized_queries"
XML_TEMPLATE = 
""
DEFAULT_CONFIG = 
{
  :z3path => "z3",
  :generation_system_mode => "Production",
  :generation_system => "Production"
}
USAGE = 
<<EOF
usage:

GENERATING A SINGLE MESSAGE:

  ruby #{$PROGRAM_NAME} -list-validation-rules
  - outputs a list of all validation rule names that have been specified in #{$PROGRAM_NAME}.

  ruby #{$PROGRAM_NAME} <options>
  - generates a message of the given type, which
    - is valid XML
    - adheres to the schema, and
    - satisfies all validation rules specified for messages of this type.
  where <options> is a combination of
    -negate <validation_rule> - negates the named validation rule. This causes the resulting message to still satisfy all other validation rules, but to violate this one.
  NOTE: the result can be found in #{OUTPUT_FILE}
  
GENERATING MESSAGES FOR ALL COMBINATIONS:

  ruby #{$PROGRAM_NAME} -list-keys
  - outputs a list of all keys that have been used in #{$PROGRAM_NAME} to mark fields or structures.

  ruby #{$PROGRAM_NAME} -list <key>
  - outputs a list of all fields and structures that have been marked with <key> in #{$PROGRAM_NAME}.

  ruby #{$PROGRAM_NAME} -count-docs-for-key <key>
  - calculates the number of combinations of all fields and structures marked with <key>

  ruby #{$PROGRAM_NAME} -generate-docs-for-key <key> <options>
  - generates all valid messages of the given type that can be derived from combinations of all the fields and structures marked with <key>.
  where <options> is a combination of
    -continue - continues a previously interrupted generation process. Must use the same <key> the the interrupted generation.ARGF
    -max-num-docs <limit> - stops generation process after generating <limit> documents.
  NOTE: enumerating large combination-spaces may take a long time.
        - Use -count-docs-for-key to measure the size of the combination-space beforehand.
        - Also: you can interrupt the generation process at any time using Ctrl+C. The intermediate result is stored in the directory #{OUTPUT_DIR} and the generation process can
          be restarted later by adding -continue to the command line.
  NOTE: do not expect the number of generated documents to equal the number of combinations as combinations may not have any valid message instances (for instance when they contradict the validation rules).
  NOTE: the result can be found in the directory #{OUTPUT_DIR}
EOF
FTYPE_MANDATORY = 
0
FTYPE_OPTIONAL = 
1
SUBF_AND = 
0
SUBF_OR = 
1
SUBF_XOR = 
2
LOG_DIR = 
'logs'

Instance Method Summary collapse

Instance Method Details

#add_model_struct_to_doc(progress, struct, doc, model, prefix = nil) ⇒ Object 



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/mbt-gen.rb', line 678

def add_model_struct_to_doc(progress, struct, doc, model, prefix = nil)
  struct.each do |key, value|
    next if key == :validation_rules || key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
    if value[:type] == :field then
      if prefix then
        xpath = "#{prefix}/#{key}"
      else
        xpath = key.to_s
      end
      model_value = model[xpath]
      unless model_value then
        raise RuntimeError.new("xpath '#{xpath}' not contained in model.")
      end
      if model_value[:filled] == true || model_value[:filled] == "true" then
        doc.add_child("<#{key}>#{solver_value_to_string(model_value[:value])}</#{key}>")
      end
    elsif value[:type] == :list then
      node = doc.add_child("<#{key}></#{key}>")
      if node.is_a?(Nokogiri::XML::NodeSet) then
        node = node.first 
      end
      if prefix then
        xpath = "#{prefix}/#{key}"
      else
        xpath = key.to_s
      end
      model_value = model[xpath]
      xpath_element = value[:xpath_element]
      if Integer(model_value[:size]) > 0 then
        model_value[:value].slice(0, Integer(model_value[:size])).each do |mvalue|
          node.add_child("<#{xpath_element}>#{solver_value_to_string(mvalue)}</#{xpath_element}>")
        end
      end
    elsif value[:type] == :structure then
      node = doc.add_child("<#{key}></#{key}>")
      if node.is_a?(Nokogiri::XML::NodeSet) then
        node = node.first 
      end
      unless value[:ref] then
        raise RuntimeError.new("struct is broken: :structure #{key.inspect} does not have a :ref")
      end
      if prefix then
        new_prefix = "#{prefix}/#{key}"
      else
        new_prefix = key
      end
      add_model_struct_to_doc(progress, value[:ref], node, model, new_prefix)
    else
      raise RuntimeError.new("struct is broken: encountered unknown :type #{value[:type].inspect}")
    end
  end
end

#all_values_for_field(field) ⇒ Object 



819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/mbt-gen.rb', line 819

def all_values_for_field(field)
  unless field[:type] == :field then
    raise RuntimeError.new("something that is not a field definition was passed to all_values_for_field(): #{field.inspect}")
  end
  unless field[:datatype] == :enum then
    raise RuntimeError.new("all_values_for_field() is only applicable to fields of datatype enum! not #{field[:datatype].inspect}.")
  end
  values = field[:values].dup
  if field[:optional] == true then
    values << nil
  end
  return values
end

#blocking_clause(docs, vars = docs.map{|e| e.keys}.flatten) ⇒ Object 



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/mbt-gen.rb', line 926

def blocking_clause(docs, vars = docs.map{|e| e.keys}.flatten)
  unless docs.empty?
      codes = docs.map do |key_values|
        value_codes = key_values.filter{|xpath,value| vars.include?(xpath) }.map do |xpath, value|
          if value == nil then
            "(= #{filled_var_for_field(xpath)} false)"
          else
            "(and (= #{filled_var_for_field(xpath)} true) (= #{value_var_for_field(xpath)} \"#{value}\"))"
          end
        end
        if value_codes.empty? then
          "true"
        else
          "(not (and #{value_codes.join(" ")}))"
        end
      end
      return "" if codes.empty?
      return "(assert (! (and #{codes.join(" ")}) :named blocking-clause))"
  end
  return nil
end

#build_document_from_model(progress, struct, model) ⇒ Object 



672
673
674
675
676
 
# File 'lib/mbt-gen.rb', line 672

def build_document_from_model(progress, struct, model)
  doc = Nokogiri::XML(XML_TEMPLATE)
  add_model_struct_to_doc(progress, struct, doc, model)
  return doc
end

#calc_combinations(message, key) ⇒ Object 



888
889
890
891
 
# File 'lib/mbt-gen.rb', line 888

def calc_combinations(message, key)
  key_fields = collect_key_fields(key, message)
  return calc_combinations_for_key_fields(key_fields)
end

#calc_combinations_for_key_fields(key_fields) ⇒ Object 



860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/mbt-gen.rb', line 860

def calc_combinations_for_key_fields(key_fields)
  count = 1
  key_fields.each do |field|
    if field[1][:type] == :field then
      if field[1][:datatype] == :enum then
        num_values = field[1][:values].size
        num_values += 1 if field[1][:optional]
      elsif field[1][:datatype] == :int then
        if field[1].has_key?(:min) and field[1].has_key?(:max) and field[1][:min] <= field[1][:max] then
          if field[1][:optional] then
            num_values = 2 + field[1][:max] - field[1][:min]
          else
            num_values = 1 + field[1][:max] - field[1][:min]
          end
        else
          return "potentially infinite"
        end
      elsif field[1][:datatype] == :string then
        return "potentially infinite"
      end
    elsif field[1][:type] == :structure then
      num_values = 2
    end
    count *= num_values
  end
  return count
end

#collect_key_fields(fkey, struct, prefix = nil) ⇒ Object 



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/mbt-gen.rb', line 1035

def collect_key_fields(fkey, struct, prefix = nil)
  result = {}
  struct.each do |key, value|
    next if key == :validation_rules || key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
    if value[:type] == :structure
      if value.has_key?(:keys) and value[:keys].include?(fkey) then
        xpath = key.to_s
        xpath = "#{prefix}/#{xpath}" if prefix
        result[xpath] = value.clone().filter{|k,v| [:type, :optional, :datatype, :values].include?(k)}
      end
      if prefix then
        new_prefix = "#{prefix}/#{key}" 
      else
        new_prefix = key
      end
      result = result.merge(collect_key_fields(fkey, value[:ref], new_prefix))
    elsif value[:type] == :field and value.has_key?(:keys) and value[:keys].include?(fkey) then
      xpath = key.to_s
      xpath = "#{prefix}/#{xpath}" if prefix
      result[xpath] = value.clone().filter{|k,v| [:type, :optional, :datatype, :values, :min, :max].include?(k)}
    end
  end
  return result
end

#collect_key_fields_and_strctures(fkey, struct, prefix = nil) ⇒ Object 



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/mbt-gen.rb', line 1060

def collect_key_fields_and_strctures(fkey, struct, prefix = nil)
  fields = []
  structures = []
  struct.each do |key, value|
    next if key == :validation_rules || key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
    if value[:type] == :structure
      if value.has_key?(:keys) and value[:keys].include?(fkey) then
        xpath = key.to_s
        xpath = "#{prefix}/#{xpath}" if prefix
        structures << xpath
      end
      if prefix then
        new_prefix = "#{prefix}/#{key}" 
      else
        new_prefix = key
      end
      result_fields, result_structures = collect_key_fields_and_strctures(fkey, value[:ref], new_prefix)
      fields += result_fields
      structures += result_structures
    elsif value[:type] == :field and value.has_key?(:keys) and value[:keys].include?(fkey) then
      xpath = key.to_s
      xpath = "#{prefix}/#{xpath}" if prefix
      fields << xpath
    end
  end
  return fields, structures
end

#collect_keys(struct) ⇒ Object 



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/mbt-gen.rb', line 1088

def collect_keys(struct)
  result = []
  struct.each do |key, value|
    next if key == :validation_rules || key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
    if value[:type] == :structure
      if value.has_key?(:keys) then
        result += value[:keys]
      end
      if value[:ref] then
        result += collect_keys(value[:ref])
      else
        raise RuntimeError.new("Model error: encountered structure without :ref: key=#{key.inspect} value=#{value.inspect}")
      end
    elsif value[:type] == :field and value.has_key?(:keys) then
      result += value[:keys]
    end
  end
  result.uniq
end

#collect_validation_rule_names(struct) ⇒ Object 



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/mbt-gen.rb', line 731

def collect_validation_rule_names(struct)
  result = []
  struct.each do |key, value|
    next if key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
    if key == :validation_rules
      value.each do |key, value|
        result << key
      end
    else
      if value[:type] == :structure
        result += collect_validation_rule_names(value[:ref])
      end
    end
  end
  return result
end

#collect_validation_rules(struct) ⇒ Object 



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/mbt-gen.rb', line 1108

def collect_validation_rules(struct)
  result = []
  struct.each do |key, value|
    next if key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
    if key == :validation_rules then
      result += value.keys
    else
      if value[:type] == :structure
        if value[:ref] then
          result += collect_validation_rules(value[:ref])
        else
          raise RuntimeError.new("Model error: encountered structure without :ref: key=#{key.inspect} value=#{value.inspect}")
        end
      end
    end
  end
  result.uniq
end

#default_value_for_fielddef(fielddef) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/mbt-gen.rb', line 238

def default_value_for_fielddef(fielddef)
  datatype = fielddef[:datatype]
  case datatype
  when :int
    return "0"
  when :string
    return "".inspect
  when :date
    return "0"
  when :timestamp
    return "0"
  when :enum
    return "".inspect
  else
    raise RuntimeError.new("unknown datatype: #{datatype.inspect}")
  end
end

#each_combination(fields, &block) ⇒ Object 



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/mbt-gen.rb', line 833

def each_combination(fields, &block)
  if fields.size < 1 then
    return
  end
  if fields.size == 1 then
    field = fields.first
    values = field[1][:values].clone()
    if field[1][:optional] == true then
      values << nil
    end
    values.each do |value|
      block.call({ field[0] => value })
    end
  else
    first = fields.shift
    values = first[1][:values].clone()
    if first[1][:optional] == true then
      values << nil
    end
    each_combination(fields) do |mapping|
      values.each do |value|
        block.call(mapping.merge({ first[0] => value }))
      end
    end
  end
end

#enum_constraint_for_expr(expr, values) ⇒ Object 



166
167
168
 
# File 'lib/mbt-gen.rb', line 166

def enum_constraint_for_expr(expr, values)
  "(or #{values.map{|x| "(= #{expr} #{translate_value_to_SMTLIB(x)})"}.join(" ")})"
end

#exists_var_for_structure(xpath) ⇒ Object 



98
99
100
101
102
 
# File 'lib/mbt-gen.rb', line 98

def exists_var_for_structure(xpath)
  struct_str = "base"
  struct_str = xpath.gsub("/", "-") if xpath
  "struct-#{struct_str}-exists"
end

#extract_key_field_values_from_model(key_fields, model) ⇒ Object 



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/mbt-gen.rb', line 796

def extract_key_field_values_from_model(key_fields, model)
  result = {}
  key_fields.each do |xpath, fieldDesc|
    fieldInfo = model[xpath]
    if fieldDesc[:type] == :field then
      if fieldInfo[:filled] then
        result[xpath] = z3ValueToRubyValue(fieldInfo[:value])
      else
        result[xpath] = nil
      end
    elsif fieldDesc[:type] == :struct || fieldDesc[:type] == :structure then
      if fieldInfo.has_key?(:exists) then
        result[xpath] = z3ValueToRubyValue(fieldInfo[:exists])
      else
        result[xpath] = false
      end
    else
      raise RuntimeError.new("encountered unknown :type in solver model: #{fieldDesc[:type].inspect}")
    end
  end
  return result
end

#filled_var_for_field(xpath) ⇒ Object 



90
91
92
 
# File 'lib/mbt-gen.rb', line 90

def filled_var_for_field(xpath)
  "#{raw_field(xpath)}-filled"
end

#fixing_clause(xpath, switched_info) ⇒ Object 



1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/mbt-gen.rb', line 1027

def fixing_clause(xpath, switched_info)
  if switched_info[:current_value] == nil then
    return "(assert (! (= #{filled_var_for_field(xpath)} false) :named fixing-clause-#{raw_field(xpath)}))"
  else
    return "(assert (! (and (= #{filled_var_for_field(xpath)} true) (= #{value_var_for_field(xpath)} \"#{switched_info[:current_value]}\")) :named fixing-clause-#{raw_field(xpath)}))"
  end
end

#generate(message, argv, message_config_filename = nil) ⇒ Object 



1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/mbt-gen.rb', line 1687

def generate(message, argv, message_config_filename = nil)
  if ARGV[0] == "--help" || ARGV[0] == "-help" || ARGV[0] == "help" then
    puts USAGE
    exit(0)
  end

  options = { :negated_validation_rules => [], :date_now => (Date.today - Time.at(0).to_date).to_i, :timestamp_now => Time.now().to_i }
  
  opt = argv.shift
  while opt do
    if opt == "-negate" then
      rule = argv.shift
      options[:negated_validation_rules] << rule
    elsif opt == "-list-keys" then
      options[:list_keys] = true
    elsif opt == "-list" then
      options[:list] = argv.shift
    elsif opt == "-list-validation-rules" then
      options[:list_validation_rules] = true      
    elsif opt == "-generate-docs-from" then
      options[:combination_source] = argv.shift
    elsif opt == "-skip" then
      options[:skip] = Integer(argv.shift)
    elsif opt == "-generate-docs-for-key" then
      options[:docs_for_key] = argv.shift
    elsif opt == "-count-docs-for-key" then
      options[:count_docs_for_key] = argv.shift
    elsif opt == "-continue" then
      options[:continue] = true
    elsif opt == "-max-num-docs" then
      options[:max_num_docs] = Integer(argv.shift)
      puts "flag -max-num-docs used. Will stop after generating #{options[:max_num_docs]} documents."
    else
      puts "FATAL: unknown option #{opt.inspect}."
      puts USAGE
      raise FatalError.new("")
    end
    opt = argv.shift
  end

  unless options[:negated_validation_rules].empty? then
    puts "negating rules: #{options[:negated_validation_rules].join(", ")}"

    rules = collect_validation_rule_names(message)
    unknown_negated_rules = options[:negated_validation_rules].filter { |rule_name| !rules.include?(rule_name) } 
    unless unknown_negated_rules.empty? then  
      throw RuntimeError.new("unknown negated rules #{unknown_negated_rules.join(", ")}")
    end

  end

  if File.exist?(CONFIG_FILE) then
    config = YAML.load_file(CONFIG_FILE)
  else
    config = DEFAULT_CONFIG
    File.open(CONFIG_FILE, "w") do |f|
      f.puts(config.to_yaml)
    end
    puts "No config file found. Default config written to #{CONFIG_FILE}"
  end
  if message_config_filename then
    message_config = YAML.load_file(message_config_filename)
    config = config.merge(message_config)
  end

  introduce_parent_links(message)

  if options[:count_docs_for_key] then
    puts "there are #{calc_combinations(message, options[:count_docs_for_key])} combinations."
  elsif options[:docs_for_key] then
    puts "using #{options[:date_now]} as [Date.now]"
    puts "using #{options[:timestamp_now]} as [Timestamp.now]"
    validate_model(message)
    CoreEnumerationAlgo.new().generate_docs_for_key(message, options[:docs_for_key], OUTPUT_DIR, config, options)
  elsif options[:list_keys] then
    list_keys(message)
  elsif options[:list] then
    list_fields_and_structures(message, options[:list])
  elsif options[:list_validation_rules] then
    list_validation_rules(message)
  else
    puts "using #{options[:date_now]} as [Date.now]"
    puts "using #{options[:timestamp_now]} as [Timestamp.now]"
    validate_model(message)
    progress = ProgressBar.new(1)
    generate_doc(progress, message, OUTPUT_FILE, config, options)
  end
end

#generate_doc(progress, message, output_filename, config, options) ⇒ Object 



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/mbt-gen.rb', line 748

def generate_doc(progress, message, output_filename, config, options)
  log = options[:log] || nil
  log.puts "generating doc #{output_filename}" if log
  options[:solverLog] = options[:solverLog] || "#{output_filename}.smt2"

  z3path = config[:z3path] || DEFAULT_Z3_PATH
  z3 = Z3Solver.new(progress, z3path)
  begin
    model = z3.query_model(progress, options) do |solver|
      solver.to_solver(progress, "(set-option :produce-unsat-cores true) ; enable generation of unsat cores")
      solver.to_solver(progress, "")
      log.puts "translating structure" if log
      translate_structure_to_SMTLIB(progress, solver, message, :options => options, :config => config)
      solver.to_solver(progress, "")
    end
  ensure
    z3.close()
  end

  if model then
    result_doc = build_document_from_model(progress, message, model)
    dir = File.dirname(output_filename)
    FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
    File.open(output_filename, "w") do |f|
      f.puts result_doc.to_xml()
    end
    progress.print_line "DONE. Generated XML was written to #{output_filename}, SMTLIB log was written to #{options[:solverLog]}"
    return true
  else
    progress.print_line "FAILED. No XML document was generated. For more details, please see the SMTLIB log in #{options[:solverLog]}"
    return false
  end
end

#introduce_parent_links(message, parent = nil, prefix = nil) ⇒ Object 



1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'lib/mbt-gen.rb', line 1618

def introduce_parent_links(message, parent = nil, prefix = nil)
  if parent != nil then
    message[:parent_link] = parent
  end
  if prefix != nil then
    message[:struct_xpath_prefix] = prefix
  end
  message.each_pair do |key, value|
    next if key == :validation_rules || key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
    if value[:type] == :structure then
      if prefix then
        new_prefix = "#{prefix}/#{key}"
      else
        new_prefix = key
      end
      introduce_parent_links(value[:ref], message, new_prefix)
    end
  end
end

#list_fields_and_structures(message, fkey) ⇒ Object 



1132
1133
1134
1135
1136
1137
1138
 
# File 'lib/mbt-gen.rb', line 1132

def list_fields_and_structures(message, fkey)
  fields, structures = collect_key_fields_and_strctures(fkey, message)
  puts "fields for key #{fkey}:"
  fields.each { |f| puts "  #{f}" }
  puts "structures for key #{fkey}:"
  structures.each { |s| puts "  #{s}" }
end

#list_keys(message) ⇒ Object 



1127
1128
1129
1130
 
# File 'lib/mbt-gen.rb', line 1127

def list_keys(message)
  keys = collect_keys(message)
  puts "keys: #{keys.join(", ")}"
end

#list_validation_rules(message) ⇒ Object 



1140
1141
1142
1143
1144
 
# File 'lib/mbt-gen.rb', line 1140

def list_validation_rules(message)
  rules = collect_validation_rules(message)
  puts "Validation Rules:"
  rules.each { |r| puts "  #{r}" }
end

#max_constraint_for_expr(expr, upper_bound) ⇒ Object 



147
148
149
 
# File 'lib/mbt-gen.rb', line 147

def max_constraint_for_expr(expr, upper_bound)
  "(<= #{expr} #{upper_bound})"
end

#maxLength_contraint_for_expr(expr, maxLength) ⇒ Object 



155
156
157
 
# File 'lib/mbt-gen.rb', line 155

def maxLength_contraint_for_expr(expr, maxLength)
  "(<= (str.len #{expr}) #{maxLength})"
end

#min_constraint_for_expr(expr, lower_bound) ⇒ Object 



143
144
145
 
# File 'lib/mbt-gen.rb', line 143

def min_constraint_for_expr(expr, lower_bound)
  "(>= #{expr} #{lower_bound})"
end

#oneOf_contraint_for_expr(expr, values) ⇒ Object 



159
160
161
162
163
164
 
# File 'lib/mbt-gen.rb', line 159

def oneOf_contraint_for_expr(expr, values)
  list = values.map do |val|
    "(= #{expr} \"#{val}\")"
  end
  "(or #{list.join(" ")})"
end

#parse_field_value(fielddef, value) ⇒ Object 



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/mbt-gen.rb', line 647

def parse_field_value(fielddef, value)
  value = value.gsub("\n", "")
  datatype = fielddef[:datatype]
  case datatype
  when :int
    return Integer(value)
  when :string
    return value
  when :enum
    return value
  when :date
    return Date.parse(value)
  when :timestamp
    return Time.new(value)
  end
end

#prepare_output_doc_filename(number, output_dir) ⇒ Object

def fixing_clause(key_values, fixed = key_value.keys)

codes = []
key_values.each do |xpath, value|
  if fixed.include?(xpath) then
    if value then
      codes << "(and (= #{filled_var_for_field(xpath)} true) (= #{value_var_for_field(xpath)} \"#{value}\"))"
    else
      codes << "(= #{filled_var_for_field(xpath)} false)"
    end
  end
end
if codes.empty? then
  return ""
else
  return "(assert (! (and #{codes.join(" ")}) :named fixing-clause))"
end

end



966
967
968
969
970
971
972
973
 
# File 'lib/mbt-gen.rb', line 966

def prepare_output_doc_filename(number, output_dir)
  chunk_number = number / 100000
  dirname = "#{output_dir}/#{chunk_number}"
  unless Dir.exist?(dirname) then
    FileUtils.mkdir_p(dirname)
  end
  return "#{dirname}/doc#{number}.xml"
end

#raw_field(xpath) ⇒ Object 



84
85
86
87
88
 
# File 'lib/mbt-gen.rb', line 84

def raw_field(xpath)
  path_str = "base"
  path_str = xpath.gsub("/", "-") if xpath
  "field-#{path_str}"
end

#read_docs_from_log_file(log_filename) ⇒ Object 



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/mbt-gen.rb', line 893

def read_docs_from_log_file(log_filename)
  result = []
  if File.exist?(log_filename) then
    File.open(log_filename, "r") do |f|
      f.each_line do |line|
        doc = {}
        if line =~ /(.*)\ <-\ \{(.*)\}/ then
          filename = $1
          combination = $2
          combination.split(", ").each do |assignment|
            if assignment =~ /(.*):\ (.*)/ then
              key = $1
              value = $2
              if value =~ /\"(.*)\"/ then
                value = $1
              elsif value == "nil" then
                value = nil
              end
              doc[key] = value
            else
              raise RuntimeError.new("could not parse logfile #{log_filename}: invalid assignment #{assignment.inspect}")
            end
          end
        else
          raise RuntimeError.new("could not parse logfile #{log_filename}: invalid line #{line.inspect}")
        end
        result << doc
      end
    end
  end
  return result
end

#regex_constraint_for_expr(expr, regex) ⇒ Object 



151
152
153
 
# File 'lib/mbt-gen.rb', line 151

def regex_constraint_for_expr(expr, regex)
  "(str.in.re #{expr} #{Regexp_to_SMTLIB.translate_regexp_to_SMTLIB(regex)})"
end

#resolve_field_def(path, relative_to_struct, prefix) ⇒ Object 



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/mbt-gen.rb', line 361

def resolve_field_def(path, relative_to_struct, prefix)
  current = relative_to_struct
  result = nil
  path.split("/").each do |segment|
    unless current then
      raise RuntimeError.new("could not resolve segment #{segment.inspect} of field path: #{path.inspect}: resolution worked up until #{result.inspect}, but then the last segment was a field or list.")
    end
    field_def = current[segment.to_sym]
    unless field_def then
      raise RuntimeError.new("could not resolve segment #{segment.inspect} of field path: #{path.inspect}: structure #{prefix.inspect} does not have a member #{segment.to_sym.inspect}.")
    end
    if field_def[:type] == :structure then
      unless field_def[:ref] then
        raise RuntimeError.new("could not resolve field path: #{path.inspect}: substructure #{segment.inspect} of structure #{prefix.inspect} does not have a :ref.")
      end
      current = field_def[:ref]
      if prefix then
        prefix = "#{prefix}/#{segment}"
      else
        prefix = segment
      end
    elsif field_def[:type] == :field then
      current = nil
      result = field_def
    elsif field_def[:type] == :list then
      current = nil
      result = field_def
    end
  end
  return result
end

#resolve_field_path(path, relative_to_struct, prefix) ⇒ Object 



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/mbt-gen.rb', line 323

def resolve_field_path(path, relative_to_struct, prefix)
  current = relative_to_struct
  result = nil
  path.split("/").each do |segment|
    unless current then
      raise RuntimeError.new("could not resolve segment #{segment.inspect} of field path: #{path.inspect}: resolution worked up until #{result.inspect}, but then the last segment was a field or list.")
    end
    field_def = current[segment.to_sym]
    unless field_def then
      raise RuntimeError.new("could not resolve segment #{segment.inspect} of field path: #{path.inspect}: structure #{prefix.inspect} does not have a member #{segment.to_sym.inspect}.")
    end
    if field_def[:type] == :structure then
      unless field_def[:ref] then
        raise RuntimeError.new("could not resolve field path: #{path.inspect}: substructure #{segment.inspect} of structure #{prefix.inspect} does not have a :ref.")
      end
      current = field_def[:ref]
      if prefix then
        prefix = "#{prefix}/#{segment}"
      else
        prefix = segment
      end
    elsif field_def[:type] == :field then
      current = nil
      result = segment
      if prefix
        result = "#{prefix}/#{result}"
      end
    elsif field_def[:type] == :list then
      current = nil
      result = segment
      if prefix
        result = "#{prefix}/#{result}"
      end
    end
  end
  return result
end

#resolve_struct_def(path, relative_to_struct, prefix, context_desc = "") ⇒ Object 



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/mbt-gen.rb', line 429

def resolve_struct_def(path, relative_to_struct, prefix, context_desc = "")
  current = relative_to_struct
  result = nil
  path.split("/").each do |segment|
    unless current then
      raise RuntimeError.new("could not resolve field path: #{path.inspect} relative to struct #{relative_to_struct.inspect} #{context_desc}")
    end
    if segment == "." then
      result = current
    elsif segment == ".." then
      current = current[:parent_link]
      if prefix then
        prefix_segs = prefix.split("/")
        prefix = prefix_segs[0,prefix_segs.size()-1].join("/")
      else
        prefix = current[:struct_xpath_prefix]
      end
    else
      field_def = current[segment.to_sym]
      unless field_def then
        raise RuntimeError.new("could not resolve segment #{segment.inspect} of field path: #{path.inspect} relative to struct #{relative_to_struct.inspect} #{context_desc}")
      end
      if field_def[:type] == :structure then
        current = field_def[:ref]
        if prefix then
          prefix = "#{prefix}/#{segment}"
        else
          prefix = segment
        end
        result = current
      end
    end
  end
  return result
end

#resolve_struct_path(path, relative_to_struct, prefix) ⇒ Object 



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/mbt-gen.rb', line 393

def resolve_struct_path(path, relative_to_struct, prefix)
  current = relative_to_struct
  result = nil
  path.split("/").each do |segment|
    unless current then
      raise RuntimeError.new("could not resolve field path: #{path.inspect} relative to struct #{relative_to_struct.inspect}")
    end
    if segment == "." then
      result = current[:struct_xpath_prefix]
    elsif segment == ".." then
      current = current[:parent_link]
      if prefix then
        prefix_segs = prefix.split("/")
        prefix = prefix_segs[0,prefix_segs.size()-1].join("/")
      else
        prefix = current[:struct_xpath_prefix]
      end
    else
      field_def = current[segment.to_sym]
      unless field_def then
        raise RuntimeError.new("could not resolve segment #{segment.inspect} of field path: #{path.inspect} relative to struct #{relative_to_struct.inspect}")
      end
      if field_def[:type] == :structure then
        current = field_def[:ref]
        if prefix then
          prefix = "#{prefix}/#{segment}"
        else
          prefix = segment
        end
        result = prefix
      end
    end
  end
  return result
end

#size_var_for_list(xpath) ⇒ Object 



104
105
106
 
# File 'lib/mbt-gen.rb', line 104

def size_var_for_list(xpath)
  "#{raw_field(xpath)}-size"
end

#solver_value_to_string(solver_value) ⇒ Object 



664
665
666
667
668
669
670
 
# File 'lib/mbt-gen.rb', line 664

def solver_value_to_string(solver_value)
  if solver_value =~ /\"(.*)\"/ then
    return $1
  else
    return solver_value
  end
end

#switch_blocking_clause(fixed, current_value, var_xpath, blocked_values) ⇒ Object 



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/mbt-gen.rb', line 975

def switch_blocking_clause(fixed, current_value, var_xpath, blocked_values)
  clauses = []
  blocked_values.each do |value|
    if value != nil then
      clauses << "(not (and (= #{filled_var_for_field(var_xpath)} true) (= #{value_var_for_field(var_xpath)} \"#{value}\")))"
    else
      clauses << "(not (= #{filled_var_for_field(var_xpath)} false))"
    end
  end
  if fixed then
    if current_value != nil then
      result = "; switch fixing clause\n(assert (! (and (= #{filled_var_for_field(var_xpath)} true) (= #{value_var_for_field(var_xpath)} \"#{current_value}\")) :named switch_fixing_clause))"
    else
      result = "; switch fixing clause\n(assert (! (= #{filled_var_for_field(var_xpath)} false) :named switch_fixing_clause))"
    end
  else
    result = ""
  end
  unless clauses.empty? then
    result = result + "\n; switch blocking clause\n(assert (! (and #{clauses.join(" ")}) :named switch_blocking_clause))"
  end
  return result
end

#translate_datatype_to_SMTLIB(datatype) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/mbt-gen.rb', line 112

def translate_datatype_to_SMTLIB(datatype)
  case datatype
  when :string
    return "String"
  when :int
    return "Int"
  when :bool
    return "Bool"
  when :date
    return "Int"
  when :timestamp
    return "Int"
  when :enum
    return "String"
  end
end

#translate_field_def_to_SMTLIB_constraints(progress, solver, fielddef, varname) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/mbt-gen.rb', line 170

def translate_field_def_to_SMTLIB_constraints(progress, solver, fielddef, varname)
  if fielddef[:optional] == nil || fielddef[:optional] == false then
    # field is required
    solver.to_solver(progress, "(assert (! #{varname}-filled :named required-#{varname}))") 
  end
  datatype = fielddef[:datatype]
  case datatype
  when :int
    if fielddef[:min] then
        solver.to_solver(progress, "(assert (! (=> #{varname}-filled #{min_constraint_for_expr("#{varname}-value", translate_value_to_SMTLIB(fielddef[:min]))}) :named min-#{varname}))") 
    end
    if fielddef[:max] then
        solver.to_solver(progress, "(assert (! (=> #{varname}-filled #{max_constraint_for_expr("#{varname}-value", translate_value_to_SMTLIB(fielddef[:max]))}) :named max-#{varname}))") 
    end
  when :string
    if fielddef[:regex] then
        solver.to_solver(progress, "(assert (! (=> #{varname}-filled #{regex_constraint_for_expr("#{varname}-value", fielddef[:regex])}) :named regex-#{varname}))") 
    end 
    # TODO: minLength?
    if fielddef[:maxLength] then
      solver.to_solver(progress, "(assert (! (=> #{varname}-filled #{maxLength_contraint_for_expr("#{varname}-value", fielddef[:maxLength])}) :named maxLength-#{varname}))") 
    end
    if fielddef[:from_list] then
      list_filename = "#{LISTS_DIR}/#{fielddef[:from_list]}"
      unless File.exist?(list_filename)
        raise RuntimeError.new("could not find list file #{list_filename}.")
      end
      values = File.read(list_filename).split("\n").map{|v| v.chomp()}
      solver.to_solver(progress, "(assert (! (=> #{varname}-filled #{oneOf_contraint_for_expr("#{varname}-value", values)}) :named oneOf-#{varname}))") 
    end
  when :enum
    solver.to_solver(progress, "(assert (! (=> #{varname}-filled #{enum_constraint_for_expr("#{varname}-value", fielddef[:values])}) :named enum-#{varname}))") 
  end
end

#translate_list_def_to_SMTLIB_constraints(progress, solver, fielddef, varname) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/mbt-gen.rb', line 205

def translate_list_def_to_SMTLIB_constraints(progress, solver, fielddef, varname)
  datatype = fielddef[:datatype]
  case datatype
  when :int
    if fielddef[:min] then
        fielddef[:model_maxLength].times do |i|
          solver.to_solver(progress, "(assert (! (=> (< #{i} #{varname}-size) #{min_constraint_for_expr("#{varname}-index-#{i}-value", translate_value_to_SMTLIB(fielddef[:min]))}) :named list-min-#{varname}-list-index-#{i}))") 
        end
    end
    if fielddef[:max] then
        fielddef[:model_maxLength].times do |i|
          solver.to_solver(progress, "(assert (! (=> (< #{i} #{varname}-size) #{max_constraint_for_expr("#{varname}-index-#{i}-value", translate_value_to_SMTLIB(fielddef[:max]))}) :named list-max-#{varname}-list-index-#{i}))") 
        end
    end
  when :string
    if fielddef[:regex] then
        fielddef[:model_maxLength].times do |i|
          solver.to_solver(progress, "(assert (! (=> (< #{i} #{varname}-size) #{regex_constraint_for_expr("#{varname}-index-#{i}-value", fielddef[:regex])}) :named list-regex-#{varname}-index-#{i}))") 
        end
    end 
    # TODO: minLength?
    if fielddef[:maxLength] then
        fielddef[:model_maxLength].times do |i|
          solver.to_solver(progress, "(assert (! (=> (< #{i} #{varname}-size) #{maxLength_contraint_for_expr("#{varname}-index-#{i}-value", fielddef[:maxLength])}) :named list-maxLength-#{varname}-index-#{i}))") 
        end
    end 
  when :enum
    fielddef[:model_maxLength].times do |i|
      solver.to_solver(progress, "(assert (! (=> (< #{i} #{varname}-size) #{enum_constraint_for_expr("#{varname}-index-#{i}-value", fielddef[:values])}) :named list-enum-#{varname}-index-#{i}))") 
    end
  end
end

#translate_structure_to_SMTLIB(progress, solver, struct, hash = {}) ⇒ Object 



256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/mbt-gen.rb', line 256

def translate_structure_to_SMTLIB(progress, solver, struct, hash = {})
  prefix = hash[:prefix]
  config = hash[:config]
  options = hash[:options]
  translate_substructure_to_SMTLIB(progress, solver, struct, hash)
  translate_validation_rules_to_SMTLIB(progress, solver, struct, prefix, config, options)
  if options[:add_SMTLIB] then
    solver.to_solver(progress, "; --- additional SMTLIB Code: ---")
    solver.to_solver(progress, options[:add_SMTLIB])
  end
end

#translate_substructure_to_SMTLIB(progress, solver, struct, hash = {}) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/mbt-gen.rb', line 268

def translate_substructure_to_SMTLIB(progress, solver, struct, hash = {})
  prefix = hash[:prefix]
  struct_varname = hash[:struct_varname]
  config = hash[:config]
  options = hash[:options]
  solver.to_solver(progress, "; --- Structure: ---")
  struct.each do |field, definition|
    if field == :additional_smtlib then
      solver.to_solver(progress, "; additional SMTLIB of structure #{prefix}")
      solver.to_solver(progress, translate_validation_rule_to_SMTLIB(definition, struct, prefix, config, options, "<additional SMTLIB of structure #{prefix}>"))
    elsif field == :validation_rules || field == :predicates || field == :parent_link || field == :struct_xpath_prefix
      next 
    else
      solver.to_solver(progress, "; #{field.to_s}")
      if definition[:type] == :field then
        display_prefix = ""
        display_prefix = "#{prefix}/" if prefix
        xpath = field.to_s
        xpath = "#{prefix}/#{xpath}" if prefix
        solver.declare_const(progress, filled_var_for_field(xpath), "Bool", {:xpath => xpath})
        solver.declare_const(progress, value_var_for_field(xpath), translate_datatype_to_SMTLIB(definition[:datatype]), {:xpath => xpath, :datatype => definition[:datatype]})
        solver.to_solver(progress, "(assert (! (=> (not #{filled_var_for_field(xpath)}) (= #{value_var_for_field(xpath)} #{default_value_for_fielddef(definition)})) :named empty-field-has-no-value-for-#{raw_field(xpath)}))") 
        if (struct_varname)
          solver.to_solver(progress, "(assert (! (=> (not #{struct_varname}) (not #{filled_var_for_field(xpath)})) :named empty-struct-has-no-fields-for-#{raw_field(xpath)}))") 
        end
        translate_field_def_to_SMTLIB_constraints(progress, solver, definition, raw_field(xpath))
      elsif definition[:type] == :list then
        display_prefix = ""
        display_prefix = "#{prefix}/" if prefix
        xpath = field.to_s
        xpath = "#{prefix}/#{xpath}" if prefix
        solver.declare_const(progress, size_var_for_list(xpath), "Int", {:xpath => xpath})
        definition[:model_maxLength].times do |i|
          solver.declare_const(progress, value_var_for_list(xpath, i), translate_datatype_to_SMTLIB(definition[:datatype]), {:xpath => xpath, :xpath_element => definition[:xpath_element], :index => i, :datatype => definition[:datatype]})
          solver.to_solver(progress, "(assert (! (=> (<= #{size_var_for_list(xpath)} #{i}) (= #{value_var_for_list(xpath, i)} #{default_value_for_fielddef(definition)})) :named empty-list-field-has-no-value-for-#{raw_field(xpath)}-index-#{i}))") 
        end
        if (struct_varname)
          solver.to_solver(progress, "(assert (! (=> (not #{struct_varname}) (= #{size_var_for_list(xpath)} 0)) :named empty-struct-has-no-fields-for-#{raw_field(xpath)}))") 
        end
        translate_list_def_to_SMTLIB_constraints(progress, solver, definition, raw_field(xpath))
      elsif definition[:type] == :structure then
        xpath = field.to_s
        xpath = "#{prefix}/#{xpath}" if prefix
        solver.declare_const(progress, exists_var_for_structure(xpath), "Bool", {:xpath => xpath})
        if (struct_varname)
          solver.to_solver(progress, "(assert (! (=> (not #{struct_varname}) (not #{exists_var_for_structure(xpath)})) :named empty-struct-has-no-substructure-#{raw_field(xpath)}))") 
        end
        translate_substructure_to_SMTLIB(progress, solver, definition[:ref], :prefix => xpath, :struct_varname => exists_var_for_structure(xpath), :options => options, :config => config)
      else
        next
      end
    end
  end
end

#translate_validation_rule_to_SMTLIB(rule, context_struct, prefix, config, options, rule_name) ⇒ Object 



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/mbt-gen.rb', line 481

def translate_validation_rule_to_SMTLIB(rule, context_struct, prefix, config, options, rule_name)
  date_now = options[:date_now]
  timestamp_now = options[:timestamp_now]
  return rule.gsub(/FILLED\[[^\]]*\]/) do |m|
                    unless m =~ /FILLED\[([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse FILLED[...]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    field = resolve_field_path($1, context_struct, prefix)
                    filled_var_for_field(field)
                  end
                  .gsub(/VALUE\[[^\]]*\]/) do |m|
                    unless m =~ /VALUE\[([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse VALUE[...]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    field = resolve_field_path($1, context_struct, prefix)
                    value_var_for_field(field)
                  end
                  .gsub(/EXIST\[[^\]]*\]/) do |m|
                    unless m =~ /EXIST\[([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse EXIST[...]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    s = resolve_struct_path($1, context_struct, prefix)
                    exists_var_for_structure(s)
                  end
                  .gsub(/SIZE\[[^\]]*\]/) do |m|
                    unless m =~ /SIZE\[([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse SIZE[...]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    l = resolve_field_path($1, context_struct, prefix)
                    size_var_for_list(l)
                  end
                  .gsub(/LIST_CONTAINS\[[^\]]*,[^\]]*\]/) do |m|
                    unless m =~ /LIST_CONTAINS\[([^\]]*),([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse LIST_CONTAINS[...]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    l = resolve_field_path($1, context_struct, prefix)
                    l_def = resolve_field_def($1, context_struct, prefix)
                    value = $2
                    terms = []
                    l_def[:model_maxLength].times do |i|
                      terms << "(and (< #{i} #{size_var_for_list(l)}) (= #{value_var_for_list(l, i)} #{value}))"
                    end
                    "(or #{terms.join(" ")})"
                  end
                  .gsub(/LIST_VALUE_FIRST_ELEMENT\[[^\]]*\]/) do |m|
                    unless m =~ /LIST_VALUE_FIRST_ELEMENT\[([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse LIST_VALUE_FIRST_ELEMENT[...]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    xpath = $1
                    l = resolve_field_path(xpath, context_struct, prefix)
                    value_var_for_list(l, 0)
                  end
                  .gsub("[Date.now]", date_now.to_s)
                  .gsub("[Timestamp.now]", timestamp_now.to_s)
                  .gsub(/PREDICATE\[[^\]]*,[^\]]*\]/) do |m|
                    unless m =~ /PREDICATE\[([^\]]*),([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse PREDICATE[...]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    path = $1
                    key = $2.strip().to_sym
                    sdef = resolve_struct_def(path, context_struct, prefix, "in validation rule #{rule_name}")
                    unless sdef
                      raise RuntimeError.new("could not resolve struct path #{path.inspect} in validation rule #{rule_name}")
                    end
                    preds = sdef[:predicates]
                    mdk = preds[key]
                    if mdk then
                      if mdk[:smtlib] then
                        translate_validation_rule_to_SMTLIB(mdk[:smtlib], sdef, sdef[:struct_xpath_prefix], config, options, "#{rule_name}.predicate.#{key}[#{sdef[:struct_xpath_prefix]}]" )
                      else
                        raise RuntimeError.new("Predicate #{key} for structure #{sdef[:struct_xpath_prefix]} does not have an SMTLIB definition, but is referenced in validation rule #{rule_name}")
                      end
                    else
                      raise RuntimeError.new("No predicate #{key.inspect} defined for structure #{sdef[:struct_xpath_prefix]}, but one referenced in validation rule #{rule_name}")
                    end
                  end
                  .gsub(/CONFIG\[[^\]]*\]/) do |m|
                    unless m =~ /CONFIG\[([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse LIST_CONTAINS[...]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    key = $1.to_sym
                    if config.has_key?(key) then
                      "\"#{config[key]}\"" 
                    else
                      raise RuntimeError.new("unknown CONFIG-key #{key.inspect} encountered in validation rule #{rule_name}" )
                    end
                  end
                  .gsub(/FIELD_IN_QUERY\[[^\]]*\]/) do |m|
                    unless m =~ /FIELD_IN_QUERY\[([^\]]*),([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse FIELD_IN_QUERY[..,..]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    xpath = $1
                    query_filename = $2
                    fpath = resolve_field_path(xpath, context_struct, prefix)
                    fdef = resolve_field_def(xpath, context_struct, prefix)
                    values = File.read("#{QUERY_DIR}/#{query_filename.strip()}").split("\n")
                    if fdef[:datatype] == :string then
                      terms = values.filter{|l| !l.start_with?("#")}.map do |val|
                        "(= #{value_var_for_field(fpath)} \"#{val}\")"
                      end
                    elsif fdef[:datatype] == :int then
                      terms = values.filter{|l| !l.start_with?("#")}.map do |val|
                        "(= #{value_var_for_field(fpath)} #{Integer(val)})"
                      end
                    else
                      raise RuntimeError.new("FIELD_IN_QUERY[] was applied to a field of datatype #{fdef[:datatype].inspect}. However, it can only be applied to fields of datatype string or int.")
                    end
                    "(or #{terms.join(" ")})"
                  end
                  .gsub(/FIELD_IN_SMTLIB_PARAMETERIZED_QUERY\[[^\]]*\]/) do |m|
                    unless m =~ /FIELD_IN_SMTLIB_PARAMETERIZED_QUERY\[([^\]]*),([^\]]*),([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse FIELD_IN_SMTLIB_PARAMETERIZED_QUERY[..,..,..]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    field_xpath = $1
                    param_smtlib = $2
                    query_filename = $3
                    fpath = resolve_field_path(field_xpath.strip(), context_struct, prefix)
                    fdef = resolve_field_def(field_xpath.strip(), context_struct, prefix)
                    query_result = YAML.load_file("#{PARAMETERIZED_QUERY_DIR}/#{query_filename.strip()}")
                    terms = []
                    if fdef[:datatype] == :string then
                      terms << "(or #{query_result.keys.map { |key| "(= #{param_smtlib} \"#{key}\")" }.join(" ")})"
                      query_result.each_pair do |key, values|
                        terms << "(=> (= #{param_smtlib} \"#{key}\") (or #{values.map{ |v| "(= #{value_var_for_field(fpath)} \"#{v}\")" }.join(" ")}))"
                      end
                    else
                      raise RuntimeError.new("FIELD_IN_SMTLIB_PARAMETERIZED_QUERY[] was applied to a field of datatype #{fdef[:datatype].inspect}. However, it can only be applied to fields of datatype string.")
                    end
                    "(and #{terms.join(" ")})"
                  end
                  .gsub(/CONFIG_IN_QUERY\[[^\]]*\]/) do |m|
                    unless m =~ /CONFIG_IN_QUERY\[([^\]]*),([^\]]*)\]/ then
                      raise RuntimeError.new("could not parse CONFIG_IN_QUERY[..,..]: #{m.inspect} in validation rule #{rule_name}")
                    end
                    key = $1.to_sym
                    unless config.has_key?(key) then
                      raise RuntimeError.new("unknown CONFIG key #{key.inspect} encountered in validation rule #{rule_name}")
                    end
                    query_filename = $2
                    values = File.read("#{QUERY_DIR}/#{query_filename.strip()}").split("\n")
                    terms = values.filter{|l| !l.start_with?("#")}.map do |val|
                      "(= \"#{config[key]}\" \"#{val}\")"
                    end
                    "(or #{terms.join(" ")})"
                  end
end

#translate_validation_rules_for_structure_to_SMTLIB(progress, solver, struct, prefix, config, options) ⇒ Object 



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/mbt-gen.rb', line 628

def translate_validation_rules_for_structure_to_SMTLIB(progress, solver, struct, prefix, config, options)
  return unless struct[:validation_rules]

  solver.to_solver(progress, "; --- Validation Rules: ---")
  negated_rules = options[:negated_validation_rules] || []
  solver.to_solver(progress, "; negated rules: #{negated_rules.empty? ? "<none>" : negated_rules.join(", ")}")

  rules = struct[:validation_rules]
  rules.each do |rule_name, rule|
    rule = rule[:smtlib]  # ignore the text representation
    next unless rule # warning about this omission is the job of validate_model()
    rule_SMTLIB = translate_validation_rule_to_SMTLIB(rule, struct, prefix, config, options, rule_name)
    if negated_rules.include?(rule_name) then
      rule_SMTLIB = "(not #{rule_SMTLIB})"
    end
    solver.to_solver(progress, "(assert (! #{rule_SMTLIB} :named validation_rule_#{rule_name}_instance_#{prefix.gsub("/", "_")}))")
  end
end

#translate_validation_rules_to_SMTLIB(progress, solver, struct, prefix, config, options) ⇒ Object 



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/mbt-gen.rb', line 465

def translate_validation_rules_to_SMTLIB(progress, solver, struct, prefix, config, options)
  solver.to_solver(progress, "; --- Validation Rules ---")
  translate_validation_rules_for_structure_to_SMTLIB(progress, solver, struct, prefix, config, options)
  struct.each_pair do |key, value|
    next if key == :validation_rules || key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
    if value[:type] == :structure then
      if prefix then
        new_prefix = "#{prefix.to_s}/#{key}"
      else
        new_prefix = key.to_s
      end
      translate_validation_rules_to_SMTLIB(progress, solver, value[:ref], new_prefix, config, options)
    end
  end
end

#translate_value_to_SMTLIB(value) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/mbt-gen.rb', line 129

def translate_value_to_SMTLIB(value)
  if value.is_a?(Integer) then
    return value.to_s
  elsif value.is_a?(String) then
    return value.inspect
  elsif value.is_a?(Date) then
    return (value - (Time.at(0).to_date)).to_i  # days since 1970.01.01
  elsif value.is_a?(Time) then
    return value.to_i
  else
    raise RuntimeError.new("cannot translate value to SMTLIB: #{value.inspect}")
  end
end

#validate_model(message, prefix = nil) ⇒ Object 



1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
 
# File 'lib/mbt-gen.rb', line 1638

def validate_model(message, prefix=nil)

  message.each_pair do |key, value|
    if key == :validation_rules then
      value.each_pair do |vr_key, vr_value|
        unless vr_value[:text] && vr_value[:text] != "" then
          puts "INFO: Model Problem: validation rule #{vr_key} does not have a textual representation."
        end
        unless vr_value[:smtlib] && vr_value[:smtlib] != "" then
          puts "WARN: Model Problem: validation rule #{vr_key} does not have an SMTLIB representation. It will hence be omitted!"
        end
      end
    elsif key == :predicates then
      value.each_pair do |mkey, mvalue|
        next unless mvalue
        unless mvalue[:text] && mvalue[:text] != "" then
            puts "INFO: Model Problem: structure #{prefix}'s predicate #{mkey} does not have a textual representation."
        end
        unless mvalue[:smtlib] && mvalue[:smtlib] != "" then
            puts "WARN: Model Problem: structure #{prefix}'s predicate #{mkey} does not have an SMTLIB representation. It will be regarded as always true."
        end
      end
    elsif key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
      next
    else
      if value[:type] == :structure then
        unless value[:ref] then
          raise RuntimeError.new("Model Problem: encountered structure without a :ref (key=#{key.inspect}, value=#{value.inspect})")
        end
        if prefix then
          new_prefix = "#{prefix}/#{key}"
        else
          new_prefix = key
        end
        validate_model(value[:ref], new_prefix)
      elsif value[:type] == :field then
        unless value[:datatype] then
          raise RuntimeError.new("Model Problem: encountered field without a :datatype (key=#{key.inspect}, value=#{value.inspect})")
        end
        if value[:datatype] == :enum then
          unless value[:values] then
            raise RuntimeError.new("Model Problem: encountered enum field without a :values (key=#{key.inspect}, value=#{value.inspect})")
          end
        end
      end
    end  
  end
end

#value_var_for_field(xpath) ⇒ Object 



94
95
96
 
# File 'lib/mbt-gen.rb', line 94

def value_var_for_field(xpath)
  "#{raw_field(xpath)}-value"
end

#value_var_for_list(xpath, index) ⇒ Object 



108
109
110
 
# File 'lib/mbt-gen.rb', line 108

def value_var_for_list(xpath, index)
  "#{raw_field(xpath)}-index-#{index}-value"
end

#values_for_key_field(field) ⇒ Object 



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/mbt-gen.rb', line 999

def values_for_key_field(field)
  if field[:type] == :field then
    if field[:datatype] == :enum then
      if field[:optional] then
        return field[:values] + [nil]
      else
        return field[:values]
      end
    elsif field[:datatype] == :int then
      if field.has_key?(:min) and field.has_key?(:max) and field[:min] <= field[:max] then
        return (field[:min]..field[:max]).to_a
      else
        raise RuntimeError.new("cannot determine values for unbounded :int field")
      end
    else
      raise RuntimeError.new("cannot determine values for datatype #{field[:datatype].inspect}")
    end
  elsif field[:type] == :structure then
    if field[:optional] then
      return [true, false]
    else
      return [true]
    end
  else
    raise RuntimeError.new("Encountered unknown :type in model: #{field[:type].inspect} - keys can only mark fields or structures.")
  end
end

#z3ValueToRubyValue(value) ⇒ Object 



782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/mbt-gen.rb', line 782

def z3ValueToRubyValue(value)
  if value =~ /\"(.*)\"/ then # string
    return $1
  elsif value =~ /\d+/ then # int
    return Integer(value)
  elsif value == "true"
    return true
  elsif value == "false" then
    return false 
  else
    raise RuntimeError.new("enountered unknown type of value in z3 model: #{value.inspect}")
  end
end