Class: TestIds::Allocator

Inherits:
Object
  • Object
show all
Defined in:
lib/test_ids/allocator.rb

Overview

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.

Constant Summary collapse

STORE_FORMAT_REVISION = 
2

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ Allocator

Returns a new instance of Allocator.



11
12
13
 
# File 'lib/test_ids/allocator.rb', line 11

def initialize(configuration)
  @config = configuration
end

Instance Method Details

#allocate(instance, options) ⇒ Object

Main method to inject generated bin and test numbers, the given options instance is modified accordingly



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/test_ids/allocator.rb', line 143

def allocate(instance, options)
  orig_options = options.dup
  clean(options)
  name = extract_test_name(instance, options)

  nones = []

  # Record any :nones that are present for later
  [:bin, :softbin, :number].each do |type|
    nones << type if options[type] == :none
    config(type).allocator.instance_variable_set('@needs_regenerated', {})
  end

  allocation_order(options).each do |type|
    config(type).allocator.send(:_allocate, type, name, options)
  end

  # Turn any :nones into nils in the returned options
  nones.each do |type|
    options[type] = nil
    options["#{type}_size"] = nil
  end

  options
end

#allocation_order(options) ⇒ Object

Returns an array containing :bin, :softbin, :number in the order that they should be calculated in order to fulfil the requirements of the current configuration and the given options. If an item is not required (e.g. if set to :none in the options), then it will not be present in the array.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/test_ids/allocator.rb', line 100

def allocation_order(options)
  items = []
  items_required = 0
  if allocation_required?(:bin, options) ||
     (allocation_required?(:softbin, options) && config(:softbin).softbins.needs?(:bin)) ||
     (allocation_required?(:number, options) && config(:number).numbers.needs?(:bin))
    items_required += 1
  else
    bin_done = true
  end
  if allocation_required?(:softbin, options) ||
     (allocation_required?(:bin, options) && config(:bin).bins.needs?(:softbin)) ||
     (allocation_required?(:number, options) && config(:number).numbers.needs?(:softbin))
    items_required += 1
  else
    softbin_done = true
  end
  if allocation_required?(:number, options) ||
     (allocation_required?(:bin, options) && config(:bin).bins.needs?(:number)) ||
     (allocation_required?(:softbin, options) && config(:softbin).softbins.needs?(:number))
    items_required += 1
  else
    number_done = true
  end
  items_required.times do |i|
    if !bin_done && (!config(:bin).bins.needs?(:softbin) || softbin_done) && (!config(:bin).bins.needs?(:number) || number_done)
      items << :bin
      bin_done = true
    elsif !softbin_done && (!config(:softbin).softbins.needs?(:bin) || bin_done) && (!config(:softbin).softbins.needs?(:number) || number_done)
      items << :softbin
      softbin_done = true
    elsif !number_done && (!config(:number).numbers.needs?(:bin) || bin_done) && (!config(:number).numbers.needs?(:softbin) || softbin_done)
      items << :number
      number_done = true
    else
      fail "Couldn't work out whether to generate next on iteration #{i} of #{items_required}, already picked: #{items}"
    end
  end
  items
end

#clear(options) ⇒ Object

Clear the :bins, :softbins and/or :numbers and/or :ranges by setting the options for each item



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/test_ids/allocator.rb', line 300

def clear(options)
  if options[:softbin] || options[:softbins]
    store['assigned']['softbins'] = {}
    store['manually_assigned']['softbins'] = {}
    store['pointers']['softbins'] = nil
    store['references']['softbins'] = {}
  end
  if options[:bin] || options[:bins]
    store['assigned']['bins'] = {}
    store['manually_assigned']['bins'] = {}
    store['pointers']['bins'] = nil
    store['references']['bins'] = {}
  end
  if options[:number] || options[:numbers]
    store['assigned']['numbers'] = {}
    store['manually_assigned']['numbers'] = {}
    store['pointers']['numbers'] = nil
    store['references']['numbers'] = {}
  end
  if options[:range] || options[:ranges]
    store['pointers']['ranges'] = nil
  end
end

#config(type = nil) ⇒ Object 



15
16
17
18
19
20
21
22
23
 
# File 'lib/test_ids/allocator.rb', line 15

def config(type = nil)
  if type
    type = type.to_s
    type.chop! if type[-1] == 's'
    TestIds.send("#{type}_config") || @config
  else
    @config
  end
end

#file ⇒ Object

Returns a path to the file that will be used to store the allocated bins/numbers, returns nil if remote storage not enabled



367
368
369
 
# File 'lib/test_ids/allocator.rb', line 367

def file
  TestIds.database_file(id)
end

#id ⇒ Object 



371
372
373
 
# File 'lib/test_ids/allocator.rb', line 371

def id
  config.id
end

#load_configuration_from_store ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



376
377
378
 
# File 'lib/test_ids/allocator.rb', line 376

def load_configuration_from_store
  config.load_from_serialized(store['configuration']) if store['configuration']
end

#merge_store(other_store) ⇒ Object

Merge the given other store into the current one, it is assumed that both are formatted from the same (latest) revision



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/test_ids/allocator.rb', line 171

def merge_store(other_store)
  store['pointers'] = store['pointers'].merge(other_store['pointers'])
  @last_bin = store['pointers']['bins']
  @last_softbin = store['pointers']['softbins']
  @last_number = store['pointers']['numbers']
  store['assigned']['bins'] = store['assigned']['bins'].merge(other_store['assigned']['bins'])
  store['assigned']['softbins'] = store['assigned']['softbins'].merge(other_store['assigned']['softbins'])
  store['assigned']['numbers'] = store['assigned']['numbers'].merge(other_store['assigned']['numbers'])
  store['manually_assigned']['bins'] = store['manually_assigned']['bins'].merge(other_store['manually_assigned']['bins'])
  store['manually_assigned']['softbins'] = store['manually_assigned']['softbins'].merge(other_store['manually_assigned']['softbins'])
  store['manually_assigned']['numbers'] = store['manually_assigned']['numbers'].merge(other_store['manually_assigned']['numbers'])
  store['references']['bins'] = store['references']['bins'].merge(other_store['references']['bins'])
  store['references']['softbins'] = store['references']['softbins'].merge(other_store['references']['softbins'])
  store['references']['numbers'] = store['references']['numbers'].merge(other_store['references']['numbers'])
end

#next_in_range(range_definition, options) ⇒ Object

Allocates a softbin number from the range specified in the test flow It also keeps a track of the last softbin assigned out from a particular range and uses that to increment the pointers accordingly. 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. This will handle the following range inputs:

- Range, Ex: 0..10
- Array, Ex: [0..10, 20..30]



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/test_ids/allocator.rb', line 34

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

#range_item(range, range_definition, options) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/test_ids/allocator.rb', line 50

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?
    rangehash = {}
  else
    rangehash = store['pointers']['ranges']
    rangehash = Hash[rangehash.map { |k, v| [k.to_sym, v] }]
  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_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_definition}"].to_i
    # Now calculate the new pointer.
    @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[@pointer]
      @pointer += options[:size]
      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[@pointer]
    end
    # Now update the database pointers to point to the lastest assigned softbin for a given range.
    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_definition}" => "#{range[@pointer]}")
    assigned_value = range[@pointer]
  end
  unless !assigned_value.nil? && range.include?(assigned_value)
    Origen.log.error 'Assigned value not in range'
    fail
  end
  # Since the assigned value for this test has now changed, update store to contain the newly assigned value
  # so that when the json file is written, it contains the latest assigned value name.
  store['pointers']['ranges'] = rangehash
  assigned_value
end

#repair(options = {}) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/test_ids/allocator.rb', line 242

def repair(options = {})
  #####################################################################
  # Add any numbers that are missing from the references pool if the
  # allocator has moved onto the reclamation phase
  #####################################################################
  { 'bins' => 'bins', 'softbins' => 'softbins', 'numbers' => 'test_numbers' }.each do |type, name|
    if !config.send(type).function? && store['pointers'][type] == 'done'
      Origen.log.info "Checking for missing #{name}..."
      recovered = add_missing_references(config.send, store['references'][type])
      if recovered == 0
        Origen.log.info "  All #{name} are already available."
      else
        Origen.log.success "  Another #{recovered} #{name} have been made available!"
      end
    end
  end

  #####################################################################
  # Check that all assignments are valid based on the current config,
  # if not remove them and they will be re-allocated next time
  #####################################################################
  { 'bins' => 'bins', 'softbins' => 'softbins', 'numbers' => 'test_numbers' }.each do |type, name|
    next if config.send(type).function?
    Origen.log.info "Checking all #{name} assignments are valid..."
    also_remove_from = []
    if type == 'bin'
      also_remove_from << store['assigned']['softbins'] if config.softbins.function?
      also_remove_from << store['assigned']['numbers'] if config.numbers.function?
    elsif type == 'softbin'
      also_remove_from << store['assigned']['numbers'] if config.numbers.function?
    else
      also_remove_from << store['assigned']['softbins'] if config.softbins.function?
    end
    removed = remove_invalid_assignments(config.send(type), store['assigned'][type], store['manually_assigned'][type], also_remove_from)
    if removed == 0
      Origen.log.info "  All #{name} assignments are already valid."
    else
      Origen.log.success "  #{removed} #{name} assignments have been removed!"
    end
  end

  #####################################################################
  # Check that all references are valid based on the current config,
  # if not remove them
  #####################################################################
  { 'bins' => 'bins', 'softbins' => 'softbins', 'numbers' => 'test_numbers' }.each do |type, name|
    next if config.send(type).function?
    Origen.log.info "Checking all #{name} references are valid..."
    removed = remove_invalid_references(config.send(type), store['references'][type], store['manually_assigned'][type])
    if removed == 0
      Origen.log.info "  All #{name} references are already valid."
    else
      Origen.log.success "  #{removed} #{name} references have been removed!"
    end
  end
end

#save ⇒ Object

Saves the current allocator state to the repository



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/test_ids/allocator.rb', line 325

def save
  if file
    # Ensure the current store has been loaded before we try to re-write it, this
    # is necessary if the program generator has crashed before creating a test
    store
    store['configuration'] = config
    p = Pathname.new(file)
    FileUtils.mkdir_p(p.dirname)
    File.open(p, 'w') do |f|
      f.puts '// The structure of this file is as follows:'
      f.puts '//'
      f.puts '//  {'
      f.puts '//    // A revision number used by TestIDs to identify the format of this file'
      f.puts "//    'format_revision'   => STORE_FORMAT_REVISION,"
      f.puts '//'
      f.puts '//    // Captures the configuration that was used the last time this database was updated.'
      f.puts "//    'configuration'          => { 'bins' => {}, 'softbins' => {}, 'numbers' => {} },"
      f.puts '//'
      f.puts '//    // If some number are still to be allocated, these point to the last number given out.'
      f.puts '//    // If all numbers have been allocated and we are now on the reclamation phase, the pointer'
      f.puts '//    // will contain "done".'
      f.puts "//    'pointers'          => { 'bins' => nil, 'softbins' => nil, 'numbers' => nil, 'ranges' => nil },"
      f.puts '//'
      f.puts '//    // This is the record of all numbers which have been previously assigned.'
      f.puts "//    'assigned'          => { 'bins' => {}, 'softbins' => {}, 'numbers' => {} },"
      f.puts '//'
      f.puts '//    // This is a record of any numbers which have been manually assigned.'
      f.puts "//    'manually_assigned' => { 'bins' => {}, 'softbins' => {}, 'numbers' => {} },"
      f.puts '//'
      f.puts '//    // This contains all assigned numbers with a timestamp of when they were last referenced.'
      f.puts '//    // When numbers need to be reclaimed, they will be taken from the bottom of this list, i.e.'
      f.puts '//    // the numbers which have not been used for the longest time, e.g. because the test they'
      f.puts '//    // were assigned to has since been removed.'
      f.puts "//    'references'        => { 'bins' => {}, 'softbins' => {}, 'numbers' => {} }"
      f.puts '//  }'
      f.puts JSON.pretty_generate(store)
    end
  end
end

#store ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/test_ids/allocator.rb', line 187

def store
  @store ||= begin
    if file && File.exist?(file)
      lines = File.readlines(file)
      # Remove any header comment lines since these are not valid JSON
      lines.shift while lines.first =~ /^\/\// && !lines.empty?
      s = JSON.load(lines.join("\n"))
    end
    if s
      unless s['format_revision']
        # Upgrade the original store format
        t = { 'bin' => {}, 'softbin' => {}, 'number' => {} }
        s['tests'].each do |name, numbers|
          t['bin'][name] = { 'number' => numbers['bin'], 'size' => 1 }
          t['softbin'][name] = { 'number' => numbers['softbin'], 'size' => 1 }
          t['number'][name] = { 'number' => numbers['number'], 'size' => 1 }
        end
        s = {
          'format_revision'   => 1,
          'assigned'          => t,
          'manually_assigned' => s['manually_assigned'],
          'pointers'          => s['pointers'],
          'references'        => s['references']
        }
      end
      # Change the keys to plural versions, this makes it easier to search for in the file
      # since 'number' is used within individual records
      if s['format_revision'] == 1
        s = {
          'format_revision'   => 2,
          'configuration'     => nil,
          'pointers'          => { 'bins' => s['pointers']['bin'], 'softbins' => s['pointers']['softbin'], 'numbers' => s['pointers']['number'] },
          'assigned'          => { 'bins' => s['assigned']['bin'], 'softbins' => s['assigned']['softbin'], 'numbers' => s['assigned']['number'] },
          'manually_assigned' => { 'bins' => s['manually_assigned']['bin'], 'softbins' => s['manually_assigned']['softbin'], 'numbers' => s['manually_assigned']['number'] },
          'references'        => { 'bins' => s['references']['bin'], 'softbins' => s['references']['softbin'], 'numbers' => s['references']['number'] }
        }
      end

      @last_bin = s['pointers']['bins']
      @last_softbin = s['pointers']['softbins']
      @last_number = s['pointers']['numbers']
      s
    else
      {
        'format_revision'   => STORE_FORMAT_REVISION,
        'configuration'     => nil,
        'pointers'          => { 'bins' => nil, 'softbins' => nil, 'numbers' => nil },
        'assigned'          => { 'bins' => {}, 'softbins' => {}, 'numbers' => {} },
        'manually_assigned' => { 'bins' => {}, 'softbins' => {}, 'numbers' => {} },
        'references'        => { 'bins' => {}, 'softbins' => {}, 'numbers' => {} }
      }
    end
  end
end