Initial test case validation using pyucis

.gitignore

@@ -4,3 +4,6 @@
 .settings/
 Debug/
 .pydevproject
+venv/
+setenv.sh
+fir.xml

examples/fir/Makefile

@@ -47,8 +47,12 @@ main: $(OBJFILES)
 obj/%.o: %.cpp
 	$(CC) $(CFLAGS) $(DEFINES) $(INCLUDES) $^ -o $@
 
-run:
+run: main
 	$(LDPATH) && ./$(EXEC)
 
+test: run
+	$(MAKE) -C ../../test/pyucis-fir/ validate_fir
+
 clean:
 	rm -rf obj $(EXEC)
+	rm coverage_results.xml

examples/fir/README.md

@@ -0,0 +1,15 @@
+# Build Instructions
+
+These are the build instructions for using the example
+
+```
+# export SYSTEMC_HOME="path to systemC release dir"
+$ make clean
+$ make
+$ make run
+```
+
+# Test Instructions *(optional)*
+Optionally test the output using the following instructions
+
+

examples/fir/src/stimulus.h

@@ -103,7 +103,7 @@ SC_MODULE(stimulus) {
         bin<int>("invalid", 0)
     };
 
-    cross<int, int, int> reset_valid_cross = cross<int, int, int> (this, "reset valid",
+    cross<int, int, int> reset_valid_cross = cross<int, int, int> (this, "reset_valid",
         &reset_cvp,
         &input_valid_cvp,
         &values_cvp

includes/fc4sc_bin.hpp

@@ -195,7 +195,8 @@ class bin : public bin_base
     stream << "type=\""
            << this->ucis_bin_type
            << "\" "
-           << "alias=\"" << this->get_hitcount() << "\""
+           << "alias=\"" << this->get_hitcount() << "\" "
+           << "key=\"KEY\""
            << ">\n";
 
     // Print each range. Coverpoint writes the header (name etc.)

includes/fc4sc_covergroup.hpp

@@ -246,7 +246,7 @@ class covergroup : public cvg_base
            << "\" line=\""
            << "1"
            << "\" inlineCount=\"1\"/>\n";
-    stream << "<ucis:cgSourceId file=\"" << file_name << "\" "
+    stream << "<ucis:cgSourceId file=\"1\" "
            << "line=\"" << line << "\""
            << " inlineCount=\"1\"/>\n";
     stream << "</ucis:cgId>\n";

includes/fc4sc_cross.hpp

@@ -265,7 +265,7 @@ class cross : public cvp_base
            << "\" ";
     stream << ">\n";
 
-    stream << option << "\n";
+    stream << "<ucis:options />\n";
 
     for (auto &cvp : cvps_vec)
     {

includes/fc4sc_master.hpp

@@ -273,7 +273,7 @@ class global
         stream << ">\n";
 
         stream << "<ucis:id ";
-        stream << "file=\"" << type_it.second.file_name << "\" ";
+        stream << "file=\"" << 1 << "\" ";
         stream << "line=\"" << type_it.second.line << "\" ";
         stream << "inlineCount=\""
                << "1"

test/pyucis-fir/.gitignore

@@ -0,0 +1 @@
+__pycache__/

test/pyucis-fir/Makefile

@@ -0,0 +1,5 @@
+.DEFAULT_GOAL := validate_fir
+
+
+validate_fir:
+	python3 validate_ucis_xml.py

test/pyucis-fir/README.md

@@ -0,0 +1,7 @@
+# test of xml output with pyucis
+
+This directory contains test code to validate the coverage_report.xml
+output for the fir example.  It requires python3 and the [VENV.md](VENV.md) 
+file shows how to setup a virtual environment for testing.
+
+

test/pyucis-fir/VENV.md

@@ -0,0 +1,22 @@
+# venv notes
+
+# Create and activate the venv 
+
+Do this once
+
+```
+sudo apt-get install python3-venv
+python3 -m venv venv
+. venv/bin/activate
+python3 -m pip install -r requirements.txt
+# test that usis can be imported
+python3 -c 'import ucis'
+alias bazel='/home/davis/bin/bazel-4.2.1-linux-x86_64'
+```
+
+
+# Activate the venv
+
+```
+. venv/bin/activate
+```

test/pyucis-fir/coverage_results.xml

@@ -0,0 +1 @@
+../../examples/fir/coverage_results.xml

test/pyucis-fir/requirements.txt

@@ -0,0 +1,4 @@
+pyucis==0.0.5.20220416.1
+pylint
+pyyaml
+

test/pyucis-fir/ucis_test.py

@@ -0,0 +1,16 @@
+"""Tests for ucis."""
+
+import unittest
+from validate_ucis_xml import validate_ucis
+
+
+
+class UcisTest(unittest.TestCase):
+
+  def test_validate_ucis_xml(self):
+    self.assertTrue(validate_ucis('../../examples/fir/coverage_results.xml'))
+
+
+
+if __name__ == '__main__':
+  unittest.main()

test/pyucis-fir/validate_ucis_xml.py

@@ -0,0 +1,44 @@
+""" Test script to compare coverage_results.xml with spec
+
+Use pyucis to validate fir example coverage result generated
+by FC4SC against specification.
+"""
+
+from io import BytesIO
+from ucis.xml import validate_ucis_xml
+
+
+
+def validate_ucis(file_name):
+    """
+    Validate UCIS function
+
+    : arg file_name: The filename to validate
+    : returns: status of validation. TODO:return
+    """
+    rc = False
+
+    try:
+      with open(file_name, encoding='utf-8') as f:
+          xml_file = BytesIO(bytes(bytearray(f.read(), encoding='utf-8')))
+          rc = validate_ucis_xml(xml_file)
+    except:
+        print("an exception occured")
+
+    return rc 
+
+
+def main() -> None:
+
+    rc = validate_ucis('../../examples/fir/coverage_results.xml')
+    return rc
+
+
+
+if __name__ == '__main__':
+  rc = main()
+  if rc:
+    print("validation OK")
+  else:
+    print("validation Failure")
+

tools/.gitignore

@@ -0,0 +1 @@
+__pycache__/

tools/VENV.md

@@ -0,0 +1,22 @@
+# venv notes
+
+# Create and activate the venv 
+
+Do this once
+
+```
+sudo apt-get install python3-venv
+python3 -m venv venv
+. venv/bin/activate
+python3 -m pip install -r requirements.txt
+# test that usis can be imported
+python3 -c 'import ucis'
+alias bazel='/home/davis/bin/bazel-4.2.1-linux-x86_64'
+```
+
+
+# Activate the venv
+
+```
+. venv/bin/activate
+```

tools/requirements.txt

@@ -0,0 +1,4 @@
+pyucis==0.0.5.20220416.1
+pylint
+pyyaml
+