origen_testers 0.52.10 → 0.52.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad56d048270f5877bdd6da72571a2b4f04ad2fc045d33d61bc34f7aedd9fdf8
-  data.tar.gz: 91032b7a9d74d80ccdf9c61e816abfd642d8b187bb5d18c79af6797f94b183e7
+  metadata.gz: 4607f1c380b66ebfbec0846cd3e5bcfcbfbb65d1ed94ba1239b088f1625372bf
+  data.tar.gz: 1f86cd54c83de4482f40f81b33775b8c216ffced71f77871fd009a94138299ae
 SHA512:
-  metadata.gz: 1ef803cd8aea71320aaa9885f827b6a93dc79c7bb2d281e8bde083c75b0e6f3abe2db66c1829c4b65b15f4310494da19a7d3c0ae315ad4b5911df68940b3b454
-  data.tar.gz: 8e8f3eee5a4740b8966b816359f471eb26958b3a090260bbf105121c1394f0eaab6a70e7537c605af0d7290a7f0912de0a035ceebb7df22a86dc6f701a826653
+  metadata.gz: 84308cebe5faddd92e75c410bba7954e90d0ac74ece08af1f4dcc9cf3204f6241286a57209139ae6fedeeecc0373edac6b6a140710c56ba62d274e551e67c070
+  data.tar.gz: a4c37216bf06b8206da9e819ff3d5239d57c28784e78942df087d3e0a5d657305b73e181d4b15def1ea174584e63ff19a262446c07a8500d2ebbddb89c2c3f0a

data/config/version.rb

@@ -1,7 +1,7 @@
 module OrigenTesters
   MAJOR = 0
   MINOR = 52
-  BUGFIX = 10
+  BUGFIX = 12
   DEV = nil
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
 end

data/lib/origen_testers/atp/flow.rb

@@ -259,6 +259,7 @@ module OrigenTesters::ATP
             nodes = [name]
             nodes << id(options[:id]) if options[:id]
             nodes << n1(:path, path.to_s)
+            nodes << n1(:bypass, true) if options[:bypass] == true
             nodes += children
             ast = ast.updated :sub_flow, nodes,
                               file:        options.delete(:source_file) || source_file,

data/lib/origen_testers/charz/profile.rb

@@ -24,6 +24,11 @@ module OrigenTesters
       def initialize(id, options, &block)
         @id = id
         @id = @id.symbolize unless id.is_a? Symbol
+        if Origen.interface_loaded? && Origen.interface.respond_to?(:default_valid_charz_placements)
+          @valid_placements = Origen.interface.default_valid_charz_placements
+        else
+          @valid_placements = [:inline, :eof]
+        end
         options.each { |k, v| instance_variable_set("@#{k}", v) }
         (block.arity < 1 ? (instance_eval(&block)) : block.call(self)) if block_given?
         @name ||= id
@@ -55,7 +60,6 @@ module OrigenTesters
           fail
         end
 
-        @valid_placements ||= [:inline, :eof]
         unless @valid_placements.include? @placement
           Origen.log.error "Profile #{id}: invalid placement value, must be one of: #{@valid_placements}"
           fail

data/lib/origen_testers/charz.rb

@@ -20,7 +20,11 @@ module OrigenTesters
     #   @return [Boolean] whether or not to wrap eof charz tests in a group
     # @!attribute eof_charz_tests_group_name
     #   @return [String, Symbol] group name to be used to for eof charz tests
-    attr_accessor :charz_stack, :charz_routines, :charz_profiles, :charz_session, :charz_instance, :eof_charz_tests, :skip_group_eof_charz_tests, :eof_charz_tests_group_name
+    # @!attribute default_valid_charz_placements
+    #   @return [Array<Symbol>] (:inline, :eof) list of charz placements used when verifying a new profile is valid
+    attr_accessor :charz_stack, :charz_routines, :charz_profiles, :charz_session, :charz_instance,
+                  :eof_charz_tests, :skip_group_eof_charz_tests, :eof_charz_tests_group_name,
+                  :default_valid_charz_placements
 
     def charz_stack
       @charz_stack ||= []
@@ -38,6 +42,10 @@ module OrigenTesters
       @charz_session ||= Session.new
     end
 
+    def default_valid_charz_placements
+      @default_valid_charz_placements ||= [:inline, :eof]
+    end
+
     # If there is a current instance present, that should always be used. However when running EOF charz,
     # the instance to be used is no longer set, so instead of referencing the session, use the one that we've
     # stored already

data/lib/origen_testers/generator.rb

@@ -258,6 +258,12 @@ module OrigenTesters
       options = {
         name: nil
       }.merge(options)
+
+      if !options.key?(:disable_group_on_sub_flow) &&
+         Origen.interface.instance_variable_get(:@disable_group_on_sub_flow)
+        options[:disable_group_on_sub_flow] = true
+      end
+
       file = Pathname.new(file).absolute? ? file : "#{current_dir}/#{file}"
       file = Origen.file_handler.add_rb_to(file)  # add .rb to filename if missing
       orig_file = "#{file}"     # capture original filename possibly without pre-pended underscore

data/lib/origen_testers/origen_ext/generator/flow.rb

@@ -34,14 +34,21 @@ module Origen
         if OrigenTesters::Flow.flow_comments
           top = false
           name = options[:name] || Pathname.new(file).basename('.rb').to_s.sub(/^_/, '')
-          # Generate imports as separate sub-flow files on this platform
-          if tester.v93k? && tester.smt8?
-            parent, sub_flow = *_sub_flow(name, options, &block)
-            path = sub_flow.output_file.relative_path_from(Origen.file_handler.output_directory)
-            parent.atp.sub_flow(sub_flow.atp.raw, path: path.to_s)
+          import_options = Origen.generator.option_pipeline.last || {}
+          if import_options[:disable_group_on_sub_flow] ||
+             # runtime options passed to the import call take priority over Flow.create static options
+             (import_options[:disable_group_on_sub_flow].nil? && options[:disable_group])
+            _create(options, &block)
           else
-            Origen.interface.flow.group(name, description: flow_comments) do
-              _create(options, &block)
+            # Generate imports as separate sub-flow files on this platform
+            if tester.v93k? && tester.smt8?
+              parent, sub_flow = *_sub_flow(name, options, &block)
+              path = sub_flow.output_file.relative_path_from(Origen.file_handler.output_directory)
+              parent.atp.sub_flow(sub_flow.atp.raw, path: path.to_s)
+            else
+              Origen.interface.flow.group(name, description: flow_comments) do
+                _create(options, &block)
+              end
             end
           end
         else
@@ -62,6 +69,7 @@ module Origen
 
       # @api private
       def _sub_flow(name, options, &block)
+        Origen.interface._on_sub_flow(name, options) if Origen.interface.respond_to?(:_on_sub_flow)
         @top_level_flow ||= Origen.interface.flow
         parent = Origen.interface.flow
         # If the parent flow already has a child flow of this name then we need to generate a
@@ -113,9 +121,9 @@ module Origen
             Origen.app.reload_target!
             Origen.tester.generating = :program
           end
-          opts = Origen.generator.option_pipeline.pop || {}
+          options[:sub_flow_options] = Origen.generator.option_pipeline.pop || {}
           Origen.interface.startup(options) if Origen.interface.respond_to?(:startup)
-          interface.instance_exec(opts, &block)
+          interface.instance_exec(options[:sub_flow_options], &block)
           Origen.interface.shutdown(options) if Origen.interface.respond_to?(:shutdown)
           if Origen.tester.doc?
             Origen.interface.flow.stop_section

data/lib/origen_testers/smartest_based_tester/base/flow.rb

@@ -491,22 +491,29 @@ module OrigenTesters
 
         def on_loop(node, options = {})
           start = node.to_a[0]
-          if start.is_a?(String)
+          if start.is_a?(String) || start.is_a?(Symbol)
             start = generate_flag_name(start)
             unless smt8?
               start = "@#{start}"
             end
           end
           stop = node.to_a[1]
-          if stop.is_a?(String) && smt8?
+          if stop.is_a?(String) || stop.is_a?(Symbol)
             stop = generate_flag_name(stop)
-          elsif stop.is_a?(String)
-            fail 'loops with \'stop\' defined as a variable cannot be supported in the defined environments.'
+            if tester.smt7?
+              stop = "@#{stop}"
+            end
           end
           step = node.to_a[2]
           if smt8? && !(step == -1 || step == 1)
             fail 'SMT8 does not support steps other than -1 or 1.'
           end
+          if step.is_a?(String) || step.is_a?(Symbol)
+            step = generate_flag_name(step)
+            if tester.smt7?
+              step = "@#{step}"
+            end
+          end
           if node.to_a[3].nil?
             fail 'You must supply a loop variable name!'
           else
@@ -518,7 +525,7 @@ module OrigenTesters
           end
           # num = (stop - start) / step + 1
           # Handle increment/decrement
-          if step < 0
+          if step.is_a?(Numeric) && step < 0
             compare = '>'
             incdec = "- #{step * -1}"
           else
@@ -526,7 +533,10 @@ module OrigenTesters
             incdec = "+ #{step}"
           end
           if tester.smt7?
-            line "for #{var} = #{start}; #{var} #{compare} #{stop + step} ; #{var} = #{var} #{incdec}; do"
+            unless stop.is_a?(String)
+              stop = "#{stop + step}"
+            end
+            line "for #{var} = #{start}; #{var} #{compare} #{stop} ; #{var} = #{var} #{incdec}; do"
             line "test_number_loop_increment = #{test_num_inc}"
             line '{'
             @indent += 1

data/lib/origen_testers/smartest_based_tester/base/processors/extract_flow_vars.rb

@@ -56,6 +56,18 @@ module OrigenTesters
           end
           alias_method :on_unless_job, :on_if_job
 
+          def on_whenever(node)
+            flow_var, *nodes = *node
+            [flow_var].flatten.each do |f|
+              if [String, Symbol].include?(f.value.class)
+                add generate_flag_name(f.value.to_s), :referenced_flags
+              end
+            end
+            process_all(nodes)
+          end
+          alias_method :on_whenever_all, :on_whenever
+          alias_method :on_whenever_any, :on_whenever
+
           def on_if_flag(node)
             flag, *nodes = *node
             [flag].flatten.each do |f|
@@ -109,6 +121,17 @@ module OrigenTesters
             add flag, :set_enables
           end
 
+          def on_loop(node)
+            start, stop, step, loop_var, test_inc, *nodes = *node
+            [start, stop, step, loop_var].each do |type|
+              if [String, Symbol].include?(type.class) && tester.smt8?
+                add generate_flag_name(type), :referenced_flags
+              end
+            end
+
+            process_all(nodes)
+          end
+
           private
 
           def in_sub_flow?

data/lib/origen_testers/smartest_based_tester/v93k_smt8/flow.rb

@@ -95,9 +95,18 @@ module OrigenTesters
           sub_flow = sub_flow_from(node)
           @sub_flows ||= {}
           path = Pathname.new(node.find(:path).value)
+          bypass = false
+          if node.find(:bypass)
+            if node.find(:bypass).value.to_s.match(/true/)
+              bypass = true
+            end
+          end
           name = path.basename('.*').to_s
           path = Origen.interface.sub_flow_path_overwrite(path) if Origen.interface.respond_to? :sub_flow_path_overwrite
-          @sub_flows[name] = "#{path.dirname}.#{name}".gsub(/(\/|\\)/, '.')
+          @sub_flows[name] = {
+            bypass: bypass,
+            path:   "#{path.dirname}.#{name}".gsub(/(\/|\\)/, '.')
+          }
           # Pass down all input variables before executing
           if sub_flow.input_variables.size > 0 && tester.flow_variable_grouping
             line "// #{name} sub-flow input variables"

data/lib/origen_testers/smartest_based_tester/v93k_smt8/templates/template.flow.erb

@@ -31,8 +31,12 @@ flow <%= flow_name %> {
 % auxiliary_flows.each do |name, path|
         flow <%= name %> calls <%= path %> {}
 % end
-% sub_flows.each do |name, path|
-        flow <%= name %> calls <%= path %> { }
+% sub_flows.each do |name, settings|
+        flow <%= name %> calls <%= settings[:path] %> {<%=" }" unless settings[:bypass]%>
+%   if settings[:bypass]
+            bypass = true;
+        }
+%   end
 % end
     }
 

data/lib/origen_testers/smartest_based_tester/v93k_smt8/test_suite.rb

@@ -165,6 +165,19 @@ module OrigenTesters
           l
         end
         # rubocop:enable Metrics/ParameterLists: Avoid parameter lists longer than 5 parameters.
+
+        def wrap_if_string(value)
+          if value.is_a?(String)
+            if value =~ /setupRef(.*)/
+              # Do not wrap setupRef calls in quotes
+              return value
+            else
+              "\"#{value}\""
+            end
+          else
+            value
+          end
+        end
       end
     end
   end

data/lib/origen_testers/test/interface.rb

@@ -60,6 +60,7 @@ module OrigenTesters
                     param_name0:          [:string, ''],
                     param_list_strings:   [:list_strings, %w(E1 E2)],
                     param_list_classes:   [:list_classes, %w(E1 E2)],
+                    param_func_call:      [:string, 'setupRef(FQN)'],
                     'param_group.param0': [:string, ''],
                     param_name1:          [{
                       param_name_int:       [:integer, 0],

data/program/components/_default_group_import.rb

@@ -0,0 +1,5 @@
+Flow.create do |options|
+
+  test :"#{options[:status]}_#{options[:type]}"
+
+end

data/program/components/_default_no_group_import.rb

@@ -0,0 +1,5 @@
+Flow.create(disable_group: true) do |options|
+
+  test :"#{options[:status]}_#{options[:type]}"
+
+end

data/program/prb1.rb

@@ -19,5 +19,10 @@ Flow.create interface: 'OrigenTesters::Test::Interface', flow_description: 'Prob
   # Test that a reference to a deeply nested test works (mainly for SMT8)
   test :on_deep_1, if_failed: :deep_test, test_text: "some_custom_text"
 
+  import 'components/default_group_import',    type: 'import_option_disable', disable_group_on_sub_flow: true, status: :ungrouped
+  import 'components/default_no_group_import', type: 'flow_create_option_disable', status: :ungrouped
+  import 'components/default_no_group_import', type: 'flow_create_option_override', disable_group_on_sub_flow: false, status: :grouped
+
+
   pass 1, description: "Good die!", softbin: 1
 end

data/templates/origen_guides/program/charz.md.erb

@@ -311,4 +311,87 @@ Flow.create(interface: 'MyApp:Interface') do
 end
 ~~~
 
+#### Custom Placement Example
+
+For an example of adding new placements lets say we want to insert a charz test if the parent
+test fails, but not until after a later test in the flow "testB" has ran. To do so:
+
+* The profile needs to know that this new placement is valid and then target it
+* The charz tests themselves need a placement specific constructor method that collects the results for later use
+* Lastly, a method for calling the collected constructors and inserting them into the flow
+
+##### Adding valid placements
+
+To add new valid placements, you can do so either on a per-profile basis or across all profiles
+for the current interface:
+
+~~~ruby
+# Per-Profile
+add_charz_profile :my_profile |p|
+  # ...
+  p.valid_placements = [:on_fail_after_testB]
+  p.placement = :on_fail_after_testB
+end
+
+# Across Interface via interface instance variable:
+@default_valid_charz_placements = [:inline, :eof, :on_fail_after_testB]
+
+add_charz_profile :my_profile |p|
+  # ...
+  p.placement = :on_fail_after_testB
+end
+~~~
+
+##### Placement Constructor and Collection
+
+So that the charz API knows how to handle this placement, it will expect a method to be defined
+named as `create_<placement>_charz_tests(options, &block)`. This method will need to store the
+current context in a manner that can be called later. To collect multiple tests, we'll use
+an interface instance variable.
+
+~~~ruby
+# collect the current instance and options into a proc,
+# which will be stored in @on_fail_after_testB_charz_tests to be called later
+def create_on_fail_after_testB_charz_tests(options, &block)
+  # we'll need to save the current charz instance as it is now as its used in the test creation
+  current_instance = charz_instance.clone
+
+  # Store the setup instructions in a proc to be called later
+  @on_fail_after_testB_charz_tests ||= []
+  @on_fail_after_testB_charz_tests << proc do
+    # these are existing methods in the charz API
+    set_charz_instance(current_instance)
+    create_charz_group(options, &block)
+  end
+end
+~~~
+
+##### Inserting collected tests into the flow
+
+Now all thats left is to define the generator to call the collected tests, then
+we can apply our charz profile to the tests of interest and call the generator after testB
+has ran.
+
+~~~ruby
+# simple generator to call each collected proc
+def generate_on_fail_after_testB_charz_tests
+  @on_fail_after_testB_charz_tests.map(&:call)
+  @on_fail_after_testB_charz_tests = [] # clear to prevent accidental repeats
+end
+~~~
+
+And then finally in the flow:
+
+~~~ruby
+charz_on :my_profile do
+  func :test_i_want_to_charz1, id: :t1
+  func :test_i_want_to_charz2, id: :t2
+end
+
+# ...
+
+func :testB
+generate_on_fail_after_testB_charz_tests
+~~~
+
 % end

data/templates/origen_guides/program/flowapi.md.erb

@@ -406,8 +406,6 @@ Decrementing loops, having `from:` value > `to:` value and using negative `step:
 
 ##### Loop Rules For Each Environment
 
-`SMT7` cannot support a variable stop location. Only the `from:` parameter is allowed to be a variable.
-
 `SMT8` cannot have a step other than -1 or 1. The limitations of the range flow restrict those steps.
 The `to:` parameter can be a flow variable just like `from:`.
  

data/templates/origen_guides/program/v93ksmt7.md.erb

@@ -110,6 +110,38 @@ end
 
 This same API may be used to implement similar features on other platforms in future, but for now only the V93K is implemented.
 
+#### Grouping on sub-flows
+
+By default, imported sub-flows are wrapped in a group named by the passed `:name` option if provided, otherwise the name of the file is used.
+
+~~~ruby
+import 'my_sub_flow' # sub flow contains single test 'my_test'
+
+# Results in the following output in the .tf file:
+#   {
+#      run(my_test);
+#   }, open,"my_sub_flow", ""
+~~~
+
+To disable this behavior, you can either pass to your import call the option `disable_group_on_sub_flow: true`,
+or set `disable_group: true` in your Flow.create() parameters:
+
+~~~ruby
+# Pass option to import
+import 'my_sub_flow', { disable_group_on_sub_flow: true }
+
+# Or set in Flow.create() in _my_sub_flow.rb
+Flow.create(disable_group: true) do
+  func :my_test
+end
+
+# Results in the following output in the .tf file:
+#   run(my_test);
+~~~
+
+Note that the import option takes priority, so if `Flow.create(disable_group: true)`
+is set but import is passed `disable_group_on_sub_flow: false` then a group will still be created.
+
 ### Test Name Uniqueness
 
 Test (suite) naming collisions can occur when importing multiple independent test flow modules into a

data/templates/origen_guides/program/v93ksmt8.md.erb

@@ -55,7 +55,11 @@ Contains the limits tables for all flows.
 A top-level test program flow file in Origen will generate a correspondingly named file in the `flows/` directory,
 where the name of the generated file is the upper-cased version of the source file name.
 If the flow imports sub-flows or contains groups, then those will be contained in a directory named after the
-lower-cased version of the flow name.
+lower-cased version of the flow name. For sub-flow imports, this can be disabled by passing the option
+`disable_sub_flow_on_group: true` to the import call, or by setting the disable_group option in your sub-flow:
+`Flow.create(disable_group: true)`. Note that if both are provided, the import option value will take priority.
+When the group is disabled this way, the content of the sub-flow will simply be inserted as if it was defined
+in the calling flow instead of a sub flow.
 
 ##### limits/
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_testers
 version: !ruby/object:Gem::Version
-  version: 0.52.10
+  version: 0.52.12
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -542,6 +542,8 @@ files:
 - program/basic_interface.rb
 - program/charz.rb
 - program/components/_deep_nested.rb
+- program/components/_default_group_import.rb
+- program/components/_default_no_group_import.rb
 - program/components/_prb1_main.rb
 - program/components/_prb2_main.rb
 - program/components/_small.rb
@@ -618,7 +620,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: This plugin provides Origen tester models to drive ATE type testers like