From e175f100247f74c0b714ba404b35258292cce050 Mon Sep 17 00:00:00 2001
From: Gabe Conradi <gconradi@uberatc.com>
Date: Tue, 7 Mar 2017 16:10:21 -0500
Subject: [PATCH 1/2] make lshw base_serial optional and omit dupes from
 overview

drop duplicate BASE_SERIAL attrs

add some docs and tooltips to attributes in show_overview

fix some tooltips
---
 app/collins/models/LshwHelper.scala       | 13 ++++++++-----
 app/collins/models/lshw/ServerBase.scala  |  4 ++--
 app/collins/util/parsers/LldpParser.scala |  1 +
 app/collins/util/parsers/LshwParser.scala |  5 +++--
 app/views/asset/show_overview.scala.html  | 21 ++++++++++++++-------
 5 files changed, 28 insertions(+), 16 deletions(-)

diff --git a/app/collins/models/LshwHelper.scala b/app/collins/models/LshwHelper.scala
index 4a6f27bb2..72df84c8c 100644
--- a/app/collins/models/LshwHelper.scala
+++ b/app/collins/models/LshwHelper.scala
@@ -213,14 +213,14 @@ object LshwHelper extends CommonHelper[LshwRepresentation] {
       val baseDescription = amfinder(seq, BaseDescription, _.toString, "")
       val baseProduct = amfinder(seq, BaseProduct, _.toString, "")
       val baseVendor = amfinder(seq, BaseVendor, _.toString, "")
-      val baseSerial = amfinder(seq, BaseSerial, _.toString, "")
+      val baseSerial = amfinder(seq, BaseSerial, x => if (x.isEmpty) { None } else { Some(x) }, None)
       Seq(ServerBase(baseDescription, baseProduct, baseVendor, baseSerial))
     }.getOrElse(Nil)
 
     val filteredMeta = meta.map { case(groupId, metaSeq) =>
       val newSeq = filterNot(
         metaSeq,
-        Set(BaseDescription.id, BaseProduct.id, BaseVendor.id)
+        Set(BaseDescription.id, BaseProduct.id, BaseVendor.id, BaseSerial.id)
       )
       groupId -> newSeq
     }
@@ -229,12 +229,15 @@ object LshwHelper extends CommonHelper[LshwRepresentation] {
 
   protected def collectBase(asset: Asset, lshw: LshwRepresentation): Seq[AssetMetaValue] = {
     val base = lshw.base
-    Seq(
+    val expectedAttrs = Seq(
       AssetMetaValue(asset, BaseDescription.id, base.description),
       AssetMetaValue(asset, BaseProduct.id, base.product),
-      AssetMetaValue(asset, BaseVendor.id, base.vendor),
-      AssetMetaValue(asset, BaseSerial.id, base.serial)
+      AssetMetaValue(asset, BaseVendor.id, base.vendor)
     )
+    base.serial match {
+      case Some(x) => expectedAttrs ++ Seq(AssetMetaValue(asset, BaseSerial.id, base.serial.get))
+      case None    => expectedAttrs
+    }
   }
 
 }
diff --git a/app/collins/models/lshw/ServerBase.scala b/app/collins/models/lshw/ServerBase.scala
index eee1378cf..0400ed353 100644
--- a/app/collins/models/lshw/ServerBase.scala
+++ b/app/collins/models/lshw/ServerBase.scala
@@ -12,7 +12,7 @@ object ServerBase {
       (json \ "DESCRIPTION").as[String],
       (json \ "PRODUCT").as[String],
       (json \ "VENDOR").as[String],
-      (json \ "SERIAL").as[String]))
+      (json \ "SERIAL").asOpt[String]))
     override def writes(serverbase: ServerBase) = JsObject(Seq(
       "DESCRIPTION" -> Json.toJson(serverbase.description),
       "PRODUCT" -> Json.toJson(serverbase.product),
@@ -22,7 +22,7 @@ object ServerBase {
 }
 
 case class ServerBase(
-    description: String = "", product: String = "", vendor: String = "", serial: String = "") extends LshwAsset {
+    description: String = "", product: String = "", vendor: String = "", serial: Option[String] = None) extends LshwAsset {
   import ServerBase._
   override def toJsValue() = Json.toJson(this)
 
diff --git a/app/collins/util/parsers/LldpParser.scala b/app/collins/util/parsers/LldpParser.scala
index 433bea3dd..203ec3346 100644
--- a/app/collins/util/parsers/LldpParser.scala
+++ b/app/collins/util/parsers/LldpParser.scala
@@ -67,6 +67,7 @@ class LldpParser(txt: String) extends CommonParser[LldpRepresentation](txt) {
   }
 
   protected def findVlans(seq: NodeSeq): Seq[Vlan] = {
+    // TODO(gabe): make this less brittle and handle missing vlan-id
     (seq \\ "vlan").foldLeft(Seq[Vlan]()) {
       case (vseq, vlan) =>
         val id = Option(vlan \ "@vlan-id" text).filter(_.nonEmpty).getOrElse("")
diff --git a/app/collins/util/parsers/LshwParser.scala b/app/collins/util/parsers/LshwParser.scala
index d1a12a778..97dbfa0d0 100644
--- a/app/collins/util/parsers/LshwParser.scala
+++ b/app/collins/util/parsers/LshwParser.scala
@@ -184,13 +184,14 @@ class LshwParser(txt: String) extends CommonParser[LshwRepresentation](txt) {
     // the correct element
     if ((elem \ "@class" text).toString == "system") {
       val asset = getAsset(elem)
-      val serial = (elem \ "serial" text)
+      // serial may be missing, so be flexible here and allow it to be absent
+      val serial = (elem \ "serial" headOption).map(_.text)
       ServerBase(asset.description, asset.product, asset.vendor, serial)
     } // To spice things up, sometimes we get <list>$everything</list>
     // instead of just $everything
     else if (((elem \ "node") \ "@class" text) == "system") {
       val asset = getAsset(elem \ "node")
-      val serial = (elem \ "serial" text)
+      val serial = (elem \ "serial" headOption).map(_.text)
       ServerBase(asset.description, asset.product, asset.vendor, serial)
     } else {
       throw MalformedAttributeException("Expected root class=system node attribute")
diff --git a/app/views/asset/show_overview.scala.html b/app/views/asset/show_overview.scala.html
index 03a9e50a5..42d611963 100644
--- a/app/views/asset/show_overview.scala.html
+++ b/app/views/asset/show_overview.scala.html
@@ -24,13 +24,15 @@ <h3>Asset Overview <small>System and user attributes</small></h3>
         }
         @if(aa.addresses.size > 0) {
         <tr>
-          <th>Ip Addresses</th>
+          <th><strong>IP Addresses</strong></th>
           <td>@TagDecorator.decorate("IP_ADDRESS", aa.addresses.map(_.dottedAddress).toList, ", ")</td>
           <td>Primary IP Addresses</td>
         </tr>
         }
         <tr>
-          <th>Asset Tag</th>
+          <th>
+            <strong data-rel="tooltip" title="" data-original-title="TAG">Asset Tag</strong>
+          </th>
           @if(SoftLayerConfig.enabled && SoftLayer.isSoftLayerAsset(aa.asset)) {
             @slLink(aa.asset, aa.asset.tag)
           } else {
@@ -40,7 +42,7 @@ <h3>Asset Overview <small>System and user attributes</small></h3>
         </tr>
         <tr>
           @defining(aa.asset.nodeClass){ nodeclass =>
-          <th>Classification</th>
+          <th><strong>Classification</strong> <a href="https://tumblr.github.io/collins/configuration.html#node classifier"><i class="glyphicon glyphicon-question-sign" data-rel="tooltip" title="" data-original-title="Asset classification according to node classifier"></i></a></th>
           <td>
             <span>
               @nodeclass.map { nc =>
@@ -60,12 +62,12 @@ <h3>Asset Overview <small>System and user attributes</small></h3>
           }
         </tr>
         <tr>
-          <th>Asset Type</th>
+          <th><strong>Asset Type<strong> <a href="https://tumblr.github.io/collins/concepts.html#assets"><i class="glyphicon glyphicon-question-sign"></i></a></th>
           <td>@aa.asset.assetType.label</td>
           <td></td>
         </tr>
         <tr class="@statusClassFromAsset(aa.asset)">
-          <td><strong>Asset Status</strong></td>
+          <td><strong>Asset Status</strong> <a href="https://tumblr.github.io/collins/concepts.html#status & state"><i class="glyphicon glyphicon-question-sign"></i></a></td>
           <td>@aa.asset.getStatusName</td>
           @if(aa.asset.isMaintenance) {
             <td><a href="#user-log-section"><span class="label label-primary">See Notes</span></a> @aa.asset.status.description</td>
@@ -76,7 +78,7 @@ <h3>Asset Overview <small>System and user attributes</small></h3>
 @if(aa.asset.stateId != 0) {
   @State.findById(aa.asset.stateId).map { state =>
         <tr>
-          <th>Asset State</th>
+          <th><strong>Asset State</strong> <a href="https://tumblr.github.io/collins/concepts.html#status & state"><i class="glyphicon glyphicon-question-sign"></i></a></th>
           <td>@state.label</td>
           <td>@state.description</td>
         </tr>
@@ -94,7 +96,12 @@ <h3>Asset Overview <small>System and user attributes</small></h3>
         </tr>
         @MetaValueOrderer.order(aa.mvs.filter(_.getName() != "HOSTNAME")).map { case(size, mv) =>
         <tr>
-          <th>@mv.getLabel() @if(size > 1 || mv.getGroupId() != 0){(@mv.getGroupId())}</th>
+          <th>
+            <span @if(mv.getLabel().toUpperCase != mv.getName()){
+            data-rel="tooltip" title="" data-original-title="@mv.getName() @if(size > 1 || mv.getGroupId() != 0){(@mv.getGroupId())}"
+          }>@mv.getLabel() @if(size > 1 || mv.getGroupId() != 0){(@mv.getGroupId())}
+            </span>
+          </th>
           <td>
           @{
             mv.getName match {

From c760f650fd45d73831f27d0c9e61aad5a7a7a45b Mon Sep 17 00:00:00 2001
From: Gabe Conradi <gconradi@uberatc.com>
Date: Thu, 9 Mar 2017 14:17:19 -0500
Subject: [PATCH 2/2] add test for missing base serial in lshw

---
 .../collins/util/parsers/LshwParserSpec.scala |  15 +-
 test/resources/missing-base-serial.xml        | 259 ++++++++++++++++++
 2 files changed, 273 insertions(+), 1 deletion(-)
 create mode 100644 test/resources/missing-base-serial.xml

diff --git a/test/collins/util/parsers/LshwParserSpec.scala b/test/collins/util/parsers/LshwParserSpec.scala
index 4c770cffd..71d59d571 100644
--- a/test/collins/util/parsers/LshwParserSpec.scala
+++ b/test/collins/util/parsers/LshwParserSpec.scala
@@ -50,7 +50,7 @@ class LshwParserSpec extends mutable.Specification {
 
           rep.base.product mustEqual "PowerEdge C6105 (N/A)"
           rep.base.vendor mustEqual "Winbond Electronics"
-          rep.base.serial mustEqual "FZ1NXQ1"
+          rep.base.serial.get mustEqual "FZ1NXQ1"
         }
       } // with a 10-gig card
 
@@ -386,6 +386,19 @@ class LshwParserSpec extends mutable.Specification {
 
     } // Parse softlayer supermicro (Intel) lshw output"
 
+    "Handle missing fields in LSHW" in {
+      "No base serial" in new LshwParserHelper("missing-base-serial.xml") {
+        val parseResults = parsed()
+        parseResults must beRight
+        parseResults.right.toOption must beSome.which { rep =>
+          rep.base.product mustEqual "Virtual Machine (None)"
+          rep.base.vendor mustEqual "Microsoft Corporation"
+          rep.base.serial mustEqual None
+          rep.base.description mustEqual "Desktop Computer"
+        }
+      }
+    }
+
     "Parse Dell LSHW Output" in {
       "R620 LSHW Output" in new LshwParserHelper("lshw-dell-r620-single-cpu.xml") {
         val parseResults = parsed()
diff --git a/test/resources/missing-base-serial.xml b/test/resources/missing-base-serial.xml
new file mode 100644
index 000000000..18eb4e6ca
--- /dev/null
+++ b/test/resources/missing-base-serial.xml
@@ -0,0 +1,259 @@
+<?xml version="1.0" standalone="yes" ?>
+<!-- generated by lshw-B.02.17 -->
+<!-- GCC 4.8.5 20150623 (Red Hat 4.8.5-4) -->
+<!-- Linux 3.10.0-327.22.2.el7.x86_64 #1 SMP Thu Jun 23 17:05:11 UTC 2016 x86_64 -->
+<!-- GNU libc 2 (glibc 2.17) -->
+<list>
+<node id="ABC-123" claimed="true" class="system" handle="DMI:0001">
+ <description>Desktop Computer</description>
+ <product>Virtual Machine (None)</product>
+ <vendor>Microsoft Corporation</vendor>
+ <version>Hyper-V UEFI Release v1.0</version>
+ <serial>0574-2207-1613-4261-5019-1454-34</serial>
+ <width units="bits">64</width>
+ <configuration>
+  <setting id="boot" value="normal" />
+  <setting id="chassis" value="desktop" />
+  <setting id="family" value="Virtual Machine" />
+  <setting id="sku" value="None" />
+  <setting id="uuid" value="893FC6A0-963E-584C-8B4D-4C6834C8E642" />
+ </configuration>
+ <capabilities>
+  <capability id="smbios-2.4" >SMBIOS version 2.4</capability>
+  <capability id="dmi-2.4" >DMI version 2.4</capability>
+  <capability id="vsyscall32" >32-bit processes</capability>
+ </capabilities>
+  <node id="core" claimed="true" class="bus" handle="DMI:0003">
+   <description>Motherboard</description>
+   <product>Virtual Machine</product>
+   <vendor>Microsoft Corporation</vendor>
+   <physid>0</physid>
+   <version>Hyper-V UEFI Release v1.0</version>
+   <serial>0574-2207-1613-4261-5019-1454-34</serial>
+   <slot>Virtual Machine</slot>
+    <node id="firmware" claimed="true" class="memory" handle="">
+     <description>BIOS</description>
+     <vendor>Microsoft Corporation</vendor>
+     <physid>0</physid>
+     <version>Hyper-V UEFI Release v1.0</version>
+     <date>11/26/2012</date>
+     <size units="bytes">1048576</size>
+     <capabilities>
+      <capability id="acpi" >ACPI</capability>
+     </capabilities>
+    </node>
+    <node id="cpu" claimed="true" class="processor" handle="DMI:0004">
+     <description>CPU</description>
+     <product>Xeon (None)</product>
+     <vendor>Intel Corp.</vendor>
+     <physid>4</physid>
+     <businfo>cpu@0</businfo>
+     <version>Intel(R) Xeon(R) CPU E5-2630 v3 @ 2.40GHz</version>
+     <serial>None</serial>
+     <slot>None</slot>
+     <size units="Hz">2400000000</size>
+     <capacity units="Hz">4000000000</capacity>
+     <width units="bits">64</width>
+     <clock units="Hz">3705032704</clock>
+     <capabilities>
+      <capability id="fpu" >mathematical co-processor</capability>
+      <capability id="fpu_exception" >FPU exceptions reporting</capability>
+      <capability id="wp" />
+      <capability id="vme" >virtual mode extensions</capability>
+      <capability id="de" >debugging extensions</capability>
+      <capability id="pse" >page size extensions</capability>
+      <capability id="tsc" >time stamp counter</capability>
+      <capability id="msr" >model-specific registers</capability>
+      <capability id="pae" >4GB+ memory addressing (Physical Address Extension)</capability>
+      <capability id="mce" >machine check exceptions</capability>
+      <capability id="cx8" >compare and exchange 8-byte</capability>
+      <capability id="apic" >on-chip advanced programmable interrupt controller (APIC)</capability>
+      <capability id="sep" >fast system calls</capability>
+      <capability id="mtrr" >memory type range registers</capability>
+      <capability id="pge" >page global enable</capability>
+      <capability id="mca" >machine check architecture</capability>
+      <capability id="cmov" >conditional move instruction</capability>
+      <capability id="pat" >page attribute table</capability>
+      <capability id="pse36" >36-bit page size extensions</capability>
+      <capability id="clflush" />
+      <capability id="mmx" >multimedia extensions (MMX)</capability>
+      <capability id="fxsr" >fast floating point save/restore</capability>
+      <capability id="sse" >streaming SIMD extensions (SSE)</capability>
+      <capability id="sse2" >streaming SIMD extensions (SSE2)</capability>
+      <capability id="ss" >self-snoop</capability>
+      <capability id="syscall" >fast system calls</capability>
+      <capability id="nx" >no-execute bit (NX)</capability>
+      <capability id="x86-64" >64bits extensions (x86-64)</capability>
+      <capability id="constant_tsc" />
+      <capability id="rep_good" />
+      <capability id="nopl" />
+      <capability id="eagerfpu" />
+      <capability id="pni" />
+      <capability id="pclmulqdq" />
+      <capability id="ssse3" />
+      <capability id="fma" />
+      <capability id="cx16" />
+      <capability id="sse4_1" />
+      <capability id="sse4_2" />
+      <capability id="movbe" />
+      <capability id="popcnt" />
+      <capability id="aes" />
+      <capability id="xsave" />
+      <capability id="avx" />
+      <capability id="f16c" />
+      <capability id="rdrand" />
+      <capability id="hypervisor" />
+      <capability id="lahf_lm" />
+      <capability id="abm" />
+      <capability id="fsgsbase" />
+      <capability id="bmi1" />
+      <capability id="avx2" />
+      <capability id="smep" />
+      <capability id="bmi2" />
+      <capability id="erms" />
+      <capability id="xsaveopt" />
+     </capabilities>
+    </node>
+    <node id="memory" claimed="true" class="memory" handle="DMI:0006">
+     <description>System Memory</description>
+     <physid>6</physid>
+     <slot>System board or motherboard</slot>
+     <size units="bytes">4294967296</size>
+      <node id="bank:0" claimed="true" class="memory" handle="DMI:0007">
+       <product>None</product>
+       <vendor>Microsoft Corporation</vendor>
+       <physid>0</physid>
+       <serial>None</serial>
+       <slot>M00</slot>
+       <size units="bytes">4160749568</size>
+      </node>
+      <node id="bank:1" claimed="true" class="memory" handle="DMI:000A">
+       <product>None</product>
+       <vendor>Microsoft Corporation</vendor>
+       <physid>1</physid>
+       <serial>None</serial>
+       <slot>M01</slot>
+       <size units="bytes">134217728</size>
+      </node>
+    </node>
+    <node id="scsi" claimed="true" class="storage" handle="">
+     <physid>1</physid>
+     <logicalname>scsi0</logicalname>
+      <node id="disk" claimed="true" class="disk" handle="GUID:f6dc42f4-c255-47a8-94cf-eb351588536d">
+       <description>SCSI Disk</description>
+       <physid>0.0.0</physid>
+       <businfo>scsi@0:0.0.0</businfo>
+       <logicalname>/dev/sda</logicalname>
+       <dev>8:0</dev>
+       <size units="bytes">53687091200</size>
+       <configuration>
+        <setting id="guid" value="f6dc42f4-c255-47a8-94cf-eb351588536d" />
+        <setting id="logicalsectorsize" value="512" />
+        <setting id="sectorsize" value="4096" />
+       </configuration>
+       <capabilities>
+        <capability id="gpt-1.00" >GUID Partition Table version 1.00</capability>
+        <capability id="partitioned" >Partitioned disk</capability>
+        <capability id="partitioned:gpt" >GUID partition table</capability>
+       </capabilities>
+        <node id="volume:0" class="volume" handle="GUID:b63580c3-869b-4acb-9089-9b5e6183d10e">
+         <description>Windows FAT volume</description>
+         <vendor>mkfs.fat</vendor>
+         <physid>1</physid>
+         <businfo>scsi@0:0.0.0,1</businfo>
+         <version>FAT16</version>
+         <serial>32c4-96a4</serial>
+         <size units="bytes">209714688</size>
+         <capacity>209714688</capacity>
+         <configuration>
+          <setting id="FATs" value="2" />
+          <setting id="filesystem" value="fat" />
+          <setting id="name" value="EFI System Partition" />
+         </configuration>
+         <capabilities>
+          <capability id="boot" >Contains boot code</capability>
+          <capability id="fat" >Windows FAT</capability>
+          <capability id="initialized" >initialized volume</capability>
+         </capabilities>
+        </node>
+        <node id="volume:1" class="volume" handle="GUID:c1747320-6774-47dc-8e61-104051115270">
+         <description>data partition</description>
+         <vendor>Windows</vendor>
+         <physid>2</physid>
+         <businfo>scsi@0:0.0.0,2</businfo>
+         <serial>c1747320-6774-47dc-8e61-104051115270</serial>
+         <capacity>524287488</capacity>
+        </node>
+        <node id="volume:2" claimed="true" class="volume" handle="GUID:4255502b-0cf7-4aaf-b651-b49b0af21155">
+         <description>LVM Physical Volume</description>
+         <vendor>Linux</vendor>
+         <physid>3</physid>
+         <businfo>scsi@0:0.0.0,3</businfo>
+         <logicalname>/dev/sda3</logicalname>
+         <dev>8:3</dev>
+         <serial>tpeGWj-gIj7-Xpa7-22j6-LqZf-qP6k-ayZLO1</serial>
+         <size units="bytes">52950990848</size>
+         <capabilities>
+          <capability id="multi" >Multi-volumes</capability>
+          <capability id="lvm2" />
+         </capabilities>
+        </node>
+      </node>
+      <node id="cdrom" claimed="true" class="disk" handle="SCSI:00:00:00:01">
+       <description>SCSI CD-ROM</description>
+       <physid>0.0.1</physid>
+       <businfo>scsi@0:0.0.1</businfo>
+       <logicalname>/dev/cdrom</logicalname>
+       <logicalname>/dev/sr0</logicalname>
+       <dev>11:0</dev>
+       <configuration>
+        <setting id="status" value="ready" />
+       </configuration>
+       <capabilities>
+        <capability id="audio" >Audio CD playback</capability>
+       </capabilities>
+      </node>
+    </node>
+  </node>
+  <node id="network:0" claimed="true" class="network" handle="">
+   <description>Ethernet interface</description>
+   <physid>1</physid>
+   <logicalname>veth7720825</logicalname>
+   <serial>e2:89:fc:fa:6c:2c</serial>
+   <size units="bit/s">10000000000</size>
+   <configuration>
+    <setting id="autonegotiation" value="off" />
+    <setting id="broadcast" value="yes" />
+    <setting id="driver" value="veth" />
+    <setting id="driverversion" value="1.0" />
+    <setting id="duplex" value="full" />
+    <setting id="link" value="yes" />
+    <setting id="multicast" value="yes" />
+    <setting id="port" value="twisted pair" />
+    <setting id="speed" value="10Gbit/s" />
+   </configuration>
+   <capabilities>
+    <capability id="ethernet" />
+    <capability id="physical" >Physical interface</capability>
+   </capabilities>
+  </node>
+  <node id="network:1" claimed="true" class="network" handle="">
+   <description>Ethernet interface</description>
+   <physid>2</physid>
+   <logicalname>eth0</logicalname>
+   <serial>00:1d:d8:b7:1e:e7</serial>
+   <configuration>
+    <setting id="broadcast" value="yes" />
+    <setting id="driver" value="hv_netvsc" />
+    <setting id="firmware" value="N/A" />
+    <setting id="ip" value="172.19.2.91" />
+    <setting id="link" value="yes" />
+    <setting id="multicast" value="yes" />
+   </configuration>
+   <capabilities>
+    <capability id="ethernet" />
+    <capability id="physical" >Physical interface</capability>
+   </capabilities>
+  </node>
+</node>
+</list>