feat: Implement Device System Events

[lenny-goodell]

Also, refactored to use common Messaging Bootstrap Handler

closes #4099

Implements related ADR

Dependent on the following PRs:

• feat: Add new SystemEvent DTO go-mod-core-contracts#752
• feat: Add common Messaging bootstrap handler go-mod-bootstrap#360

Signed-off-by: Leonard Goodell [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/edgex-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?)
• 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?)
  feat: Document Core Metadata Device System Events edgex-docs#830

Testing Instructions

Run edgex stack with Device Virtual
Stop Core Metadata container
Build and run this branch locally (require branches from PR referenced above) with DEBUG enabled
Using curl or postman delete, add and remove Device Virtual devices (can't use EdgeX UI from docker since core-metadata is running locally)
Verify log show debug message that System Event was published

New Dependency Instructions (If applicable)

[codecov-commenter]

Codecov Report

Merging #4101 (d69e356) into main (062af8d) will decrease coverage by 3.69%.
The diff coverage is 75.86%.

@@            Coverage Diff             @@
##             main    #4101      +/-   ##
==========================================
- Coverage   47.32%   43.63%   -3.70%     
==========================================
  Files         114      120       +6     
  Lines        9850    10591     +741     
==========================================
- Hits         4662     4621      -41     
- Misses       4801     5586     +785     
+ Partials      387      384       -3     

Impacted Files	Coverage Δ
internal/core/metadata/application/device.go	13.09% <75.86%> (ø)
...rnal/core/metadata/application/provisionwatcher.go	0.00% <0.00%> (ø)
...ternal/core/metadata/application/deviceresource.go	0.00% <0.00%> (ø)
...nternal/core/metadata/application/devicecommand.go	0.00% <0.00%> (ø)
...nternal/core/metadata/application/deviceprofile.go	0.00% <0.00%> (ø)
internal/core/metadata/application/notify.go	0.00% <0.00%> (ø)
...nternal/core/metadata/application/deviceservice.go	0.00% <0.00%> (ø)

---

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 062af8d...d69e356. Read the comment docs.

[cloudxxx8]

LGTM

[farshidtz]

The snap fails to start because security-secretstore-setup exits with non-zero code. The CI logs currently don't get the logs when the snap fails to even start (we are working on improving this).

I downloaded the build from Github (see for example here; scroll down) and installed manually to check the logs:

$ snap install --dangerous ./edgexfoundry_2.3.0-dev.30_amd64.snap
Run service command "start" for services ["consul" "core-command" "core-data" "core-metadata" "kong-daemon" "postgres" "redis" "security-bootstrapper-redis" "security-consul-bootstrapper" "security-proxy-setup" "security-secretstore-setup" "vault"] of snap "edgexfoundry" (systemctl command [start snap.edgexfoundry.security-secretstore-setup.service] failed with exit status 1: Job for snap.edgexfoundry.security-secretstore-setup.service failed because the control process exited with error code.

$ sudo journalctl -n 1000 | grep edgexfoundry | grep ERROR
level=ERROR ts=2022-07-28T08:14:23.57437856Z app=security-secretstore-setup source=init.go:329 msg="token provider failed: /snap/edgexfoundry/x1/bin/security-file-token-provider terminated with non-zero exit code 1"

Unfortunately, security-secretstore-setup is not printing the error message. Unrelated to this PR, it looks like standard output and standard error aren't captured by EdgeX logger here. This code sets to use os output streams but not sure if this is ever called.

I could not figure out why the changes in this PR are causing this failure.

Full logs: edgexfoundry_2.3.0-dev.30.logs.txt, see line 493

[lenny-goodell]

@farshidtz , @jim-wang-intel create this PR to test which go-mod and which version has triggered this. We have narrowed it down to go-mod-bootstrap v2.2.1-dev.9
#4105

I am taking a look at the commit for that to see how it could be impacting this.

[lenny-goodell]

@farshidtz , that change to go-mod-bootstrap was to make sure the exit code it set properly when bootstrapping fails. Before it always returned with 0 exit code.

I suspect that the issue with Secret Store setup in the test was always there, be now has the proper exit code.

[lenny-goodell]

@farshidtz , found the culprit !

The file token provider is incorrectly returning false in its bootstrap hander which now causes it to exit with non-zero exit code.

We'll get a fix in for that which will un-block this PR.

[lenny-goodell]

@jim-wang-intel , @farshidtz , Rebased this PR to pull in fixes from the other PR.

[lenny-goodell]

Put in draft to it doesn't get merged until this PR is merged otherwise TAF tests will fail.
edgexfoundry/edgex-compose#261

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.5% Duplication

Addressed comments