mbt-gen 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd9a7ea0a78ff033dc866b98d56e7cae0f058e96ea63a9b150872fcf393197a5
-  data.tar.gz: ec0bda3f93bad648f79d52190bc6cfadaab7e6d06988f81869d017a49d1ccc56
+  metadata.gz: b4c7dc3614c0f3345b728127808e7bd517487298968c8edab06f6436b84d60c1
+  data.tar.gz: 780f4e406e9b84d112074106bb905e48a8eab8fac3e02936ab36f85087381c07
 SHA512:
-  metadata.gz: 8a9aa5db05da1d32904fb227f2791023745d6727a34eaac76711424911522a402705f656ecc81f953a9ac3b1fd722ef9b870d210296f9d023c8b8f9a42f878ab
-  data.tar.gz: 9d81c6d1867f1cafaff988665310ee65a0ac0e41d23d46f5bbb326f8752d0a9ec58fe392fc3c24fd3d9279dcf3367489b9e9b1ffbcdad6768e9e37d7e3b67942
+  metadata.gz: 05d34d034b0aa1438c15f47969d8c9bd3d61545d2c9ade72efc0edfcee081e562c9fb3cc6f421e846319bbc43c0fe426b10bf81b8030b5ff560f97942405f5b7
+  data.tar.gz: 9f7b485dc1034d0529c3b8033633a862adb30c938899cfa8ceaaab95e130a10385c7d77c9e5859d31d8f5aeedf271e742e242e8699785ba8936b67df8f8f6b17

data/lib/mbt-gen.rb

@@ -18,6 +18,7 @@ DEFAULT_Z3_PATH = "z3"
 
 CONFIG_FILE = "config.yml"
 OUTPUT_FILE = "result.xml"
+BASE_FILENAME = "doc-base.xml"
 CONTINUATION_FILE = "continuation.log"
 COMBINATION_LOG = "combinations.log"
 VARS_LOG = "vars.log"
@@ -51,6 +52,19 @@ GENERATING A SINGLE MESSAGE:
     -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 SPECIAL REQUIREMENTS:
+
+  ruby #{$PROGRAM_NAME} -generate-max
+  - generates a message of maximum size. The message will be valid XML and will adhere to the schema, but it will
+    not neccessarily satisfy all validation rules. It will contain all structures, all optional fields and all lists of maximum size.
+
+  ruby #{$PROGRAM_NAME} -generate-equality-test-data
+  - generates a base message of maximum size (see -generate-max option) as well as the following test messages for each field and structure
+    - one test message in which the field contains a different value (only for fields)
+    - one test message in which the field/structure is empty in case it is optional
+    NOTE: all the other fields and structures will be the same as in the base message. This kind of test data is useful for
+          testing implementations of equality and comparison functionality on the specified messages.
+
 GENERATING MESSAGES FOR ALL COMBINATIONS:
 
   ruby #{$PROGRAM_NAME} -list-keys
@@ -772,6 +786,7 @@ def parse_field_value(fielddef, value)
   when :enum
     return solver_value_to_string(value)
   when :date
+    puts "DEBUG: parsing date #{value.inspect}"
     return Date.parse(value)
   when :timestamp
     return Time.new(value)
@@ -799,6 +814,91 @@ def format_solver_value(fielddef, solver_value)
   end
 end
 
+def build_max_doc(progress, struct)
+  doc = Nokogiri::XML(XML_TEMPLATE)
+  add_max_struct_to_doc(progress, struct, doc)
+  return doc
+end
+
+def pick_solver_value_for_field(field_desc)
+  if field_desc[:datatype] == :int then
+    if field_desc[:min] then
+      field_desc[:min].to_s
+    elsif field_desc[:max] then
+      field_desc[:max].to_s
+    else
+      "0"
+    end
+  elsif field_desc[:datatype] == :string then
+    # TODO: when a string field has a :regexp, use the solver to find a value satisfying it
+    if field_desc[:maxLength] then
+      "a" * field_desc[:maxLength]
+    else
+      "default"
+    end
+  elsif field_desc[:datatype] == :enum then
+    field_desc[:values].first.to_s
+  elsif field_desc[:datatype] == :date then
+    Time.at(0).to_date.to_s
+  elsif field_desc[:datatype] == :timestamp then
+    Time.at(0).to_s
+  else
+    raise RuntimeError.new("encountered unknown :datatype #{field_desc[:datatype].inspect}")
+  end
+end
+
+def add_max_struct_to_doc(progress, struct, doc, 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 prefix then
+      xpath = "#{prefix}/#{key}"
+    else
+      xpath = key.to_s
+    end
+    if value[:type] == :field then
+      val = pick_solver_value_for_field(value)
+      fvalue_str = format_solver_value(value, val)
+      doc.add_child("<#{key}>#{fvalue_str}</#{key}>")
+    elsif value[:type] == :list then
+      node = doc.add_child("<#{key}></#{key}>")
+      if node.is_a?(Nokogiri::XML::NodeSet) then
+        node = node.first 
+      end
+      xpath_element = value[:xpath_element]
+      if Integer(value[:model_maxLength]) > 0 then
+        Integer(value[:model_maxLength]).times do |i|
+          node.add_child("<#{xpath_element}>#{format_solver_value(value, pick_solver_value_for_field(value))}</#{xpath_element}>")
+        end
+      end
+    elsif value[:type] == :objlist then
+      node = doc.add_child("<#{key}></#{key}>")
+      if node.is_a?(Nokogiri::XML::NodeSet) then
+        node = node.first 
+      end
+      xpath_element = value[:xpath_element]
+      value[:model_maxLength].times do |index|
+        cnode = node.add_child("<#{xpath_element}></#{xpath_element}>")
+        if cnode.is_a?(Nokogiri::XML::NodeSet) then
+          cnode = cnode.first 
+        end
+        add_max_struct_to_doc(progress, value[:ref], cnode, "#{xpath}/#{index}")
+      end
+    elsif value[:type] == :structure then
+      unless value[:ref] then
+        raise RuntimeError.new("struct is broken: :structure #{key.inspect} does not have a :ref")
+      end
+      node = doc.add_child("<#{key}></#{key}>")
+      if node.is_a?(Nokogiri::XML::NodeSet) then
+        node = node.first 
+      end
+      add_max_struct_to_doc(progress, value[:ref], node, xpath)
+    else
+      raise RuntimeError.new("struct is broken: encountered unknown :type #{value[:type].inspect}")
+    end    
+  end
+end
+
+
 def build_document_from_model(progress, struct, model)
   doc = Nokogiri::XML(XML_TEMPLATE)
   add_model_struct_to_doc(progress, struct, doc, model)
@@ -888,6 +988,244 @@ def set_standard_options(progress, solver)
   solver.to_solver(progress, "")
 end
 
+def each_structure_and_field_in(struct, prefix = nil, &block)
+  struct.each do |key, value|
+    next if key == :validation_rules || key == :predicates || key == :parent_link || key == :struct_xpath_prefix || key == :additional_smtlib
+
+    if prefix then
+      xpath = "#{prefix}/#{key}"
+    else
+      xpath = key
+    end
+    
+    if value[:type] == :field then
+      block.call(value, xpath)
+    elsif value[:type] == :list then
+      block.call(value, xpath)
+      value[:model_maxLength].times do |i|
+        cvalue = value.clone()
+        cvalue[:element] = true
+        block.call(cvalue, xpath + "/#{value[:xpath_element]}[#{i+1}]")
+      end
+    elsif value[:type] == :objlist then
+      block.call(value, xpath)
+      value[:model_maxLength].times do |i|
+        cxpath = xpath + "/#{value[:xpath_element]}[#{i+1}]"
+        cvalue = value.clone()
+        cvalue[:element] = true
+        block.call(cvalue, cxpath)
+        each_structure_and_field_in(value[:ref], cxpath, &block)      
+      end
+    elsif value[:type] == :structure then
+      block.call(value, xpath)
+      each_structure_and_field_in(value[:ref], xpath, &block)      
+    else
+      raise RuntimeError.new("encountered unknown :type #{value[:type].inspect}")
+    end
+  end
+end
+
+def xpath_to_filename(xpath)
+  xpath.gsub("/", "-").gsub(/\[\d*\]/) {|s| if s =~ /\[(\d*)\]/ then "-#{$1}-" else s end }
+end
+
+def generate_equality_test_data(progress, message, output_dir, config, options)
+  unless Dir.exist?(output_dir)
+    FileUtils.mkdir_p(output_dir)
+  end
+
+  base_filename = "#{output_dir}/#{BASE_FILENAME}"
+  generate_max_doc(progress, message, base_filename, config, options)
+
+  base_doc = Nokogiri::XML(File.read(base_filename))
+
+  each_structure_and_field_in(message) do |desc, xpath|
+    if desc[:type] == :field then
+      mutated_doc = base_doc.clone()
+      node = mutated_doc.at_xpath(xpath)
+      unless node then
+        raise RuntimeError.new("xpath #{xpath.inspect} could not be found in base_doc")
+      end
+      node.inner_html = node.inner_html + "x"
+      File.open("#{output_dir}/doc-mutated-#{xpath_to_filename(xpath)}.xml", "w") do |f|
+        f.puts(mutated_doc.to_xml)
+      end
+      if desc[:optional] == true then
+        mutated_doc = base_doc.clone()
+        node = mutated_doc.at_xpath(xpath)
+        unless node then
+          raise RuntimeError.new("xpath #{xpath.inspect} could not be found in base_doc")
+        end
+        node.remove()
+        File.open("#{output_dir}/doc-removed-#{xpath_to_filename(xpath)}.xml", "w") do |f|
+          f.puts(mutated_doc.to_xml)
+        end
+      end
+    elsif desc[:type] == :list then
+      if desc[:element] then
+        # list elements
+        mutated_doc = base_doc.clone()
+        node = mutated_doc.at_xpath(xpath)
+        unless node then
+          raise RuntimeError.new("xpath #{xpath.inspect} could not be found in base_doc")
+        end
+        node.inner_html = node.inner_html + "x"
+        File.open("#{output_dir}/doc-mutated-#{xpath_to_filename(xpath)}.xml", "w") do |f|
+          f.puts(mutated_doc.to_xml)
+        end
+      else
+        # the list itself
+        mutated_doc = base_doc.clone()
+        node = mutated_doc.at_xpath(xpath)
+        unless node then
+          raise RuntimeError.new("xpath #{xpath.inspect} could not be found in base_doc")
+        end
+        node.remove()
+        File.open("#{output_dir}/doc-removed-#{xpath_to_filename(xpath)}.xml", "w") do |f|
+          f.puts(mutated_doc.to_xml)
+        end
+      end
+    elsif desc[:type] == :objlist then
+      if desc[:element] then
+        # list elements
+        # no additional test data neccessary as the element objects will contain fields that are modified already
+      else
+        # the list itself
+        mutated_doc = base_doc.clone()
+        node = mutated_doc.at_xpath(xpath)
+        unless node then
+          raise RuntimeError.new("xpath #{xpath.inspect} could not be found in base_doc")
+        end
+        node.remove()
+        File.open("#{output_dir}/doc-removed-#{xpath_to_filename(xpath)}.xml", "w") do |f|
+          f.puts(mutated_doc.to_xml)
+        end
+      end
+    elsif desc[:type] == :structure then
+      if desc[:optional] == true then
+        mutated_doc = base_doc.clone()
+        node = mutated_doc.at_xpath(xpath)
+        unless node then
+          raise RuntimeError.new("xpath #{xpath.inspect} could not be found in base_doc")
+        end
+        node.remove()
+        File.open("#{output_dir}/doc-removed-#{xpath_to_filename(xpath)}.xml", "w") do |f|
+          f.puts(mutated_doc.to_xml)
+        end
+      end
+    else
+      raise RuntimeError.new("encountered unknown :type #{desc[:type].inspect}")
+    end
+  end
+  
+  generate_equality_test(message, "#{output_dir}/test-equality.rb")
+end
+
+def generate_equality_test(message, output_filename)
+
+  base_filename = BASE_FILENAME
+  positive_tests = []
+  positive_tests << "assert(equality('#{base_filename}', '#{base_filename}'), 'Equality implementation is not reflexive on file #{base_filename}')"
+  each_structure_and_field_in(message) do |desc, xpath|
+    if desc[:type] == :field then
+      positive_tests << "assert(equality('doc-mutated-#{xpath_to_filename(xpath)}.xml', 'doc-mutated-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation is not reflexive on file doc-mutated-#{xpath_to_filename(xpath)}.xml')"
+      if desc[:optional] == true then
+        positive_tests << "assert(equality('doc-removed-#{xpath_to_filename(xpath)}.xml', 'doc-removed-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation is not reflexive on file doc-removed-#{xpath_to_filename(xpath)}.xml')"
+      end
+    elsif desc[:type] == :list then
+      if desc[:element] then
+        positive_tests << "assert(equality('doc-mutated-#{xpath_to_filename(xpath)}.xml', 'doc-mutated-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation is not reflexive on file doc-mutated-#{xpath_to_filename(xpath)}.xml')"
+      else
+        positive_tests << "assert(equality('doc-removed-#{xpath_to_filename(xpath)}.xml', 'doc-removed-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation is not reflexive on file doc-removed-#{xpath_to_filename(xpath)}.xml')"
+      end
+    elsif desc[:type] == :objlist then
+      if desc[:element] then
+        # list elements
+        # no additional test data neccessary as the element objects will contain fields that are modified already
+      else
+        # the list itself
+        positive_tests << "assert(equality('doc-removed-#{xpath_to_filename(xpath)}.xml', 'doc-removed-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation is not reflexive on file doc-removed-#{xpath_to_filename(xpath)}.xml')"
+      end
+    elsif desc[:type] == :structure then
+      if desc[:optional] == true then
+        positive_tests << "assert(equality('doc-removed-#{xpath_to_filename(xpath)}.xml', 'doc-removed-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation is not reflexive on file doc-removed-#{xpath_to_filename(xpath)}.xml')"
+      end
+    else
+      raise RuntimeError.new("encountered unknown :type #{desc[:type].inspect}")
+    end
+  end
+  
+  negative_tests = []
+  each_structure_and_field_in(message) do |desc, xpath|
+    if desc[:type] == :field then
+      negative_tests << "assert(!equality('#{base_filename}', 'doc-mutated-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation seems not to take the field #{xpath} into account. It regards the files #{base_filename} and doc-mutated-#{xpath_to_filename(xpath)}.xml as equal.')"
+      if desc[:optional] == true then
+        negative_tests << "assert(!equality('#{base_filename}', 'doc-removed-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation seems not to take the existence of field #{xpath} into account. It regards the files #{base_filename} and doc-removed-#{xpath_to_filename(xpath)}.xml as equal.')"
+      end
+    elsif desc[:type] == :list then
+      if desc[:element] then
+        negative_tests << "assert(!equality('#{base_filename}', 'doc-mutated-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation seems not to take the list #{xpath} into account. It regards the files #{base_filename} and doc-mutated-#{xpath_to_filename(xpath)}.xml as equal.')"
+      else
+        negative_tests << "assert(!equality('#{base_filename}', 'doc-removed-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation seems not to take the existence of the list #{xpath} into account. It regards the files #{base_filename} and doc-removed-#{xpath_to_filename(xpath)}.xml as equal.')"
+      end
+    elsif desc[:type] == :objlist then
+      if desc[:element] then
+        # list elements
+        # no additional test data neccessary as the element objects will contain fields that are modified already
+      else
+        # the list itself
+        negative_tests << "assert(!equality('#{base_filename}', 'doc-removed-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation seems not to take the existence of objlist #{xpath} into account. It regards the files #{base_filename} and doc-removed-#{xpath_to_filename(xpath)}.xml as equal.')"
+      end
+    elsif desc[:type] == :structure then
+      if desc[:optional] == true then
+        negative_tests << "assert(!equality('#{base_filename}', 'doc-removed-#{xpath_to_filename(xpath)}.xml'), 'Equality implementation seems not to take the existence of structure #{xpath} into account. It regards the files #{base_filename} and doc-removed-#{xpath_to_filename(xpath)}.xml as equal.')"
+      end
+    else
+      raise RuntimeError.new("encountered unknown :type #{desc[:type].inspect}")
+    end
+  end
+
+  
+  content = <<EOF
+#!/bin/ruby
+
+require 'test/unit'
+
+class EqualityTest < Test::Unit::TestCase
+
+  def equality(filename1, filename2)
+    # TODO: call your equality implementation here.
+    #       This is just an example showing how to call an externally-provided implementation.
+    system("diff", filename1, filename2)
+  end
+
+  def test_equality_positive
+    #{positive_tests.join("\n    ")}
+  end
+  
+  def test_equality_negative
+    #{negative_tests.join("\n    ")}
+  end
+end
+EOF
+
+  File.open(output_filename, "w") do |f|
+    f.puts(content)
+  end
+
+end
+
+def generate_max_doc(progress, message, output_filename, config, options)
+  result_doc = build_max_doc(progress, message)
+  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}."
+  return true
+end
+
 def generate_doc(progress, message, output_filename, config, options)
   raise RuntimeError.new("option :solverFactory is required") unless options[:solverFactory]
   log = options[:log] || nil
@@ -2132,6 +2470,10 @@ def generate(message, argv, message_config_filename = nil)
       else
         options[:validate_files] = [argv.shift]
       end
+    elsif opt == '-generate-max' then
+      options[:generate_max] = true
+    elsif opt == '-generate-equality-test-data' then
+      options[:generate_equality_test_data] = true
     else
       puts "FATAL: unknown option #{opt.inspect}."
       puts USAGE
@@ -2192,6 +2534,12 @@ def generate(message, argv, message_config_filename = nil)
       list_fields_and_structures(message, options[:list])
     elsif options[:list_validation_rules] then
       list_validation_rules(message)
+    elsif options[:generate_max] then
+      validate_model(message)
+      generate_max_doc(progress, message, OUTPUT_FILE, config, options)
+    elsif options[:generate_equality_test_data] then
+      validate_model(message)
+      generate_equality_test_data(progress, message, OUTPUT_DIR, config, options)
     else
       progress.print_line "using #{options[:date_now]} as [Date.now]"
       progress.print_line "using #{options[:timestamp_now]} as [Timestamp.now]"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mbt-gen
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - FM-enthusiast
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-10 00:00:00.000000000 Z
+date: 2026-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri