Move .local/share/arduino-app-cli in /var/lib

[martacarbone]

Motivation

Currently the examples (and other static data) are stored inside the arduino home folder.
Current location: ~/.local/share/arduino-app-cli

This is needed because at some point the arduino-flasher-cli will support keeping user data, by preserving the user partition (where the arduino home folder is mounted). And we cannot keep some static data in the preserved paths, otherwise that data would not match the software version that gets installed in the root partition (which is not preserved).

Change description

# copied from prev installation
/home/arduino/.local/share/arduino-app-cli/examples -> /var/lib/arduino-app-cli/examples
/home/arduino/.local/share/arduino-app-cli/properties.msgpack -> /var/lib/arduino-app-cli/properties.msgpack
/home/arduino/.local/share/arduino-app-cli/bootloader_burned.flag -> /var/lib/arduino-app-cli/bootloader_burned.flag
/home/arduino/.local/share/arduino-app-cli/properties.msgpack.lock -> /var/lib/arduino-app-cli/properties.msgpack.lock

# created by the new installation
/home/arduino/.local/share/arduino-app-cli/assets -> /var/lib/arduino-app-cli/assets
/home/arduino/.local/share/arduino-app-cli/examples -> /var/lib/arduino-app-cli/examples (overwrite)

Additional Notes

The installation scripts try to gracefully stop any runner application and delete the .cache directory, allowing the packaging system to clean the installed files.

Test

Case test #1 fresh install

# Test from a clean system, expected no package installed, empty local dir
dpkg -l |grep arduino-app-cli;
ls -la /home/arduino/.local;
# going to install
sudo dpkg --install arduino-app-cli_0.9.0-1_arm64.deb ;
# expect no .local, expected examples and assets in new dir
ls -la /home/arduino/.local/share/arduino-app-cli;
ls -la /var/lib/arduino-app-cli/;

Case test #2 purge after a fresh install

# check 0.9.0 installed
dpkg -l |grep arduino-app-cli
# Create caches
# Start blink
arduino-app-cli app start /var/lib/arduino-app-cli/examples/blink
# check cache
ls -la /var/lib/arduino-app-cli/examples/blink
# purge
sudo dpkg --purge arduino-app-cli
# check not installed
dpkg -l |grep arduino-app-cli
# check not exists
ls -la /var/lib/arduino-app-cli/
# this does not exists before too
ls -la /home/arduino/.local/share/arduino-app-cli

Case test #3 upgrade from 0.8.0 to 0.9.0

# old version should be installed
dpkg -l |grep arduino-app-cli
dpkg --install arduino-app-cli_0.8.0-1_arm64.deb
# expected
ls -la /home/arduino/.local/share/arduino-app-cli/examples/blink
# not expected
ls -la /var/lib/arduino-app-cli/examples/blink
# trigger cache creation, start app
arduino-app-cli app start  /home/arduino/.local/share/arduino-app-cli/examples/blink
# expected to see .cache
ls -la /home/arduino/.local/share/arduino-app-cli/examples/blink
# here no .cache
ls -la /home/arduino/.local/share/arduino-app-cli/examples/code-detector/
# run upgrade
sudo apt install ./arduino-app-cli_0.9.0-1_arm64.deb
# test upgrade results
# check new package is installed
dpkg -l |grep arduino-app-cli
# check for .cache removal
ls -la /home/arduino/.local/share/arduino-app-cli/examples/blink
# here all should be fine
find /home/arduino/.local/share/arduino-app-cli/
# check new file installation
# expected assets and examples
ls -la /var/lib/arduino-app-cli
# run blink
arduino-app-cli app start  /var/lib/arduino-app-cli/examples/blink
# verify .cache is created in the new dir (the old one not exists, the new one has .cache)
ls -la /home/arduino/.local/share/arduino-app-cli/examples/blink
ls -la /var/lib/arduino-app-cli/examples/blink

Reviewer checklist

• PR addresses a single concern.
• PR title and description are properly filled.
• Changes will be merged in main.
• Changes are covered by tests.
• Logging is meaningful in case of troubleshooting.

[lucarin91]

Suggested change

	echo "Running pre-0.8.0 legacy cleanup/migration..."
	cleanup_arduino_examples /home/arduino/.local/share/arduino-app-cli/examples

[martacarbone]

Removed the cleanup of old dir examples; leave the app shutdown and cache cleanup of /var/lib/arduino-app-cli

[lucarin91]

Suggested change

	fi
	cp -r /home/arduino/.local/share/arduino-app-cli /examples /var/lib/arduino-app-cli

[martacarbone]

Add the copy of examples here; add the copy of properties.msgpack* and bootloader_burned.flag here;
add rm -rf of examples, properties.msgpack, properties.msgpack.lock and bootloader_burned.flag in postinst

[martacarbone]

done. Added file check to prevent "apt reinstall" from failing if the source is missing.

[lucarin91]

@martacarbone can you fix the conflict?

[dido18]

In the /home/arduino/.local/share/arduino-app-cli there is also the default.app file containing the default app to be started.
When the default app is moved to the root, user data is preserved; however, the user loses the previously configured default app.
Is this what we want?

[lucarin91]

In the /home/arduino/.local/share/arduino-app-cli there is also the default.app file containing the default app to be started. When the default app is moved to the root, user data is preserved; however, the user loses the previously configured default app. Is this what we want?

I think it is fine; in that case, we are updating the app-cli so that it could also change the way the default app works.

[dido18]

IMHO, this step is a bit magical.

Can we simply define the function where they are needed

• cleanup_home_arduino_examples that has hardcoded /home/arduino/.local/share/arduino-app-cli/examples
• cleanup_root_arduino_examples that has hard coded /var/lib/arduino-app-cli/examples

like

cleanup_home_arduino_examples() {
    if [ -d "/home/arduino/.local/share/arduino-app-cli/examples" ]; then
        local EXAMPLES=$(find "/home/arduino/.local/share/arduino-app-cli/examples" -maxdepth 1 -mindepth 1 -type d 2>/dev/null)
        echo "Stopping apps and clearing cache in: ${EXAMPLES_DIR}"
        for dir_path in ${EXAMPLES}; do
            # Stop apps and cache cleanup
            sudo -u arduino /usr/bin/arduino-app-cli app stop "${dir_path}" > /dev/null 2>&1 || true
            local CACHE_PATH="${dir_path}/.cache"
            if [ -d "${CACHE_PATH}" ]; then
                rm -r "${CACHE_PATH}"
            fi
        done
    fi
}