refactoring fuzzer and sql_doc structures

Author: RPG-Alex

fuzz/fuzz_targets/sql_docs.rs

@@ -4,71 +4,7 @@ use libfuzzer_sys::fuzz_target;
 use std::str;
 
 use sql_docs::SqlDoc;
-use std::{fs, path::PathBuf};
 
-fuzz_target!(|data: &[u8]| {
-   const MAX_FILES: usize = 16;
-    const MAX_FILE_BYTES: usize = 8 * 1024;
-
-    if data.is_empty() {
-        return;
-    }
-
-    let tmp = match tempfile::tempdir() {
-        Ok(t) => t,
-        Err(_) => return,
-    };
-    let root = tmp.path();
-
-    let mut i = 0usize;
-    let file_count = (data[i] as usize % MAX_FILES).max(1);
-    i += 1;
-
-    for file_idx in 0..file_count {
-        if i >= data.len() {
-            break;
-        }
-
-        let name_len = (data[i] as usize % 24).max(1);
-        i += 1;
-        if i + name_len > data.len() {
-            break;
-        }
-
-        let name_bytes = &data[i..i + name_len];
-        i += name_len;
-
-        let mut name = String::with_capacity(name_len);
-        for &b in name_bytes {
-            name.push(match b {
-                b'a'..=b'z' | b'A'..=b'Z' | b'0'..=b'9' => b as char,
-                _ => '_',
-            });
-        }
-
-        let ext = if (file_idx + data[0] as usize) % 3 == 0 { "sql" } else { "txt" };
-        let path = root.join(format!("{name}_{file_idx}.{ext}"));
-
-        if i + 2 > data.len() {
-            break;
-        }
-        let raw_len = u16::from_le_bytes([data[i], data[i + 1]]) as usize;
-        i += 2;
-
-        let content_len = raw_len % MAX_FILE_BYTES;
-        if i + content_len > data.len() {
-            break;
-        }
-
-        let content = &data[i..i + content_len];
-        i += content_len;
-
-        let text = String::from_utf8_lossy(content);
-        let _ = fs::write(&path, text.as_bytes());
-    }
-    let res = SqlDoc::from_dir(root).build();
-    if let Err(e) = res {
-        let _ = e.to_string();
-        let _ = std::error::Error::source(&e);
-    }
+fuzz_target!(|data: String| {
+    
 });

src/docs.rs

@@ -1,6 +1,7 @@
 //! Module for parsing sql and comments and returning `table` and `column`
 //! information, including comments
 use core::fmt;
+use std::path::PathBuf;
 
 use sqlparser::ast::{Ident, ObjectName, ObjectNamePart, Spanned, Statement};
 
@@ -65,6 +66,7 @@ pub struct TableDoc {
     name: String,
     doc: Option<String>,
     columns: Vec<ColumnDoc>,
+    file: Option<PathBuf>,
 }
 
 impl TableDoc {
@@ -223,6 +225,25 @@ impl SqlFileDoc {
     pub fn tables(&self) -> &[TableDoc] {
         &self.tables
     }
+    /// Returns the number fo tables in the `SqlFileDoc`
+    #[must_use]
+    pub fn number_of_tables(&self) -> usize {
+        self.tables().len()
+    }
+}
+
+impl From<SqlFileDoc> for Vec<TableDoc> {
+    fn from(value: SqlFileDoc) -> Self {
+        value.tables
+    }
+}
+
+impl IntoIterator for SqlFileDoc {
+    type Item = TableDoc;
+    type IntoIter = <Vec<TableDoc> as IntoIterator>::IntoIter;
+    fn into_iter(self) -> Self::IntoIter {
+        self.tables.into_iter()
+    }
 }
 
 /// Helper function that will parse the table's schema and table name.

src/sql_doc.rs

@@ -21,9 +21,9 @@ pub struct SqlDoc {
 
 /// Builder structure for the [`SqlDoc`]
 #[derive(Debug, Eq, PartialEq)]
-pub struct SqlDocBuilder {
+pub struct SqlDocBuilder<'a> {
     /// The source for implementing the [`SqlDoc`] to be built
-    source: SqlFileDocSource,
+    source: SqlFileDocSource<'a>,
     /// The list of Paths to be ignored for parsing purposes.
     deny: Vec<String>,
     /// Used to indicate maintaining the `[(PathBuf, SqlFileDoc)]`
@@ -45,9 +45,10 @@ pub enum MultiFlatten {
 
 /// Enum for specifying a file doc source as a `directory` or a specific `file`
 #[derive(Debug, Eq, PartialEq)]
-enum SqlFileDocSource {
+enum SqlFileDocSource<'a>{
     Dir(PathBuf),
     File(PathBuf),
+    FromString(&'a str),
 }
 
 impl SqlDoc {
@@ -57,7 +58,7 @@ impl SqlDoc {
         Self { tables, files }
     }
     /// Method for generating builder from a directory.
-    pub fn from_dir<P: AsRef<Path>>(root: P) -> SqlDocBuilder {
+    pub fn from_dir<P: AsRef<Path> + ?Sized>(root: &P) -> SqlDocBuilder<'_> {
         SqlDocBuilder {
             source: SqlFileDocSource::Dir(root.as_ref().to_path_buf()),
             deny: Vec::new(),
@@ -66,7 +67,7 @@ impl SqlDoc {
         }
     }
     /// Method for generating builder from a [`Path`] of a single file
-    pub fn from_path<P: AsRef<Path>>(path: P) -> SqlDocBuilder {
+    pub fn from_path<P: AsRef<Path> + ?Sized>(path: &P) -> SqlDocBuilder<'_> {
         SqlDocBuilder {
             source: SqlFileDocSource::File(path.as_ref().to_path_buf()),
             deny: Vec::new(),
@@ -144,7 +145,7 @@ impl SqlDoc {
     }
 }
 
-impl SqlDocBuilder {
+impl SqlDocBuilder<'_> {
     /// Method for adding an item to the deny list
     ///
     /// # Parameters
@@ -181,7 +182,6 @@ impl SqlDocBuilder {
         self.multiline_flat = MultiFlatten::NoFlat;
         self
     }
-
     /// Builds the [`SqlDoc`]
     ///
     /// # Errors
@@ -193,18 +193,20 @@ impl SqlDocBuilder {
                 let gen_files = generate_docs_from_file(file)?;
                 let (path, sql_doc) = gen_files;
                 vec![(path, sql_doc)]
-            }
+            },
+            SqlFileDocSource::FromString(content) => {todo!()} 
         };
-        let mut tables = Vec::new();
+        let num_of_tables = docs.iter().map(|(_,s)| s.number_of_tables()).sum();
+        let mut tables = Vec::with_capacity(num_of_tables);
         let mut sql_doc = if self.retain_files {
             let files = docs;
             for (_, sql_doc) in &files {
-                tables.extend(sql_doc.tables().iter().cloned());
+                tables.extend(sql_doc.clone());
             }
             SqlDoc { tables, files: Some(files) }
         } else {
-            for (_, sql_doc) in &docs {
-                tables.extend(sql_doc.tables().iter().cloned());
+            for (_, sql_doc) in docs {
+                tables.extend(sql_doc);
             }
             SqlDoc { tables, files: None }
         };