Class: Athenian::CodeCheckRunStatistics

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/models/code_check_run_statistics.rb

Overview

Gathered statistics about a group of check runs.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CodeCheckRunStatistics

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



98
99
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 98

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Athenian::CodeCheckRunStatistics` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Athenian::CodeCheckRunStatistics`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  end

  if attributes.key?(:'successes')
    self.successes = attributes[:'successes']
  end

  if attributes.key?(:'critical')
    self.critical = attributes[:'critical']
  end

  if attributes.key?(:'mean_execution_time')
    self.mean_execution_time = attributes[:'mean_execution_time']
  end

  if attributes.key?(:'stddev_execution_time')
    self.stddev_execution_time = attributes[:'stddev_execution_time']
  end

  if attributes.key?(:'median_execution_time')
    self.median_execution_time = attributes[:'median_execution_time']
  end

  if attributes.key?(:'skips')
    self.skips = attributes[:'skips']
  end

  if attributes.key?(:'flaky_count')
    self.flaky_count = attributes[:'flaky_count']
  end

  if attributes.key?(:'count_timeline')
    if (value = attributes[:'count_timeline']).is_a?(Array)
      self.count_timeline = value
    end
  end

  if attributes.key?(:'successes_timeline')
    if (value = attributes[:'successes_timeline']).is_a?(Array)
      self.successes_timeline = value
    end
  end

  if attributes.key?(:'mean_execution_time_timeline')
    if (value = attributes[:'mean_execution_time_timeline']).is_a?(Array)
      self.mean_execution_time_timeline = value
    end
  end

  if attributes.key?(:'median_execution_time_timeline')
    if (value = attributes[:'median_execution_time_timeline']).is_a?(Array)
      self.median_execution_time_timeline = value
    end
  end
end

Instance Attribute Details

#count ⇒ Object

Number of executions with respect to ‘date_from` and `date_to`.



17
18
19
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 17

def count
  @count
end

#count_timeline ⇒ Object

Number of executions through time. The dates sequence is ‘FilteredCodeCheckRuns.timeline`.



38
39
40
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 38

def count_timeline
  @count_timeline
end

#critical ⇒ Object

This code check dominated the overall check suite execution time at least once.



23
24
25
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 23

def critical
  @critical
end

#flaky_count ⇒ Object

Number of times this check run appeared flaky: it both failed and succeeded for the same commit.



35
36
37
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 35

def flaky_count
  @flaky_count
end

#mean_execution_time ⇒ Object

Returns the value of attribute mean_execution_time.



25
26
27
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 25

def mean_execution_time
  @mean_execution_time
end

#mean_execution_time_timeline ⇒ Object

Average elapsed execution time through time. The dates sequence is ‘FilteredCodeCheckRuns.timeline`.



44
45
46
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 44

def mean_execution_time_timeline
  @mean_execution_time_timeline
end

#median_execution_time ⇒ Object

Returns the value of attribute median_execution_time.



29
30
31
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 29

def median_execution_time
  @median_execution_time
end

#median_execution_time_timeline ⇒ Object

Median elapsed execution time through time. The dates sequence is ‘FilteredCodeCheckRuns.timeline`.



47
48
49
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 47

def median_execution_time_timeline
  @median_execution_time_timeline
end

#skips ⇒ Object

Number of times this check run was skipped.



32
33
34
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 32

def skips
  @skips
end

#stddev_execution_time ⇒ Object

Returns the value of attribute stddev_execution_time.



27
28
29
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 27

def stddev_execution_time
  @stddev_execution_time
end

#successes ⇒ Object

Number of successful executions with respect to ‘date_from` and `date_to`.



20
21
22
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 20

def successes
  @successes
end

#successes_timeline ⇒ Object

Number of successful executions through time. The dates sequence is ‘FilteredCodeCheckRuns.timeline`.



41
42
43
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 41

def successes_timeline
  @successes_timeline
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 50

def self.attribute_map
  {
    :'count' => :'count',
    :'successes' => :'successes',
    :'critical' => :'critical',
    :'mean_execution_time' => :'mean_execution_time',
    :'stddev_execution_time' => :'stddev_execution_time',
    :'median_execution_time' => :'median_execution_time',
    :'skips' => :'skips',
    :'flaky_count' => :'flaky_count',
    :'count_timeline' => :'count_timeline',
    :'successes_timeline' => :'successes_timeline',
    :'mean_execution_time_timeline' => :'mean_execution_time_timeline',
    :'median_execution_time_timeline' => :'median_execution_time_timeline'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



332
333
334
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 332

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 91

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 73

def self.openapi_types
  {
    :'count' => :'Integer',
    :'successes' => :'Integer',
    :'critical' => :'Boolean',
    :'mean_execution_time' => :'CodeCheckRunStatisticsMeanExecutionTime',
    :'stddev_execution_time' => :'CodeCheckRunStatisticsStddevExecutionTime',
    :'median_execution_time' => :'CodeCheckRunStatisticsMedianExecutionTime',
    :'skips' => :'Integer',
    :'flaky_count' => :'Integer',
    :'count_timeline' => :'Array<Integer>',
    :'successes_timeline' => :'Array<Integer>',
    :'mean_execution_time_timeline' => :'Array<String>',
    :'median_execution_time_timeline' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 300

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      count == o.count &&
      successes == o.successes &&
      critical == o.critical &&
      mean_execution_time == o.mean_execution_time &&
      stddev_execution_time == o.stddev_execution_time &&
      median_execution_time == o.median_execution_time &&
      skips == o.skips &&
      flaky_count == o.flaky_count &&
      count_timeline == o.count_timeline &&
      successes_timeline == o.successes_timeline &&
      mean_execution_time_timeline == o.mean_execution_time_timeline &&
      median_execution_time_timeline == o.median_execution_time_timeline
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 363

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Athenian.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 434

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 339

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


319
320
321
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



325
326
327
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 325

def hash
  [count, successes, critical, mean_execution_time, stddev_execution_time, median_execution_time, skips, flaky_count, count_timeline, successes_timeline, mean_execution_time_timeline, median_execution_time_timeline].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 170

def list_invalid_properties
  invalid_properties = Array.new
  if @count.nil?
    invalid_properties.push('invalid value for "count", count cannot be nil.')
  end

  if @successes.nil?
    invalid_properties.push('invalid value for "successes", successes cannot be nil.')
  end

  if @successes < 0
    invalid_properties.push('invalid value for "successes", must be greater than or equal to 0.')
  end

  if @critical.nil?
    invalid_properties.push('invalid value for "critical", critical cannot be nil.')
  end

  if @mean_execution_time.nil?
    invalid_properties.push('invalid value for "mean_execution_time", mean_execution_time cannot be nil.')
  end

  if @stddev_execution_time.nil?
    invalid_properties.push('invalid value for "stddev_execution_time", stddev_execution_time cannot be nil.')
  end

  if @median_execution_time.nil?
    invalid_properties.push('invalid value for "median_execution_time", median_execution_time cannot be nil.')
  end

  if @skips.nil?
    invalid_properties.push('invalid value for "skips", skips cannot be nil.')
  end

  if @skips < 0
    invalid_properties.push('invalid value for "skips", must be greater than or equal to 0.')
  end

  if @flaky_count.nil?
    invalid_properties.push('invalid value for "flaky_count", flaky_count cannot be nil.')
  end

  if @flaky_count < 0
    invalid_properties.push('invalid value for "flaky_count", must be greater than or equal to 0.')
  end

  if @count_timeline.nil?
    invalid_properties.push('invalid value for "count_timeline", count_timeline cannot be nil.')
  end

  if @successes_timeline.nil?
    invalid_properties.push('invalid value for "successes_timeline", successes_timeline cannot be nil.')
  end

  if @mean_execution_time_timeline.nil?
    invalid_properties.push('invalid value for "mean_execution_time_timeline", mean_execution_time_timeline cannot be nil.')
  end

  if @median_execution_time_timeline.nil?
    invalid_properties.push('invalid value for "median_execution_time_timeline", median_execution_time_timeline cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



410
411
412
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 410

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 416

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



404
405
406
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 404

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/athenian/models/code_check_run_statistics.rb', line 237

def valid?
  return false if @count.nil?
  return false if @successes.nil?
  return false if @successes < 0
  return false if @critical.nil?
  return false if @mean_execution_time.nil?
  return false if @stddev_execution_time.nil?
  return false if @median_execution_time.nil?
  return false if @skips.nil?
  return false if @skips < 0
  return false if @flaky_count.nil?
  return false if @flaky_count < 0
  return false if @count_timeline.nil?
  return false if @successes_timeline.nil?
  return false if @mean_execution_time_timeline.nil?
  return false if @median_execution_time_timeline.nil?
  true
end