test_ids 1.1.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2715a10e5e999b8e7cb1d8240803232fadf178139e64a2f44186d69b65602a15
-  data.tar.gz: 2b550ced04afc190362992970a7cfaeb76e7ba78d519894ebdeb04391cd3b721
+  metadata.gz: 3cc056bd639bd5288a0ed73842d5790de1beaf2d8ef53aefe004376fd2647ca2
+  data.tar.gz: 75ee0869b2c5d8a9e0e0ec75d9125bd8ad5286a1490af80e95ddcd986874b12e
 SHA512:
-  metadata.gz: 4d62fc377c3bcbd5e840ed16c17e3749d7611f95e89eee17fe4bfa5ae7b572e6db8f12bf6016393f103e3dc2c59363205b5c90ad8ad999d43d87ba52017fd349
-  data.tar.gz: dfe969df5389777ea3545f506b78046b0d5596d49fc37890b7eab748329337ee955050ed6756c0977d22420408b6329c1dcaab1f400e0d8ef744c386bd197f13
+  metadata.gz: ca98189aaf0d39ba9b4f7acac86354e5f6afa2c537dc3e6f70ebcce6413e607aeca2ed722f548c761432306729163c1b893ca4a10bbf2b711b217cd2418bfc58
+  data.tar.gz: 86b3b1023d650d963adf0cc4998dda002bec9bd925b4ac20e414f4215a765101ca7c8e5a8dfd84024eec4808e17fb61ca425a150218357955c622dc5d22d0bfc

data/config/application.rb

@@ -83,7 +83,7 @@ class TestIdsApplication < Origen::Application
       puts "All tests passing, proceeding with release process!"
     end
   end
-
+  
   # To enabled source-less pattern generation create a class (for example PatternDispatcher)
   # to generate the pattern. This should return false if the requested pattern has been
   # dispatched, otherwise Origen will proceed with looking up a pattern source as normal.

data/config/shared_commands.rb

@@ -17,7 +17,7 @@ when "test_ids:clear", "test_ids:repair"
 else
   @plugin_commands << <<-EOT
  test_ids:rollback  Rollback the TestIds store to the given commit ID
- test_ids:clear     Clear the assignment database for bins, softbins, numbers or all
+ test_ids:clear     Clear the assignment database for bins, softbins, numbers, ranges or all for the given configuration database ID
  test_ids:repair    Repair the given database, see -h for more
   EOT
 

data/config/version.rb

@@ -1,8 +1,7 @@
 module TestIds
   MAJOR = 1
-  MINOR = 1
-  BUGFIX = 2
+  MINOR = 2
+  BUGFIX = 3
   DEV = nil
-
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
 end

data/lib/test_ids/allocator.rb

@@ -28,11 +28,26 @@ module TestIds
     # If a numeric number is passed to the softbin, it uses that number.
     # The configuration for the TestId plugin needs to pass in the bin number and the options from the test flow
     # For this method to work as intended.
-    def next_in_range(range, options)
-      range_item(range, options)
+    # This will handle the following range inputs:
+    #   - Range, Ex: 0..10
+    #   - Array, Ex: [0..10, 20..30]
+    def next_in_range(range_definition, options)
+      if range_definition.is_a?(Range)
+        range = range_definition.to_a
+      elsif range_definition.is_a?(Array)
+        range = []
+        range_definition.each do |range_element|
+          range += range_element.is_a?(Integer) ? [range_element] : range_element.step(options[:size]).to_a
+        end
+        if range.uniq.size != range.size
+          Origen.log.error "Duplicate or overlapping range has been detected in configuration: \'#{TestIds.current_configuration.id}\'."
+          fail
+        end
+      end
+      range_item(range, range_definition, options)
     end
 
-    def range_item(range, options)
+    def range_item(range, range_definition, options)
       # This is the actual fix, it should now not be dependent on the json file being read in, instead the store pointers
       # will be utilized to get the correct number assigned from the range.
       if store['pointers']['ranges'].nil?
@@ -43,33 +58,33 @@ module TestIds
       end
       orig_options = options.dup
       # Check the database to see if the passed in range has already been included in the database hash
-      if rangehash.key?(:"#{range}")
+      if rangehash.key?(:"#{range_definition}")
         # Read out the database hash to see what the last_softbin given out was for that range.
         # This hash is updated whenever a new softbin is assigned, so it should have the updated values for each range.
-        previous_assigned_value = rangehash[:"#{range}"].to_i
+        previous_assigned_value = rangehash[:"#{range_definition}"].to_i
         # Now calculate the new pointer.
-        @pointer = previous_assigned_value - range.min
+        @pointer = range.index(previous_assigned_value) + 1
         # Check if the last_softbin given out is the same as the range[@pointer],
         # if so increment pointer by softbin size, default size is 1, config.softbins.size is configurable.
         # from example above, pointer was calculated as 1,range[1] is 10101 and is same as last_softbin, so pointer is incremented
         # and new value is assigned to the softbin.
-        if previous_assigned_value == range.to_a[@pointer]
+        if previous_assigned_value == range[@pointer]
           @pointer += options[:size]
-          assigned_value = range.to_a[@pointer]
+          assigned_value = range[@pointer]
         else
           # Because of the pointer calculations above, I don't think it will ever reach here, has not in my test cases so far!
-          assigned_value = range.to_a[@pointer]
+          assigned_value = range[@pointer]
         end
         # Now update the database pointers to point to the lastest assigned softbin for a given range.
-        rangehash.merge!(:"#{range}" => "#{range.to_a[@pointer]}")
+        rangehash.merge!(:"#{range_definition}" => "#{range[@pointer]}")
       else
         # This is the case for a brand new range that has not been passed before
         # We start from the first value as the assigned softbin and update the database to reflect.
         @pointer = 0
-        rangehash.merge!(:"#{range}" => "#{range.to_a[@pointer]}")
-        assigned_value = range.to_a[@pointer]
+        rangehash.merge!(:"#{range_definition}" => "#{range[@pointer]}")
+        assigned_value = range[@pointer]
       end
-      unless !assigned_value.nil? && assigned_value.between?(range.min, range.max)
+      unless !assigned_value.nil? && range.include?(assigned_value)
         Origen.log.error 'Assigned value not in range'
         fail
       end
@@ -281,7 +296,7 @@ module TestIds
       end
     end
 
-    # Clear the :bins, :softbins and/or :numbers by setting the options for each item to true
+    # Clear the :bins, :softbins and/or :numbers and/or :ranges by setting the options for each item
     def clear(options)
       if options[:softbin] || options[:softbins]
         store['assigned']['softbins'] = {}
@@ -301,6 +316,9 @@ module TestIds
         store['pointers']['numbers'] = nil
         store['references']['numbers'] = {}
       end
+      if options[:range] || options[:ranges]
+        store['pointers']['ranges'] = nil
+      end
     end
 
     # Saves the current allocator state to the repository

data/lib/test_ids/commands/clear.rb

@@ -18,6 +18,7 @@ Examples: origen test_ids:clear --bins                      # Clear the bins in
   opts.on('--bins', 'Clear the bin database') {  options[:bins] = true }
   opts.on('--softbins', 'Clear the softbin database') {  options[:softbins] = true }
   opts.on('--numbers', 'Clear the test number database') {  options[:numbers] = true }
+  opts.on('--ranges', 'Clear the ranges database') {  options[:ranges] = true }
   # opts.on('-pl', '--plugin PLUGIN_NAME', String, 'Set current plugin') { |pl_n|  options[:current_plugin] = pl_n }
   opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
   app_options.each do |app_option|
@@ -38,6 +39,11 @@ begin
   # Get the commit before the lock to give the user later
   rollback_id = git.repo.object('HEAD^').sha[0, 11]
   a = TestIds.load_allocator(ARGV.first)
+  if a.nil?
+    Origen.log.error "No configuration file could be found for file ID: '#{ARGV.first}'!"
+    Origen.log.warn 'By default, the correct ID to pass in will need to match the filename in the form: store_<file id>.json'
+    fail
+  end
   a.clear(options)
   a.save
 ensure

data/lib/test_ids/git.rb

@@ -50,26 +50,28 @@ module TestIds
     end
 
     def initialize(options)
-      unless File.exist?("#{options[:local]}/.git")
-        FileUtils.rm_rf(options[:local]) if File.exist?(options[:local])
-        FileUtils.mkdir_p(options[:local])
-        Dir.chdir options[:local] do
-          `git clone #{options[:remote]} .`
-          unless File.exist?('lock.json')
-            # Should really try to use the Git driver for this
-            exec 'touch lock.json'
-            exec 'git add lock.json'
-            exec 'git commit -m "Initial commit"'
-            exec 'git push'
+      if !(TestIds.lsf_manual_init_shutdown) && Origen.running_locally?
+        unless File.exist?("#{options[:local]}/.git")
+          FileUtils.rm_rf(options[:local]) if File.exist?(options[:local])
+          FileUtils.mkdir_p(options[:local])
+          Dir.chdir options[:local] do
+            `git clone #{options[:remote]} .`
+            unless File.exist?('lock.json')
+              # Should really try to use the Git driver for this
+              exec 'touch lock.json'
+              exec 'git add lock.json'
+              exec 'git commit -m "Initial commit"'
+              exec 'git push'
+            end
           end
         end
+        @local = options[:local]
+        @repo = ::Git.open(options[:local])
+        # Get rid of any local edits coming in here, this is only called once at the start
+        # of the program generation run.
+        # No need to pull latest as that will be done when we obtain a lock.
+        @repo.reset_hard
       end
-      @local = options[:local]
-      @repo = ::Git.open(options[:local])
-      # Get rid of any local edits coming in here, this is only called once at the start
-      # of the program generation run.
-      # No need to pull latest as that will be done when we obtain a lock.
-      @repo.reset_hard
     end
 
     # Roll the repo back to the given commit ID
@@ -108,11 +110,13 @@ module TestIds
     end
 
     def publish
-      Origen.profile 'Publishing the test IDs store' do
-        release_lock
-        repo.add  # Checkin everything
-        repo.commit('Publishing latest store')
-        repo.push('origin', 'master', force: true)
+      if !(TestIds.lsf_manual_init_shutdown) && Origen.running_locally?
+        Origen.profile 'Publishing the test IDs store' do
+          release_lock
+          repo.add  # Checkin everything
+          repo.commit('Publishing latest store')
+          repo.push('origin', 'master', force: true)
+        end
       end
     end
 
@@ -124,23 +128,25 @@ module TestIds
     end
 
     def get_lock
-      return if @lock_open
-      Origen.profile 'Obtaining test IDs lock' do
-        until available_to_lock?
-          puts
-          puts "Waiting for lock, currently locked by #{lock_user} (the lock will expire in less than #{lock_minutes_remaining} #{'minute'.pluralize(lock_minutes_remaining)} if not released before that)"
-          puts
-          sleep 5
+      if !(TestIds.lsf_manual_init_shutdown) && Origen.running_locally?
+        return if @lock_open
+        Origen.profile 'Obtaining test IDs lock' do
+          until available_to_lock?(@repo)
+            puts
+            puts "Waiting for lock, currently locked by #{lock_user} (the lock will expire in less than #{lock_minutes_remaining} #{'minute'.pluralize(lock_minutes_remaining)} if not released before that)"
+            puts
+            sleep 5
+          end
+          data = {
+            'user'    => User.current.name,
+            'expires' => (Time.now + minutes(5)).to_f
+          }
+          write('lock.json', JSON.pretty_generate(data))
+          repo.commit('Obtaining lock')
+          repo.push('origin')
         end
-        data = {
-          'user'    => User.current.name,
-          'expires' => (Time.now + minutes(5)).to_f
-        }
-        write('lock.json', JSON.pretty_generate(data))
-        repo.commit('Obtaining lock')
-        repo.push('origin')
+        @lock_open = true
       end
-      @lock_open = true
     end
 
     def release_lock
@@ -151,11 +157,11 @@ module TestIds
       write('lock.json', JSON.pretty_generate(data))
     end
 
-    def available_to_lock?
+    def available_to_lock?(repo_to_use)
       result = false
       Origen.profile 'Checking for lock' do
-        repo.fetch
-        repo.reset_hard('origin/master')
+        repo_to_use.fetch
+        repo_to_use.reset_hard('origin/master')
         if lock_content && lock_user && lock_user != User.current.name
           result = Time.now.to_f > lock_expires
         else

data/lib/test_ids.rb

@@ -239,10 +239,78 @@ module TestIds
       @publish = val ? :save : :dont_save
     end
 
+    def lsf_manual_init_shutdown
+      if @lsf_manual_init_shutdown
+        true
+      end
+      false
+    end
+
     def next_in_range(range, options)
       current_configuration.allocator.next_in_range(range, options)
     end
 
+    def lsf_init(git_repo, lsf_publish)
+      @lsf_manual_init_shutdown = true
+      local_var_git_database_dir = "#{Origen.app.imports_directory}/test_ids/#{Pathname.new(git_repo).basename}"
+      FileUtils.mkdir_p(local_var_git_database_dir)
+      unless File.exist?("#{local_var_git_database_dir}/.git")
+        FileUtils.rm_rf(local_var_git_database_dir) if File.exist?(local_var_git_database_dir)
+        FileUtils.mkdir_p(local_var_git_database_dir)
+        Dir.chdir local_var_git_database_dir do
+          `git clone #{git_repo} .`
+          unless File.exist?('lock.json')
+            # Should really try to use the Git driver for this
+            exec 'touch lock.json'
+            exec 'git add lock.json'
+            exec 'git commit -m "Initial commit"'
+            exec 'git push'
+          end
+        end
+      end
+      @local = local_var_git_database_dir
+      @repo = ::Git.open(local_var_git_database_dir)
+      # Get rid of any local edits coming in here, this is only called once at the start
+      # of the program generation run.
+      # No need to pull latest as that will be done when we obtain a lock.
+      @repo.reset_hard
+      @git = Git.new(local: local_var_git_database_dir, remote: @repo)
+      if lsf_publish
+        return if @lock_open
+        Origen.profile 'Obtaining test IDs lock' do
+          until @git.available_to_lock?(@repo)
+            puts
+            puts "Waiting for lock, currently locked by #{@git.lock_user} (the lock will expire in less than #{@git.lock_minutes_remaining} #{'minute'.pluralize(@git.lock_minutes_remaining)} if not released before that)"
+            puts
+            sleep 5
+          end
+          data = {
+            'user'    => User.current.name,
+            'expires' => (Time.now + @git.minutes(5)).to_f
+          }
+          @git.write('lock.json', JSON.pretty_generate(data))
+          repo.commit('Obtaining lock')
+          repo.push('origin')
+        end
+        @lock_open = true
+      end
+    end
+
+    def lsf_shutdown(lsf_publish)
+      if lsf_publish
+        Origen.profile 'Publishing the test IDs store' do
+          data = {
+            'user'    => nil,
+            'expires' => nil
+          }
+          @git.write('lock.json', JSON.pretty_generate(data))
+          repo.add  # Checkin everything
+          repo.commit('Publishing latest store')
+          repo.push('origin', 'master', force: true)
+        end
+      end
+    end
+
     ## When set to true, all numbers generated will be checked to see if they comply
     ## with the current configuration, and if not they will be re-assigned based on the
     ## current configuration
@@ -257,6 +325,24 @@ module TestIds
     #  @reallocate_non_compliant = val
     # end
 
+    # Reset everything related to the TestIds module
+    # only needed for cases where running several targets
+    # back to back, e.g. for regression testing
+    def reset_everything(are_you_sure: false)
+      if are_you_sure
+        @repo = nil   # accessor
+        @git = nil   # accessor
+        @git_database_dir = nil
+        @git_initialized = nil
+        @configuration = nil
+        @configuration_id = nil
+        @bin_config = nil
+        @softbin_config = nil
+        @number_config = nil
+        @publish = nil
+      end
+    end
+
     private
 
     def on_origen_shutdown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_ids
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,14 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.40
+        version: 0.57.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.40
+        version: 0.57.0
+- !ruby/object:Gem::Dependency
+  name: dentaku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: origen_testers
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.31
 signing_key: 
 specification_version: 4
 summary: Origen plugin to assign and track test program bins and test numbers