test_ids 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7349366c381561bec8b1fc71f12f322ab443b50e
-  data.tar.gz: be512c9947423b3f8f5466ad0ea769e390789a31
+  metadata.gz: 3187c134f83d0e5a9c3513027fb2c1bad26a1b12
+  data.tar.gz: 8d265c7f97de0eb22d62efff091a0974fc5e0482
 SHA512:
-  metadata.gz: b6eca8998668fda629296815c729d9a3b519b8b00b1a834223894862437ec665d6db005d93d853193c11101a0c07675dfab89f2e390c06b6228e3a3a21373316
-  data.tar.gz: a392383d2fff3e4ea061c72710e04e7667a5b36894e89cd987ce9c524e6a8ffa8ec64ef9c7bc47550049f3d1536e5c2998ff1eb80b09cb1f172134e6181b4bc0
+  metadata.gz: f30d12207607a2eac1335af1f9e4e4e37854dbd36aea7647c79e74cb68e3c1810d7cdbe5d4174f2c52ac8e7081ad3b96119cb8f3386d314d4966672fac29b9ce
+  data.tar.gz: 2d0347b9c85d6edec9f36be9994639916f1a6eb0447a9ab5bbc5f98b48b0f9d54d565e7aca366fa1edbea7f13f3a1ea41a530d717586b1e8bc1d911e143cf659

data/config/shared_commands.rb

@@ -3,14 +3,21 @@ case @command
 
 when "test_ids:rollback"
   if ARGV[0]
-    TestIds::Git.rollback(ARGV[0])
+    local = TestIds::Git.path_to_local
+    TestIds::Git.new(local: local).rollback(ARGV[0])
   else
     puts "You must supply a commit ID to rollback to, e.g. origen test_ids:rollback 456ac3f53"
   end
   exit 0
+
+when "test_ids:clear"
+  require "test_ids/commands/#{@command.split(':').last}"
+  exit 0
+
 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
   EOT
 
 end

data/config/version.rb

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

data/lib/test_ids.rb

@@ -6,17 +6,13 @@ module TestIds
   # THIS FILE SHOULD ONLY BE USED TO LOAD RUNTIME DEPENDENCIES
   # If this plugin has any development dependencies (e.g. dummy DUT or other models that are only used
   # for testing), then these should be loaded from config/boot.rb
-
-  # Example of how to explicitly require a file
-  # require "test_ids/my_file"
-
-  # Load all files in the lib/test_ids directory.
-  # Note that there is no problem from requiring a file twice (Ruby will ignore
-  # the second require), so if you have a file that must be required first, then
-  # explicitly require it up above and then let this take care of the rest.
-  Dir.glob("#{File.dirname(__FILE__)}/test_ids/**/*.rb").sort.each do |file|
-    require file
-  end
+  require 'test_ids/allocator'
+  require 'test_ids/bin_array'
+  require 'test_ids/configuration'
+  require 'test_ids/git'
+  require 'test_ids/shutdown_handler'
+  require 'test_ids/origen/origen'
+  require 'test_ids/origen_testers/flow'
 
   class <<self
     # Allocates a number to the given test and returns a new hash containing
@@ -34,6 +30,12 @@ module TestIds
       }
     end
 
+    # Load an existing allocator, which will be loaded with an empty configuration
+    # @api internal
+    def load_allocator(id = nil)
+      Configuration.new(id).allocator
+    end
+
     def current_configuration
       configuration(@configuration_id)
     end
@@ -64,6 +66,27 @@ module TestIds
       initialize_git
     end
 
+    ## Can be called in place of TestIDs.configure to change the configuration from
+    ## the one that was originally supplied.
+    ## It is expected that this is mainly useful for testing purposes only.
+    # def reconfigure(id = nil, options = {}, &block)
+    #  id, options = nil, id if id.is_a?(Hash)
+
+    #  @configuration_id = id || options[:id] || :not_specified
+
+    #  @configuration ||= {}
+
+    #  old = @configuration[@configuration_id]
+    #  new = Configuration.new(@configuration_id)
+    #  new.instance_variable_set('@allocator', old.allocator)
+    #  new.allocator.instance_variable_set('@config', new)
+    #  @configuration[@configuration_id] =  new
+
+    #  yield new
+
+    #  new.validate!
+    # end
+
     def configured?
       !!@configuration_id
     end
@@ -82,7 +105,7 @@ module TestIds
     # git storage has not been enabled
     def database_file(id)
       if repo
-        if id == :not_specified
+        if id == :not_specified || !id || id == ''
           f = 'store.json'
         else
           f = "store_#{id.to_s.downcase}.json"
@@ -136,6 +159,20 @@ module TestIds
       @publish = val ? :save : :dont_save
     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
+    # def reallocate_non_compliant
+    #  @reallocate_non_compliant
+    # 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
+    # def reallocate_non_compliant=(val)
+    #  @reallocate_non_compliant = val
+    # end
+
     private
 
     def on_origen_shutdown

data/lib/test_ids/allocator.rb

@@ -16,6 +16,7 @@ module TestIds
     # Main method to inject generated bin and test numbers, the given
     # options instance is modified accordingly
     def allocate(instance, options)
+      orig_options = options.dup
       clean(options)
       @callbacks = []
       name = extract_test_name(instance, options)
@@ -93,10 +94,19 @@ module TestIds
       # Otherwise generate the missing ones
       bin['number'] ||= allocate_bin(size: bin_size)
       bin['size'] ||= bin_size
-      softbin['number'] ||= allocate_softbin(bin: bin['number'], size: softbin_size)
-      softbin['size'] ||= softbin_size
-      number['number'] ||= allocate_number(bin: bin['number'], softbin: softbin['number'], size: number_size)
-      number['size'] ||= number_size
+      # If the softbin is based on the test number, then need to calculate the
+      # test number first
+      if config.softbins.algorithm && config.softbins.algorithm.to_s =~ /n/
+        number['number'] ||= allocate_number(bin: bin['number'], size: number_size)
+        number['size'] ||= number_size
+        softbin['number'] ||= allocate_softbin(bin: bin['number'], number: number['number'], size: softbin_size)
+        softbin['size'] ||= softbin_size
+      else
+        softbin['number'] ||= allocate_softbin(bin: bin['number'], size: softbin_size)
+        softbin['size'] ||= softbin_size
+        number['number'] ||= allocate_number(bin: bin['number'], softbin: softbin['number'], size: number_size)
+        number['size'] ||= number_size
+      end
 
       # Record that there has been a reference to the final numbers
       time = Time.now.to_f
@@ -123,6 +133,18 @@ module TestIds
         options[:number] = number['number']
         options[:number_size] = number['size']
       end
+
+      ## If reallocation is on, then check if the generated numbers are compliant, if not
+      ## clear them and go back around again to generate a new set
+      # if TestIds.reallocate_non_compliant
+      #  if !config.bins.function?
+      #    if !config.bins.compliant?(options[:bin])
+      #      store["assigned"]["bin"].delete(bin_id)
+      #      return allocate(instance, orig_options)
+      #    end
+      #  end
+      # end
+
       options
     end
 
@@ -162,6 +184,28 @@ module TestIds
       end
     end
 
+    # Clear the :bins, :softbins and/or :numbers by setting the options for each item to true
+    def clear(options)
+      if options[:softbin] || options[:softbins]
+        store['assigned']['softbin'] = {}
+        store['manually_assigned']['softbin'] = {}
+        store['pointers']['softbin'] = nil
+        store['references']['softbin'] = {}
+      end
+      if options[:bin] || options[:bins]
+        store['assigned']['bin'] = {}
+        store['manually_assigned']['bin'] = {}
+        store['pointers']['bin'] = nil
+        store['references']['bin'] = {}
+      end
+      if options[:number] || options[:numbers]
+        store['assigned']['number'] = {}
+        store['manually_assigned']['number'] = {}
+        store['pointers']['number'] = nil
+        store['references']['number'] = {}
+      end
+    end
+
     # Saves the current allocator state to the repository
     def save
       if file
@@ -220,19 +264,28 @@ module TestIds
 
     def allocate_softbin(options)
       bin = options[:bin]
+      num = options[:number]
       return nil if config.softbins.empty?
       if config.softbins.algorithm
         algo = config.softbins.algorithm.to_s.downcase
-        if algo.to_s =~ /^[b\dx]+$/
+        if algo.to_s =~ /^[b\dxn]+$/
           number = algo.to_s
           bin = bin.to_s
           if number =~ /(b+)/
             max_bin_size = Regexp.last_match(1).size
             if bin.size > max_bin_size
-              fail "Bin number (#{bin}) overflows the test number algorithm (#{algo})"
+              fail "Bin number (#{bin}) overflows the softbin number algorithm (#{algo})"
             end
             number = number.sub(/b+/, bin.rjust(max_bin_size, '0'))
           end
+          if number =~ /(n+)/
+            num = num.to_s
+            max_num_size = Regexp.last_match(1).size
+            if num.size > max_num_size
+              fail "Test number (#{num}) overflows the softbin number algorithm (#{algo})"
+            end
+            number = number.sub(/n+/, num.rjust(max_num_size, '0'))
+          end
           if number =~ /(x+)/
             max_counter_size = Regexp.last_match(1).size
             refs = store['references']['softbin']

data/lib/test_ids/commands/clear.rb

@@ -0,0 +1,52 @@
+require 'optparse'
+
+options = {}
+
+# App options are options that the application can supply to extend this command
+app_options = @application_options || []
+opt_parser = OptionParser.new do |opts|
+  opts.banner = <<-EOT
+Clear all existing bin, softbin or test number allocations in the given TestId database.
+
+Usage: origen test_ids:clear [ID] [options]
+
+Examples: origen test_ids:clear --bins                      # Clear the bins in the default database
+          origen test_ids:clear wafer_test --numbers        # Clear the test numbers in the wafer_test database
+          origen test_ids:clear --bins --softbin --numbers  # Clear everything in the default database
+
+  EOT
+  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('-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|
+    opts.on(*app_option) {}
+  end
+  opts.separator ''
+  opts.on('-h', '--help', 'Show this message') { puts opts; exit 0 }
+end
+
+opt_parser.parse! ARGV
+
+local = TestIds::Git.path_to_local
+git = TestIds::Git.new(local: local)
+TestIds.repo = git.repo.remote.url
+git.get_lock
+rollback_id = nil
+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)
+  a.clear(options)
+  a.save
+ensure
+  git.publish
+end
+if rollback_id
+  puts
+  puts 'TestIDs database cleared as requested, you can rollback this change by running:'
+  puts
+  puts "   origen test_ids:rollback #{rollback_id}"
+  puts
+end

data/lib/test_ids/configuration.rb

@@ -25,6 +25,9 @@ module TestIds
         !!algorithm || !!callback
       end
 
+      # def compliant?(number)
+      # end
+
       def freeze
         @include.freeze
         @exclude.freeze

data/lib/test_ids/git.rb

@@ -14,10 +14,11 @@ module TestIds
 
     attr_reader :repo, :local
 
-    class Rollback
+    # @api private
+    class PathToLocal
       include Origen::Utility::InputCapture
 
-      def initialize(id)
+      def find
         repos = Dir.glob("#{Origen.app.imports_dir}/test_ids/*.git")
         if repos.size == 0
           puts 'No TestIds repositories were found in this application'
@@ -37,37 +38,15 @@ module TestIds
         else
           selection = 0
         end
-        name = Pathname.new(repos[selection]).basename.to_s
-        repo = ::Git.open(repos[selection])
-        begin
-          commit = repo.object(id)
-        rescue ::Git::GitExecuteError
-          puts 'The given commit ID cannot be found in that repository'
-          exit
-        end
-        day = 24 * 60 * 60
-        if commit.date < Time.now - (7 * day)
-          puts "Sorry, that commit is more than a week old and I'm too scared to rollback that far."
-          puts 'You will need to do that manually if you must.'
-          exit
-        end
-        puts
-        puts "About to rollback the TestIds repository #{name} to commit #{id}."
-        puts
-        puts 'This will permanently delete any IDs assigned by anyone, anywhere, since that commit.'
-        puts
-        puts 'ARE YOU SURE YOU KNOW WHAT YOU ARE DOING?'
-        puts
-        get_text(confirm: true, default: 'no')
-        repo.reset_hard(id)
-        repo.push('origin', 'master', force: true)
-        puts 'As you wish, rolled back successfully!'
+        repos[selection]
       end
     end
 
-    def self.rollback(id)
+    # Returns a path to the local test IDs repo, if multiple are found the user will be
+    # prompted to choose one
+    def self.path_to_local
       # Implemented as a class as a hack to get access to InputCapture
-      Rollback.new(id)
+      PathToLocal.new.find
     end
 
     def initialize(options)
@@ -93,6 +72,34 @@ module TestIds
       @repo.reset_hard
     end
 
+    # Roll the repo back to the given commit ID
+    def rollback(id)
+      name = Pathname.new(local).basename.to_s
+      begin
+        commit = repo.object(id)
+      rescue ::Git::GitExecuteError
+        puts 'The given commit ID cannot be found in that repository'
+        exit
+      end
+      # day = 24 * 60 * 60
+      # if commit.date < Time.now - (7 * day)
+      #  puts "Sorry, that commit is more than a week old and I'm too scared to rollback that far."
+      #  puts 'You will need to do that manually if you must.'
+      #  exit
+      # end
+      puts
+      puts "About to rollback the TestIds repository #{name} to commit #{id}."
+      puts
+      puts 'This will permanently delete any IDs assigned by anyone, anywhere, since that commit.'
+      puts
+      puts 'ARE YOU SURE YOU KNOW WHAT YOU ARE DOING?'
+      puts
+      get_text(confirm: true, default: 'no')
+      repo.reset_hard(id)
+      repo.push('origin', 'master', force: true)
+      puts 'As you wish, rolled back successfully!'
+    end
+
     def exec(cmd)
       r = system(cmd)
       unless r

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_ids
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -68,6 +68,7 @@ files:
 - lib/test_ids.rb
 - lib/test_ids/allocator.rb
 - lib/test_ids/bin_array.rb
+- lib/test_ids/commands/clear.rb
 - lib/test_ids/configuration.rb
 - lib/test_ids/git.rb
 - lib/test_ids/origen/origen.rb