Class: Debci::Status
- Inherits:
-
Object
- Object
- Debci::Status
- Defined in:
- lib/debci/status.rb
Overview
This class represents one test execution.
Instance Attribute Summary collapse
-
#architecture ⇒ Object
Returns the value of attribute architecture.
-
#date ⇒ Object
Returns the value of attribute date.
-
#duration_seconds ⇒ Object
Returns the value of attribute duration_seconds.
-
#last_pass_date ⇒ Object
Returns the value of attribute last_pass_date.
-
#last_pass_version ⇒ Object
Returns the value of attribute last_pass_version.
-
#message ⇒ Object
Returns the value of attribute message.
-
#package ⇒ Object
Returns the value of attribute package.
-
#previous_status ⇒ Object
Returns the value of attribute previous_status.
-
#requestor ⇒ Object
Returns the value of attribute requestor.
-
#run_id ⇒ Object
Returns the value of attribute run_id.
-
#status ⇒ Object
Returns the value of attribute status.
-
#suite ⇒ Object
Returns the value of attribute suite.
-
#trigger ⇒ Object
Returns the value of attribute trigger.
-
#version ⇒ Object
Returns the value of attribute version.
Class Method Summary collapse
-
.from_data(data, suite, architecture) ⇒ Object
Populates an object by reading from a data hash.
-
.from_file(file, suite, architecture) ⇒ Object
Constructs a new object by reading the JSON status
file
.
Instance Method Summary collapse
- #blacklisted? ⇒ Boolean
-
#description ⇒ Object
A longer version of the headline for a new failure, include whether this version previously passed.
- #duration_human ⇒ Object
- #expired? ⇒ Boolean
-
#extended_status ⇒ Object
a larger set of possible test result states, to show “at a glance” the package's test history potentially other attributes could be included here * partial or total failure if there are multiple tests * dependency failure vs test failure * guessed nondeterminism but probably too many combinations will make this unhelpful.
- #failmsg ⇒ Object
-
#headline ⇒ Object
Returns a headline for this status object, to be used as a short description of the event it represents.
- #inspect ⇒ Object
- #newer?(days) ⇒ Boolean
-
#newsworthy? ⇒ Boolean
Returns
true
if this status object represents an important event, such as a package that used to pass started failing, of vice versa. -
#time ⇒ Object
Returns the amount of time since the date for this status object.
- #title ⇒ Object
Instance Attribute Details
#architecture ⇒ Object
Returns the value of attribute architecture
11 12 13 |
# File 'lib/debci/status.rb', line 11 def architecture @architecture end |
#date ⇒ Object
Returns the value of attribute date
11 12 13 |
# File 'lib/debci/status.rb', line 11 def date @date end |
#duration_seconds ⇒ Object
Returns the value of attribute duration_seconds
11 12 13 |
# File 'lib/debci/status.rb', line 11 def duration_seconds @duration_seconds end |
#last_pass_date ⇒ Object
Returns the value of attribute last_pass_date
11 12 13 |
# File 'lib/debci/status.rb', line 11 def last_pass_date @last_pass_date end |
#last_pass_version ⇒ Object
Returns the value of attribute last_pass_version
11 12 13 |
# File 'lib/debci/status.rb', line 11 def last_pass_version @last_pass_version end |
#message ⇒ Object
Returns the value of attribute message
11 12 13 |
# File 'lib/debci/status.rb', line 11 def @message end |
#package ⇒ Object
Returns the value of attribute package
11 12 13 |
# File 'lib/debci/status.rb', line 11 def package @package end |
#previous_status ⇒ Object
Returns the value of attribute previous_status
11 12 13 |
# File 'lib/debci/status.rb', line 11 def previous_status @previous_status end |
#requestor ⇒ Object
Returns the value of attribute requestor
11 12 13 |
# File 'lib/debci/status.rb', line 11 def requestor @requestor end |
#run_id ⇒ Object
Returns the value of attribute run_id
11 12 13 |
# File 'lib/debci/status.rb', line 11 def run_id @run_id end |
#status ⇒ Object
Returns the value of attribute status
11 12 13 |
# File 'lib/debci/status.rb', line 11 def status @status end |
#suite ⇒ Object
Returns the value of attribute suite
11 12 13 |
# File 'lib/debci/status.rb', line 11 def suite @suite end |
#trigger ⇒ Object
Returns the value of attribute trigger
11 12 13 |
# File 'lib/debci/status.rb', line 11 def trigger @trigger end |
#version ⇒ Object
Returns the value of attribute version
11 12 13 |
# File 'lib/debci/status.rb', line 11 def version @version end |
Class Method Details
.from_data(data, suite, architecture) ⇒ Object
Populates an object by reading from a data hash
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/debci/status.rb', line 156 def self.from_data(data, suite, architecture) status = Debci::Status.new status.suite = suite status.architecture = architecture status.run_id = data['run_id'] || data['date'] status.package = data['package'] status.version = data['version'] status.requestor = data['requestor'] status.date = begin d = data['date'] d ||= data['created_at'] d ||= 'unknown' Time.parse(d + ' UTC') rescue ArgumentError nil end status.trigger = data['trigger'] status.status = (data['status'] || :unknown).to_sym status.previous_status = (data['previous_status'] || :unknown).to_sym status.duration_seconds = begin Integer(data['duration_seconds'] || 0) rescue ArgumentError nil end status. = data['message'] status.last_pass_version = data.fetch('last_pass_version', 'unknown') status.last_pass_date = begin Time.parse((data['last_pass_date'] || 'unknown') + ' UTC') rescue ArgumentError nil end status end |
.from_file(file, suite, architecture) ⇒ Object
Constructs a new object by reading the JSON status file
.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/debci/status.rb', line 130 def self.from_file(file, suite, architecture) status = new status.suite = suite status.architecture = architecture unless File.exists?(file) status.status = :no_test_data return status end data = nil begin File.open(file, 'r') do |f| data = JSON.load(f) end rescue JSON::ParserError true # nothing really end return status unless data from_data(data, suite, architecture) end |
Instance Method Details
#blacklisted? ⇒ Boolean
214 215 216 217 218 |
# File 'lib/debci/status.rb', line 214 def blacklisted? Debci.blacklist.include?( package, suite: suite, arch: architecture, version: version ) end |
#description ⇒ Object
A longer version of the headline for a new failure, include whether this version previously passed
106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/debci/status.rb', line 106 def description msg = "The tests for #{package} (version #{version}) resulted in #{status.upcase} on #{suite}/#{architecture}. Previously it was #{previous_status.upcase}" msg += case extended_status when :fail_passed_current " for the current version." when :fail_passed_old " for version #{last_pass_version}." else "." end end |
#duration_human ⇒ Object
76 77 78 79 80 81 82 83 84 |
# File 'lib/debci/status.rb', line 76 def duration_human s = duration_seconds.to_i return '0s' if s == 0 { h: s / 3600, m: (s % 3600) / 60, s: s % 60, }.select { |k,v| v > 0 }.map { |k,v| v.to_s + k.to_s }.join(' ') end |
#expired? ⇒ Boolean
195 196 197 198 199 200 201 202 203 |
# File 'lib/debci/status.rb', line 195 def expired? days = Debci.config.data_retention_days.to_i if days > 0 retention_window = days * (24*60*60) Time.now > self.date + retention_window else false end end |
#extended_status ⇒ Object
a larger set of possible test result states, to show “at a glance” the package's test history potentially other attributes could be included here * partial or total failure if there are multiple tests * dependency failure vs test failure * guessed nondeterminism but probably too many combinations will make this unhelpful
43 44 45 46 47 48 49 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 |
# File 'lib/debci/status.rb', line 43 def extended_status case status when :pass :pass # distinguish between always failing, and whether the test has # previously passed for this or older versions when :fail case last_pass_version when "never" :fail_passed_never when version :fail_passed_current when "unknown" :fail else :fail_passed_old end # tmpfail is usually not interesting to the observer, so provide # a hint if it is masking a previous pass or fail when :tmpfail case previous_status when :pass :tmpfail_pass when :fail :tmpfail_fail else :tmpfail end else status end end |
#failmsg ⇒ Object
86 87 88 89 90 91 92 |
# File 'lib/debci/status.rb', line 86 def failmsg { :fail_passed_never => "never passed", :fail_passed_current => "previously passed", :fail_passed_old => "#{last_pass_version} passed" }[extended_status] end |
#headline ⇒ Object
Returns a headline for this status object, to be used as a short description of the event it represents
96 97 98 99 100 101 102 |
# File 'lib/debci/status.rb', line 96 def headline msg = "#{package} #{version} #{status.upcase} on #{suite}/#{architecture}" if status == :fail && failmsg msg += " (#{failmsg})" end msg end |
#inspect ⇒ Object
210 211 212 |
# File 'lib/debci/status.rb', line 210 def inspect "<#{suite}/#{architecture} #{status}>" end |
#newer?(days) ⇒ Boolean
205 206 207 208 |
# File 'lib/debci/status.rb', line 205 def newer?(days) return true if days <= 0 (Time.now - date) < days * (24 * 60 * 60) end |
#newsworthy? ⇒ Boolean
Returns true
if this status object represents an important
event, such as a package that used to pass started failing, of vice versa.
15 16 17 18 19 20 21 22 23 24 |
# File 'lib/debci/status.rb', line 15 def newsworthy? [ [:fail, :pass], [:pass, :fail], [:fail, :neutral], [:pass, :neutral], [:neutral, :pass], [:neutral, :fail], ].include?([status, previous_status]) end |
#time ⇒ Object
Returns the amount of time since the date for this status object
119 120 121 122 123 124 125 126 127 |
# File 'lib/debci/status.rb', line 119 def time days = (Time.now - date)/86400 if days >= 1 || days <= -1 "#{days.floor} day(s) ago" else "#{Time.at(Time.now - date).gmtime.strftime('%H')} hour(s) ago" end end |
#title ⇒ Object
26 27 28 29 30 31 32 33 34 |
# File 'lib/debci/status.rb', line 26 def title { :pass => "Pass", :fail => "Fail", :neutral => "No tests or all skipped", :tmpfail => "Temporary failure", :no_test_data => "No test data", }.fetch(status, "Unknown") end |