Merge pull request #52 from srcML/develop

Add guarding to stack accesses

Author: Joshua2000B

nameCollector.cpp

@@ -10,16 +10,13 @@
 /**
  *
  * Takes srcML input (with --position) of a source code file(s)
- *  Gets a vector<identifier> which contains name, category, and position
- *  of all the user defined identifiers in the file
- *
  * Works for srcML single unit or archives.
  *
- *
  * Need to have installed: libxml2 and srcml
  * Need to build and install srcSAX:
  *  In srcSAX folder:
- *    cmake CMakeLists.txt
+ *    cmake CMakeLists.txt -B build
+ *    cd build
  *    make
  *    sudo make install
  *
@@ -50,8 +47,13 @@ int main(int argc, char * argv[]) {
     bool        noHeader     = false; //Do not print header in csv
     bool        appendOutput = false;
 
-    CLI::App app{"nameCollector: Output all user defined identifier names in a srcML file (i.e., one or more source code files).  "};
+    std::string   description = "nameCollector";
+    description = description + "\n Produces a list of all user defined identifier names in a source code file(s).  Works for C, C++, C#, Java, Python. ";
+    description = description + "\n Input: a srcML file/archive - which is one or more source code files. srcML needs --position option.";
+    description = description + "\n Output: For each name gives type, syntactic category, and location in file.  CSV or text description output.";
+    description = description + "\n Typical USAGE: ./nameCollector -i foo.cpp.xml -o foo.cpp.csv --csv \n";
 
+    CLI::App app{description};
     app.add_option("-i, --input",    inputFile,    "Name of srcML file of source code with --position option");
     app.add_option("-o, --output",   outputFile,   "Name of output file");
     app.add_option("-f, --format",   outputFormat, "The output format (text by default): csv, text"); //To support other output options

nameCollectorHandler.hpp

@@ -503,4 +503,191 @@ else
     echo "Test set_pos passed"
 fi
 
+
+# Testing the CSV header and position attribute features
+#####################################################################
+cat <<EOF > archive_position.xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<unit xmlns="http://www.srcML.org/srcML/src" xmlns:pos="http://www.srcML.org/srcML/position" revision="1.0.0" pos:tabs="8">
+
+<unit revision="1.0.0" language="C++" filename="a.cpp" pos:tabs="8" hash="7caa72dfd567a04e9e64b0502814bde478a317b5"><decl_stmt pos:start="1:1" pos:end="1:6"><decl pos:start="1:1" pos:end="1:5"><type pos:start="1:1" pos:end="1:3"><name pos:start="1:1" pos:end="1:3">int</name></type> <name pos:start="1:5" pos:end="1:5">x</name></decl>;</decl_stmt>
+</unit>
+
+</unit>
+EOF
+
+output=$(cat archive_position.xml | ../bin/nameCollector --csv 2>&1 )
+expected=$(cat <<EOF
+Name,Type,Category,File,Position,Language,Stereotype
+x,int,global,a.cpp,1:5,C++,
+EOF
+)
+if [[ "$output" != "$expected" ]]; then
+    echo "Test archive_position passed failed!"
+    echo "Expected: '$expected'"
+    echo "Got:      '$output'"
+    exit 1
+else
+    echo "Test archive_position passed"
+fi
+
+#####################################################################
+cat <<EOF > archive_no_position.xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<unit xmlns="http://www.srcML.org/srcML/src" revision="1.0.0">
+
+<unit revision="1.0.0" language="C++" filename="a.cpp" hash="7caa72dfd567a04e9e64b0502814bde478a317b5"><decl_stmt><decl><type><name>int</name></type> <name>x</name></decl>;</decl_stmt>
+</unit>
+
+</unit>
+EOF
+
+output=$(cat archive_no_position.xml | ../bin/nameCollector --csv 2>&1 )
+expected=$(cat <<EOF
+WARNING: srcml --position NOT used to generate input file.
+Name,Type,Category,File,Position,Language,Stereotype
+x,int,global,a.cpp,,C++,
+EOF
+)
+if [[ "$output" != "$expected" ]]; then
+    echo "Test archive_no_position passed failed!"
+    echo "Expected: '$expected'"
+    echo "Got:      '$output'"
+    exit 1
+else
+    echo "Test archive_no_position passed"
+fi
+
+#####################################################################
+cat <<EOF > single_unit_position.xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<unit xmlns="http://www.srcML.org/srcML/src" xmlns:pos="http://www.srcML.org/srcML/position" revision="1.0.0" language="C++" filename="a.cpp" pos:tabs="8"><decl_stmt pos:start="1:1" pos:end="1:6"><decl pos:start="1:1" pos:end="1:5"><type pos:start="1:1" pos:end="1:3"><name pos:start="1:1" pos:end="1:3">int</name></type> <name pos:start="1:5" pos:end="1:5">x</name></decl>;</decl_stmt>
+</unit>
+EOF
+
+output=$(cat single_unit_position.xml | ../bin/nameCollector --csv 2>&1 )
+expected=$(cat <<EOF
+Name,Type,Category,File,Position,Language,Stereotype
+x,int,global,a.cpp,1:5,C++,
+EOF
+)
+if [[ "$output" != "$expected" ]]; then
+    echo "Test single_unit_position passed failed!"
+    echo "Expected: '$expected'"
+    echo "Got:      '$output'"
+    exit 1
+else
+    echo "Test single_unit_position passed"
+fi
+
+#####################################################################
+cat <<EOF > single_unit_no_position.xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<unit xmlns="http://www.srcML.org/srcML/src" revision="1.0.0" language="C++" filename="a.cpp"><decl_stmt><decl><type><name>int</name></type> <name>x</name></decl>;</decl_stmt>
+</unit>
+EOF
+
+output=$(cat single_unit_no_position.xml | ../bin/nameCollector --csv 2>&1 )
+expected=$(cat <<EOF
+WARNING: srcml --position NOT used to generate input file.
+Name,Type,Category,File,Position,Language,Stereotype
+x,int,global,a.cpp,,C++,
+EOF
+)
+if [[ "$output" != "$expected" ]]; then
+    echo "Test single_unit_no_position passed failed!"
+    echo "Expected: '$expected'"
+    echo "Got:      '$output'"
+    exit 1
+else
+    echo "Test single_unit_no_position passed"
+fi
+
+#####################################################################
+cat <<EOF > double_file_position.xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<unit xmlns="http://www.srcML.org/srcML/src" xmlns:pos="http://www.srcML.org/srcML/position" revision="1.0.0" pos:tabs="8">
+
+<unit revision="1.0.0" language="C++" filename="a.cpp" pos:tabs="8" hash="7caa72dfd567a04e9e64b0502814bde478a317b5"><decl_stmt pos:start="1:1" pos:end="1:6"><decl pos:start="1:1" pos:end="1:5"><type pos:start="1:1" pos:end="1:3"><name pos:start="1:1" pos:end="1:3">int</name></type> <name pos:start="1:5" pos:end="1:5">x</name></decl>;</decl_stmt>
+</unit>
+
+<unit revision="1.0.0" language="C++" filename="b.cpp" pos:tabs="8" hash="4d9f53177cc4ca85d01a8b93ffb6d9b4f9effe7f"><decl_stmt pos:start="1:1" pos:end="1:6"><decl pos:start="1:1" pos:end="1:5"><type pos:start="1:1" pos:end="1:3"><name pos:start="1:1" pos:end="1:3">int</name></type> <name pos:start="1:5" pos:end="1:5">y</name></decl>;</decl_stmt>
+</unit>
+
+</unit>
+EOF
+
+output=$(cat double_file_position.xml | ../bin/nameCollector --csv 2>&1 )
+expected=$(cat <<EOF
+Name,Type,Category,File,Position,Language,Stereotype
+x,int,global,a.cpp,1:5,C++,
+y,int,global,b.cpp,1:5,C++,
+EOF
+)
+if [[ "$output" != "$expected" ]]; then
+    echo "Test double_file_position passed failed!"
+    echo "Expected: '$expected'"
+    echo "Got:      '$output'"
+    exit 1
+else
+    echo "Test double_file_position passed"
+fi
+
+#####################################################################
+cat <<EOF > double_file_no_position.xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<unit xmlns="http://www.srcML.org/srcML/src" revision="1.0.0">
+
+<unit revision="1.0.0" language="C++" filename="a.cpp" hash="7caa72dfd567a04e9e64b0502814bde478a317b5"><decl_stmt><decl><type><name>int</name></type> <name>x</name></decl>;</decl_stmt>
+</unit>
+
+<unit revision="1.0.0" language="C++" filename="b.cpp" hash="4d9f53177cc4ca85d01a8b93ffb6d9b4f9effe7f"><decl_stmt><decl><type><name>int</name></type> <name>y</name></decl>;</decl_stmt>
+</unit>
+
+</unit>
+EOF
+
+output=$(cat double_file_no_position.xml | ../bin/nameCollector --csv 2>&1 )
+expected=$(cat <<EOF
+WARNING: srcml --position NOT used to generate input file.
+Name,Type,Category,File,Position,Language,Stereotype
+x,int,global,a.cpp,,C++,
+y,int,global,b.cpp,,C++,
+EOF
+)
+if [[ "$output" != "$expected" ]]; then
+    echo "Test double_file_no_position passed failed!"
+    echo "Expected: '$expected'"
+    echo "Got:      '$output'"
+    exit 1
+else
+    echo "Test double_file_no_position passed"
+fi
+
+#####################################################################
+cat <<EOF > archive_no_header.xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<unit xmlns="http://www.srcML.org/srcML/src" xmlns:pos="http://www.srcML.org/srcML/position" revision="1.0.0" pos:tabs="8">
+
+<unit revision="1.0.0" language="C++" filename="a.cpp" pos:tabs="8" hash="7caa72dfd567a04e9e64b0502814bde478a317b5"><decl_stmt pos:start="1:1" pos:end="1:6"><decl pos:start="1:1" pos:end="1:5"><type pos:start="1:1" pos:end="1:3"><name pos:start="1:1" pos:end="1:3">int</name></type> <name pos:start="1:5" pos:end="1:5">x</name></decl>;</decl_stmt>
+</unit>
+
+</unit>
+EOF
+
+output=$(cat archive_no_header.xml | ../bin/nameCollector --csv -n 2>&1 )
+expected=$(cat <<EOF
+x,int,global,a.cpp,1:5,C++,
+EOF
+)
+if [[ "$output" != "$expected" ]]; then
+    echo "Test archive_no_header passed failed!"
+    echo "Expected: '$expected'"
+    echo "Got:      '$output'"
+    exit 1
+else
+    echo "Test archive_no_header passed"
+fi
+
+
 exit 0

testsuite/CMakeLists.txt

@@ -85,7 +85,7 @@ expected_functions=(
 for function in "${expected_functions[@]}"; do
   if ! echo "$output" | grep -Fq "$function"; then
     echo "Test test_c_function failed!"
-    echo "Expected field: '$function' not found"
+    echo "Expected function: '$function' not found"
     echo "Got:"
     echo "$output"
     exit 1

testsuite/cli.sh

@@ -0,0 +1,76 @@
+#!/bin/bash
+
+cat <<EOF > test_c_function_parameter.c
+#include <stdio.h>
+// passing function pointers
+void function_with_function_parameter ( int (*f)(int, int) ) {
+    int result;
+    for ( int ctr = 0 ; ctr < 5 ; ctr++ ) {
+        result = (*f)(ctr, (ctr+1));
+        printf("result: %d\n", result);
+    }
+}
+
+int add(int x, int y){
+  return x+y; 
+}
+
+void pass_function_with_multiple_parameters(void (*fxnPointer)(float, int, double)) {};
+void function_with_multiple_parameters(int (*fxnPointer2)(int, char), char, float) {};
+void function_with_multiple_function_parameters(int (*fxnPointerA)(int), char (*fxnPointerB)(char), void (*fxnPointerC)(float)) {};
+int main(){
+    function_with_function_parameter(add);
+    return 0;
+}
+
+EOF
+
+input=$(srcml test_c_function_parameter.c --position)
+output=$(echo "$input" | ./nameCollector )
+expected="function_with_function_parameter is a void function in C file: test_c_function_parameter.c:3:6
+f is a function-parameter in C file: test_c_function_parameter.c:3:47
+result is a int local in C file: test_c_function_parameter.c:4:9
+ctr is a int local in C file: test_c_function_parameter.c:5:15
+add is a int function in C file: test_c_function_parameter.c:11:5
+x is a int parameter in C file: test_c_function_parameter.c:11:13
+y is a int parameter in C file: test_c_function_parameter.c:11:20
+pass_function_with_multiple_parameters is a void function in C file: test_c_function_parameter.c:15:6
+fxnPointer is a function-parameter in C file: test_c_function_parameter.c:15:52
+function_with_multiple_parameters is a void function in C file: test_c_function_parameter.c:16:6
+fxnPointer2 is a function-parameter in C file: test_c_function_parameter.c:16:46
+function_with_multiple_function_parameters is a void function in C file: test_c_function_parameter.c:17:6
+fxnPointerA is a function-parameter in C file: test_c_function_parameter.c:17:55
+fxnPointerB is a function-parameter in C file: test_c_function_parameter.c:17:81
+fxnPointerC is a function-parameter in C file: test_c_function_parameter.c:17:108
+main is a int function in C file: test_c_function_parameter.c:18:5"
+
+
+expected_function_parameters=(
+    "f is a function-parameter in C file: test_c_function_parameter.c:3:47"
+    "fxnPointer is a function-parameter in C file: test_c_function_parameter.c:15:52"
+    "fxnPointer2 is a function-parameter in C file: test_c_function_parameter.c:16:46"
+    "fxnPointerA is a function-parameter in C file: test_c_function_parameter.c:17:55"
+    "fxnPointerB is a function-parameter in C file: test_c_function_parameter.c:17:81"
+    "fxnPointerC is a function-parameter in C file: test_c_function_parameter.c:17:108"
+)
+
+for function_parameter in "${expected_function_parameters[@]}"; do
+  if ! echo "$output" | grep -Fq "$function_parameter"; then
+    echo "Test test_c_function_parameter failed!"
+    echo "Expected function_parameter: '$function_parameter' not found"
+    echo "Got:"
+    echo "$output"
+    exit 1
+  fi
+done
+echo "Test test_c_function_parameter passed!" 
+
+if [[ "$output" != "$expected" ]]; then
+    echo "Test test_c_function_parameter output did not match expected!" 
+    echo "Expected: '$expected'"
+    echo "Got: '$output'"
+    exit 1
+fi
+# Repeat tests
+
+exit 0

testsuite/test_c_function.sh

@@ -0,0 +1,66 @@
+#!/bin/bash
+
+cat <<EOF > test_c_label.c
+#include <stdio.h>
+
+int main(){
+    int x=5;
+    if(x == 6){
+        goto conditionA;
+    } else if(x > 6){
+        goto conditonB;
+    } else{
+        goto conditionC; 
+    }
+
+    conditionA:
+        printf("conditonA");
+        goto end;
+    conditonB:
+        printf("conditonB");
+        goto end;
+    conditionC:
+        printf("conditonC");
+        goto end; 
+    end:
+        printf("\n");
+        return 0;
+}
+EOF
+
+input=$(srcml test_c_label.c --position)
+output=$(echo "$input" | ./nameCollector )
+expected="main is a int function in C file: test_c_label.c:3:5
+x is a int local in C file: test_c_label.c:4:9
+conditionA is a label in C file: test_c_label.c:13:5
+conditonB is a label in C file: test_c_label.c:16:5
+conditionC is a label in C file: test_c_label.c:19:5
+end is a label in C file: test_c_label.c:22:5"
+
+expected_label=(
+  "conditionA is a label in C file: test_c_label.c:13:5"
+  "conditonB is a label in C file: test_c_label.c:16:5"
+  "conditionC is a label in C file: test_c_label.c:19:5"
+  "end is a label in C file: test_c_label.c:22:5"
+)
+
+for label in "${expected_label[@]}"; do
+  if ! echo "$output" | grep -Fq "$label"; then
+    echo "Test test_c_label failed!"
+    echo "Expected label: '$label' not found"
+    echo "Got:"
+    echo "$output"
+    exit 1
+  fi
+done
+echo "Test test_c_label passed!" 
+
+if [[ "$output" != "$expected" ]]; then
+    echo "Test test_c_label output did not match expected!" 
+    echo "Expected: '$expected'"
+    echo "Got: '$output'"
+    exit 1
+fi
+# Repeat tests
+
+exit 0