@specs-feup/clava-misra 1.0.0 → 1.0.1

package/src/misra/tests/S10_EssentialTypes.test.ts

@@ -1,253 +0,0 @@
-import MISRAReporter from "../MISRAReporter.js";
-import S10_EssentialTypePass from "../passes/S10_EssentialTypePass.js";
-import Query from "@specs-feup/lara/api/weaver/Query.js";
-import { FileJp, Joinpoint } from "@specs-feup/clava/api/Joinpoints.js";
-import { expectNumberOfErrors, registerSourceCode, TestFile } from "./utils.js";
-
-const passingOperands = `void goodOperands() {
-    bool bla, blb;
-    unsigned u8a, u8b, u16b;
-    char cha, chb;
-    enum ena {R,G,B} ena;
-    enum {K1=5}; 
-    int a1,s8a,s16b,s8b;
-    float f32a, f32b;
-
-    bla && blb;
-    bla ? u8a : u8b;
-    cha - chb;
-    cha > chb;
-    ena > a1;
-    K1 * s8a; /* Compliant as K1 from anonymous enum */
-    s8a + s16b;
-    -( s8a ) * s8b;
-    s8a > 0;
-    --s16b;
-    u8a + u16b;
-    u8a & 2U;
-    u8a > 0U;
-    u8a << 2U;
-    u8a << 1; /* Compliant by exception */
-    f32a + f32b;
-    f32a > 0.0;
-
-    '0' + u8a; /* Convert u8a to digit */
-    s8a + '0'; /* Convert s8a to digit */
-    cha - '0'; /* Convert cha to ordinal */
-    '0' - s8a; /* Convert -s8a to digit */
-}`;
-
-const failingOperands = `void badOperands() {
-    char cha, chb;
-    enum ena {R,G,B} ena;
-    bool bla, blb;
-    int a1,a2,s8a;
-    unsigned u8a;
-    float f32a;
-
-    cha && bla ; /* Rationale 2 - char type used as a Boolean value */
-    ena ? a1 : a2 ; /* Rationale 2 - enum type used as a Boolean value */
-    s8a && bla ; /* Rationale 2 - signed type used as a Boolean value */
-    u8a ? a1 : a2 ; /* Rationale 2 - unsigned type used as a Boolean value */
-    f32a && bla ; /* Rationale 2 - floating type used as a Boolean value */
-    bla * blb ; /* Rationale 3 - Boolean used as a numeric value */
-    bla > blb ; /* Rationale 3 - Boolean used as a numeric value */
-    cha & chb ; /* Rationale 4 - char type used as a numeric value */
-    cha << 1 ;  /* Rationale 4 - char type used as a numeric value */
-    ena * a1 ; /* Rationale 5 - enum type used in arithmetic operation */
-    s8a & 2 ; /* Rationale 6 - bitwise operation on signed type */
-    50 << 3U ;  /* Rationale 6 - shift operation on signed type */
-    u8a << s8a ;  /* Rationale 7 - shift magnitude uses signed type */
-    u8a << -1 ;  /* Rationale 7 - shift magnitude uses signed type */
-    -u8a ; /* Rationale 8 - unary minus on unsigned type */
-
-    int s16a;
-    s16a - 'a';
-    '0' + f32a;
-    cha + ':';
-    cha - ena;
-}`;
-
-const operandFiles: TestFile[] = [
-    {name: "badoperands.cpp", code: failingOperands},
-    {name: "goodoperands.cpp", code: passingOperands},
-];
-
-const passingAssignments = `void use_uint16(unsigned int a) {
-    return;
-}
-
-void goodAssignments() {
-    unsigned char u8b, u8c, u8d;
-    enum ena {R,G,B} ena;
-    enum {A1, K1};
-    int s8a;
-    char cha;
-
-    unsigned int u8a = 0; /* By exception */
-    bool flag = ( bool ) 0;
-    bool set = true; /* true is essentially Boolean */
-    bool get = ( u8b > u8c );
-    s8a = K1; /* Constant value fits */
-    u8a = 2; /* By exception */
-    //u8a = 2 * 24; /* By exception */ <-- DO THIS WHEN ISINTEGERCONSTANTEXPR IS AVAILABLE
-    u8a = ( unsigned int ) s8a; /* Cast gives same essential type */
-
-    unsigned int u32a;
-    unsigned char u16a, u16b;
-    u32a = u16a; /* Assignment to a wider essential type */
-    u32a = 2U + 125U; /* Assignment to a wider essential type */
-    use_uint16 ( u8a ); /* Assignment to a wider essential type */
-    use_uint16 ( u8a + u16b ); /* Assignment to same essential type */
-}`;
-
-const failingAssignments = `void use_uint32(unsigned int a) {
-    return;
-}
-
-void use_uint16(unsigned short a) {
-    return;
-}
-
-unsigned char foo1 ( unsigned int x )
-{
-return x; /* uint16_t to uint8_t */
-}
-
-void badAssignments() {
-    char cha;
-    unsigned u8b, u8c;
-    int s32a;
-    short u16a;
-    long u32a;
-
-    unsigned u8a = 1.0f; /* unsigned and floating */
-    bool bla = 0; /* boolean and signed */
-    cha = 7; /* character and signed */
-    u8a = 'a'; /* unsigned and character */
-    u8b = 1 - 2; /* unsigned and signed */
-    //u8c += 'a'; /* u8c = u8c + 'a' assigns character to unsigned */
-    use_uint32 ( s32a ); /* signed and unsigned */
-    //s8a = K2; /* Constant value does not fit */
-    u16a = u32a; /* uint32_t to uint16_t */
-    use_uint16 ( u32a ); /* uint32_t to uint16_t */
-}`;
-
-const assignmentFiles: TestFile[] = [
-    {name: "badassignments.cpp", code: failingAssignments},
-    {name: "goodassignments.cpp", code: passingAssignments}
-];
-
-const failingCasts = `void badCasts() {
-    enum enuma {R,G,B} ena;
-    enum enumc {C,M,Y} enc;
-
-    //( bool ) false; /* Compliant - 'false' is essentially Boolean */
-    //( int ) 3U; /* Compliant */
-    //( bool ) 0; /* Compliant - by exception */
-    ( bool ) 3U; /* Non-compliant */
-    //( int ) ena; /* Compliant */
-    ( enum enuma ) 3; /* Non-compliant */
-    //( char ) enc; /* Compliant */
-}`;
-
-const passingCasts = `void goodCasts() {
-    enum enuma {R,G,B} ena;
-    enum enumc {C,M,Y} enc;
-
-    ( bool ) false; /* Compliant - 'false' is essentially Boolean */
-    ( int ) 3U; /* Compliant */
-    ( bool ) 0; /* Compliant - by exception */
-    //( bool ) 3U; /* Non-compliant */
-    ( int ) ena; /* Compliant */
-    //( enum enuma ) 3; /* Non-compliant */
-    ( char ) enc; /* Compliant */
-}`;
-
-const castFiles: TestFile[] = [
-    {name: "goodcasts.cpp", code: passingCasts},
-    {name: "badcasts.cpp", code: failingCasts}
-];
-
-const passingComposites = `void goodComposites() {
-    unsigned short u16a,u16b,u16c;
-    unsigned long u32a,u32b;
-    signed long s32a;
-
-    u16c = u16a + u16b; /* Same essential type */
-    u32a = ( unsigned long ) u16a + u16b; /* Cast causes addition in uint32_t */
-
-    ( unsigned short ) ( u32a + u32b ); /* Compliant */
-    ( unsigned long ) s32a; /* Compliant - s32a is not composite */
-}`;
-
-const failingComposites = `void badComposites() {
-    unsigned short u16a,u16b,u16c;
-    unsigned long u32a,u32b;
-    signed long s32a,s32b;
-
-    u32a = u16a + u16b; /* Implicit conversion on assignment */
-    ( unsigned short ) ( s32a + s32b );
-    //( unsigned long ) ( u16a + u16b ); WIDTH PROBLEMS
-}`;
-
-const compositeFiles: TestFile[] = [
-    {name: "goodcomposites.cpp", code: passingComposites},
-    {name: "badcomposites.cpp", code: failingComposites}
-]
-
-describe("Essential type model: operands", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S10_EssentialTypePass(true, [1, 2]);
-    registerSourceCode(operandFiles);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 0, Query.search(FileJp, {name: "goodoperands.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => {
-        expectNumberOfErrors(reporter, pass, 24, Query.search(FileJp, {name: "badoperands.cpp"}).first() as Joinpoint);
-    });
-});
-
-describe("Essential type model: assignments", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S10_EssentialTypePass(true, [3]);
-    registerSourceCode(assignmentFiles);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 0, Query.search(FileJp, {name: "goodassignments.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => { //SHOULD BE 9 BUT DOESNT WORK FOR RETURN STMTS
-        expectNumberOfErrors(reporter, pass, 8, Query.search(FileJp, {name: "badassignments.cpp"}).first() as Joinpoint);
-    });
-});
-
-describe("Essential type model: casts", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S10_EssentialTypePass(true, [5]);
-    registerSourceCode(castFiles);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 0, Query.search(FileJp, {name: "goodcasts.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => { //SHOULD BE 9 BUT DOESNT WORK FOR RETURN STMTS
-        expectNumberOfErrors(reporter, pass, 2, Query.search(FileJp, {name: "badcasts.cpp"}).first() as Joinpoint);
-    });
-});
-
-describe("Essential type model: composite expressions", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S10_EssentialTypePass(true, [6,8]);
-    registerSourceCode(compositeFiles);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 0, Query.search(FileJp, {name: "goodcomposites.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => { //SHOULD BE 9 BUT DOESNT WORK FOR RETURN STMTS
-        expectNumberOfErrors(reporter, pass, 2, Query.search(FileJp, {name: "badcomposites.cpp"}).first() as Joinpoint);
-    });
-});

package/src/misra/tests/S12_Expressions.test.ts

@@ -1,43 +0,0 @@
-import MISRAReporter from "../MISRAReporter.js";
-import S12_ExpressionPass from "../passes/S12_ExpressionPass.js";
-import Query from "@specs-feup/lara/api/weaver/Query.js";
-import { FileJp, Joinpoint } from "@specs-feup/clava/api/Joinpoints.js";
-import { expectNumberOfErrors, registerSourceCode, TestFile } from "./utils.js";
-
-const passingCode = `int main(int argc, char *argv[]) {
-    int x, y, z;
-   x = 2;
-   y = 3;
-
-   x = x + (y * z);
-
-    return 0;
-}`;
-
-const failingCode = `int test(int argc, char *argv[]) {
-    int x, y, z;
-   x = 2, y = 3;
-
-   x = x + y * z;
-
-    return 0;
-}`;
-
-const files: TestFile[] = [
-    {name: "bad.cpp", code: failingCode},
-    {name: "good.cpp", code: passingCode}
-]
-
-describe("Expressions", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S12_ExpressionPass(true, [1, 3]);
-    registerSourceCode(files);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 0, Query.search(FileJp, {name: "good.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => {
-        expectNumberOfErrors(reporter, pass, 2, Query.search(FileJp, {name: "bad.cpp"}).first() as Joinpoint);
-    });
-});

package/src/misra/tests/S13_SideEffects.test.ts

@@ -1,77 +0,0 @@
-import MISRAReporter from "../MISRAReporter.js";
-import S13_SideEffectPass from "../passes/S13_SideEffectPass.js";
-import Query from "@specs-feup/lara/api/weaver/Query.js";
-import { FileJp, Joinpoint } from "@specs-feup/clava/api/Joinpoints.js";
-import { expectNumberOfErrors, registerSourceCode, TestFile } from "./utils.js";
-
-const passingCode = `int v1;
-void f1 ( void )
-{
-int a[ 2 ] = { v1, 0 };
-}
-int x = 0u;
-extern void p ( int a[ 2 ] );
-void h1 ( void )
-{
-/* Non-compliant - two side effects */
-p ( ( int[ 2 ] ) { x, x } );
-}
-
-void foo1() {
-    unsigned u8a, u8b;
-    int a[4], x, y, s;
-    u8a = ( 1u == 1u ) ? 0u : u8b;
-    u8b++;
-    s = sizeof ( 5 ); 
-    if ( ( x == 0u ) || ( v1 == 1u ) )
-{
-}
-}`;
-
-const failingCode = `volatile int v1;
-void f ( void )
-{
-/* Non-compliant - volatile access is persistent side effect */
-int a[ 2 ] = { v1, 0 };
-}
-int x = 0u;
-extern void p ( int a[ 2 ] );
-void h ( void )
-{
-/* Non-compliant - two side effects */
-p ( ( int[ 2 ] ) { x++, x++ } );
-}
-
-int bar() {
-    return 5;
-}
-
-void foo() {
-    unsigned u8a, u8b;
-    int a[4], x, y, s;
-    u8a = ( 1u == 1u ) ? 0u : u8b++;
-    s = sizeof ( bar() ); /* Non-compliant */
-    a[ x ] = a[ x = y ];
-    if ( ( x == 0u ) || ( v1 == 1u ) )
-{
-}
-}`;
-
-const files: TestFile[] = [
-    {name: "bad.cpp", code: failingCode},
-    {name: "good.cpp", code: passingCode}
-]
-
-describe("Expressions", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S13_SideEffectPass(true, [1, 3, 4, 5, 6]);
-    registerSourceCode(files);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 0, Query.search(FileJp, {name: "good.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => {
-        expectNumberOfErrors(reporter, pass, 8, Query.search(FileJp, {name: "bad.cpp"}).first() as Joinpoint);
-    });
-});

package/src/misra/tests/S15_ControlFlow.test.ts

@@ -1,144 +0,0 @@
-import MISRAReporter from "../MISRAReporter.js";
-import S15_ControlFlowPass from "../passes/S15_ControlFlowPass.js";
-import Query from "@specs-feup/lara/api/weaver/Query.js";
-import { FileJp, Joinpoint } from "@specs-feup/clava/api/Joinpoints.js";
-import { expectNumberOfErrors, registerSourceCode, TestFile } from "./utils.js";
-
-const passingCode = `void f ( void )
-{
-int j = 0;
-++j;
-if ( 10 == j )
-{
-goto L2; /* Compliant */
-}
-L2 :
-++j;
-}
-
-void f1 ( int a )
-{
-if ( a <= 0 )
-{
-}
-goto L1; /* Compliant */
-if ( a == 0 )
-{
-goto L1; /* Compliant */
-}
-L1:
-if ( a > 0 )
-{
-L2:
-;
-}
-}
-
-void f2() {
-   int x,y,z;
-   while ( x != 0u )
-{
-x = 5;
-if ( x == 1u )
-{
-break;
-}
-while ( y != 0u )
-{
-y = 6;
-if ( y == 1u )
-{
-goto L1;
-}
-}
-L1:
-z = x + y;
-}
-}
-
-int main(int argc, char *argv[]) {
-
-
-    return 0;
-}`;
-
-const failingCode = `void g ( void )
-{
-int j = 0;
-L1:
-++j;
-if ( 10 == j )
-{
-goto L2; /* Compliant */
-}
-goto L1; /* Non-compliant */
-L2 :
-++j;
-}
-
-void g1 ( int a )
-{
-if ( a <= 0 )
-{
-goto L2; /* Non-compliant */
-}
-goto L1; /* Compliant */
-if ( a == 0 )
-{
-goto L1; /* Compliant */
-}
-goto L2; /* Non-compliant */
-L1:
-if ( a > 0 )
-{
-L2:
-;
-}
-}
-
-void g2() {
-   int x,y,z;
-   while ( x != 0u )
-{
-x = 5;
-if ( x == 1u )
-{
-break;
-}
-while ( y != 0u )
-{
-y = 6;
-if ( y == 1u )
-{
-goto L1;
-}
-}
-}
-L1:
-z = x + y;
-}
-
-int test(int argc, char *argv[]) {
-
-
-    return 0;
-}`;
-
-const files: TestFile[] = [
-    {name: "bad.cpp", code: failingCode},
-    {name: "good.cpp", code: passingCode}
-]
-
-describe("Expressions", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S15_ControlFlowPass(true, [1, 2, 3, 4]);
-    registerSourceCode(files);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 4, Query.search(FileJp, {name: "good.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => {
-        expectNumberOfErrors(reporter, pass, 11, Query.search(FileJp, {name: "bad.cpp"}).first() as Joinpoint);
-    });
-});

package/src/misra/tests/S16_SwitchStatements.test.ts

@@ -1,164 +0,0 @@
-import MISRAReporter from "../MISRAReporter.js";
-import S16_SwitchStatementPass from "../passes/S16_SwitchStatementPass.js";
-import Query from "@specs-feup/lara/api/weaver/Query.js";
-import { FileJp, Joinpoint } from "@specs-feup/clava/api/Joinpoints.js";
-import { expectNumberOfErrors, registerSourceCode, TestFile } from "./utils.js";
-
-const passingMisc = `void f ( void )
-{
-    int x;
-    bool flag;
-    switch ( x )
-{
-case 1:
-case 2: 
-x = 1;
-break;
-default:
-break;
-}
-switch (x) {
-    case 1:
-    case 2:
-    default:
-    break;
-}
-}`;
-
-const failingMisc = `void f ( void )
-{
-    int x;
-    bool flag;
-    switch ( x )
-{
-case 1: /* Compliant */
-if ( flag )
-{
-case 2: /* Non-compliant */
-x = 1;
-}
-break;
-default:
-break;
-case 3:
-break;
-}
-switch (x) {
-    case 1:
-    case 2:
-    break;
-}
-}`;
-
-const passingFormat = `void f ( void )
-{
-    int x, y, z;
-    int flag;
-    switch (x) {
-        case 1:
-            z = y+x;
-            break;
-        case 2:
-            z = y-x;
-            break;
-        default:
-            z = 4;
-            break;
-    }
-    switch (flag) {
-        case 0:
-            x = 2;
-            break;
-        case 1: 
-            x = 4;
-            break;
-        case 2:
-            x = 6;
-            break;
-    }
-    switch (z) {
-        case 1:
-            y = 0;
-            break;
-        case 6:
-        case 42:
-            y = 1;
-            break;
-        case 9139:
-        default:
-            y = 2;
-            break;
-    }
-}`;
-
-const failingFormat = `void f ( void )
-{
-    int x, y, z;
-    bool flag;
-    switch (x) {
-        case 1:
-            z = y+x;
-        case 2:
-            z = y-x;
-            break;
-        default:
-            z = 4;
-    }
-    switch (flag) {
-        case 0:
-            x = 2;
-            break;
-        case 1: 
-            x = 4;
-            break;
-    }
-    switch (z) {
-        case 1:
-        case 6:
-        case 42:
-            y = 1;
-            break;
-        case 9139:
-        default:
-            y = 2;
-            break;
-    }
-}`;
-
-const miscFiles: TestFile[] = [
-    {name: "badmmisc.cpp", code: failingMisc},
-    {name: "goodmisc.cpp", code: passingMisc}
-];
-
-const formatFiles: TestFile[] = [
-    {name: "badformat.cpp", code: failingFormat},
-    {name: "goodformat.cpp", code: passingFormat}
-];
-
-describe("Switch statements: misc", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S16_SwitchStatementPass(true, [2, 4, 5]);
-    registerSourceCode(miscFiles);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 0, Query.search(FileJp, {name: "goodmisc.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => {
-        expectNumberOfErrors(reporter, pass, 3, Query.search(FileJp, {name: "badmisc.cpp"}).first() as Joinpoint);
-    });
-});
-
-describe("Switch statements: format", () => {
-    const reporter = new MISRAReporter();
-    const pass = new S16_SwitchStatementPass(true, [1, 6, 7]);
-    registerSourceCode(formatFiles);
-
-    it("should pass", () => {
-        expectNumberOfErrors(reporter, pass, 0, Query.search(FileJp, {name: "goodformat.cpp"}).first() as Joinpoint);
-    });
-    
-    it("should fail", () => {
-        expectNumberOfErrors(reporter, pass, 5, Query.search(FileJp, {name: "badformat.cpp"}).first() as Joinpoint);
-    });
-});