Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add special handling for names we might get wrong (#25570) #25604

Merged
merged 1 commit into from
Jan 20, 2025
Merged

fix: add special handling for names we might get wrong (#25570) #25604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions server/datastore/mysql/migrations/tables/20250109150150_UpdateFMAInstallScripts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ func init() {
}

const quitApplicationFunc = `

quit_application() {
local bundle_id="$1"
local timeout_duration=10
Expand Down Expand Up @@ -55,6 +54,10 @@ quit_application() {
}
`

// This is a map from tokens to known app filenames. These app names differ from the name field we pull
// from fleet_library_apps.
var knownGoodAppFilenames = map[string]string{"visual-studio-code": "Visual Studio Code.app", "firefox": "Firefox.app", "brave-browser": "Brave Browser.app"}

func Up_20250109150150(tx *sql.Tx) error {
var scriptsToModify []struct {
InstallScriptContents string `db:"contents"`
Expand Down Expand Up @@ -112,11 +115,11 @@ WHERE fla.token IN (?)
}
}

// Default to using the name we pulled + ".app". We know that is incorrect for some apps
// though, so look them up in our map of known good names and use that if it exists.
appFileName := fmt.Sprintf("%s.app", sc.AppName)
if sc.Token == "visual-studio-code" {
// VSCode has the name "Microsoft Visual Studio Code" in fleet_library_apps, but the
// .app name is "Visual Studio Code.app", so account for that here.
appFileName = "Visual Studio Code.app"
if knownName, ok := knownGoodAppFilenames[sc.Token]; ok {
appFileName = knownName
}

// This line will move the old version of the .app (if it exists) to the temporary directory
Expand Down
106 changes: 95 additions & 11 deletions server/datastore/mysql/migrations/tables/20250109150150_UpdateFMAInstallScripts_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package tables

import (
"fmt"
"testing"

"github.com/jmoiron/sqlx"
Expand All @@ -25,16 +26,28 @@ TMPDIR=$(dirname "$(realpath $INSTALLER_PATH)")
# extract contents
unzip "$INSTALLER_PATH" -d "$TMPDIR"
# copy to the applications folder
sudo cp -R "$TMPDIR/Figma.app" "$APPDIR"
sudo cp -R "$TMPDIR/%s" "$APPDIR"
`

tx, err := db.Begin()
require.NoError(t, err)
txx := sqlx.Tx{Tx: tx, Mapper: reflectx.NewMapperFunc("db", sqlx.NameMapper)}
installScriptID, err := getOrInsertScript(txx, originalContents)
installScriptID, err := getOrInsertScript(txx, fmt.Sprintf(originalContents, "Figma.app"))
require.NoError(t, err)
uninstallScriptID, err := getOrInsertScript(txx, "echo uninstall")
require.NoError(t, err)
firefoxInstallScriptID, err := getOrInsertScript(txx, fmt.Sprintf(originalContents, "Firefox.app"))
require.NoError(t, err)
firefoxUninstallScriptID, err := getOrInsertScript(txx, "echo uninstall")
require.NoError(t, err)
vsCodeInstallScriptID, err := getOrInsertScript(txx, fmt.Sprintf(originalContents, "Visual Studio Code.app"))
require.NoError(t, err)
vsCodeUninstallScriptID, err := getOrInsertScript(txx, "echo uninstall")
require.NoError(t, err)
braveInstallScriptID, err := getOrInsertScript(txx, fmt.Sprintf(originalContents, "Brave Browser.app"))
require.NoError(t, err)
braveUninstallScriptID, err := getOrInsertScript(txx, "echo uninstall")
require.NoError(t, err)
boxInstallScriptID, err := getOrInsertScript(txx, "echo install")
require.NoError(t, err)
boxUninstallScriptID, err := getOrInsertScript(txx, "echo uninstall")
Expand All @@ -58,6 +71,54 @@ sudo cp -R "$TMPDIR/Figma.app" "$APPDIR"
uninstallScriptID,
)

// Insert Firefox (one of our target apps)
execNoErr(
t,
db,
`INSERT INTO fleet_library_apps (name, token, version, platform, installer_url, sha256, bundle_identifier, install_script_content_id, uninstall_script_content_id) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`,
"Mozilla Firefox",
"firefox",
"134.0.1",
"darwin",
"https://download-installer.cdn.mozilla.net/pub/firefox/releases/134.0.1/mac/en-US/Firefox%20134.0.1.dmg",
"b3342c12bb44b7c78351fb32442a0775c15fb2ac809c24447fd8f8d1e2a42c62",
"org.mozilla.firefox",
firefoxInstallScriptID,
firefoxUninstallScriptID,
)

// Insert VSCode (one of our target apps)
execNoErr(
t,
db,
`INSERT INTO fleet_library_apps (name, token, version, platform, installer_url, sha256, bundle_identifier, install_script_content_id, uninstall_script_content_id) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`,
"Microsoft Visual Studio Code",
"visual-studio-code",
"1.96.4",
"darwin",
"https://update.code.visualstudio.com/1.96.4/darwin-arm64/stable",
"331a1969ee128b251917ae76c58ac65eb1c81deb90aad277d6466f0531dffd8b",
"com.microsoft.VSCode",
vsCodeInstallScriptID,
vsCodeUninstallScriptID,
)

// Insert Brave (one of our target apps)
execNoErr(
t,
db,
`INSERT INTO fleet_library_apps (name, token, version, platform, installer_url, sha256, bundle_identifier, install_script_content_id, uninstall_script_content_id) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`,
"Brave",
"brave-browser",
"1.74.48.0",
"darwin",
"https://updates-cdn.bravesoftware.com/sparkle/Brave-Browser/stable-arm64/174.48/Brave-Browser-arm64.dmg",
"c49b8d7e7029ed665bacafaf93a36b96b0889338f713ded62ed60c0306cf22af",
"com.brave.Browser",
braveInstallScriptID,
braveUninstallScriptID,
)

// Insert Box Drive, should be unaffected
execNoErr(
t,
Expand Down Expand Up @@ -96,13 +157,9 @@ FROM
ON fla.install_script_content_id = sc.id
WHERE fla.token = ?`

err = sqlx.Get(db, &scriptContents, selectStmt, "figma")
require.NoError(t, err)

expectedContents := `
expectedContentsTmpl := `
#!/bin/sh


quit_application() {
local bundle_id="$1"
local timeout_duration=10
Expand All @@ -113,7 +170,7 @@ quit_application() {
fi

local console_user
console_user=$(stat -f "%Su" /dev/console)
console_user=$(stat -f "%%Su" /dev/console)
if [[ $EUID -eq 0 && "$console_user" == "root" ]]; then
echo "Not logged into a non-root GUI; skipping quitting application ID '$bundle_id'."
return
Expand Down Expand Up @@ -148,13 +205,40 @@ TMPDIR=$(dirname "$(realpath $INSTALLER_PATH)")
# extract contents
unzip "$INSTALLER_PATH" -d "$TMPDIR"
# copy to the applications folder
quit_application com.figma.Desktop
sudo [ -d "$APPDIR/Figma.app" ] && sudo mv "$APPDIR/Figma.app" "$TMPDIR/Figma.app.bkp"
sudo cp -R "$TMPDIR/Figma.app" "$APPDIR"
quit_application %[1]s
sudo [ -d "$APPDIR/%[2]s" ] && sudo mv "$APPDIR/%[2]s" "$TMPDIR/%[2]s.bkp"
sudo cp -R "$TMPDIR/%[2]s" "$APPDIR"
`

err = sqlx.Get(db, &scriptContents, selectStmt, "figma")
require.NoError(t, err)

expectedContents := fmt.Sprintf(expectedContentsTmpl, "com.figma.Desktop", "Figma.app")
expectedChecksum := md5ChecksumScriptContent(expectedContents)
require.Equal(t, expectedContents, scriptContents.InstallScriptContents)
require.Equal(t, expectedChecksum, scriptContents.Checksum)

err = sqlx.Get(db, &scriptContents, selectStmt, "firefox")
require.NoError(t, err)

expectedContents = fmt.Sprintf(expectedContentsTmpl, "org.mozilla.firefox", "Firefox.app")
expectedChecksum = md5ChecksumScriptContent(expectedContents)
require.Equal(t, expectedContents, scriptContents.InstallScriptContents)
require.Equal(t, expectedChecksum, scriptContents.Checksum)

err = sqlx.Get(db, &scriptContents, selectStmt, "visual-studio-code")
require.NoError(t, err)

expectedContents = fmt.Sprintf(expectedContentsTmpl, "com.microsoft.VSCode", "Visual Studio Code.app")
expectedChecksum = md5ChecksumScriptContent(expectedContents)
require.Equal(t, expectedContents, scriptContents.InstallScriptContents)
require.Equal(t, expectedChecksum, scriptContents.Checksum)

err = sqlx.Get(db, &scriptContents, selectStmt, "brave-browser")
require.NoError(t, err)

expectedContents = fmt.Sprintf(expectedContentsTmpl, "com.brave.Browser", "Brave Browser.app")
expectedChecksum = md5ChecksumScriptContent(expectedContents)
require.Equal(t, expectedContents, scriptContents.InstallScriptContents)
require.Equal(t, expectedChecksum, scriptContents.Checksum)

Expand Down
Loading