test_ids 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37097520304a42cec66a48fdac2b192dda5451b0
-  data.tar.gz: 6df4dd37ea78ec47a562f03a72f0503f37d304b0
+  metadata.gz: 32e0f28dcb31510be128dc89738ae51f437217bc
+  data.tar.gz: 3cbdd628afd3537d092e2ef60518a45342367e63
 SHA512:
-  metadata.gz: 6609ad85bed7091b9b647a3ac24551b245a253b965d6ca2f99f99342da53f871af220a721d940269e2886d4111058938b4b3ee10a166180efcf5af00c7559214
-  data.tar.gz: e3ab6e8d0ae659f2c6845032b8f021dd414a4c671778dfb61933c90dbf1f12573a09795368270827073c76c7e49536e21f9fe811ab4b947ca2e56b8f23f04d04
+  metadata.gz: 86e9efb2f2b12789ace7a19180235128c926faff668483ce1c359aa1d6133aa85df2a0b018f0355f268c49fd3bb8001bdb5410ceb5ef1cd4354fbff997be23ac
+  data.tar.gz: b5edb4c6e60077a18ef9e1d5d4b26f2970c4c0ab236e2fb269f4bcfcaec36a1c7838124ba94d9b8eb4a9110890b19b590d3cad8d120ae3927711ce647437140a

data/config/version.rb

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

data/lib/test_ids/allocator.rb

@@ -1,20 +1,19 @@
 module TestIds
+  # The allocator is responsible for assigning new numbers and keeping a record of
+  # existing assignments.
+  #
+  # There is one allocator instance per configuration, and each has its own database
+  # file.
   class Allocator
-    include Origen::Callbacks
     attr_reader :config
 
-    def initialize
-      @@allocators ||= 0
-      @@allocators += 1
-      if @@allocators > 1 && !TestIds.send(:testing?)
-        fail 'TestIds::Allocators is a singleton, there can be only one'
-      end
+    def initialize(configuration)
+      @config = configuration
     end
 
     # Main method to inject generated bin and test numbers, the given
     # options instance is modified accordingly
     def allocate(instance, options)
-      @changes_made = true
       clean(options)
       @callbacks = []
       name = extract_test_name(instance, options)
@@ -65,10 +64,6 @@ module TestIds
       options
     end
 
-    def config
-      TestIds.config
-    end
-
     def store
       @store ||= begin
         s = JSON.load(File.read(file)) if file && File.exist?(file)
@@ -96,40 +91,14 @@ module TestIds
       end
     end
 
-    def on_origen_shutdown
-      unless TestIds.send(:testing?)
-        if config.repo && @changes_made && config.on_completion != :discard
-          save
-          git.publish if publish?
-        end
-      end
-    end
-
-    # Returns a path to the file that will be used to store the allocated bins/numbers.
-    # If config.repo has not been set it returns nil.
+    # Returns a path to the file that will be used to store the allocated bins/numbers,
+    # returns nil if remote storage not enabled
     def file
-      if config.repo
-        @file ||= begin
-          if git?
-            dir = "#{Origen.app.imports_directory}/test_ids/#{Pathname.new(config.repo).basename}"
-            FileUtils.mkdir_p(dir)
-            "#{dir}/store.json"
-          else
-            config.repo
-          end
-        end
-      end
+      TestIds.database_file(id)
     end
 
-    def git
-      @git ||= Git.new(local: Pathname.new(file).dirname, remote: config.repo, no_pull: publish?)
-    end
-
-    def prepare
-      if git?
-        git # Pulls the latest repo
-        git.get_lock if publish?
-      end
+    def id
+      config.id
     end
 
     private

data/lib/test_ids/configuration.rb

@@ -31,18 +31,15 @@ module TestIds
       end
     end
 
-    attr_accessor :repo
-    attr_reader :on_completion
+    attr_reader :allocator
 
-    def on_completion
-      @on_completion || :publish
+    def initialize(id)
+      @id = id
+      @allocator = Allocator.new(self)
     end
 
-    def on_completion=(val)
-      unless %w(publish save discard).include?(val.to_s)
-        fail 'on_completion must be set to one of: :publish, :save, :discard'
-      end
-      @on_completion = val.to_sym
+    def id
+      @id
     end
 
     def bins

data/lib/test_ids/git.rb

@@ -18,10 +18,10 @@ module TestIds
         FileUtils.mkdir_p(options[:local])
         Dir.chdir options[:local] do
           `git clone #{options[:remote]} .`
-          if !File.exist?('store.json') || !File.exist?('lock.json')
+          unless File.exist?('lock.json')
             # Should really try to use the Git driver for this
-            exec 'touch store.json lock.json'
-            exec 'git add store.json lock.json'
+            exec 'touch lock.json'
+            exec 'git add lock.json'
             exec 'git commit -m "Initial commit"'
             exec 'git push'
           end
@@ -29,8 +29,10 @@ module TestIds
       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
-      @repo.pull unless options[:no_pull]
     end
 
     def exec(cmd)
@@ -41,10 +43,12 @@ module TestIds
     end
 
     def publish
-      write('store.json')
-      release_lock
-      repo.commit('Publishing latest store')
-      repo.push('origin')
+      Origen.profile 'Publishing the test IDs store' do
+        release_lock
+        repo.add  # Checkin everything
+        repo.commit('Publishing latest store')
+        repo.push('origin')
+      end
     end
 
     # Writes the data to the given file and pushes to the remote repo
@@ -55,17 +59,21 @@ module TestIds
     end
 
     def get_lock
-      until available_to_lock?
-        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)"
-        sleep 5
+      return if @lock_open
+      Origen.profile 'Obtaining test IDs lock' do
+        until available_to_lock?
+          Origen.log "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)"
+          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
 
     def release_lock
@@ -76,20 +84,17 @@ module TestIds
       write('lock.json', JSON.pretty_generate(data))
     end
 
-    def with_lock
-      get_lock
-      yield
-    ensure
-      release_lock
-    end
-
     def available_to_lock?
-      repo.pull
-      if lock_content && lock_user && lock_user != User.current.name
-        Time.now.to_f > lock_expires
-      else
-        true
+      result = false
+      Origen.profile 'Checking for lock' do
+        repo.pull
+        if lock_content && lock_user && lock_user != User.current.name
+          result = Time.now.to_f > lock_expires
+        else
+          result = true
+        end
       end
+      result
     end
 
     def lock_minutes_remaining

data/lib/test_ids/origen/origen.rb

@@ -0,0 +1,12 @@
+require 'origen'
+module Origen
+  class <<self
+    # Override the Origen.reset_interface method to clear out the TestIds
+    # configuration, so that it doesn't carry over from one flow to the next
+    alias_method :_orig_reset_interface, :reset_interface
+    def reset_interface(options = {})
+      TestIds.send(:clear_configuration_id)
+      _orig_reset_interface(options)
+    end
+  end
+end

data/lib/test_ids/origen_testers/flow.rb

@@ -5,8 +5,8 @@ module OrigenTesters
     # test numbers
     alias_method :_orig_test, :test
     def test(instance, options = {})
-      unless TestIds.config.empty?
-        TestIds.allocator.allocate(instance, options)
+      if TestIds.configured?
+        TestIds.current_configuration.allocator.allocate(instance, options)
       end
       _orig_test(instance, options)
     end

data/lib/test_ids/shutdown_handler.rb

@@ -0,0 +1,12 @@
+module TestIds
+  class ShutdownHandler
+    include Origen::PersistentCallbacks
+
+    def on_origen_shutdown
+      TestIds.send(:on_origen_shutdown)
+    end
+  end
+  # Instantiate an instance of this class immediately when this file is loaded, this object will
+  # then listen for the remainder of the Origen thread
+  ShutdownHandler.new
+end

data/lib/test_ids.rb

@@ -19,52 +19,136 @@ module TestIds
   end
 
   class <<self
-    def store
-      unless @configuration
-        fail 'The test ID generator has to be configured before you can start using it'
-      end
-      @store ||= Store.new
+    def current_configuration
+      configuration(@configuration_id)
+    end
+
+    def configuration(id)
+      return @configuration[id] if @configuration && @configuration[id]
+      fail('You have to create the configuration first before you can access it')
+    end
+    alias_method :config, :configuration
+
+    def configure(id = nil, options = {})
+      id, options = nil, id if id.is_a?(Hash)
+
+      @configuration_id = id || options[:id] || :not_specified
+
+      @configuration ||= {}
+
+      return if @configuration[@configuration_id]
+
+      @configuration[@configuration_id] = Configuration.new(@configuration_id)
+
+      config = @configuration[@configuration_id]
+
+      yield config
+
+      config.validate!
+
+      initialize_git
+    end
+
+    def configured?
+      !!@configuration_id
     end
 
-    def allocator
-      unless @configuration
-        fail 'The test ID generator has to be configured before you can start using it'
+    def initialize_git
+      @git_initialized ||= begin
+        if repo
+          @git = Git.new(local: git_database_dir, remote: repo)
+          git.get_lock if on_completion == :save
+        end
+        true
       end
-      @allocator ||= Allocator.new
     end
 
-    def configuration
-      if block_given?
-        configure do |config|
-          yield config
+    # Returns a full path to the database file for the given id, returns nil if
+    # git storage has not been enabled
+    def database_file(id)
+      if repo && on_completion == :save
+        if id == :not_specified
+          f = 'store.json'
+        else
+          f = "store_#{id.to_s.downcase}.json"
         end
-      else
-        @configuration ||
-          fail('You have to create the configuration first before you can access it')
+        "#{git_database_dir}/#{f}"
       end
     end
-    alias_method :config, :configuration
 
-    def configure
+    def git_database_dir
+      @git_database_dir ||= begin
+        d = "#{Origen.app.imports_directory}/test_ids/#{Pathname.new(repo).basename}"
+        FileUtils.mkdir_p(d)
+        d
+      end
+    end
+
+    def git
+      @git
+    end
+
+    def repo=(val)
+      return if @repo && @repo == val
+      if @repo && @repo != val
+        fail 'You can only use a single test ids repository per program generation run, one per application is recommended'
+      end
+      if @configuration
+        fail 'TestIds.repo must be set before creating the first configuration'
+      end
+      @repo = val
+    end
+
+    def repo
+      @repo
+    end
+
+    # Returns what should be done with the database for the given configuration
+    # at the end, :save (the default) or :discard.
+    #
+    # If a repo has not been specified, then this attribute has no effect and the
+    # data will always be discarded.
+    def on_completion
+      @on_completion || :save
+    end
+
+    def on_completion=(val)
+      return if @on_completion && @on_completion == val
+      if @on_completion && @on_completion != val
+        fail 'You can only use a single setting for on_completion per program generation run'
+      end
       if @configuration
-        fail "You can't modify an existing test IDs configuration"
+        fail 'TestIds.on_completion must be set before creating the first configuration'
       end
-      @configuration = Configuration.new
-      yield @configuration
-      @configuration.validate!
-      allocator.prepare
+      unless %w(save discard).include?(val.to_s)
+        fail 'on_completion must be set to either :save or :discard'
+      end
+      @on_completion = val.to_sym
     end
 
     private
 
+    def on_origen_shutdown
+      unless testing?
+        if repo && on_completion == :save
+          @configuration.each do |id, config|
+            config.allocator.save
+          end
+          git.publish
+        end
+      end
+    end
+
     # For testing, clears all instances including the configuration
     def reset
       @git = nil
-      @store = nil
-      @allocator = nil
       @configuration = nil
     end
 
+    def clear_configuration_id
+      @configuration_id = nil
+    end
+
     def testing=(val)
       @testing = val
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_ids
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -69,7 +69,9 @@ files:
 - lib/test_ids/bin_array.rb
 - lib/test_ids/configuration.rb
 - lib/test_ids/git.rb
+- lib/test_ids/origen/origen.rb
 - lib/test_ids/origen_testers/flow.rb
+- lib/test_ids/shutdown_handler.rb
 - lib/test_ids_dev/dut.rb
 - lib/test_ids_dev/interface.rb
 - program/prb1.rb
@@ -96,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Origen plugin to assign and track test program bins and test numbers