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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
use regex::{Regex, RegexBuilder};
use std::collections::BTreeMap;
pub type Tags = Vec<String>;
pub type Labels = BTreeMap<String, String>;
#[derive(Serialize, Deserialize, Clone, Debug, Ord, PartialEq, PartialOrd, Eq)]
#[serde(default)]
pub struct MetaData {
pub labels: Labels,
pub tags: Tags,
}
impl Default for MetaData {
/// Returns a default implementation of the `MetaData`
/// ```
/// let m = tusk_data::metadata::MetaData::default();
/// ```
fn default() -> Self {
MetaData {
labels: Labels::new(),
tags: Tags::new(),
}
}
}
impl MetaData {
/// Returns a new instance of `MetaData`
/// ```
/// let m = tusk_data::metadata::MetaData::new();
/// ```
pub fn new() -> Self {
Self::default()
}
/// Adds a new tag to the `MetaData`
/// ```
/// assert_eq!(tusk_data::metadata::MetaData::new()
/// .add_tag("example")
/// .add_tag("another_tag")
/// .tags,
/// vec!("example".to_string(), "another_tag".to_string())
/// );
/// ```
pub fn add_tag(&mut self, tag: &str) -> &mut Self {
self.tags.push(tag.to_string());
self
}
/// Returns all the `Tags` for this piece of `MetaData`
/// ```
/// assert_eq!(tusk_data::metadata::MetaData::new()
/// .add_tag("example")
/// .add_tag("another_tag")
/// .get_tags(),
/// vec!("example".to_string(), "another_tag".to_string())
/// );
/// ```
pub fn get_tags(&self) -> Tags {
self.tags.clone()
}
/// Adds a new label to this piece of `MetaData`
/// ```
/// let mut expect = tusk_data::metadata::Labels::new();
/// expect.insert("example".to_string(), "value".to_string());
/// assert_eq!(tusk_data::metadata::MetaData::new()
/// .add_label("example", "value")
/// .labels, expect);
/// ```
pub fn add_label(&mut self, name: &str, value: &str) -> &mut Self {
self.labels.insert(name.to_string(), value.to_string());
self
}
/// Returns all `Labels` for this piece of `MetaData`
/// ```
/// let mut expect = tusk_data::metadata::Labels::new();
/// expect.insert("example".to_string(), "value".to_string());
/// assert_eq!(tusk_data::metadata::MetaData::new()
/// .add_label("example", "value")
/// .get_labels(), expect);
/// ```
pub fn get_labels(&self) -> Labels {
self.labels.clone()
}
/// Returns true if the labels of the `MetaData` on the LHS are a
/// superset of the labels of the `MetaData` on the RHS.
/// ```
/// let mut base = tusk_data::metadata::MetaData::new();
/// base.add_label("example", "value");
/// let mut cover = tusk_data::metadata::MetaData::new();
/// cover.add_label("example", "value");
/// cover.add_label("example2", "value2");
/// assert!(cover.superset(&base));
/// assert!(!base.superset(&cover));
/// // If the two are equal then they are supersets of each other
/// assert!(base.superset(&base));
/// ```
pub fn superset(&self, md: &MetaData) -> bool {
for (key, _) in &md.labels {
if !self.labels.contains_key(key) {
return false;
}
}
true
}
/// Compiles the regexes so that the `MetaData` into a `MetaDataFilter`
/// can be matched against other `MetaData`. Any failures
/// are simply skipped over and not added to the
/// filter.
/// ```
/// assert_eq!(tusk_data::metadata::MetaData::new()
/// .add_label("test", "value")
/// .add_tag("example")
/// .compile()
/// .labels
/// .len(), 1);
/// assert_eq!(tusk_data::metadata::MetaData::new()
/// .add_label("test", "value")
/// .add_tag("bad_tag")
/// .compile()
/// .tags
/// .len(), 1);
/// ```
pub fn compile(&self) -> MetaDataFilter {
MetaDataFilter {
tags: self.tags
.iter()
.filter_map(|tag| match RegexBuilder::new(tag).build() {
Err(error) => {
warn!("{}: Could not build regex {:?}", error, tag);
None
}
Ok(regex) => {
trace!("Build regex {:?}", tag);
Some(regex)
}
})
.collect(),
labels: self.labels
.iter()
.filter_map(|(key, value)| match RegexBuilder::new(value).build() {
Err(error) => {
warn!(
"{}: Could not build regex {:?} for key {:?}",
error, value, key
);
None
}
Ok(regex) => {
trace!("Build regex {:?} for key {:?}", value, key);
Some((key.clone(), regex))
}
})
.collect(),
}
}
}
pub struct MetaDataFilter {
pub tags: Vec<Regex>,
pub labels: BTreeMap<String, Regex>,
}
impl MetaDataFilter {
/// Performs checks to see if the MetaDataFilter is_match
/// the provided MetaData document.
/// ```
/// assert!(tusk_data::metadata::MetaData::new()
/// .add_label("test", "value")
/// .add_tag("example")
/// .compile()
/// .is_match(tusk_data::metadata::MetaData::new()
/// .add_tag("example")
/// .add_label("test", "value")
/// ));
/// assert!(!tusk_data::metadata::MetaData::new()
/// .add_label("test", "value")
/// .add_tag("bad_tag")
/// .compile()
/// .is_match(tusk_data::metadata::MetaData::new()
/// .add_tag("example")
/// .add_label("test", "value")
/// ));
pub fn is_match(&self, md: &MetaData) -> bool {
// Check the labels
for (key, labels_re) in &self.labels {
for (label_name, label_value) in &md.get_labels() {
if label_name == key {
if !labels_re.is_match(&label_value) {
return false;
}
} else {
// The key is not defined
return false;
}
}
}
// Check the tags
for tag_re in &self.tags {
for tag in md.get_tags() {
if !tag_re.is_match(&tag) {
return false;
}
}
}
true
}
}
#[cfg(test)]
mod tests {
use super::*;
//#[test]
fn test_metadata_builder() {
let mut md = MetaData::new();
md.add_tag("test")
.add_tag("another_test")
.add_label("example", "value");
// Check that we can add labels OK.
assert_eq!(
md.get_labels().get("example").unwrap(),
&"value".to_string()
);
// Check that we can add tags OK.
assert_eq!(md.get_tags(), vec!["test", "another_test"]);
}
//#[test]
fn test_metadata_filter() {
let mut md = MetaData::new();
md.add_tag("test")
.add_tag("another_test")
.add_label("example", "value");
// Check for a single tag match
assert!(
MetaData::new()
.add_tag("test")
.compile()
.is_match(&md)
);
// Check for a tag failure
assert!(!MetaData::new()
.add_tag("test")
.add_tag("doot doot")
.compile()
.is_match(&md));
// Check for tag match and label match
assert!(
MetaData::new()
.add_tag("test")
.add_label("example", "^val.e")
.compile()
.is_match(&md)
);
// Check for tag match and label failure
assert!(!MetaData::new()
.add_tag("test")
.add_label("example", "^$")
.compile()
.is_match(&md));
// Check for tag failure and label match
assert!(!MetaData::new()
.add_tag("another_test")
.add_label("example", ".*")
.compile()
.is_match(&md));
// Check for label key failure
assert!(!MetaData::new()
.add_label("key not exist", "^.")
.compile()
.is_match(&md));
}
}