Initial contribution of UpdateManager to Eclipse Kanto #1

stoyan-zoubev · 2023-06-02T12:58:05Z

[#2] Initial Contribution of the Update Manager

This is the initial contribution of the implementation of a device update manager as proposed.
More technical documentation will follow with additional PRs.

Signed-off-by: Stoyan Zoubev [email protected]

Signed-off-by: Stoyan Zoubev <[email protected]>

README.md

.github/workflows/validation.yaml

api/agent/agent_options.go

api/agent/timer_desired_state_feedback.go

api/agent/agent_test.go

api/agent/callback_current_state_test.go

updatem/domain/update_manager_handler.go

updatem/domain/update_manager.go

- golang version bumped to 1.19.4 in validation.yaml - fixed broken links in README.md file - removed commented/unused code from source files

- use strings.Builder for string concatenation in toActionsString function.

Signed-off-by: Stoyan Zoubev <[email protected]>

mqtt/update_agent_client.go

Signed-off-by: Stoyan Zoubev <[email protected]>

k-gostev

In the NOTICE file we add only what is included in the go binary file. This can be checked with go version -m <binary>. It is nice that there are not any absences from what I checked, however some additions are not needed.

NOTICE.md

k-gostev

There are some general recommendations, nits and some things that I am just curious about for the api/agent. I will continue later on with the other packages.

api/agent/agent.go

api/agent/callback_current_state.go

api/agent/callback_desired_state_feedback.go

api/agent/timer_desired_state_feedback.go

the imports in three groups that is from top to bottom: standard libraries, internal libraries, external libraries, all separated by a new line. Signed-off-by: Stoyan Zoubev <[email protected]>

Signed-off-by: Stoyan Zoubev <[email protected]>

These are not needed, according to the Eclipse Kanto Project Lead. Signed-off-by: Stoyan Zoubev <[email protected]>

k-gostev

Another batch with general recommendations, nits and suggestions, plus a couple of questions that I have. I did not went trough all files, I still need to cover some more ground, so thanks for your patience.

api/types/desired_state.go

api/types/desired_state_feedback.go

api/types/envelope.go

api/types/inventory.go

config/flags.go

config/flags_internal.go

Signed-off-by: Stoyan Zoubev <[email protected]>

k-gostev

Another set of some minor stuff here and there. I still need to go trough the domain and orchestration packages.

mqtt/desired_state_client.go

mqtt/update_agent_client.go

k-gostev

Another set of some minor stuff here and there. I still need to go trough the domain and orchestration packages.

api/agent/agent_options.go

api/agent/agent_test.go

api/types/desired_state_test.go

api/types/inventory_test.go

api/client.go

updatem/orchestration/reboot.go

- DesiredStateClient's Unsubscribe method to return error. - fixed typos, missing doc, wrong text descriptions. - removed incorrect log messages, extend log message with extra info. - some test case improvements. Signed-off-by: Stoyan Zoubev <[email protected]>

Signed-off-by: Stoyan Zoubev <[email protected]>

updatem/domain/update_manager.go

Signed-off-by: Stoyan Zoubev <[email protected]>

cmd/main.go

k-gostev

a bit more general suggestions from me

updatem/domain/update_manager.go

updatem/orchestration/reboot_linux.go

updatem/orchestration/update_manager.go

updatem/orchestration/update_orchestrator.go

updatem/orchestration/update_orchestrator_feedback.go

updatem/orchestration/reboot_windows.go

NOTICE.md

logger/logger_test.go

mqtt/mock/mqtt_client_mock.go

config/config_internal.go

mqtt/desired_state_client.go

mqtt/desired_state_client_test.go

mqtt/update_agent_client_test.go

mqtt/update_agent_client.go

k-gostev

My comments regarding the unit tests. Whether you chose to fix them now, or in the incoming test PR, those comments should be addressed.

api/agent/agent_test.go

updatem/domain/update_manager_test.go

- moved main package into nested directory cmd/update-manager - only containers update agent remains as default updage agents config - mqtt topics pre-generated, no concatenations on every request - other minor source code improvements

updatem/orchestration/update_manager_inventory.go

updatem/domain/update_manager.go

updatem/orchestration/update_orchestrator_feedback.go

…d var declarations. Signed-off-by: Stoyan Zoubev <[email protected]>

- all byte[] parameters replaced with concrete types - serialization/deserialization to/from byte[] moved to mqtt clients - renaming: Publish -> Send, Connect/Subscribe -> Start, Disconnect/Unsubscribe -> Stop - unit test case improvements - mock file regenerated

mqtt/desired_state_client.go

…ponents. Signed-off-by: Stoyan Zoubev <[email protected]>

Initial contribution of UpdateManager to Eclipse Kanto.

a884684

Signed-off-by: Stoyan Zoubev <[email protected]>

k-gostev requested review from hristobojilov, dimitar-dimitrow and k-gostev June 2, 2023 13:24

hristobojilov requested changes Jun 5, 2023

View reviewed changes

stoyan-zoubev added 3 commits June 5, 2023 15:46

Apply PR review comments:

604b3b0

- golang version bumped to 1.19.4 in validation.yaml - fixed broken links in README.md file - removed commented/unused code from source files

Apply PR review comments:

2d63b9e

- use strings.Builder for string concatenation in toActionsString function.

Fixed linter (golangci-lint) issues.

e3eb93b

Signed-off-by: Stoyan Zoubev <[email protected]>

stoyan-zoubev requested a review from hristobojilov June 5, 2023 13:59

hristobojilov requested changes Jun 5, 2023

View reviewed changes

mqtt/update_agent_client.go Show resolved Hide resolved

stoyan-zoubev added 2 commits June 6, 2023 09:36

Fixed wrong assertions after previous commit.

353f9d0

Signed-off-by: Stoyan Zoubev <[email protected]>

Make use of mqtt client username and password options (if provided).

7fda86a

Signed-off-by: Stoyan Zoubev <[email protected]>

stoyan-zoubev requested a review from hristobojilov June 6, 2023 07:10

k-gostev suggested changes Jun 6, 2023

View reviewed changes

NOTICE.md Outdated Show resolved Hide resolved

NOTICE.md Outdated Show resolved Hide resolved

k-gostev suggested changes Jun 6, 2023

View reviewed changes

stoyan-zoubev added 3 commits June 6, 2023 14:07

Align import sections with project conventions:

d420df0

the imports in three groups that is from top to bottom: standard libraries, internal libraries, external libraries, all separated by a new line. Signed-off-by: Stoyan Zoubev <[email protected]>

Applied PR review suggestions to api/agent package.

f7e53fc

Signed-off-by: Stoyan Zoubev <[email protected]>

Removed golang/mock and stretchr/testify entries from NOTICE file.

44b88aa

These are not needed, according to the Eclipse Kanto Project Lead. Signed-off-by: Stoyan Zoubev <[email protected]>

stoyan-zoubev requested a review from k-gostev June 6, 2023 11:40

k-gostev suggested changes Jun 6, 2023

View reviewed changes

Apply PR review comments, mainly typos, text issues.

14e5e16

Signed-off-by: Stoyan Zoubev <[email protected]>

stoyan-zoubev requested a review from k-gostev June 6, 2023 16:01

k-gostev suggested changes Jun 7, 2023

View reviewed changes

dimitar-dimitrow suggested changes Jun 8, 2023

View reviewed changes

hristobojilov requested changes Jun 8, 2023

View reviewed changes

updatem/orchestration/reboot.go Outdated Show resolved Hide resolved

k-gostev linked an issue Jun 8, 2023 that may be closed by this pull request

Initial Contribution of the Update Manager #2

Closed

stoyan-zoubev added 3 commits June 8, 2023 10:39

Enhanced implementation for reboot manager.

2968367

Signed-off-by: Stoyan Zoubev <[email protected]>

Added reboot implementation for windows (for completeness).

8e02ac2

Signed-off-by: Stoyan Zoubev <[email protected]>

hristobojilov requested changes Jun 8, 2023

View reviewed changes

updatem/domain/update_manager.go Outdated Show resolved Hide resolved

Fixed latest PR review comments.

b00b1e7

Signed-off-by: Stoyan Zoubev <[email protected]>

stoyan-zoubev requested review from hristobojilov, dimitar-dimitrow and k-gostev June 8, 2023 12:01

hristobojilov requested changes Jun 9, 2023

View reviewed changes

cmd/main.go Outdated Show resolved Hide resolved

k-gostev suggested changes Jun 9, 2023

View reviewed changes

k-gostev reviewed Jun 9, 2023

View reviewed changes

updatem/orchestration/reboot_windows.go Show resolved Hide resolved

dimitar-dimitrow reviewed Jun 9, 2023

View reviewed changes

k-gostev suggested changes Jun 9, 2023

View reviewed changes

Fixed PR review comments:

de86738

- moved main package into nested directory cmd/update-manager - only containers update agent remains as default updage agents config - mqtt topics pre-generated, no concatenations on every request - other minor source code improvements

stoyan-zoubev force-pushed the initial-contribution branch from 7c7716a to de86738 Compare June 12, 2023 12:19

dimitar-dimitrow reviewed Jun 12, 2023

View reviewed changes

Fixed PR review comments - removed unnecessary function parameters an…

ac78913

…d var declarations. Signed-off-by: Stoyan Zoubev <[email protected]>

stoyan-zoubev force-pushed the initial-contribution branch from d9019e9 to ac78913 Compare June 12, 2023 14:53

stoyan-zoubev requested review from k-gostev, hristobojilov and dimitar-dimitrow June 12, 2023 14:53

stoyan-zoubev changed the title ~~[#216] Initial contribution of UpdateManager to Eclipse Kanto.~~ Initial contribution of UpdateManager to Eclipse Kanto Jun 15, 2023

dimitar-dimitrow reviewed Jun 16, 2023

View reviewed changes

mqtt/desired_state_client.go Outdated Show resolved Hide resolved

mqtt/desired_state_client.go Outdated Show resolved Hide resolved

Minor doc fixes and updates.

5350290

stoyan-zoubev requested a review from dimitar-dimitrow June 19, 2023 06:49

Align connection config properties with the rest of Eclipse Kanto com…

d048831

…ponents. Signed-off-by: Stoyan Zoubev <[email protected]>

dimitar-dimitrow approved these changes Jun 28, 2023

View reviewed changes

hristobojilov approved these changes Jun 28, 2023

View reviewed changes

k-gostev approved these changes Jun 28, 2023

View reviewed changes

k-gostev merged commit b91f0c3 into eclipse-kanto:main Jun 28, 2023

Initial contribution of UpdateManager to Eclipse Kanto #1

Initial contribution of UpdateManager to Eclipse Kanto #1

Uh oh!

Conversation

stoyan-zoubev commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k-gostev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

k-gostev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k-gostev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k-gostev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k-gostev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k-gostev left a comment

Choose a reason for hiding this comment

stoyan-zoubev commented Jun 2, 2023 •

edited

Loading