Merge pull request #400 from reubenmiller/feat-software-add-type

reubenmiller · Jun 24, 2024 · 760bed0 · 760bed0
2 parents c904752 + 1d5dcb3
commit 760bed0
Show file tree

Hide file tree

Showing 10 changed files with 97 additions and 18 deletions.
diff --git a/api/spec/json/software.json b/api/spec/json/software.json
@@ -34,7 +34,12 @@
           },
           {
             "description": "Get a list of software packages starting with \"python3\"",
-            "command": "c8y software list --name \"python3*\"",
+            "command": "c8y software list --name \"python3*\" --softwareType apt",
+            "skipTest": true
+          },
+          {
+            "description": "List all software packages of a given software type",
+            "command": "c8y software list --softwareType rpm",
             "skipTest": true
           }
         ]
@@ -85,6 +90,12 @@
               "description": "Filter by deviceType",
               "format": "(c8y_Filter.type eq '%s')"
             },
+            {
+              "name": "softwareType",
+              "type": "string",
+              "description": "Filter by softwareType",
+              "format": "(softwareType eq '%s')"
+            },
             {
               "name": "description",
               "type": "string",
@@ -147,15 +158,15 @@
         "go": [
           {
             "description": "Create a software package",
-            "command": "c8y software create --name \"python3-requests\" --description \"python requests library\""
+            "command": "c8y software create --name \"python3-requests\" --description \"python requests library\" --softwareType apt"
           },
           {
             "description": "Create a software package which is only applicable for a specific device type",
-            "command": "c8y software create --name \"python3-requests\" --description \"python requests library\" --deviceType \"c8y_Linux\""
+            "command": "c8y software create --name \"python3-requests\" --description \"python requests library\" --deviceType \"c8y_Linux\" --softwareType apt"
           },
           {
             "description": "Create the same software package for multiple device types",
-            "command": "echo -e \"c8y_Linux\\nc8y_MacOS\" | c8y software create --name \"python3-requests\" --description \"python requests library\"",
+            "command": "echo -e \"c8y_Linux\\nc8y_MacOS\" | c8y software create --name \"python3-requests\" --description \"python requests library\"  --softwareType rpm",
             "assertStdOut": {
               "line-count": 2,
               "json": {
@@ -166,7 +177,8 @@
                 "..1.method": "POST",
                 "..1.body.name": "python3-requests",
                 "..1.body.description": "python requests library",
-                "..1.body.c8y_Filter.type": "c8y_MacOS"
+                "..1.body.c8y_Filter.type": "c8y_MacOS",
+                "..1.body.softwareType": "rpm"
               }
             }
           },
@@ -199,6 +211,11 @@
           "required": false,
           "description": "Description of the software package"
         },
+        {
+          "name": "softwareType",
+          "type": "string",
+          "description": "Software type"
+        },
         {
           "name": "deviceType",
           "type": "string",
@@ -363,6 +380,11 @@
           "required": false,
           "description": "Description of the software package"
         },
+        {
+          "name": "softwareType",
+          "type": "string",
+          "description": "Software type"
+        },
         {
           "name": "deviceType",
           "type": "string",

diff --git a/api/spec/yaml/software.yaml b/api/spec/yaml/software.yaml
@@ -29,7 +29,11 @@ commands:
           skipTest: true
 
         - description: Get a list of software packages starting with "python3"
-          command: c8y software list --name "python3*"
+          command: c8y software list --name "python3*" --softwareType apt
+          skipTest: true
+
+        - description: List all software packages of a given software type
+          command: c8y software list --softwareType rpm
           skipTest: true
 
     queryParameters:
@@ -70,6 +74,11 @@ commands:
             description: Filter by deviceType
             format: (c8y_Filter.type eq '%s')
 
+          - name: softwareType
+            type: string
+            description: Filter by softwareType
+            format: (softwareType eq '%s')
+
           - name: description
             type: string
             description: Filter by description
@@ -115,13 +124,13 @@ commands:
 
       go:
         - description: Create a software package
-          command: c8y software create --name "python3-requests" --description "python requests library"
+          command: c8y software create --name "python3-requests" --description "python requests library" --softwareType apt
 
         - description: Create a software package which is only applicable for a specific device type
-          command: c8y software create --name "python3-requests" --description "python requests library" --deviceType "c8y_Linux"
+          command: c8y software create --name "python3-requests" --description "python requests library" --deviceType "c8y_Linux" --softwareType apt
 
         - description: Create the same software package for multiple device types
-          command: echo -e "c8y_Linux\nc8y_MacOS" | c8y software create --name "python3-requests" --description "python requests library"
+          command: echo -e "c8y_Linux\nc8y_MacOS" | c8y software create --name "python3-requests" --description "python requests library"  --softwareType rpm
           assertStdOut:
             line-count: 2
             json:
@@ -133,6 +142,7 @@ commands:
               ..1.body.name: python3-requests
               ..1.body.description: python requests library
               ..1.body.c8y_Filter.type: c8y_MacOS
+              ..1.body.softwareType: rpm
 
         - description: Create a software package and create a new version
           skipTest: true
@@ -154,6 +164,10 @@ commands:
         required: false
         description: Description of the software package
 
+      - name: softwareType
+        type: string
+        description: Software type
+
       - name: deviceType
         type: string
         property: c8y_Filter.type
@@ -273,7 +287,11 @@ commands:
         type: string
         required: false
         description: Description of the software package
-
+
+      - name: softwareType
+        type: string
+        description: Software type
+
       - name: deviceType
         type: string
         property: c8y_Filter.type

diff --git a/pkg/cmd/software/create/create.auto.go b/pkg/cmd/software/create/create.auto.go
diff --git a/pkg/cmd/software/list/list.auto.go b/pkg/cmd/software/list/list.auto.go
diff --git a/pkg/cmd/software/update/update.auto.go b/pkg/cmd/software/update/update.auto.go
diff --git a/tests/auto/software/tests/software_create.yaml b/tests/auto/software/tests/software_create.yaml
@@ -1,11 +1,12 @@
 tests:
     software_create_Create a software package:
-        command: c8y software create --name "python3-requests" --description "python requests library"
+        command: c8y software create --name "python3-requests" --description "python requests library" --softwareType apt
         exit-code: 0
         stdout:
             json:
                 body.description: python requests library
                 body.name: python3-requests
+                body.softwareType: apt
                 method: POST
                 path: /inventory/managedObjects
     software_create_Create a software package and create a new version:
@@ -19,17 +20,18 @@ tests:
                 method: POST
                 path: /inventory/managedObjects
     software_create_Create a software package which is only applicable for a specific device type:
-        command: c8y software create --name "python3-requests" --description "python requests library" --deviceType "c8y_Linux"
+        command: c8y software create --name "python3-requests" --description "python requests library" --deviceType "c8y_Linux" --softwareType apt
         exit-code: 0
         stdout:
             json:
                 body.c8y_Filter.type: c8y_Linux
                 body.description: python requests library
                 body.name: python3-requests
+                body.softwareType: apt
                 method: POST
                 path: /inventory/managedObjects
     software_create_Create the same software package for multiple device types:
-        command: $TEST_SHELL -c 'echo -e "c8y_Linux\nc8y_MacOS" | c8y software create --name "python3-requests" --description "python requests library"'
+        command: $TEST_SHELL -c 'echo -e "c8y_Linux\nc8y_MacOS" | c8y software create --name "python3-requests" --description "python requests library"  --softwareType rpm'
         exit-code: 0
         stdout:
             json:
@@ -40,8 +42,10 @@ tests:
                 ..1.body.c8y_Filter.type: c8y_MacOS
                 ..1.body.description: python requests library
                 ..1.body.name: python3-requests
+                ..1.body.softwareType: rpm
                 ..1.method: POST
                 body.description: python requests library
                 body.name: python3-requests
+                body.softwareType: rpm
                 method: POST
                 path: /inventory/managedObjects
diff --git a/tests/auto/software/tests/software_list.yaml b/tests/auto/software/tests/software_list.yaml
@@ -8,7 +8,7 @@ tests:
                 method: GET
                 path: /inventory/managedObjects
     software_list_Get a list of software packages starting with "python3":
-        command: c8y software list --name "python3*"
+        command: c8y software list --name "python3*" --softwareType apt
         exit-code: 0
         skip: true
         stdout:
@@ -17,3 +17,14 @@ tests:
                 path: /inventory/managedObjects
             contains:
                 - name=python3*
+                - softwareType=apt
+    software_list_List all software packages of a given software type:
+        command: c8y software list --softwareType rpm
+        exit-code: 0
+        skip: true
+        stdout:
+            json:
+                method: GET
+                path: /inventory/managedObjects
+            contains:
+                - softwareType=rpm
diff --git a/tools/PSc8y/Public/Get-SoftwareCollection.ps1 b/tools/PSc8y/Public/Get-SoftwareCollection.ps1
@@ -48,6 +48,11 @@ Get a list of software packages
         [string]
         $DeviceType,
 
+        # Filter by softwareType
+        [Parameter()]
+        [string]
+        $SoftwareType,
+
         # Filter by description
         [Parameter()]
         [string]

diff --git a/tools/PSc8y/Public/New-Software.ps1 b/tools/PSc8y/Public/New-Software.ps1
@@ -32,6 +32,11 @@ Create a software package
         [string]
         $Description,
 
+        # Software type
+        [Parameter()]
+        [string]
+        $SoftwareType,
+
         # Device type filter. Only allow software to be applied to devices of this type
         [Parameter(ValueFromPipeline=$true,
                    ValueFromPipelineByPropertyName=$true)]

diff --git a/tools/PSc8y/Public/Update-Software.ps1 b/tools/PSc8y/Public/Update-Software.ps1
@@ -44,6 +44,11 @@ Update a software package (using pipeline)
         [string]
         $Description,
 
+        # Software type
+        [Parameter()]
+        [string]
+        $SoftwareType,
+
         # Device type filter. Only allow software to be applied to devices of this type
         [Parameter()]
         [string]