feat(snap): add initial snap packaging

[MonicaisHer]

fix: #6
Signed-off-by: Mengyi [email protected]

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/device-snmp-go/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

• I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
• I am not introducing a new dependency (add notes below if you are)
• I have added unit tests for the new feature or bug fix (if not, why?) no hardware available
• I have fully tested (add details below) this the new feature or bug fix (if not, why?)
• I have opened a PR for the related docs change (if not, why?) this will be done after the snap been published

Testing Instructions

Test guideline:

git clone https://github.com/MonicaisHer/device-snmp-go.git
cd device-snmp-go
git checkout add-snap-v2
snapcraft
snap install edgexfoundry --channel=2.0
snap install edgex-device-snmp_2.0.1-dev.4_amd64.snap --dangerous
sudo snap connect edgexfoundry:edgex-secretstore-token edgex-device-snmp:edgex-secretstore-token
sudo nano /var/snap/edgex-device-snmp/current/config/device-snmp/res/profiles/device.snmp.trendnet.TPE082WS.yaml

please change the deviceResources's RebootCurrentState's properties readWrite: "R" to "RW", to let device profile align the device resource. (issue: #126 )

check if the snap is running:

snap start --enable edgex-device-snmp
snap logs edgex-device-snmp

expect:

level=INFO ts=2021-10-28T11:38:56.615380966Z app=device-snmp source=message.go:55 msg="device snmp started"

ping edgex-device-snmp's port:

curl http://localhost:59993/api/v2/ping

expect:{"apiVersion":"v2","timestamp":"Wed Oct 27 14:11:36 CEST 2021"}

New Dependency Instructions (If applicable)

[MonicaisHer]

Could you please help me review it, thanks! @farshidtz @siggiskulason @tonyespy

[farshidtz]

Thanks @MonicaisHer. I added several inline comments. Please also add a snap/README.md.

[MonicaisHer]

Thanks @MonicaisHer. I added several inline comments. Please also add a snap/README.md.

Thanks for your review @farshidtz . I was intent to add readme after publishing this snap because it's never been published, so it cant be installed from either the snap store or using snap install yet by a user. If you want me to add now, should I add steps on how to build a snap by snapcraft?

[farshidtz]

Thanks for your review @farshidtz . I was intent to add readme after publishing this snap because it's never been published, so it cant be installed from either the snap store or using snap install yet by a user. If you want me to add now, should I add steps on how to build a snap by snapcraft?

That's a good point. I can think of three options:

1. Publish manually once and then publish the code with the docs
2. Publish the code with docs for manual build and installation steps. Once added to store, add the store badge and replace the commands.
3. Add a separate PR with the expected README, set it to draft and link to it from here. We can merge that PR later on.

What do you think @siggiskulason @tonyespy?

[farshidtz]

The top level go.mod and go.sum are probably changed by mistake. Please remove/revert that commit and go mod tidy.

[MonicaisHer]

The top level go.mod and go.sum are probably changed by mistake. Please remove/revert that commit and go mod tidy.

Thanks. That commit has been reverted.

[keanjapesan]

recheck

[codecov-commenter]

Codecov Report

Merging #127 (e0d79c5) into main (128899a) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #127   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files          2       2           
  Lines        200     200           
=====================================
  Misses       200     200           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8bb3280...e0d79c5. Read the comment docs.

[farshidtz]

The key should be read, not write as it is exposing the read-only $SNAP/config directory.

[MonicaisHer]

Thank you for your re-review, I have updated this part. I also updated this part's word based on your another PR.

[farshidtz]

Thanks. Looks good.
Please squash and merge which should also fix the semantic commit issues.

[MonicaisHer]

@siggiskulason Could you please help me squash and merge this PR? Thank you!

[siggiskulason]

LGTM