1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
|
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_DIAGNOSTICS_DIAGNOSTICS_TEST_H_
#define CHROME_BROWSER_DIAGNOSTICS_DIAGNOSTICS_TEST_H_
#include <stddef.h>
#include <string>
#include <string_view>
#include "base/time/time.h"
#include "chrome/browser/diagnostics/diagnostics_model.h"
namespace base {
class FilePath;
}
namespace diagnostics {
// Test IDs used to look up string identifiers for tests. If you add an ID here,
// you will also need to add corresponding strings to several things in the .cc
// file.
enum DiagnosticsTestId {
DIAGNOSTICS_CONFLICTING_DLLS_TEST,
DIAGNOSTICS_DISK_SPACE_TEST,
DIAGNOSTICS_INSTALL_TYPE_TEST,
DIAGNOSTICS_JSON_BOOKMARKS_TEST,
DIAGNOSTICS_JSON_LOCAL_STATE_TEST,
DIAGNOSTICS_JSON_PREFERENCES_TEST,
DIAGNOSTICS_OPERATING_SYSTEM_TEST,
DIAGNOSTICS_PATH_DICTIONARIES_TEST,
DIAGNOSTICS_PATH_LOCAL_STATE_TEST,
DIAGNOSTICS_PATH_RESOURCES_TEST,
DIAGNOSTICS_PATH_USER_DATA_TEST,
DIAGNOSTICS_VERSION_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_APP_CACHE_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_ARCHIVED_HISTORY_TEST_OBSOLETE,
DIAGNOSTICS_SQLITE_INTEGRITY_COOKIE_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_DATABASE_TRACKER_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_HISTORY_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_NSS_CERT_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_NSS_KEY_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_THUMBNAILS_TEST_OBSOLETE,
DIAGNOSTICS_SQLITE_INTEGRITY_WEB_DATA_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_FAVICONS_TEST,
DIAGNOSTICS_SQLITE_INTEGRITY_TOPSITES_TEST,
// Add new entries immediately above this comment. Do not reorder or renumber
// the entries, as they are tied to historical enum values in the UMA stats.
// If you add an entry, you will need to also add an entry to kTestNameInfo,
// and to the TEST_CASES macro in the .cc.
// This must always be last in the list.
DIAGNOSTICS_TEST_ID_COUNT
};
// Represents a single diagnostic test and encapsulates the common
// functionality across platforms as well.
// It also implements the TestInfo interface providing the storage
// for the outcome of the test.
// Specific tests need (minimally) only to:
// 1- override ExecuteImpl() to implement the test.
// 2- call RecordStopFailure() or RecordFailure() or RecordSuccess()
// at the end of the test.
// 3- Optionally call observer->OnProgress() if the test is long.
// 4- Optionally call observer->OnSkipped() if the test cannot be run.
class DiagnosticsTest : public DiagnosticsModel::TestInfo {
public:
explicit DiagnosticsTest(DiagnosticsTestId id);
~DiagnosticsTest() override;
// Runs the test. Returning false signals that no more tests should be run.
// The actual outcome of the test should be set using the RecordXX functions.
bool Execute(DiagnosticsModel::Observer* observer, DiagnosticsModel* model,
size_t index);
// Runs any recovery steps for the test. Returning false signals that no more
// recovery should be attempted.
bool Recover(DiagnosticsModel::Observer* observer, DiagnosticsModel* model,
size_t index);
void RecordStopFailure(int outcome_code, const std::string& additional_info) {
RecordOutcome(
outcome_code, additional_info, DiagnosticsModel::TEST_FAIL_STOP);
}
void RecordFailure(int outcome_code, const std::string& additional_info) {
RecordOutcome(
outcome_code, additional_info, DiagnosticsModel::TEST_FAIL_CONTINUE);
}
void RecordSuccess(const std::string& additional_info) {
RecordOutcome(0, additional_info, DiagnosticsModel::TEST_OK);
}
void RecordOutcome(int outcome_code,
const std::string& additional_info,
DiagnosticsModel::TestResult result);
static base::FilePath GetUserDefaultProfileDir();
// DiagnosticsModel::TestInfo overrides
int GetId() const override;
std::string_view GetName() const override;
std::string_view GetTitle() const override;
DiagnosticsModel::TestResult GetResult() const override;
std::string GetAdditionalInfo() const override;
int GetOutcomeCode() const override;
base::Time GetStartTime() const override;
base::Time GetEndTime() const override;
protected:
// Derived classes override this method do perform the actual test.
virtual bool ExecuteImpl(DiagnosticsModel::Observer* observer) = 0;
// Derived classes may override this method to perform a recovery, if recovery
// makes sense for the diagnostics test.
virtual bool RecoveryImpl(DiagnosticsModel::Observer* observer);
const DiagnosticsTestId id_;
std::string additional_info_;
int outcome_code_;
DiagnosticsModel::TestResult result_;
base::Time start_time_;
base::Time end_time_;
};
} // namespace diagnostics
#endif // CHROME_BROWSER_DIAGNOSTICS_DIAGNOSTICS_TEST_H_
|
