Refactoring test folder structure

* Changing file structure for IN5

* Commonizing test functions

* Refactoring rules tests

* Removing in5 temporary

Author: kevv87

src/lint/rules/indentation.rs

@@ -324,35 +324,3 @@ impl Rule for IN9Rule {
          so that they are on the same level as the switch statement"
     }
 }
-
-#[cfg(test)]
-pub mod tests {
-
-    use crate::lint::rules::tests::assert_snippet;
-    use crate::lint::rules::instantiate_rules;
-    use crate::lint::LintCfg;
-    use crate::lint::LongLineOptions;
-    use std::convert::TryInto;
-
-    //  Line length can be configured to a maximum
-    //(defaults to 80, feature disabled)
-    pub static LONG_LINE: &str = "
-param some_parameter_name_in_this_device = some_long_name_bank.some_long_name_group.SOME_REGISTER_NAME;
-";
-    #[test]
-    fn style_check_long_line() {
-        let mut cfg = LintCfg::default();
-        let mut rules = instantiate_rules(&cfg);
-        assert_snippet(LONG_LINE, 1, &rules);
-        // Test rule disable
-        cfg.long_lines = None;
-        rules = instantiate_rules(&cfg);
-        assert_snippet(LONG_LINE, 0, &rules);
-        // Test lower max_length
-        cfg.long_lines = Some(LongLineOptions{
-            max_length: (LONG_LINE.len()-3).try_into().unwrap()
-        });
-        rules = instantiate_rules(&cfg);
-        assert_snippet(LONG_LINE, 1, &rules);
-    }
-}

src/lint/rules/mod.rs

@@ -1,6 +1,8 @@
 pub mod spacing;
 pub mod indentation;
-pub mod test;
+
+#[cfg(test)]
+pub mod tests;
 
 use spacing::{SpBracesRule,
     SpPunctRule, NspFunparRule, NspInparenRule,
@@ -41,29 +43,3 @@ pub trait Rule {
     fn name() -> &'static str;
     fn description() -> &'static str;
 }
-
-pub mod tests {
-
-use crate::lint::tests::create_ast_from_snippet;
-use crate::lint::begin_style_check;
-use crate::lint::rules::CurrentRules;
-use crate::analysis::LocalDMLError;
-use crate::vfs::Error;
-
-pub fn run_linter(source_code: &str, rules: &CurrentRules)
-    -> Result<Vec<LocalDMLError>, Error>
-{
-    print!("\nSnippet to test on:\n{}\n", source_code);
-    let ast = create_ast_from_snippet(source_code);
-    print!("Resulting AST:\n{:#?}\n", ast);
-    begin_style_check(ast, source_code.to_string(), rules)
-}
-
-pub fn assert_snippet(source_code: &str, expected_errors: usize, rules: &CurrentRules) {
-    let lint_errors = run_linter(source_code, rules);
-    assert!(lint_errors.is_ok());
-    assert_eq!(lint_errors.clone().unwrap().len(), expected_errors,
-               "{:#?}", lint_errors);
-}
-
-}

src/lint/rules/spacing.rs

@@ -519,215 +519,3 @@ impl Rule for NspTrailingRule {
         "Found trailing whitespace on row"
     }
 }
-
-#[cfg(test)]
-pub mod tests {
-
-    use crate::lint::rules::tests::assert_snippet;
-    use crate::lint::rules::instantiate_rules;
-    use crate::lint::LintCfg;
-
-    // Put whitespace (space or newline):
-    //  SP.reserved around reserved words, such as if, else, default,
-    //  size, const and in, except when a reserved word is used as an identifier
-    //  (e.g., local uint8 *data;)
-    pub static SP_RESERVED: &str = "
-method this_is_some_method() {
-    local int this_some_integer = 0x666;
-    if(this_some_integer == 0x666)
-        return;
-}
-";
-
-    //  SP.braces around braces ({ and })
-    pub static SP_BRACES: &str = "
-method this_is_some_method() {return 0;}
-
-method this_is_empty_method() { }
-
-bank pcie_config {register command {field mem {
-            method pcie_write(uint64 value) {
-                if (value != 0) {value = value + 1;
-                }
-                default(value);
-                map_memory_alt();}
-}}}
-";
-    #[test]
-    fn style_check_sp_braces() {
-        let mut cfg = LintCfg::default();
-        let mut rules = instantiate_rules(&cfg);
-        assert_snippet(SP_BRACES, 8, &rules);
-        // Test rule disable
-        cfg.sp_brace = None;
-        rules = instantiate_rules(&cfg);
-        assert_snippet(SP_BRACES, 0, &rules);
-
-    }
-
-    pub static SP_BRACES_02: &str = "
-typedef struct {uint16 idx;} hqm_cq_list_release_ctx_t;
-
-typedef layout \"little-endian\" {bitfields 8 {uint2 rsvd @ [7:6];
-        uint1 error_f          @ [5:5];
-        uint1 int_arm          @ [4:4];
-        uint1 qe_valid         @ [3:3];
-        uint1 qe_frag          @ [2:2];
-        uint1 qe_comp          @ [1:1];
-        uint1 cq_token         @ [0:0];} byte;} prod_qe_cmd_t;
-";
-    #[test]
-    fn style_check_sp_braces_02() {
-        let mut cfg = LintCfg::default();
-        let mut rules = instantiate_rules(&cfg);
-        assert_snippet(SP_BRACES_02, 6, &rules);
-        // Test rule disable
-        cfg.sp_brace = None;
-        rules = instantiate_rules(&cfg);
-        assert_snippet(SP_BRACES_02, 0, &rules);
-
-    }
-
-    //  SP.binop around binary operators except the dereferencing operators dot
-    //  (a.b) and arrow (a->b)
-    pub static SP_BINOP: &str = "
-method this_is_some_method() {
-    local int this_some_integer = 5+6;
-    if (this_some_integer == 0x666)
-        this_some_integer = this.val;
-}
-";
-
-    //  SP.ternary around ? and : in the ternary ?: operator
-    pub static SP_TERNARY: &str = "
-method this_is_some_method(bool flag) {
-    local int this_some_integer = (flag?5:7));
-}
-";
-
-    //  SP.punct after but not before colon, semicolon and comma
-    pub static SP_PUNCT: &str = "
-method this_is_some_method(bool flag ,int8 var) {
-    local int this_some_integer = 0x666 ;
-    if(this_some_integer == 0x666)
-        return;
-    some_func(arg1 ,arg2 ,arg3 ,arg4);
-}
-";
-    #[test]
-    fn style_check_sp_punct_rule() {
-        let mut cfg = LintCfg::default();
-        let mut rules = instantiate_rules(&cfg);
-        assert_snippet(SP_PUNCT, 9, &rules);
-        // Test rule disable
-        cfg.sp_punct = None;
-        rules = instantiate_rules(&cfg);
-        assert_snippet(SP_PUNCT, 0, &rules);
-    }
-
-    //  SP.ptrdecl between a type and the * marking a pointer
-    pub static SP_PTRDECL: &str = "
-method this_is_some_method(conf_object_t* dummy_obj) {
-    if(!dummy_obj)
-        return;
-}
-";
-
-    //  SP.comment around the comment delimiters //, /* and **/
-    pub static SP_COMMENT: &str = "
-/*Function
-documentation*/
-method this_is_some_method(conf_object_t *dummy_obj) {
-    if(!dummy_obj)//Not null
-        return;
-}
-";
-
-    // There should be no space:
-    //  NSP.funpar between a function/method name and its opening parenthesis
-    pub static NSP_FUNPAR: &str = "
-method this_is_some_method (conf_object_t *dummy_obj) {
-    if(!dummy_obj)
-        other_method_called ();
-}
-";
-    #[test]
-    fn style_check_nsp_funpar() {
-        let mut cfg = LintCfg::default();
-        let mut rules = instantiate_rules(&cfg);
-        assert_snippet(NSP_FUNPAR, 2, &rules);
-        // Test rule disable
-        cfg.nsp_funpar = None;
-        rules = instantiate_rules(&cfg);
-        assert_snippet(NSP_FUNPAR, 0, &rules);
-    }
-
-    //  NSP.inparen immediately inside parentheses or brackets
-    pub static NSP_INPAREN: &str = "
-method this_is_some_method( conf_object_t *dummy_obj ) {
-    if( !dummy_obj[ 0 ] )
-        return;
-}
-";
-    #[test]
-    fn style_check_nsp_inparen() {
-        let mut cfg = LintCfg::default();
-        let mut rules = instantiate_rules(&cfg);
-        assert_snippet(NSP_INPAREN, 6, &rules);
-        // Test rule disable
-        cfg.nsp_inparen = None;
-        rules = instantiate_rules(&cfg);
-        assert_snippet(NSP_INPAREN, 0, &rules);
-    }
-
-    //  NSP.unary between a unary operator and its operand
-    pub static NSP_UNARY: &str = "
-method this_is_some_method(conf_object_t *dummy_obj) {
-    if(! dummy_obj)
-        return;
-    local uint64 p = & dummy_obj;
-    p ++;
-    -- p;
-    local int64 neg = - 1;
-}
-";
-    #[test]
-    fn style_check_nsp_unary() {
-        let mut cfg = LintCfg::default();
-        let mut rules = instantiate_rules(&cfg);
-        assert_snippet(NSP_UNARY, 5, &rules);
-        // Test rule disable
-        cfg.nsp_unary = None;
-        rules = instantiate_rules(&cfg);
-        assert_snippet(NSP_UNARY, 0, &rules);
-    }
-
-    //  NSP.ptrdecl after the * marking a pointer in a declaration
-    pub static NSP_PTRDECL: &str = "
-method this_is_some_method(conf_object_t * dummy_obj) {
-    if(!dummy_obj)
-        return;
-}
-";
-
-    //  Adding trailing whitespace removal to spacing rules:
-    //  no whitespaces should be left at the end of a line between the last token
-    //  and the newline \n
-    pub static NSP_TRAILING: &str = "
-method this_is_some_method(int64 num) {
-    local int this_some_integer = 0x666;           
-    if (this_some_integer == 0x666)       
-        return;  
-}   
-";
-    #[test]
-    fn style_check_nsp_trailing() {
-        let mut cfg = LintCfg::default();
-        let mut rules = instantiate_rules(&cfg);
-        assert_snippet(NSP_TRAILING, 4, &rules);
-        // Test rule disable
-        cfg.nsp_trailing = None;
-        rules = instantiate_rules(&cfg);
-        assert_snippet(NSP_TRAILING, 0, &rules);
-    }
-}

src/lint/rules/tests/common.rs

@@ -0,0 +1,26 @@
+use crate::lint::{LintCfg, begin_style_check};
+use crate::lint::rules::{CurrentRules, instantiate_rules};
+use crate::lint::tests::create_ast_from_snippet;
+use crate::analysis::LocalDMLError;
+use crate::vfs::Error;
+
+pub fn run_linter(source_code: &str, rules: &CurrentRules)
+    -> Result<Vec<LocalDMLError>, Error>
+{
+    print!("\nSnippet to test on:\n{}\n", source_code);
+    let ast = create_ast_from_snippet(source_code);
+    print!("Resulting AST:\n{:#?}\n", ast);
+    begin_style_check(ast, source_code.to_string(), rules)
+}
+
+pub fn assert_snippet(source_code: &str, expected_errors: usize, rules: &CurrentRules) {
+    let lint_errors = run_linter(source_code, rules);
+    assert!(lint_errors.is_ok());
+    assert_eq!(lint_errors.clone().unwrap().len(), expected_errors,
+               "{:#?}", lint_errors);
+}
+
+pub fn set_up() -> CurrentRules {
+    let cfg = LintCfg::default();
+    instantiate_rules(&cfg)
+}