Class: Debci::Status
- Inherits:
-
Object
- Object
- Debci::Status
- Includes:
- Test::Duration, Test::Expired, Test::Prefix
- 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.
-
#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
Methods included from Test::Prefix
Methods included from Test::Expired
Methods included from Test::Duration
Instance Attribute Details
#architecture ⇒ Object
Returns the value of attribute architecture
19 20 21 |
# File 'lib/debci/status.rb', line 19 def architecture @architecture end |
#date ⇒ Object
Returns the value of attribute date
19 20 21 |
# File 'lib/debci/status.rb', line 19 def date @date end |
#duration_seconds ⇒ Object
Returns the value of attribute duration_seconds
19 20 21 |
# File 'lib/debci/status.rb', line 19 def duration_seconds @duration_seconds end |
#last_pass_date ⇒ Object
Returns the value of attribute last_pass_date
19 20 21 |
# File 'lib/debci/status.rb', line 19 def last_pass_date @last_pass_date end |
#last_pass_version ⇒ Object
Returns the value of attribute last_pass_version
19 20 21 |
# File 'lib/debci/status.rb', line 19 def last_pass_version @last_pass_version end |
#message ⇒ Object
Returns the value of attribute message
19 20 21 |
# File 'lib/debci/status.rb', line 19 def @message end |
#package ⇒ Object
Returns the value of attribute package
19 20 21 |
# File 'lib/debci/status.rb', line 19 def package @package end |
#previous_status ⇒ Object
Returns the value of attribute previous_status
19 20 21 |
# File 'lib/debci/status.rb', line 19 def previous_status @previous_status end |
#requestor ⇒ Object
Returns the value of attribute requestor
19 20 21 |
# File 'lib/debci/status.rb', line 19 def requestor @requestor end |
#run_id ⇒ Object
Returns the value of attribute run_id
19 20 21 |
# File 'lib/debci/status.rb', line 19 def run_id @run_id end |
#status ⇒ Object
Returns the value of attribute status
19 20 21 |
# File 'lib/debci/status.rb', line 19 def status @status end |
#suite ⇒ Object
Returns the value of attribute suite
19 20 21 |
# File 'lib/debci/status.rb', line 19 def suite @suite end |
#trigger ⇒ Object
Returns the value of attribute trigger
19 20 21 |
# File 'lib/debci/status.rb', line 19 def trigger @trigger end |
#version ⇒ Object
Returns the value of attribute version
19 20 21 |
# File 'lib/debci/status.rb', line 19 def version @version end |
Class Method Details
.from_data(data, suite, architecture) ⇒ Object
Populates an object by reading from a data hash
155 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 |
# File 'lib/debci/status.rb', line 155 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
.
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 |
# File 'lib/debci/status.rb', line 128 def self.from_file(file, suite, architecture) status = new status.suite = suite status.architecture = architecture unless File.exists?(file) status.package = File.basename(File.dirname(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
203 204 205 206 207 |
# File 'lib/debci/status.rb', line 203 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
104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/debci/status.rb', line 104 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 |
#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
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 |
# File 'lib/debci/status.rb', line 51 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
84 85 86 87 88 89 90 |
# File 'lib/debci/status.rb', line 84 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
94 95 96 97 98 99 100 |
# File 'lib/debci/status.rb', line 94 def headline msg = "#{package} #{version} #{status.upcase} on #{suite}/#{architecture}" if status == :fail && failmsg msg += " (#{failmsg})" end msg end |
#inspect ⇒ Object
199 200 201 |
# File 'lib/debci/status.rb', line 199 def inspect "<#{suite}/#{architecture} #{status}>" end |
#newer?(days) ⇒ Boolean
194 195 196 197 |
# File 'lib/debci/status.rb', line 194 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.
23 24 25 26 27 28 29 30 31 32 |
# File 'lib/debci/status.rb', line 23 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
117 118 119 120 121 122 123 124 125 |
# File 'lib/debci/status.rb', line 117 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
34 35 36 37 38 39 40 41 42 |
# File 'lib/debci/status.rb', line 34 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 |