Version 2.2.1. Support device tags to tell two UPSes apart. (#73)

config:
      deviceTags:
        - "serverName:cusomterUps"
        - "someTag:someThing"
        <etc>

Makefile

@@ -3,7 +3,7 @@
 #
 
 PLUGIN_NAME    := snmp
-PLUGIN_VERSION := 2.2.0
+PLUGIN_VERSION := 2.2.1
 IMAGE_NAME     := vaporio/snmp-plugin
 BIN_NAME       := synse-snmp-plugin
 

pkg/devices/devices_test.go

@@ -43,14 +43,15 @@ func logDeviceProtos(t *testing.T, protos []*config.DeviceProto, header string)
 	for _, proto := range protos {
 		t.Logf(".. [proto: %s] Count device instances: %d", proto.Type, len(proto.Instances))
 		for _, instance := range proto.Instances {
-			t.Logf("     device: %v %v %v %v %v row:%v column:%v\n",
+			t.Logf("     device: %v %v %v %v %v row:%v column:%v, tags: %v\n",
 				instance.Data["table_name"],
 				proto.Type,
 				instance.Info,
 				instance.Data["oid"],
 				instance.Data["base_oid"],
 				instance.Data["row"],
 				instance.Data["column"],
+				proto.Tags,
 			)
 		}
 
@@ -77,7 +78,8 @@ func TestDevices(t *testing.T) { // nolint: gocyclo
 		"127.0.0.1", // Endpoint
 		1024,        // Port
 		securityParameters,
-		"public", //  Context name
+		"public",                           //  Context name
+		[]string{"serverName:customerUps"}, // tags
 	)
 	assert.NoError(t, err)
 
@@ -163,7 +165,7 @@ func TestDevices(t *testing.T) { // nolint: gocyclo
 		t.Logf("device[%d]: %+v", i, devices[i])
 	}
 
-	// Read each device
+	// Read each device. Check device tags.
 	t.Logf("Reading each device.")
 	for i := 0; i < len(devices); i++ {
 		context, err := devices[i].Read() // Call Read through the device's function pointer.
@@ -175,6 +177,12 @@ func TestDevices(t *testing.T) { // nolint: gocyclo
 		for j := 0; j < len(readings); j++ {
 			t.Logf("Reading[%d][%d]: %T, %+v", i, j, readings[j], readings[j])
 		}
+
+		// Check device tags.
+		assert.Len(t, devices[i].Tags, 1)
+		assert.Equal(t, "default", devices[i].Tags[0].Namespace)
+		assert.Equal(t, "serverName", devices[i].Tags[0].Annotation)
+		assert.Equal(t, "customerUps", devices[i].Tags[0].Label)
 	}
 	t.Log("Finished reading each device.")
 }

pkg/snmp/core/client.go

@@ -72,6 +72,7 @@ func NewSecurityParameters(
 }
 
 // DeviceConfig is a thin wrapper around the configuration for gosnmp using SNMP V3.
+// Tags are included here to expose on a Synse scan.
 type DeviceConfig struct {
 	Version            string              // SNMP protocol version. Currently only SNMP V3 is supported.
 	Endpoint           string              // Endpoint of the SNMP server to connect to.
@@ -80,6 +81,7 @@ type DeviceConfig struct {
 	Retries            int                 // The number of retries on the connection.
 	SecurityParameters *SecurityParameters // SNMP V3 security parameters.
 	Port               uint16              // UDP port to connect to.
+	Tags               []string            // List of synse device tags.
 }
 
 // checkForEmptyString checks for an empty string variable and fails with an
@@ -91,13 +93,14 @@ func checkForEmptyString(variable string, variableName string) (err error) {
 	return nil
 }
 
-// NewDeviceConfig creates an DeviceConfig.
+// NewDeviceConfig creates a DeviceConfig.
 func NewDeviceConfig(
 	version string,
 	endpoint string,
 	port uint16,
 	securityParameters *SecurityParameters,
-	contextName string) (*DeviceConfig, error) {
+	contextName string,
+	tags []string) (*DeviceConfig, error) {
 
 	// Check parameters.
 	versionUpper := strings.ToUpper(version)
@@ -123,6 +126,7 @@ func NewDeviceConfig(
 		ContextName:        contextName,
 		Timeout:            time.Duration(30) * time.Second,
 		Retries:            3,
+		Tags:               tags,
 	}, nil
 }
 
@@ -228,13 +232,19 @@ func GetDeviceConfig(instanceData map[string]interface{}) (*DeviceConfig, error)
 		return nil, err
 	}
 
+	tags, ok := instanceData["deviceTags"].([]string)
+	if !ok {
+		tags = []string{}
+	}
+
 	// Create the config.
 	return NewDeviceConfig(
 		version,
 		endpoint,
 		port,
 		securityParameters,
-		contextName)
+		contextName,
+		tags)
 }
 
 // ToMap serializes DeviceConfig to map[string]interface{}.
@@ -249,6 +259,7 @@ func (deviceConfig *DeviceConfig) ToMap() (m map[string]interface{}, err error)
 	m["endpoint"] = deviceConfig.Endpoint
 	m["port"] = deviceConfig.Port
 	m["contextName"] = deviceConfig.ContextName
+	m["deviceTags"] = deviceConfig.Tags
 
 	securityParameters := deviceConfig.SecurityParameters
 	m["userName"] = securityParameters.UserName

pkg/snmp/core/client_test.go

@@ -25,7 +25,8 @@ func TestClient(t *testing.T) {
 		"127.0.0.1", // Endpoint
 		1024,        // Port
 		securityParameters,
-		"public", //  Context name
+		"public",   //  Context name
+		[]string{}, // tags (none)
 	)
 	assert.NoError(t, err)
 
@@ -283,7 +284,8 @@ func TestDeviceConfigSerialization(t *testing.T) {
 		"127.0.0.1", // Endpoint
 		1024,        // Port
 		securityParameters,
-		"public", //  Context name
+		"public",   //  Context name
+		[]string{}, // tags (none)
 	)
 	assert.NoError(t, err)
 

pkg/snmp/core/table_test.go

@@ -29,7 +29,8 @@ func TestTable(t *testing.T) {
 		"127.0.0.1", // Endpoint
 		1024,        // Port
 		securityParameters,
-		"public", //  Context name
+		"public",   //  Context name
+		[]string{}, // tags (none)
 	)
 	assert.NoError(t, err)
 

pkg/snmp/mibs/ups_mib/ups_alarms_headers_table.go

@@ -75,6 +75,7 @@ func (enumerator UpsAlarmsHeadersTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	devices = []*config.DeviceProto{

pkg/snmp/mibs/ups_mib/ups_alarms_table.go

@@ -107,6 +107,7 @@ func (enumerator UpsAlarmsTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	devices = []*config.DeviceProto{

pkg/snmp/mibs/ups_mib/ups_battery_table.go

@@ -86,6 +86,7 @@ func (enumerator UpsBatteryTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	voltageProto := &config.DeviceProto{
@@ -94,6 +95,7 @@ func (enumerator UpsBatteryTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	currentProto := &config.DeviceProto{
@@ -102,6 +104,7 @@ func (enumerator UpsBatteryTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	temperatureProto := &config.DeviceProto{
@@ -110,6 +113,7 @@ func (enumerator UpsBatteryTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	percentageProto := &config.DeviceProto{
@@ -118,6 +122,7 @@ func (enumerator UpsBatteryTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	minutesProto := &config.DeviceProto{
@@ -126,6 +131,7 @@ func (enumerator UpsBatteryTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	secondsProto := &config.DeviceProto{
@@ -134,6 +140,7 @@ func (enumerator UpsBatteryTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	devices = []*config.DeviceProto{

pkg/snmp/mibs/ups_mib/ups_bypass_table.go

@@ -67,6 +67,11 @@ func (enumerator UpsBypassTableDeviceEnumerator) DeviceEnumerator(
 	mib := table.Mib.(*UpsMib)
 	model := mib.UpsIdentityTable.UpsIdentity.Model
 
+	snmpDeviceConfigMap, err := table.SnmpServerBase.DeviceConfig.ToMap()
+	if err != nil {
+		return nil, err
+	}
+
 	// We will have "voltage", "current", and "power" device kinds.
 	// There is probably a better way of doing this, but this just gets things to
 	// where they need to be for now.
@@ -76,6 +81,7 @@ func (enumerator UpsBypassTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	currentProto := &config.DeviceProto{
@@ -84,6 +90,7 @@ func (enumerator UpsBypassTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	powerProto := &config.DeviceProto{
@@ -92,6 +99,7 @@ func (enumerator UpsBypassTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	devices = []*config.DeviceProto{
@@ -100,11 +108,6 @@ func (enumerator UpsBypassTableDeviceEnumerator) DeviceEnumerator(
 		powerProto,
 	}
 
-	snmpDeviceConfigMap, err := table.SnmpServerBase.DeviceConfig.ToMap()
-	if err != nil {
-		return nil, err
-	}
-
 	for i := 0; i < len(table.Rows); i++ {
 		// upsBypassVoltage ---------------------------------------------------
 		// deviceData gets shimmed into the DeviceConfig for each synse device.

pkg/snmp/mibs/ups_mib/ups_identity_table.go

@@ -175,6 +175,7 @@ func (enumerator UpsIdentityTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	devices = []*config.DeviceProto{

pkg/snmp/mibs/ups_mib/ups_input_table.go

@@ -75,12 +75,14 @@ func (enumerator UpsInputTableDeviceEnumerator) DeviceEnumerator(
 	// We will have "frequency", "voltage", "current", and "power" device kinds.
 	// There is probably a better way of doing this, but this just gets things to
 	// where they need to be for now.
+	// TODO: Shim in the tags here.
 	frequencyProto := &config.DeviceProto{
 		Type: "frequency",
 		Context: map[string]string{
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	voltageProto := &config.DeviceProto{
@@ -89,6 +91,7 @@ func (enumerator UpsInputTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	currentProto := &config.DeviceProto{
@@ -97,6 +100,7 @@ func (enumerator UpsInputTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	powerProto := &config.DeviceProto{
@@ -105,6 +109,7 @@ func (enumerator UpsInputTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	devices = []*config.DeviceProto{

pkg/snmp/mibs/ups_mib/ups_mib_test.go

@@ -45,7 +45,8 @@ func TestUpsMib(t *testing.T) { // nolint: gocyclo
 		"127.0.0.1", // Endpoint
 		1024,        // Port
 		securityParameters,
-		"public", //  Context name
+		"public",   //  Context name
+		[]string{}, // tags (none)
 	)
 	assert.NoError(t, err)
 

pkg/snmp/mibs/ups_mib/ups_output_headers_table.go

@@ -79,6 +79,7 @@ func (enumerator UpsOutputHeadersTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	frequencyProto := &config.DeviceProto{
@@ -87,6 +88,7 @@ func (enumerator UpsOutputHeadersTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	devices = []*config.DeviceProto{

pkg/snmp/mibs/ups_mib/ups_output_table.go

@@ -81,6 +81,7 @@ func (enumerator UpsOutputTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	voltageProto := &config.DeviceProto{
@@ -89,6 +90,7 @@ func (enumerator UpsOutputTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	currentProto := &config.DeviceProto{
@@ -97,6 +99,7 @@ func (enumerator UpsOutputTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	powerProto := &config.DeviceProto{
@@ -105,6 +108,7 @@ func (enumerator UpsOutputTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	percentageProto := &config.DeviceProto{
@@ -113,6 +117,7 @@ func (enumerator UpsOutputTableDeviceEnumerator) DeviceEnumerator(
 			"model": model,
 		},
 		Instances: []*config.DeviceInstance{},
+		Tags:      snmpDeviceConfigMap["deviceTags"].([]string),
 	}
 
 	devices = []*config.DeviceProto{