@specs-feup/clava-misra 1.0.2 → 1.0.4

package/src/tests/Section2_UnusedCode/Rule_2_4_UnusedTagDecl.test.ts

@@ -2,197 +2,277 @@ import Query from "@specs-feup/lara/api/weaver/Query.js";
 import { countErrorsAfterCorrection, countMISRAErrors, registerSourceCode, TestFile } from "../utils.js";
 import { FileJp } from "@specs-feup/clava/api/Joinpoints.js";
 
+const utils_code = `
+#include <stdint.h>
+#include <stdbool.h>
+
+void use_uint16(uint16_t param) {
+    (void)(param & 0xFF00U);
+}
+`;
+
+const utils_header = `
+#include <stdint.h>
+#include <stdbool.h>
+
+extern void use_uint16(uint16_t param);
+`;
+
+const misraExample = `
+#include "utils.h"
+
+static void unusedtag (void) {
+    enum state { // Violation of rule 2.4
+        S_init, 
+        S_run, 
+        S_sleep 
+    };  
+}
+
+static void test_2_4_1() {
+    typedef struct record_t { // Violation of rule 2.4
+        uint16_t  key;
+        uint16_t  val;
+    } record1_t;
+
+    typedef struct { 
+        uint16_t  key;
+        uint16_t  val;
+    } record2_t;
+    
+    record1_t var1;
+    record2_t var2;
+    use_uint16(var1.key + var1.val + var2.key + var2.val);
+}
+`;
+
+
 const failingCodeEnum1 = `
-    enum MyEnum { 
-        RED, GREEN, BLUE 
-    };
-
-    enum EnumForCast1 {
-        RED2, GREEN2, BLUE2
-    };
-
-    enum EnumForCast2 {
-        RED3, GREEN3, BLUE3
-    };
-
-    enum MyEnum2 {
-        RED4, GREEN4, BLUE4
-    };
-
-    enum EnumForPtr {
-        RED5, GREEN5, BLUE5
-    };
-
-    enum EnumForArray {
-        RED6, GREEN6, BLUE6
-    };
-
-    // Non-compliant
-    enum UnusedEnum {
-        RED7, GREEN7, BLUE7
-    };
-
-    void enumAsParam(enum MyEnum color) {
-        int i;
-        if (color == RED) {
-            i = 1;
-        }
+enum MyEnum { 
+    RED, GREEN, BLUE 
+};
+
+enum EnumForCast1 {
+    RED2, GREEN2, BLUE2
+};
+
+enum EnumForCast2 {
+    RED3, GREEN3, BLUE3
+};
+
+enum MyEnum2 {
+    RED4, GREEN4, BLUE4
+};
+
+enum EnumForPtr {
+    RED5, GREEN5, BLUE5
+};
+
+enum EnumForArray {
+    RED6, GREEN6, BLUE6
+};
+
+// Non-compliant
+enum UnusedEnum {
+    RED7, GREEN7, BLUE7
+};
+
+static void enumAsParam(enum MyEnum color) {
+    int i;
+    if (color == RED) {
+        i = 1;
     }
+}
 
-    enum EnumForCast1 enumAsReturn() {
-        return (enum EnumForCast1) RED2;
-    };
+static enum EnumForCast1 enumAsReturn() {
+    return (enum EnumForCast1) RED2;
+};
 
-    enum EnumForCast2 enumAsReturn2() {
-        int id = 2;
-        return (enum EnumForCast2) id;
-    };
+static enum EnumForCast2 enumAsReturn2() {
+    int id = 2;
+    return (enum EnumForCast2) id;
+};
 
+static void use_tags_2_4_1() {
     enum MyEnum2 color_enum = RED4;
-
     enum EnumForPtr *colorPtr;
-
     enum EnumForArray colorArray[3];
+
+    (void) color_enum;
+    (void) colorPtr;
+    (void) colorArray;
+}
 `;
 
 const failingCodeEnum2 = `
-    typedef enum {
-        A1,
-        B1,
-        C1
-    } ColorEnum2;
-    ColorEnum2 colorEnum2 = A1;
-
-    typedef enum MyColors {
-        A2,
-        B3,
-        C4
-    } ColorOption;
+typedef enum {
+    A1,
+    B1,
+    C1
+} ColorEnum2;
+
+typedef enum MyColors {
+    A2,
+    B3,
+    C4
+} ColorOption;
+
+// MyColors2 tag should be removed
+typedef enum MyColors2 {
+    A5,
+    B6,
+    C7
+} ColorOption2;
+
+static void use_tags_2_4_2() {
     enum MyColors my_color = A2;
     ColorOption color_option = B3;
-
-    // MyColors2 tag should be removed
-    typedef enum MyColors2 {
-        A5,
-        B6,
-        C7
-    } ColorOption2;
+    ColorEnum2 colorEnum2 = A1;
     ColorOption2 color2 = B6;
+
+    (void) my_color;
+    (void) color_option;
+    (void) colorEnum2;
+    (void) color2;
+}
 `;
 
 const failingCodeStruct1 = `
-    struct MyStruct {
-        int x;
-        float y;
-    };
-
-    struct StructForReturn1 {
-        int x;
-        float y;
-    };
-
-    struct MyStruct2 {
-        int x;
-        float y;
-    };
-
-    struct StructForPtr {
-        int x;
-        float y;
-    };
-
-    struct StructForArray {
-        int x;
-        float y;
-    };
-
-    // Non-compliant: should be removed
-    struct UnusedStruct {
-        int x;
-        float y;
-    };
-
-    void structAsParam(struct MyStruct s) {
-        int xField = s.x;
-    }
-
-    struct StructForReturn1 structAsReturn() {
-        return (struct StructForReturn1){1, 1.5f};
-    }
-
-    struct MyStruct2 myStruct = {10, 20.5f};
-    struct StructForPtr *structPtr;
-    struct StructForArray structArray[3];
+struct MyStruct {
+    int x;
+    float y;
+};
+
+struct StructForReturn1 {
+    int x;
+    float y;
+};
+
+struct MyStruct2 {
+    int x;
+    float y;
+};
+
+struct StructForPtr {
+    int x;
+    float y;
+};
+
+struct StructForArray {
+    int x;
+    float y;
+};
+
+// Non-compliant: should be removed
+struct UnusedStruct {
+    int x;
+    float y;
+};
+
+static void structAsParam(struct MyStruct s) {
+    int xField = s.x;
+}
+
+static struct StructForReturn1 structAsReturn() {
+    return (struct StructForReturn1){1, 1.5f};
+}
+
+static void use_tags_2_4_3() {
+    static struct MyStruct2 myStruct = {10, 20.5f};
+    static struct StructForPtr *structPtr;
+    static struct StructForArray structArray[3];
+
+    (void) myStruct;
+    (void) structPtr;
+    (void) structArray;
+}
 `;
 
 const failingCodeStruct2 = `
-    typedef struct {
-        int x;
-        float y;
-    } ColorStruct;
-    ColorStruct colorStruct = {1, 2.5};
-
-    typedef struct MyStruct5 {
-        int x;
-        float y;
-    } ColorStruct2;
-    struct MyStruct5 struct5 = {2, 4.5};
-    ColorStruct2 colorStruct2 = {1, 2.5};
-
-    // Violation: MyStruct3 tag will be removed
-    typedef struct MyStruct3 { 
-        int x;
-        float y;
-    } ColorStruct3;
-    ColorStruct3 colorStruct3 = {10, 5.5};
+typedef struct {
+    int x;
+    float y;
+} ColorStruct;
+
+typedef struct MyStruct5 {
+    int x;
+    float y;
+} ColorStruct2;
+
+// Violation: MyStruct3 tag will be removed
+typedef struct MyStruct3 { 
+    int x;
+    float y;
+} ColorStruct3;
+
+static void use_tags_2_4_4() {
+    static ColorStruct colorStruct = {1, 2.5};
+    static struct MyStruct5 struct5 = {2, 4.5};
+    static ColorStruct2 colorStruct2 = {1, 2.5};
+    static ColorStruct3 colorStruct3 = {10, 5.5};
+
+    (void) colorStruct;
+    (void) struct5;
+    (void) colorStruct2;
+    (void) colorStruct3;
+}
 `;
 
 const failingCodeUnion1 = `
-    union MyUnion {
-        int x;
-        float y;
-    };
-
-    union UnionForReturn1 {
-        int x;
-        float y;
-    };
-
-    union MyUnion2 {
-        int x;
-        float y;
-    };
-
-    union UnionForPtr {
-        int x;
-        float y;
-    };
-
-    union UnionForArray {
-        int x;
-        float y;
-    };
-
-    // Non-compliant: should be removed
-    union UnusedUnion {
-        int x;
-        float y;
-    };
-
-    void unionAsParam(union MyUnion u) {
-        int xField = u.x;
-    }
-
-    union UnionForReturn1 unionAsReturn() {
-        return (union UnionForReturn1){.x = 1};
-    }
-
+union MyUnion {
+    int x;
+    float y;
+};
+
+union UnionForReturn1 {
+    int x;
+    float y;
+};
+
+union MyUnion2 {
+    int x;
+    float y;
+};
+
+union UnionForPtr {
+    int x;
+    float y;
+};
+
+union UnionForArray {
+    int x;
+    float y;
+};
+
+// Non-compliant: should be removed
+union UnusedUnion {
+    int x;
+    float y;
+};
+
+static void unionAsParam(union MyUnion u) {
+    int xField = u.x;
+}
+
+static union UnionForReturn1 unionAsReturn() {
+    return (union UnionForReturn1){.x = 1};
+}
+
+static void use_tags_2_4_5() {
     union MyUnion2 myUnion = {.y = 20.5f};
     union UnionForPtr *unionPtr;
     union UnionForArray unionArray[3];
+
+    (void) myUnion;
+    (void) unionPtr;
+    (void) unionArray;
+}
 `;
 
 const files: TestFile[] = [
+    { name: "utils.c", code: utils_code },
+    { name: "utils.h", code: utils_header },
+    { name: "misra_example.c", code: misraExample },
     { name: "testEnum1.c", code: failingCodeEnum1 },
     { name: "testEnum2.c", code: failingCodeEnum2 },
     { name: "testStruct1.c", code: failingCodeStruct1 },
@@ -204,7 +284,7 @@ describe("Rule 2.4", () => {
     registerSourceCode(files);
 
     it("should detect errors in bad.c", () => {
-        expect(countMISRAErrors()).toBe(5);
+        expect(countMISRAErrors()).toBe(7);
 
         expect(countMISRAErrors(Query.search(FileJp, {name: "testEnum1.c"}).first()!)).toBe(1);
         expect(countMISRAErrors(Query.search(FileJp, {name: "testEnum2.c"}).first()!)).toBe(1);

package/src/tests/Section2_UnusedCode/Rule_2_6_UnusedLabels.test.ts

@@ -3,44 +3,56 @@ import { countErrorsAfterCorrection, countMISRAErrors, registerSourceCode, TestF
 import { FileJp } from "@specs-feup/clava/api/Joinpoints.js";
 
 const passingCode = `
-    int test1() {
-        int x = 0;
-        goto label1;
+static int test_2_6_2() {
+    int x = 0;
+    goto label1;
 
-        label1: 
-            x++;
+    label1: 
+        x++;
 
-        return 0;
-    }`;
+    return 0;
+}
+`;
 
 const failingCode = `
-    int test2() {
-        int x = 0;
-        label1: 
-            x = 1;
-            label2:
-                x++;
+static int test_2_6_1() {
+    int x = 0;
+    label1: // Violation of rule 2.6
+        x = 1;
+        label2: // Violation of rule 2.6
+            x++;
+
+    goto label3;
 
-        goto label3;
+    label3: 
+        x += 4;
+    return 0;
+}
+`;
 
-        label3: 
-            x += 4;
-        return 0;
-    }`;
+const misraExample = `
+static void unused_label ( void ) {
+    int x = 6;
+    label1: // Violation of rule 2.6
+    x++;
+}
+`;
 
 const files: TestFile[] = [
     { name: "bad.c", code: failingCode },
-    { name: "good.c", code: passingCode }
+    { name: "good.c", code: passingCode },
+    { name: "misra_example.c", code: misraExample }
 ];
 
 describe("Rule 2.6", () => {
     registerSourceCode(files);
 
     it("should detect errors in bad.c", () => {
-        expect(countMISRAErrors()).toBe(2);
+        expect(countMISRAErrors()).toBe(3);
 
         expect(countMISRAErrors(Query.search(FileJp, {name: "bad.c"}).first()!)).toBe(2);
         expect(countMISRAErrors(Query.search(FileJp, {name: "good.c"}).first()!)).toBe(0);
+        expect(countMISRAErrors(Query.search(FileJp, {name: "misra_example.c"}).first()!)).toBe(1);
     });
 
     it("should correct errors in bad.c", () => {

package/src/tests/Section2_UnusedCode/Rule_2_7_UnusedParameters.test.ts

@@ -1,52 +1,58 @@
-import Query from "@specs-feup/lara/api/weaver/Query.js";
 import { countErrorsAfterCorrection, countMISRAErrors, registerSourceCode, TestFile } from "../utils.js";
-import { FileJp } from "@specs-feup/clava/api/Joinpoints.js";
 
 const failingCode = `
-    int foo(int x, int y, int z); 
+int foo(int x, int y, int z); 
 
-    int foo(int x, int y, int z) { 
-        y++;
-        return y;
-    }
+int foo(int x, int y, int z) { 
+    y++;
+    return y;
+}
 
-    int main() {
-        int a = 5, b = 10, c = 15;
-        int result1 = foo(a, b, c);
+int main() {
+    int a = 5, b = 10, c = 15;
+    int result1 = foo(a, b, c);
 
-        int result2 = result1 + foo(a, b, c);
-        
-        return result2;
-    }`;
+    int result2 = result1 + foo(a, b, c);
+    
+    return result2;
+}
+`;
 
 const passingCode = `
-    extern int foo(int x, int y, int z);
+extern int foo(int x, int y, int z);
 
-    int my_func(int x, int y, int z) {
-        return x + y + z;
-    }
-        
-    int my_func2() {
-        return 0;
-    }
+static int my_func(int x, int y, int z) {
+    return x + y + z;
+}
+    
+static int my_func2() {
+    return 0;
+}
 
-    int bar() { 
-        return my_func(1, 2, 3) + foo(50, 51, 52);
-    }`;
+static int bar() { 
+    return my_func(1, 2, 3) + foo(50, 51, 52);
+}
+`;
+
+const misraExample = `
+#include <stdint.h>
+
+static void withunusedpara (uint16_t *para1, int16_t unusedpara ) { // Violation of rule 2.7
+    *para1 = 42U;
+}
+`;
 
 const files: TestFile[] = [
     { name: "bad.c", code: failingCode },
-    { name: "good.c", code: passingCode }
+    { name: "good.c", code: passingCode },
+    { name: "misra_example.c", code: misraExample }
 ];
 
 describe("Rule 2.7", () => {
     registerSourceCode(files);
 
     it("should detect errors in bad.c", () => {
-        expect(countMISRAErrors()).toBe(2);
-        
-        expect(countMISRAErrors(Query.search(FileJp, {name: "bad.c"}).first()!)).toBe(2);
-        expect(countMISRAErrors(Query.search(FileJp, {name: "good.c"}).first()!)).toBe(0);
+        expect(countMISRAErrors()).toBe(3);
     });
 
     it("should correct errors in bad.c", () => {

package/src/tests/Section3_Comments/Rule_3_1_CommentSequences.test.ts

@@ -2,32 +2,61 @@ import Query from "@specs-feup/lara/api/weaver/Query.js";
 import { countErrorsAfterCorrection, countMISRAErrors, registerSourceCode, TestFile } from "../utils.js";
 import { FileJp } from "@specs-feup/clava/api/Joinpoints.js";
 
-const passingCode = `int main() {
+const passingCode = `
+int static test_3_1_1() {
     int x, y, z;// good inline comment
     // good */ comment
+    // good // comment
     return 0;
-}`;
+}
+`;
 
-const failingCode = `int test() {
-    int x, y, z; // bad inl/*ine comment
+const failingCode = `
+static int test_3_1_2() {
+    int x, y, z; // bad inl/*ine comment - Violation of rule 3.1
+    
+    /* bad // comment - violation of rule 3.1 */
 
-    /* bad /* block comment */
+    /* bad /* block comment - Violation of rule 3.1*/
 
     return 0;
-}`;
+}
+`;
+
+const misraExample = `
+static int test_3_1_3() {
+    /* [Violation of rule 3.1] some comment, end comment marker accidentally omitted
+    <<New Page>>
+    Perform_Critical_Safety_Function( X );
+    /* this comment is non-compliant */
+
+    int x;
+    int y = 6;
+    int z = 3;
+
+    x = y // /* violation of rule 3.1
+        + z
+    // */
+    ;
+
+    return 0;
+}
+`;
 
 const files: TestFile[] = [
     { name: "bad.c", code: failingCode },
-    { name: "good.c", code: passingCode }
+    { name: "good.c", code: passingCode },
+    { name: "misra_c_example.c", code: misraExample },
 ];
 
 describe("Rule 3.1", () => {
     registerSourceCode(files);
 
     it("should detect errors in bad.c", () => {
-        expect(countMISRAErrors()).toBe(2);
+        expect(countMISRAErrors()).toBe(4);
 
         expect(countMISRAErrors(Query.search(FileJp, {name: "bad.c"}).first()!)).toBe(2);
+        expect(countMISRAErrors(Query.search(FileJp, {name: "misra_c_example.c"}).first()!)).toBe(2);
         expect(countMISRAErrors(Query.search(FileJp, {name: "good.c"}).first()!)).toBe(0);
     });