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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
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
|
use c8y_smartrest::{
smartrest_deserializer::{get_datetime_from_file_path, SmartRestLogRequest},
smartrest_serializer::{
CumulocitySupportedOperations, SmartRestSerializer, SmartRestSetOperationToExecuting,
SmartRestSetOperationToSuccessful,
},
topic::C8yTopic,
};
use mqtt_channel::Message;
/// returns a c8y message specifying to set log status to executing.
///
/// example message: '501,c8y_LogfileRequest'
pub async fn get_log_file_request_executing() -> Result<Message, anyhow::Error> {
let topic = C8yTopic::SmartRestResponse.to_topic()?;
let smartrest_set_operation_status =
SmartRestSetOperationToExecuting::new(CumulocitySupportedOperations::C8yLogFileRequest)
.to_smartrest()?;
Ok(Message::new(&topic, smartrest_set_operation_status))
}
/// returns a c8y message specifying to set log status to successful.
///
/// example message: '503,c8y_LogfileRequest,https://{c8y.url}/etc...'
pub async fn get_log_file_request_done_message(
binary_upload_event_url: &str,
) -> Result<Message, anyhow::Error> {
let topic = C8yTopic::SmartRestResponse.to_topic()?;
let smartrest_set_operation_status =
SmartRestSetOperationToSuccessful::new(CumulocitySupportedOperations::C8yLogFileRequest)
.with_response_parameter(binary_upload_event_url)
.to_smartrest()?;
Ok(Message::new(&topic, smartrest_set_operation_status))
}
/// Reads tedge logs according to `SmartRestLogRequest`.
///
/// If needed, logs are concatenated.
///
/// Logs are sorted alphanumerically from oldest to newest.
///
/// # Examples
///
/// ```
/// let smartrest_obj = SmartRestLogRequest::from_smartrest(
/// "522,DeviceSerial,syslog,2021-01-01T00:00:00+0200,2021-01-10T00:00:00+0200,,1000",
/// )
/// .unwrap();
///
/// let log = read_tedge_system_logs(&smartrest_obj, "/var/log/tedge").unwrap();
/// ```
pub fn read_tedge_logs(
smartrest_obj: &SmartRestLogRequest,
logs_dir: &str,
) -> Result<String, anyhow::Error> {
let mut output = String::new();
// NOTE: As per documentation of std::fs::read_dir:
// "The order in which this iterator returns entries is platform and filesystem dependent."
// Therefore, files are sorted by date.
let mut read_vector: Vec<_> = std::fs::read_dir(logs_dir)?
.filter_map(|r| r.ok())
.filter(|dir_entry| {
get_datetime_from_file_path(&dir_entry.path())
.map(|dt| !(dt < smartrest_obj.date_from || dt > smartrest_obj.date_to))
.unwrap_or(false)
})
.filter(|dir_entry| {
let file_name = &dir_entry.file_name();
let mut file_name = file_name.to_str().unwrap();
// FIXME: this is a hotfix to map "software-list" and "software-update" to "software-management"
// this should be fixed in https://github.com/thin-edge/thin-edge.io/issues/1077
if file_name.starts_with("software-list") | file_name.starts_with("software-update") {
file_name = "software-management";
}
file_name.starts_with(&smartrest_obj.log_type)
})
.collect();
read_vector.sort_by_key(|dir| dir.path());
// loop sorted vector and push store log file to `output`
let mut line_counter: usize = 0;
for entry in read_vector {
let file_path = entry.path();
let file_content = std::fs::read_to_string(&file_path)?;
if file_content.is_empty() {
continue;
}
// adding file header only if line_counter permits more lines to be added
match &file_path.file_stem().and_then(|f| f.to_str()) {
Some(file_name) if line_counter < smartrest_obj.lines => {
output.push_str(&format!("filename: {}\n", file_name));
}
_ => {}
}
// split at new line delimiter ("\n")
let mut lines = file_content.lines();
while line_counter < smartrest_obj.lines {
if let Some(haystack) = lines.next() {
if let Some(needle) = &smartrest_obj.needle {
if haystack.contains(needle) {
output.push_str(&format!("{}\n", haystack));
line_counter += 1;
}
} else {
output.push_str(&format!("{}\n", haystack));
line_counter += 1;
}
} else {
// there are no lines.next()
break;
}
}
}
Ok(output)
}
#[cfg(test)]
mod tests {
use super::read_tedge_logs;
use c8y_smartrest::smartrest_deserializer::{SmartRestLogRequest, SmartRestRequestGeneric};
use std::fs::File;
use std::io::Write;
fn parse_file_names_from_log_content(log_content: &str) -> [&str; 5] {
let mut files: Vec<&str> = vec![];
for line in log_content.lines() {
if line.contains("filename: ") {
let filename: &str = line.split("filename: ").last().unwrap();
files.push(filename);
}
}
match files.try_into() {
Ok(arr) => arr,
Err(_) => panic!("Could not convert to Array &str, size 5"),
}
}
#[test]
/// testing read_tedge_logs
///
/// this test creates 5 fake log files in a temporary directory.
/// files are dated 2021-01-0XT01:00Z, where X = a different day.
///
/// this tests will assert that files are read alphanumerically from oldest to newest
fn test_read_logs() {
// order in which files are created
const LOG_FILE_NAMES: [&str; 5] = [
"software-list-2021-01-03T01:00:00Z.log",
"software-list-2021-01-02T01:00:00Z.log",
"software-list-2021-01-01T01:00:00Z.log",
"software-update-2021-01-03T01:00:00Z.log",
"software-update-2021-01-02T01:00:00Z.log",
];
// expected (sorted) output
const EXPECTED_OUTPUT: [&str; 5] = [
"software-list-2021-01-01T01:00:00Z",
"software-list-2021-01-02T01:00:00Z",
"software-list-2021-01-03T01:00:00Z",
"software-update-2021-01-02T01:00:00Z",
"software-update-2021-01-03T01:00:00Z",
];
let smartrest_obj = SmartRestLogRequest::from_smartrest(
"522,DeviceSerial,software-management,2021-01-01T00:00:00+0200,2021-01-10T00:00:00+0200,,1000",
)
.unwrap();
let temp_dir = tempfile::tempdir().unwrap();
// creating the files
for (idx, file) in LOG_FILE_NAMES.iter().enumerate() {
let file_path = &temp_dir.path().join(file);
let mut file = File::create(file_path).unwrap();
writeln!(file, "file num {}", idx).unwrap();
}
// reading the logs and extracting the file names from the log output.
let output = read_tedge_logs(&smartrest_obj, temp_dir.path().to_str().unwrap()).unwrap();
let parsed_values = parse_file_names_from_log_content(&output);
// asserting the order = `EXPECTED_OUTPUT`
assert!(parsed_values.eq(&EXPECTED_OUTPUT));
}
}
|
