tests: add desktop-file and common-id checks to desktop-file-ids test

olivercalder · olivercalder · commit 8f286b3789f9 · 2026-05-10T16:19:34.000+02:00
Signed-off-by: Oliver Calder &lt;oliver.calder@canonical.com&gt;
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/bin/check-dirs b/tests/lib/snaps/test-snapd-desktop-file-ids/bin/check-dirs
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/sh -e
 
 for dir in "$@"; do
     ls "$dir"
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/bin/check-files b/tests/lib/snaps/test-snapd-desktop-file-ids/bin/check-files
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/sh -e
 
 for file in "$@"; do
     cat "$file"
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/arbitrary.desktop b/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/arbitrary.desktop
@@ -1,7 +1,7 @@
 [Desktop Entry]
-Name=test-snapd-desktop.cmd
-Comment=A desktop file for test-snapd-desktop.cmd
-Exec=test-snapd-desktop.cmd
+Name=test-snapd-desktop-file-ids.cmd
+Comment=A desktop file for test-snapd-desktop-file-ids.cmd
+Exec=test-snapd-desktop-file-ids.cmd
 Terminal=true
 Type=Application
 X-SnapCommonID=org.example.MyCommonID
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/bar.desktop b/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/bar.desktop
@@ -1,7 +1,7 @@
 [Desktop Entry]
-Name=test-snapd-desktop.cmd
-Comment=A desktop file for test-snapd-desktop.cmd
-Exec=test-snapd-desktop.cmd
+Name=test-snapd-desktop-file-ids.cmd
+Comment=A desktop file for test-snapd-desktop-file-ids.cmd
+Exec=test-snapd-desktop-file-ids.cmd
 Terminal=true
 Type=Application
 X-SnapCommonID=org.example.NotListed
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/foo.desktop b/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/foo.desktop
@@ -1,6 +1,6 @@
 [Desktop Entry]
-Name=test-snapd-desktop.cmd
-Comment=A desktop file for test-snapd-desktop.cmd
-Exec=test-snapd-desktop.cmd
+Name=test-snapd-desktop-file-ids.cmd
+Comment=A desktop file for test-snapd-desktop-file-ids.cmd
+Exec=test-snapd-desktop-file-ids.cmd
 Terminal=true
 Type=Application
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/org.example.Bar.desktop b/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/org.example.Bar.desktop
@@ -0,0 +1,6 @@
+[Desktop Entry]
+Name=test-snapd-desktop-file-ids.cmd
+Comment=A desktop file for test-snapd-desktop-file-ids.cmd
+Exec=test-snapd-desktop-file-ids.cmd
+Terminal=true
+Type=Application
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/org.example.Fallback.desktop b/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/org.example.Fallback.desktop
@@ -1,6 +1,6 @@
 [Desktop Entry]
-Name=test-snapd-desktop.cmd
-Comment=A desktop file for test-snapd-desktop.cmd
-Exec=test-snapd-desktop.cmd
+Name=test-snapd-desktop-file-ids.cmd
+Comment=A desktop file for test-snapd-desktop-file-ids.cmd
+Exec=test-snapd-desktop-file-ids.cmd
 Terminal=true
 Type=Application
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/org.example.Foo.desktop b/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/org.example.Foo.desktop
@@ -1,6 +1,6 @@
 [Desktop Entry]
-Name=test-snapd-desktop.cmd
-Comment=A desktop file for test-snapd-desktop.cmd
-Exec=test-snapd-desktop.cmd
+Name=test-snapd-desktop-file-ids.cmd
+Comment=A desktop file for test-snapd-desktop-file-ids.cmd
+Exec=test-snapd-desktop-file-ids.cmd
 Terminal=true
 Type=Application
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/org.example.desktop b/tests/lib/snaps/test-snapd-desktop-file-ids/meta/gui/org.example.desktop
@@ -1,6 +1,6 @@
 [Desktop Entry]
-Name=test-snapd-desktop.cmd
-Comment=A desktop file for test-snapd-desktop.cmd
-Exec=test-snapd-desktop.cmd
+Name=test-snapd-desktop-file-ids.cmd
+Comment=A desktop file for test-snapd-desktop-file-ids.cmd
+Exec=test-snapd-desktop-file-ids.cmd
 Terminal=true
 Type=Application
diff --git a/tests/lib/snaps/test-snapd-desktop-file-ids/meta/snap.yaml b/tests/lib/snaps/test-snapd-desktop-file-ids/meta/snap.yaml
@@ -10,10 +10,44 @@ apps:
     check-dirs:
         command: bin/check-dirs
         plugs: [desktop, desktop-legacy]
+    cmd:
+        command: bin/check-files # doesn't matter
+        common-id: org.example.Foo
+        plugs:
+        - desktop # really also a decoy
+        - desktop-ids
+        - desktop-decoy1
+        - desktop-decoy2
+        - desktop-decoy3
+        - desktop-decoy4
+        - desktop-decoy5
+        - desktop-decoy6
+        - desktop-decoy7
+        - desktop-decoy8
 
 plugs:
-  desktop:
+  desktop-ids:
+    interface: desktop
     desktop-file-ids:
     - org.example.desktop
+    - org.example.Foo.desktop
     - org.example.Fallback
-    - org.example.MyCommonID.desktop
+    - org.example.NonexistentFile.desktop
+  # Declare lots of desktop plugs without desktop-file-ids to make sure the
+  # correct desktop file ID is chosen
+  desktop-decoy1:
+    interface: desktop
+  desktop-decoy2:
+    interface: desktop
+  desktop-decoy3:
+    interface: desktop
+  desktop-decoy4:
+    interface: desktop
+  desktop-decoy5:
+    interface: desktop
+  desktop-decoy6:
+    interface: desktop
+  desktop-decoy7:
+    interface: desktop
+  desktop-decoy8:
+    interface: desktop
diff --git a/tests/main/desktop-file-ids/task.yaml b/tests/main/desktop-file-ids/task.yaml
@@ -16,9 +16,9 @@ environment:
 prepare: |
     cat > "$TESTSLIB"/snaps/test-snapd-desktop-file-ids/meta/gui/'bad. ,?**[]{}^\$#.desktop' << EOF
     [Desktop Entry]
-    Name=test-snapd-desktop.cmd
+    Name=test-snapd-desktop-file-ids.cmd
     Comment=A desktop file for test-snapd-desktop.cmd
-    Exec=test-snapd-desktop.cmd
+    Exec=test-snapd-desktop-file-ids.cmd
     Terminal=true
     Type=Application
     EOF
@@ -32,7 +32,7 @@ restore: |
     tests.session -u test restore
 
 execute: |
-    files="$DIR/org.example.desktop $DIR/org.example.Fallback.desktop $DIR/org.example.MyCommonID.desktop $DIR/test-snapd-desktop-file-ids_foo.desktop $DIR/test-snapd-desktop-file-ids_bar.desktop $DIR/test-snapd-desktop-file-ids_org.example.Foo.desktop $DIR/test-snapd-desktop-file-ids_bad._____________.desktop"
+    files="$DIR/org.example.desktop $DIR/org.example.Foo.desktop $DIR/org.example.Fallback.desktop $DIR/test-snapd-desktop-file-ids_foo.desktop $DIR/test-snapd-desktop-file-ids_bar.desktop $DIR/test-snapd-desktop-file-ids_org.example.Bar.desktop $DIR/test-snapd-desktop-file-ids_bad._____________.desktop"
 
     # Connect desktop-legacy interface to test generated desktop allow/deny rules
     # only allows access to the snap's desktop files
@@ -51,6 +51,17 @@ execute: |
         not tests.session -u test exec test-snapd-desktop-file-ids.check-files "$DIR/test-confinement.desktop"
     fi
 
+    echo "Just because a desktop file ID is declared does not mean it is created"
+    test ! -f "$DIR/org.example.NonexistentFile.desktop"
+
+    echo "Check that common ID and desktop file ID is correct"
+    RESULT="$(snap debug api /v2/snaps/test-snapd-desktop-file-ids)"
+    echo "$RESULT" | MATCH '"status-code": 200'
+    APPS="$(echo "$RESULT" | gojq .result.apps)"
+    # Should have common-id but no file id
+    echo "$APPS" | gojq '.[] | select(.name == "cmd")."common-id"' | MATCH "org.example.Foo"
+    echo "$APPS" | gojq '.[] | select(.name == "cmd")."desktop-file"' | MATCH "org.example.Foo.desktop"
+
     snap remove --purge test-snapd-desktop-file-ids
     echo "Check desktop files are removed"
     for file in $files; do

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#!/bin/sh`
	`1`	`+#!/bin/sh -e`
`2`	`2`
`3`	`3`	`for dir in "$@"; do`
`4`	`4`	`ls "$dir"`