blob: e1ad225436dbfe0ad2ae741c1d2aff6baa727ec1 [file] [log] [blame]
// Copyright 2020 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <cstdint>
#include <memory>
#include <string>
#include <base/cancelable_callback.h>
#include <base/memory/weak_ptr.h>
#include <base/optional.h>
#include <base/time/default_tick_clock.h>
#include <base/time/tick_clock.h>
#include <base/time/time.h>
#include <base/values.h>
#include "diagnostics/cros_healthd/routines/diag_routine.h"
#include "diagnostics/cros_healthd/system/context.h"
#include "mojo/cros_healthd_diagnostics.mojom.h"
namespace diagnostics {
// Checks the discharge rate of the battery.
class BatteryDischargeRoutine final : public DiagnosticRoutine {
// |exec_duration| - length of time to run the routine for.
// |maximum_discharge_percent_allowed| - the routine will fail if the battery
// discharges more than this percentage during the execution of the routine.
// Valid range: [0, 100].
// Override |tick_clock| for testing only.
BatteryDischargeRoutine(Context* const context,
base::TimeDelta exec_duration,
uint32_t maximum_discharge_percent_allowed,
const base::TickClock* tick_clock = nullptr);
BatteryDischargeRoutine(const BatteryDischargeRoutine&) = delete;
BatteryDischargeRoutine& operator=(const BatteryDischargeRoutine&) = delete;
// DiagnosticRoutine overrides:
~BatteryDischargeRoutine() override;
void Start() override;
void Resume() override;
void Cancel() override;
void PopulateStatusUpdate(
chromeos::cros_healthd::mojom::RoutineUpdate* response,
bool include_output) override;
chromeos::cros_healthd::mojom::DiagnosticRoutineStatusEnum GetStatus()
// Calculates the progress percent based on the current status.
void CalculateProgressPercent();
// Checks the machine state against the input parameters.
// Determine success or failure for the routine.
void DetermineRoutineResult(double beginning_discharge_percent);
// Unowned pointer that outlives this routine instance.
Context* const context_;
// Status of the routine, reported by GetStatus() or noninteractive routine
// updates.
chromeos::cros_healthd::mojom::DiagnosticRoutineStatusEnum status_;
// Details of the routine's status, reported in noninteractive status updates.
std::string status_message_;
// Details about the routine's execution. Reported in all status updates.
base::Value output_dict_{base::Value::Type::DICTIONARY};
// Length of time to run the routine for.
const base::TimeDelta exec_duration_;
// Maximum discharge percent allowed for the routine to pass.
const uint32_t maximum_discharge_percent_allowed_;
// A measure of how far along the routine is, reported in all status updates.
uint32_t progress_percent_ = 0;
// When the routine started. Used to calculate |progress_percent_|.
base::Optional<base::TimeTicks> start_ticks_ = base::nullopt;
// Tracks the passage of time.
std::unique_ptr<base::DefaultTickClock> default_tick_clock_;
// Unowned pointer which should outlive this instance. Allows the default tick
// clock to be overridden for testing.
const base::TickClock* tick_clock_;
// Wraps DetermineRoutineResult in a cancellable callback.
base::CancelableClosure callback_;
// Must be the last class member.
base::WeakPtrFactory<BatteryDischargeRoutine> weak_ptr_factory_{this};
} // namespace diagnostics