Proposal for "Refactoring of Common Modules"#1
Conversation
dboltovskyi
changed the title
|
@dboltovskyi |
There was a problem hiding this comment.
@dboltovskyi
Would be good to put link here to repository
There was a problem hiding this comment.
@dboltovskyi
Why to mention that if proposal is about what to change basically?
There was a problem hiding this comment.
@dboltovskyi
I think its better to say "must be updated when new common modules will be used in the test script". Otherwise to me it sounds like "well, you may still continue to use old code as long as you want, don't bother to update anything"
dboltovskyi
requested review from
AByzhynar,
AKalinich-Luxoft,
AStasiuk,
Itileda,
aderiabin and
vkushnirenko-luxoft
There was a problem hiding this comment.
suggest to rewrite Test Scripts to test scripts
also, it would be better like
ATF test scripts use a lot of functions like:
There was a problem hiding this comment.
suggest to add sentence before
All these functionality are not tests artifacts but tools that tests use.
There was a problem hiding this comment.
@dboltovskyi ,
and "The purpose of this proposal is to clean up these common modules." better to move to solution
|
|
||
| ## Motivation | ||
|
|
||
| Current downsides of common modules are: |
There was a problem hiding this comment.
Please, move this to downside section of template
There was a problem hiding this comment.
@Itileda Does 'Potential downsides' section mean? If so, 'Potential downsides' section is about downsides of new implementation.
But current comment is related to downsides of existing implementation
There was a problem hiding this comment.
@dboltovskyi
please add (backward compatibility)
There was a problem hiding this comment.
@dboltovskyi better to say "a lot of functions in commonly used modules"
| By leaving all existing modules currently located in ./user_modules folder as is | ||
| it will be possible to use all existing ATF test scripts without changes. | ||
|
|
||
| ### Design a standard template for functions |
There was a problem hiding this comment.
@dboltovskyi You are right. Correct word is STANDARD
| By leaving all existing modules currently located in ./user_modules folder as is | ||
| it will be possible to use all existing ATF test scripts without changes. | ||
|
|
||
| ### Design a standard template for functions |
There was a problem hiding this comment.
@dboltovskyi You are right. Correct word is STANDARD
There was a problem hiding this comment.
@dboltovskyi needs-> need as functions are plural
There was a problem hiding this comment.
@dboltovskyi Use at least - between exist and create
There was a problem hiding this comment.
@dboltovskyi I propose to avoid to start sentence from And.
I think Aslo they need to be updated... sounds better.
|
@Itileda , @dev-gh , @AByzhynar , @AKalinich-Luxoft please check new commit e932de8 |
|
@dboltovskyi |
|
|
||
| The purpose of this proposal is to clean up these common modules. | ||
|
|
||
| ### Leave existing modules as is for backward compatibility |
There was a problem hiding this comment.
@dboltovskyi
If you insist on keeping this point in the list (however I don't see why it is mentioned as proposal is about something to change) I recommend to put it at the end and don't mark it as point for changes.
There was a problem hiding this comment.
@dev-gh Regarding the comment "What is "Common modules"
Common modules is not part of ATF - it's part of test scripts
* SendLocation for Mobile Nav This proposal is about extending the capability for apps to receive and service SendLocation requests from other apps which is currently limited to the Head Unit's embedded navigation system. * Updating links to assets * Updated links to assets * Create a * Asset #1 * asset #2 * Delete a * Delete SendLocationForMobileNav_RAI.jpg * Add files via upload * Delete SendLocationForMobileNav_RequestResponse.jpg * Add files via upload * Addressed comments
…on) (smartdevicelink#644) * Add revision fixes Minor changes #1 Update 0205-Avoid_custom_button_subscription_when_HMI_does_not_support.md Updates after review#2 * Update 0205-Avoid_custom_button_subscription_when_HMI_does_not_support.md
7 participants
Proposal for Refactoring of Common Modules
Common modules consist of commonly used functions
Current downsides:
● No single standard
● Duplicates
● Lack of description
● A lot of outdated or unused code
To Do:
● Design a standard template for common functions
● Split all functions into two groups: Utils and Common sequences
● Split these two huge groups between a few modules (based on functionality)
● Update all existing test scripts