Skip to content

Update mbed-client-cli from v0.5.0 #13443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Aug 21, 2020
Merged

Update mbed-client-cli from v0.5.0 #13443

merged 3 commits into from
Aug 21, 2020

Conversation

artokin
Copy link
Contributor

@artokin artokin commented Aug 17, 2020 •
edited
Loading

Summary of changes

Update mbed-client-cli from v0.5.0 of master repository https://github.com/ARMmbed/mbed-client-cli

This PR improves module configuration and may fix issue: #13438

Impact of changes

Migration actions required

Documentation

Pull request type 

[x] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results 

[] No Tests required for this change (E.g docs only update)
[x] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers

@artokin artokin mentioned this pull request Aug 17, 2020
Closed
@ciarmcom ciarmcom added the release-type: patch Indentifies a PR as containing just a patch label Aug 17, 2020
@ciarmcom ciarmcom requested a review from a team August 17, 2020 13:00
@ciarmcom
Copy link
Member

@artokin, thank you for your changes.
@ARMmbed/mbed-os-maintainers please review.

@AGlass0fMilk AGlass0fMilk mentioned this pull request Aug 17, 2020
Closed
AGlass0fMilk
AGlass0fMilk reviewed Aug 17, 2020
View reviewed changes
Copy link
Member

@AGlass0fMilk AGlass0fMilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the default buffer size, LGTM.

Glad to see there are some new features for this super useful framework 👍

features/frameworks/mbed-client-cli/source/ns_cmdline.c
#else
#define MAX_LINE 2000
#ifndef MBED_CONF_CMDLINE_MAX_LINE_LENGTH
#define MBED_CONF_CMDLINE_MAX_LINE_LENGTH 2000
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo? This is a ridiculously large default buffer size and the mbed_lib.json states this:

https://github.com/artokin/mbed-os/blob/9325f17d7066856b6504fd0d27e21d85de307f0e/features/frameworks/mbed-client-cli/mbed_lib.json#L44-L47

"defaults to 200 when not set"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lib-file is actually incorrect in this case. That is valid value for complex automation tests.

@AGlass0fMilk
Copy link
Member

Resolves #13438

@artokin artokin requested a review from mikter August 17, 2020 13:23
mikter
mikter previously approved these changes Aug 17, 2020
View reviewed changes
@mergify mergify bot added needs: CI and removed needs: review labels Aug 17, 2020
Decrease max line length from 2000 to 200
3ce9f34 
Decrease maximun line length from 2000 to 200 to reduce heap usage.
@mergify mergify bot dismissed mikter’s stale review August 17, 2020 13:45

Pull request has been modified.

@artokin artokin requested review from AGlass0fMilk and mikter August 17, 2020 13:45
AGlass0fMilk
AGlass0fMilk approved these changes Aug 17, 2020
View reviewed changes
Copy link
Member

@AGlass0fMilk AGlass0fMilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

OPpuolitaival
OPpuolitaival previously approved these changes Aug 17, 2020
View reviewed changes
@teetak01
Copy link
Contributor

I would claim that changing the default from 2000 to 200 is a breaking change and not appropriate for patch-release. It is easy to configure it to smaller values for specific use-cases, or just enable the use_minimum_set to optimize all parameters.

teetak01
teetak01 previously requested changes Aug 18, 2020
View reviewed changes
Copy link
Contributor

@teetak01 teetak01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert the buffer-change as that can be unexpected breaking change for some of the users of this library.

For bigger Mbed OS release it might be appropriate to enable for. ex. the use_minimum_set by default which does bring significant RAM/ROM savings, as this was optimised specifically for Mbed OS Ice-tea tests.

@mergify mergify bot added needs: work and removed needs: CI labels Aug 18, 2020
Revert max line length change
d3fc6c4 
Do not chnage default line length as it is a breaking chnage.
Library configuration can be used to adjust max lien length.
@mergify mergify bot dismissed stale reviews from OPpuolitaival and teetak01 August 18, 2020 07:17

Pull request has been modified.

@artokin
Copy link
Contributor Author

artokin commented Aug 18, 2020

Thanks @teetak01 for detecting this. The MAX_LINE_LENGTH change is now reverted.

@mergify mergify bot added needs: CI and removed needs: work labels Aug 18, 2020
@AGlass0fMilk
Copy link
Member

The default buffer size should be highlighted in the documentation to prevent other developers from spending hours debugging the silent failures it can produce on more constrained targets.

I also think if we plan on changing the default setting in the future we should put some sort of build warning (like for deprecated APIs) so the change is anticipated.

@0xc0170
Copy link
Contributor

0xc0170 commented Aug 19, 2020

CI started

@mbed-ci
Copy link

mbed-ci commented Aug 19, 2020

Jenkins CI Test : ✔️ SUCCESS

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs Status
jenkins-ci/mbed-os-ci_unittests ✔️
jenkins-ci/mbed-os-ci_build-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-ARM ✔️
jenkins-ci/mbed-os-ci_dynamic-memory-usage ✔️
jenkins-ci/mbed-os-ci_greentea-test ✔️
jenkins-ci/mbed-os-ci_cloud-client-pytest ✔️

@0xc0170 0xc0170 merged commit c355d8d into ARMmbed:master Aug 21, 2020
@mergify mergify bot removed the ready for merge label Aug 21, 2020
@artokin artokin deleted the update_mbed_client_cli_v050 branch August 21, 2020 13:38
@mbedmain mbedmain added release-version: 6.3.0 Release-pending and removed release-type: patch Indentifies a PR as containing just a patch Release-pending labels Sep 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0xc0170 0xc0170 0xc0170 approved these changes

@teetak01 teetak01 teetak01 approved these changes

@jonikula jonikula Awaiting requested review from jonikula

@mikter mikter Awaiting requested review from mikter

@AGlass0fMilk AGlass0fMilk Awaiting requested review from AGlass0fMilk

@OPpuolitaival OPpuolitaival Awaiting requested review from OPpuolitaival

Assignees
No one assigned
Labels
release-version: 6.3.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@artokin @ciarmcom @AGlass0fMilk @teetak01 @0xc0170 @mbed-ci @OPpuolitaival @mikter @mbedmain