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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
use std::ffi::CString;
use std::path::Path;

use libc::size_t;

use error;
use libucl_bind::*;
use object::{
    self,
    Object,
};
use utils;

use super::Result;

bitflags! {
    pub struct Flags: i32 {
        const DEFAULT            = 0x0;
        const LOWERCASE          = 0x1;
        const ZEROCOPY           = 0x2;
        const NO_TIME            = 0x4;
        const NO_IMPLICIT_ARRAYS = 0x8;
    }
}

pub struct Parser {
    parser: *mut ucl_parser,
}

impl Parser {
    /// Create new parser instance with default options
    pub fn new() -> Self {
        Self::with_flags(Flags::DEFAULT)
    }

    /// Create new parser with given option flags
    ///
    /// Flags:
    ///
    /// - `DEFAULT` - default configuration
    /// - `LOWERCASE` - convert all keys to lower case
    /// - `ZEROCOPY` - parse input in zero-copy mode if possible (you must ensure that input memory
    ///   is not freed if an object is in use)
    /// - `NO_TIME` - do not parse time and treat it's value as string
    /// - `NO_IMPLICIT_ARRAYS` - create explicit arrays instead of implicit ones
    ///
    /// # Examples
    ///
    /// ```rust
    /// let parser = libucl::Parser::with_flags(libucl::parser::Flags::LOWERCASE);
    /// let doc = parser.parse("A = b").unwrap();
    ///
    /// assert!(doc.fetch("a").is_some());
    /// ```
    pub fn with_flags(flags: Flags) -> Self {
        Parser {
            parser: unsafe { ucl_parser_new(flags.bits()) }
        }
    }

    /// Parse given string. Returns root object on success.
    ///
    /// It moves out `Parser`.
    ///
    /// # Examples
    ///
    /// ```rust
    /// assert!(libucl::Parser::new().parse("a = b").is_ok());
    /// assert!(libucl::Parser::new().parse("a =").is_err());
    /// ```
    pub fn parse<T: AsRef<str>>(mut self, string: T) -> Result<Object> {
        let len = string.as_ref().len() as size_t;
        let s = CString::new(string.as_ref()).unwrap();
        let result = unsafe { ucl_parser_add_chunk(self.parser, s.as_ptr(), len) };

        if result {
            Ok(self.get_object().unwrap())
        } else {
            Err(self.get_error())
        }
    }

    /// Parse file at given `Path`.
    ///
    pub fn parse_file<T: AsRef<Path>>(mut self, path: T) -> Result<Object> {
        let filename = path.as_ref().to_str().unwrap();
        let s = CString::new(filename).unwrap();
        let result = unsafe { ucl_parser_add_file(self.parser, s.as_ptr()) };

        if result {
            Ok(self.get_object().unwrap())
        } else {
            Err(self.get_error())
        }
    }

    /// Register new variable
    ///
    /// # Examples
    ///
    /// ```rust
    /// let p = libucl::Parser::new();
    /// p.register_var("someVar".to_string(), "test_string".to_string());
    /// let res = p.parse("testVar = $someVar").unwrap();
    ///
    /// assert_eq!(res.fetch("testVar").unwrap().as_string(), Some("test_string".to_string()));
    /// ```
    pub fn register_var(&self, name: String, value: String) {
        let n = CString::new(name).unwrap();
        let v = CString::new(value).unwrap();
        unsafe {
            ucl_parser_register_variable(self.parser, n.as_ptr(), v.as_ptr())
        }
    }

    fn get_object(&mut self) -> Option<Object> {
        object::Builder::from_ptr(unsafe { ucl_parser_get_object(self.parser) }).map(|o| o.build())
    }

    fn get_error(&mut self) -> error::UclError {
        let err = unsafe { ucl_parser_get_error_code(self.parser) };
        let desc = unsafe { ucl_parser_get_error(self.parser) };

        error::UclErrorType::from_code(err, utils::to_str(desc).unwrap())
    }
}

impl Drop for Parser {
    fn drop(&mut self) {
        unsafe { ucl_parser_free(self.parser) }
    }
}

#[cfg(test)]
mod test {
    extern crate regex;
    use self::regex::Regex;

    use error::UclSchemaErrorType;
    use object::Emitter;

    use super::*;

    #[test]
    fn string_parsing() {
        let p = Parser::new();
        let s = r#"test_string = "test_string""#;

        assert!(p.parse(s).is_ok());
    }

    #[test]
    fn empty_string_parsing() {
        let p = Parser::new();
        let s = r#""#;

        assert!(p.parse(s).is_ok());
    }

    #[test]
    fn key_fetching() {
        let p = Parser::new();
        let s = r#"test_var = 10"#;
        let res = p.parse(s).unwrap();

        assert_eq!(res.fetch("test_var").unwrap().as_int(), Some(10));
    }

    #[test]
    fn flags() {
        let s = r#"test_Var = 10"#;
        let p = Parser::with_flags(Flags::DEFAULT);
        let res = p.parse(s).unwrap();

        assert!(res.fetch("test_var").is_none());

        let p = Parser::with_flags(Flags::LOWERCASE);
        let res = p.parse(s).unwrap();

        assert_eq!(res.fetch("test_var").unwrap().as_int(), Some(10));
    }

    #[test]
    fn variables() {
        let s = r#"testVar = $ENV"#;
        let p = Parser::new();
        p.register_var("ENV".to_string(), "test".to_string());
        let res = p.parse(s).unwrap();

        assert_eq!(res.fetch("testVar").unwrap().as_string(), Some("test".to_string()));
    }

    #[test]
    fn parse_array_and_iter() {
        let parser = Parser::new();
        let result = parser.parse(r#"name = "test_string";
            section {
                nice = true;
                server = ["http://localhost:6666", "test_string"];
                chunk = 1Gb;
            }"#).unwrap();
        let val = result.fetch_path("section.server");
        assert!(val.is_some());

        let mut obj = val.unwrap();
        assert_eq!(obj.get_type() == object::Type::Array, true);
        assert_eq!(obj.next().unwrap().as_string().unwrap(), "http://localhost:6666");
        assert_eq!(obj.next().unwrap().as_string().unwrap(), "test_string");
        assert_eq!(obj.next().is_none(), true);

        let val = result.fetch_path("section.server").unwrap();
        for o in val {
            assert_ne!(o.as_string(), None);
        }

    }

    #[test]
    fn object_dump() {
        let parser = Parser::new();
        let result = parser.parse(r#"name = "test_string";
            section {
                nice = true;
                server = ["http://localhost:6666", "test_string"];
                chunk = 1Gb;
            }"#).unwrap();
        let val = result.fetch_path("section.server");
        assert!(val.is_some());
        assert_eq!(result.dump().len(), 138);
    }

    #[test]
    fn object_dump_into_json() {
        let parser = Parser::new();
        let result = parser.parse(r#"section {
    flag = true;
    number = 10k;
    subsection {
        hosts = {
            host = "localhost";
            port = 9000
        }
        hosts = {
            host = "remotehost"
            port = 9090
        }
    }
}"#).unwrap();
        let regex = Regex::new("\"flag\": true").unwrap();
        let val = result.dump_into(Emitter::JSON);
        assert_eq!(regex.is_match(val.as_str()), true);
    }

    #[test]
    fn object_dump_into_json_compact() {
        let parser = Parser::new();
        let result = parser.parse(r#"section {
    flag = true;
    number = 10k;
    subsection {
        hosts = {
            host = "localhost";
            port = 9000
        }
        hosts = {
            host = "remotehost"
            port = 9090
        }
    }
}"#).unwrap();
        let regex = Regex::new("\"flag\":true").unwrap();
        let val = result.dump_into(Emitter::JSONCompact);
        assert_eq!(regex.is_match(val.as_str()), true);
    }

    #[test]
    fn object_dump_into_yml() {
        let parser = Parser::new();
        let result = parser.parse(r#"section {
    flag = true;
    number = 10k;
    subsection {
        hosts = {
            host = "localhost";
            port = 9000
        }
        hosts = {
            host = "remotehost"
            port = 9090
        }
    }
}"#).unwrap();
        let regex = Regex::new("flag: true").unwrap();
        let val = result.dump_into(Emitter::YAML);
        assert_eq!(regex.is_match(val.as_str()), true);
    }

    #[test]
    fn object_dump_into_config() {
        let parser = Parser::new();
        let result = parser.parse(r#"section {
    flag = true;
    number = 10k;
    subsection {
        hosts = {
            host = "localhost";
            port = 9000
        }
        hosts = {
            host = "remotehost"
            port = 9090
        }
    }
}"#).unwrap();
        let regex = Regex::new("flag = true").unwrap();
        let val = result.dump_into(Emitter::Config);
        assert_eq!(regex.is_match(val.as_str()), true);
    }

    #[test]
    fn validate_with_schema() {
        let parser = Parser::new();
        let item = r#"{"key": "some string"}"#;
        let schema = r#"{"type": "object", "properties":{"key": {"type":"string"}}}"#;
        let item = parser.parse(item).unwrap();
        let parser = Parser::new();
        let schema = parser.parse(schema).unwrap();
        let res = item.validate_with_schema(&schema);
        assert_eq!(res.is_ok(), true);
    }

    #[test]
    fn validate_with_schema_wrong_type() {
        let parser = Parser::new();
        let item = r#"{"key": 123}"#;
        let schema = r#"{"type": "object", "properties":{"key": {"type":"string"}}}"#;
        let item = parser.parse(item).unwrap();
        let parser = Parser::new();
        let schema = parser.parse(schema).unwrap();
        let res = item.validate_with_schema(&schema);
        assert_eq!(res.is_err(), true);
        assert_eq!(res.err().unwrap().code, UclSchemaErrorType::TypeMismatch)
    }

    #[test]
    fn validate_with_schema_missing_type() {
        let parser = Parser::new();
        let item = r#"{"key": "123"}"#;
        let schema = r#"{"type": "object", "properties":{"key": {"type":"string"},"value":{"type":"string"}}, "required":["value"]}"#;
        let item = parser.parse(item).unwrap();
        let parser = Parser::new();
        let schema = parser.parse(schema).unwrap();
        let res = item.validate_with_schema(&schema);
        assert_eq!(res.is_err(), true);
        assert_eq!(res.err().unwrap().code, UclSchemaErrorType::MissingProperty)
    }

    #[test]
    fn validate_with_schema_invalid_schema() {
        let parser = Parser::new();
        let item = r#"{"key": "123"}"#;
        let schema = r#"{"type": "object", "properties":{"key": {"type":"aa"},"value":{"type":"string"}}, "required":["value"]}"#;
        let item = parser.parse(item).unwrap();
        let parser = Parser::new();
        let schema = parser.parse(schema).unwrap();
        let res = item.validate_with_schema(&schema);
        assert_eq!(res.is_err(), true);
        assert_eq!(res.err().unwrap().code, UclSchemaErrorType::InvalidSchema)
    }

    #[test]
    fn validate_with_schema_invalid_constraint() {
        let parser = Parser::new();
        let item = r#"{"key": "123"}"#;
        let schema = r#"{"type": "object", "properties":{"key": {"type":"string","maxLength":2}}}"#;
        let item = parser.parse(item).unwrap();
        let parser = Parser::new();
        let schema = parser.parse(schema).unwrap();
        let res = item.validate_with_schema(&schema);
        assert_eq!(res.is_err(), true);
        assert_eq!(res.err().unwrap().code, UclSchemaErrorType::Constraint)
    }

    #[test]
    fn validate_with_schema_missing_dependency() {
        let parser = Parser::new();
        let item = r#"{"key": "123"}"#;
        let schema = r#"{"type": "object",
        "properties":{
            "key": {"type":"string"},
            "value":{"type":"string"}
         },
        "dependencies":{
            "key":["value"]
        }}"#;
        let item = parser.parse(item).unwrap();
        let parser = Parser::new();
        let schema = parser.parse(schema).unwrap();
        let res = item.validate_with_schema(&schema);
        assert_eq!(res.is_err(), true);
        assert_eq!(res.err().unwrap().code, UclSchemaErrorType::MissingDependency)
    }
}