perf/perf_stress_ng: add readme file

This commit introduces a README.txt file. The README provides a description of the test, outlines the steps followed during the test execution and lists the prerequisites necessary for running the test successfully. Signed-off-by: Disha Goel <[email protected]>
vaishnavibhat · Apr 18, 2024 · 380ff18 · 380ff18
1 parent eff496b
commit 380ff18
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/perf/perf_stress_ng.py b/perf/perf_stress_ng.py
@@ -247,8 +247,5 @@ def tearDown(self):
                            "/tmp/stressng_output*"]
         for file_path in files_to_remove:
             if os.path.exists(file_path):
-                try:
-                    os.remove(file_path)
-                except OSError:
-                    self.log.warn("Files do not exist")
+                os.remove(file_path)
         dmesg.collect_dmesg()
diff --git a/perf/perf_stress_ng.py.data/README.txt b/perf/perf_stress_ng.py.data/README.txt
@@ -0,0 +1,16 @@
+Description:
+This test is to compare CPU load percentage from vmstat and perf
+command by running stress-ng in background.
+The test collects vmstat and perf record data with CPU load
+10, 50 and 80 by running it for 5 iterations.
+
+Steps followed:
+Run stress-ng in background with CPU load 10, 50 and 80.
+Run perf record to collect CPU load for 5 iterations.
+Run vmstat to collect CPU load for 5 iterations.
+Compare both results.
+
+Pre-requisite:
+1. Install psutil using pip
+   # pip3 install psutil
+2. Install perf, gcc and stress-ng packages