Fix sanitizing filenames

Signed-off-by: Alexandre Peixoto Ferreira <alexandref75@gmail.com>

README.md

@@ -17,6 +17,10 @@ The smarter-device-manager starts by reading a YAML configuration file. This con
   nummaxdevices: 10
 ```
 
+Devices in subdirectories have the slash replaced with underscore in the
+resource name, due to kubernetes naming restrictions: e.g. `/dev/net/tun`
+becomes `smarter-devices/net_tun`.
+
 The default config file provided will enable most of the devices available on a Raspberry Pi (vers 1-4) or equivalent boards. I2C, SPI, video devices, sound and others would be enabled. The config file can be replaced using a configmap to enable or disable access to different devices, like accelerators, GPUs, etc.
 
 The node will show the devices it recognizes as resources in the node object in Kubernetes. The example below shows a raspberry PI.

main.go

@@ -55,18 +55,45 @@ func init() {
 	flag.Parse()
 }
 
-func readDevDirectory(dirToList string) (files []string, err error) {
-	f, err := os.Open(dirToList)
-	if err != nil {
-		return nil, err
-	}
-	files, err = f.Readdirnames(-1)
-	f.Close()
-	if err != nil {
-		return nil, err
-	}
+func readDevDirectory(dirToList string, allowedRecursions uint8) (files []string, err error) {
+        var foundFiles []string
 
-	return files, nil
+        fType, err := os.Stat(dirToList)
+        if err != nil {
+                return nil, err
+        }
+
+        if !fType.IsDir()  {
+                return nil, nil
+        }
+
+        f, err := os.Open(dirToList)
+        if err != nil {
+                return nil, err
+        }
+        files, err = f.Readdirnames(-1)
+        if err != nil {
+                f.Close()
+                return nil, err
+        }
+        f.Close()
+        for _, subDir := range files {
+                foundFiles = append(foundFiles, subDir)
+                if allowedRecursions > 0 {
+                        filesDir, err := readDevDirectory(dirToList+"/"+subDir,allowedRecursions-1)
+                        if err == nil {
+                                for _, fileName := range filesDir {
+                                        foundFiles = append(foundFiles, subDir+"/"+fileName)
+                                }
+                        }
+                }
+        }
+
+        return foundFiles, nil
+}
+
+func sanitizeName(path string) string {
+        return strings.Replace(path, "/!@#$%^&*()[]{}'`~.", "___________________",-1)
 }
 
 func findDevicesPattern(listDevices []string, pattern string) ([]string,error) {
@@ -102,13 +129,13 @@ func main() {
         }
 
 	glog.V(0).Info("Reading existing devices on /dev")
-	ExistingDevices, err := readDevDirectory("/dev")
+	ExistingDevices, err := readDevDirectory("/dev",10)
 	if err != nil {
 		glog.Errorf(err.Error())
 		os.Exit(1)
 	}
 
-	ExistingDevicesSys, err := readDevDirectory("/sys/devices")
+	ExistingDevicesSys, err := readDevDirectory("/sys/devices",0)
 	if err != nil {
 		glog.Errorf(err.Error())
 		os.Exit(1)
@@ -151,9 +178,10 @@ func main() {
                         if len(foundDevices) > 0 {
                                 for _, deviceToCreate := range foundDevices {
                                         var newDevice DeviceInstance
+                                        deviceSafeName := sanitizeName(deviceToCreate)
                                         newDevice.deviceType = deviceFileType
-                                        newDevice.deviceName = "smarter-devices/" + deviceToCreate
-                                        newDevice.socketName = pluginapi.DevicePluginPath + "smarter-" + deviceToCreate + ".sock"
+                                        newDevice.deviceName = "smarter-devices/" + deviceSafeName
+                                        newDevice.socketName = pluginapi.DevicePluginPath + "smarter-" + deviceSafeName + ".sock"
                                         newDevice.deviceFile = "/dev/" + deviceToCreate
                                         newDevice.numDevices = deviceToTest.NumMaxDevices
                                         listDevicesAvailable = append(listDevicesAvailable, newDevice)

smarter-device-management-pod-k3s-test-xavier.yaml

@@ -15,7 +15,7 @@ spec:
   nodeName: smarter-jetson-xavier-4bcc2584
   containers:
   - name: smarter-device-manager
-    image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+    image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
     imagePullPolicy: IfNotPresent
     securityContext:
       allowPrivilegeEscalation: false

smarter-device-management-pod-k3s.yaml

@@ -15,7 +15,7 @@ spec:
   nodeName: <replace with node to run>
   containers:
   - name: smarter-device-manager
-    image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+    image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
     imagePullPolicy: IfNotPresent
     securityContext:
       allowPrivilegeEscalation: false

smarter-device-management-pod.yaml

@@ -15,7 +15,7 @@ spec:
   nodeName: <replace with node to run>
   containers:
   - name: smarter-device-manager
-    image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+    image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
     imagePullPolicy: IfNotPresent
     securityContext:
       allowPrivilegeEscalation: false

smarter-device-manager-ds-k3s.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds-with-configmap-rpi-k3s.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds-with-configmap-rpi.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds-with-configmap-xavier-k3s.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds-with-configmap-xavier.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.1.2
+        image: registry.gitlab.com/arm-research/smarter/smarter-device-manager:v1.20.8
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false