** Description changed:

- ## DRAFT ##
  
  [Impact]
  
-  * An explanation of the effects of the bug on users and
+   lshw(1) https://linux.die.net/man/1/lshw
+  * lshw is a small tool to extract detailed information on the hardware 
+    configuration of the machine. It can report exact memory configuration,
+    firmware version, mainboard configuration, CPU version and speed, 
+    cache configuration, bus speed, etc. on DMI-capable x86 or IA-64
+    systems and on some PowerPC machines (PowerMac G4 is known to work).
  
-  * justification for backporting the fix to the stable release.
+  * Adding 'lshw' will help Canonical or third-party vendor using the 
+    sosreport package to not having to ask 'lshw' in addition to sosreport.  
+    This is a frequent command to run to troubleshoot/debug things
  
-  * In addition, it is helpful, but not required, to include an
-    explanation of how the upload fixes this bug.
+  * Including hardware information is a helpful debug step to determine
+    issues found
  
  [Test Case]
  
-  * detailed instructions how to reproduce the bug
+  * Run sosreport in different customer scenarios:
+     server, desktop, cloud, hypervisor, instance (container, vm), 
+     physical server, since this is specifically listing hardware  
+     informations.
+  * For all distros:
+    - install sosreport from the proposed pocket
+    - run sosreport with default settings `sudo sosreport -a --config 
+    sos.conf` 
+    Or to just test hardware plugin `sosreport -o hardware --config
+    sos.conf`
+  * Extract archive and look at contents
+       - untar report file in /tmp/<sosreport.tar.gz>
+     - cd <sosreport folder>/sos_commands/hardware/
+     - less lshw
+      -- the ouput is information about the system's hardware
+     - look under "sos_logs" for warnings/errors.
+     - look under "sos_reports" for full report.
+  * Run `simple.sh`: A quick port of the travis unit tests to bash.  
  
-  * these should allow someone who is not familiar with the affected
-    package to reproduce the bug and verify that the updated package fixes
-    the problem.
+ Generates various types of sosreports collection.
+  * Ensure simple.sh test passes 
+     - wget https://raw.githubusercontent.com/sosreport/sos/master
+       /test/simple.sh
+     - execute command  `sudo tests/simple.sh`
  
  [Regression Potential]
  
-  * discussion of how regressions are most likely to manifest as a result
- of this change.
- 
-  * It is assumed that any SRU candidate patch is well-tested before
-    upload and has a low overall risk of regression, but it's important
-    to make the effort to think about what ''could'' happen in the
-    event of a regression.
- 
-  * This both shows the SRU team that the risks have been considered,
-    and provides guidance to testers in regression-testing the SRU.
+  * Command implicitly slows down python script
+  * Unit test failures
+  * Only affects the hardware plugin and won't affect core functionalities nor 
other plugins
+  * Lshw that is commonly used on system, the command cannot create any harm 
on the system (read only)
+  * If the command doesn't exist sosreport will continue and move on
+  * Lshw must be run as super user or it will only report partial information
  
  [Other Info]
-  
-  * Anything else you think is useful to include
-  * Anticipate questions from users, SRU, +1 maintenance, security teams and 
the Technical Board
-  * and address these questions in advance
+ 
+  * Upstream commit:
+ 
https://github.com/sosreport/sos/pull/1994/commits/2dd5cd45a8381fa36ea99c85b526f9d79e526d91
  
  [Original description]
- This is a wishlist to add the cmd 'lshw' into the hardware's sosreport plugin
  
- Upstream commit:
- 
https://github.com/sosreport/sos/pull/1994/commits/2dd5cd45a8381fa36ea99c85b526f9d79e526d91
+  * This is a wishlist to add the cmd 'lshw' into the hardware's
+ sosreport plugin

-- 
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1871494

Title:
  add lshw cmd into sosreport's hardware plugin

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/sosreport/+bug/1871494/+subscriptions

-- 
ubuntu-bugs mailing list
[email protected]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs

Reply via email to