Add tests for Matter plugin

[MonicaisHer]

This PR

• add unit test
• add spread test to build a hello world matter snap
• add craft parts plugin test to check storage path replacement and app initialization

Testing

Unit test

setting up a development environment, then run only the unit tests for the plugins:

$ ./tools/environment-setup.sh
$ lxc exec snapcraft-dev -- sudo -iu ubuntu bash
ubuntu@snapcraft-dev:~$ cd snapcraft
ubuntu@snapcraft-dev:~$ pip install pytest-cov pytest-mock pytest-subprocess
ubuntu@snapcraft-dev:~$ pip install -r requirements.txt
ubuntu@snapcraft-dev:~$ pytest tests/unit/parts/plugins
...
collected 99 items
...
99 passed in 1.02s

tox test

$ lxc exec snapcraft-dev -- sudo -iu ubuntu bash
ubuntu@snapcraft-dev:~$ cd snapcraft
ubuntu@snapcraft-dev:~$ pip install -U pyopenssl cryptography
ubuntu@snapcraft-dev:~$ pytest --cov=snapcraft_legacy --cov-report=xml:results/coverage-test-legacy-py310.xml --junit-xml=results/test-results-test-legacy-py310.xml tests/legacy

Spread test for plugins integration (with matter-lighting snap)

Please note this spread test has not been executed on the local machine. The matter-lighting app, based on the Matter plugin, can be built and manually tested by runing:

cd snapcraft/tests/spread/plugins/craft-parts/matter
snapcraft clean
snapcraft -v --debug

sudo snap install ./matter-lighting_1.0_amd64.snap --dangerous
start_time=$(date +"%Y-%m-%d %H:%M:%S")
snap start matter-lighting

# Check if storage path replacement from /tmp to SNAP_COMMON/mnt works
for file in /tmp/chip_*; do
  if [ -e "$file" ]; then
    echo "Error: $file should not exist."
    exit 1
  fi
done

if [ ! -e "${SNAP_COMMON/mnt/chip_*}" ]; then
  echo "Error: ${SNAP_COMMON}/mnt/chip_* does not exist."
  exit 1
fi

# Check if server initialization is complete for matter-lighting
if ! journalctl --since "$start_time" | grep matter-lighting | grep "CHIP:SVR: Server initialization complete"; then
  echo "Error: matter-lighting initialization failed."
  exit 1
fi

[MonicaisHer]

Could you please review @farshidtz

[farshidtz]

Thanks. Please see my comments.

Have you also tried running the spread tests?

[MonicaisHer]

Thanks. Please see my comments.

Have you also tried running the spread tests?

As mentioned in this PR description, the spread test has not been executed on the local machine. The hello world snap, using the Matter plugin, has been manually tested to verify that the output is equal to 'hello world.'

The spread test is integrated into the GitHub Action process.

[MonicaisHer]

The linter check error is unrelated to this PR and has already been fixed upstream. It will be solved once this branch has been rebased on the upstream main.

[farshidtz]

Please find my latest round of review addressing the changes and some of the original plugin code.