origen_testers 0.42.0 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b61e30758057f753a3f11c3f9e804ec902c04b11ab5d044eead50e933396dcc4
-  data.tar.gz: 56e4f2859a2dd2d3440f41b8f0025764a1fdbe49dd54266ec46f3f18f6ed4315
+  metadata.gz: bcd28a31ae733240fb79442791a52b0289cb60767ab4ca3420958a5c5451cb29
+  data.tar.gz: 208ed25a437e3df788b0305f88fbcd967ffa563fd68a7508d5b055f7c3380395
 SHA512:
-  metadata.gz: 218203f35e42e7d2de5fa2668dca505dff43339e598ce231d9a5d57f6f8dd02d90f5fb3b53e6d4aef3bc6036eeebe4bc09663190fb192fa72e1aed3ed3e7eb2c
-  data.tar.gz: 83d9e9baee738fac32b9123d8991f18b5b4b3c00cbfda40b74fde58c75c7d052f3da23533e090c8cef611207ae037a151da9d78bad8446a0b696240cf10788c2
+  metadata.gz: c36b5d4a30d947489f3ed2d165c867249df0235b3d5d797bd3eaf5b2f232cbf0c6d4d33b1425ab6fd061d65eac4fd8803355af6e0b317a96b5f98335438845f2
+  data.tar.gz: 4af3ae57d4c893138271ac876bc7968def1bc4df416764481a264594af38213264f8f818fbdf40204f3b4b54441158ce05d1233245b1872124b2801495af0587

data/config/commands.rb

@@ -200,7 +200,15 @@ when "examples", "test"
     puts
     puts "To approve any diffs in the reference.list files run the following command:"
     puts
-    puts "cp list/j750/referenced.list approved/j750/referenced.list && cp list/j750_hpt/referenced.list approved/j750_hpt/referenced.list && cp list/ultraflex/referenced.list approved/ultraflex/referenced.list && cp list/v93k/referenced.list approved/v93k/referenced.list"
+    platforms = %w(j750 j750_hpt ultraflex v93k v93k_multiport v93k_enable_flow v93k_disable_flow v93k_limits_file v93k_global v93k_smt8) # put here the various platforms used in examples/program_generator.rb
+    reflist_command = ''
+    platforms.each do |platform|
+      unless reflist_command == ''
+        reflist_command = "#{reflist_command} && "
+      end
+      reflist_command = "#{reflist_command}cp list/#{platform}/referenced.list approved/#{platform}/referenced.list"
+    end
+    puts "#{reflist_command}"
     puts
     Origen.app.stats.report_fail
     status = 1

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenTesters
   MAJOR = 0
-  MINOR = 42
+  MINOR = 43
   BUGFIX = 0
   DEV = nil
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/origen_testers/generator.rb

@@ -253,9 +253,24 @@ module OrigenTesters
       end
     end
 
+    # Import sub-program
     def import(file, options = {})
       file = Pathname.new(file).absolute? ? file : "#{current_dir}/#{file}"
-      file = Origen.file_handler.clean_path_to_sub_program(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
+      file_w_underscore = Origen.file_handler.add_underscore_to(file) # determine filename definitely with pre-pended underscore
+
+      # first check filename definitely with underscore
+      file = Origen.file_handler.clean_path_to(file_w_underscore, allow_missing: true)  # allow for file missing
+      if file.nil?   # check if file missing
+        # if so, check original filename that possibly is without underscore
+        file = Origen.file_handler.clean_path_to(orig_file, allow_missing: true)  # allow for file missing
+        if file.nil?
+          # give error if could not find either file
+          fail "Could not find file to import: #{orig_file}" if file.nil?  # give error if neither option above is found
+        end
+      end
+
       base_collection = collection
       @collection = []
       Origen.generator.option_pipeline << options

data/program/prb1.rb

@@ -10,6 +10,8 @@ Flow.create interface: 'OrigenTesters::Test::Interface', flow_description: 'Prob
 
   import 'components/prb1_main'
 
+  import 'test' # import top-level test.rb directly, note that Flow.create options of sub-flow will be ignored!
+
   # Test that a reference to a deeply nested test works (mainly for SMT8)
   test :on_deep_1, if_failed: :deep_test
 

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

@@ -265,8 +265,8 @@ In our case let's say that we have a new DUT on the horizon which has two vreg i
 let's extract this suite of vreg tests to a module so that we can instantiate two of them in
 our flow.
 
-All sub flow file names must begin with "_", this is what tells Origen that it is a sub-flow and
-not a top-level flow.
+By convention, sub flow file names that are meant only to be used from inside another top-level flow should begin with a "_". 
+(We'll discuss importing top-level flows below).
 The sub-flow syntax is virtually identical to the regular flow syntax except that a hash of
 options are passed in which will contain any arguments passed in by the caller when they
 instantiate the sub-flow.
@@ -374,6 +374,32 @@ Flow.create(environment: :probe) do
 end
 ~~~
 
+#### Importing Top-Level Flows
+
+Occasionally you may have the need to import a top-level flow for debug or simulation purposes.  
+This is generally not recommended since any `Flow.create` options in the top-level flow being imported 
+will be lost, but if you are careful that the `Flow.create` options are aligned between the real top-level flow 
+and any imported top-level flows, then you should be fine.
+
+The same import command is used as before, as it will also look also for a file name not starting with \"\_\"
+if one with \"\_\" is not found.
+
+So for example we have 3 top-level flows that we know work ok stand-alone, but we want to check that they work ok when 
+running back to back:
+
+~~~ruby
+# program/probe.rb
+Flow.create(environment: :probe) do  # options here match those in the probe_* flows imported below
+
+  import "probe_start"   # will import file called 'probe_start.rb'
+
+  import "probe_middle"  # will import file called 'probe_middle.rb'
+
+  import "probe_end"     # will import file called 'probe_end.rb'
+
+end
+~~~
+
 #### Documenting Tests
 
 All of the test attributes will be available later when it comes to generating documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_testers
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.43.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-08 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen