blob: 74fe7cc98bb8d397152ad2e25f46f272048eea65 [file] [log] [blame]
/* Copyright 2019 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 <sysexits.h>
#include <cstdlib>
#include <iostream>
#include <memory>
#include <base/at_exit.h>
#include <base/logging.h>
#include <brillo/flag_helper.h>
#include <brillo/syslog_logging.h>
#include "hardware_verifier/cli.h"
#include "hardware_verifier/observer.h"
namespace {
enum ExitStatus {
kSuccess = EXIT_SUCCESS, // 0
// The verification report shows the device is not complicant.
kVerifiedFail = 1,
kUnknownError = 10,
// Some of the argument is invalid.
kInvalidArgument = 11,
// Translate the error code from |hardware_verifier::CLI::Run()| to
// the corresponding return code.
ExitStatus ConvertCLIVerificationResultToExitStatus(
const hardware_verifier::CLIVerificationResult& verification_result) {
using hardware_verifier::CLIVerificationResult;
switch (verification_result) {
case CLIVerificationResult::kPass:
return ExitStatus::kSuccess;
case CLIVerificationResult::kFail:
return ExitStatus::kVerifiedFail;
case CLIVerificationResult::kInvalidHwVerificationSpecFile:
case CLIVerificationResult::kInvalidProbeResultFile:
return ExitStatus::kInvalidArgument;
return ExitStatus::kUnknownError;
int SafeConvertVerbosityFlagToLogLevel(int verbosity_flag) {
if (verbosity_flag < 0 || 5 < verbosity_flag) {
LOG(ERROR) << "The verbosity value (" << verbosity_flag
<< ") is out of range.";
// We would like to print |VLOG(K)| messages if the verbosity level is `K`.
// Since the corresponding log level is `-K`, we can resolve the correct
// log level by simply taking a negative sign.
return -verbosity_flag;
hardware_verifier::CLIOutputFormat SafeConvertOutputFormatFlagToEnum(
const std::string& output_format_flag) {
if (output_format_flag == "proto") {
return hardware_verifier::CLIOutputFormat::kProtoBin;
if (output_format_flag == "text") {
return hardware_verifier::CLIOutputFormat::kText;
LOG(ERROR) << "The output format (" << output_format_flag << ") is invalid.";
} // namespace
int main(int argc, char* argv[]) {
// Required by dbus in libchrome.
base::AtExitManager at_exit_manager;
DEFINE_int32(verbosity, 0,
"Verbosity level, range from 0 to 5. The greater number is "
"set, the more detail messages will be printed.");
DEFINE_string(probe_result_file, "",
"File path to the probe result in prototxt format, empty to "
"get directly from |runtime_probe| D-Bus service.");
DEFINE_string(hw_verification_spec_file, "",
"File path to the hardware verification spec in prototxt "
"format, empty to use the default one.");
DEFINE_string(output_format, "proto",
"Format of the output verification report, can be either "
"\"proto\" for protobuf binary format or \"text\" for human "
"readable text format.");
DEFINE_bool(send_to_uma, false, "Send data to UMA.");
DEFINE_bool(pii, false,
"Output result including PII data like UUID and generic device "
brillo::FlagHelper::Init(argc, argv, "ChromeOS Hardware Verifier Tool");
brillo::InitLog(brillo::kLogToSyslog | brillo::kLogToStderr);
// Validate the non-trivial flags and convert them to the proper value types.
const auto log_level = SafeConvertVerbosityFlagToLogLevel(FLAGS_verbosity);
const auto output_format =
auto observer = hardware_verifier::Observer::GetInstance();
if (FLAGS_send_to_uma) {
// TODO(yhong): Add the D-Bus service mode.
hardware_verifier::CLI cli;
const auto cli_result =
cli.Run(FLAGS_probe_result_file, FLAGS_hw_verification_spec_file,
output_format, FLAGS_pii);
const auto exit_status = ConvertCLIVerificationResultToExitStatus(cli_result);
return exit_status;