Proposal for "Refactoring of Common Modules" #1

dboltovskyi · 2017-11-07T10:57:22Z

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

dev-gh · 2017-11-07T12:26:58Z

@dboltovskyi
What is "Common modules" ? Add some meaningful description to PR

dev-gh · 2017-11-07T12:30:46Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+## Introduction
+
+ATF Test Scripts use a lot of commonly used functions. Such as:


@dboltovskyi
Would be good to put link here to repository

dev-gh · 2017-11-07T12:36:23Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+## Proposed solution
+
+### Leave existing modules as is


@dboltovskyi
Why to mention that if proposal is about what to change basically?

dev-gh · 2017-11-07T12:40:15Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+## Potential downsides
+
+Existing ATF test scripts may need to be updated if some function from new common modules is required.


@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"

Itileda · 2017-11-07T12:38:41Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+## Introduction
+
+ATF Test Scripts use a lot of commonly used functions. Such as:


@dboltovskyi ,

suggest to rewrite Test Scripts to test scripts
also, it would be better like
ATF test scripts use a lot of functions like:

Itileda · 2017-11-07T12:40:07Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+    - perform policy table update
+  - etc.
+
+The purpose of this proposal is to clean up these common modules.


@dboltovskyi ,

suggest to add sentence before
All these functionality are not tests artifacts but tools that tests use.

Itileda · 2017-11-07T12:42:41Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+    - perform policy table update
+  - etc.
+
+The purpose of this proposal is to clean up these common modules.


@dboltovskyi ,
and "The purpose of this proposal is to clean up these common modules." better to move to solution

Itileda · 2017-11-07T12:48:21Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+## Motivation
+
+Current downsides of common modules are:


@dboltovskyi ,

Please, move this to downside section of template

@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

Itileda · 2017-11-07T12:56:13Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+## Proposed solution
+
+### Leave existing modules as is


@dboltovskyi
please add (backward compatibility)

Itileda · 2017-11-07T12:59:11Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+  - utils - folder for modules with utility functions (e.g.: data accessors, table functions, data converters, etc.)
+  - sequences - folder for modules with common sequences (e.g.: register/activate mobile application, policy update, put file, etc.)
+
+TBD: Names of the module files.


@dboltovskyi ,
please remove TBD.

AKalinich-Luxoft · 2017-11-07T13:35:44Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+## Introduction
+
+ATF Test Scripts use a lot of commonly used functions. Such as:


@dboltovskyi better to say "a lot of functions in commonly used modules"

AKalinich-Luxoft · 2017-11-07T13:46:14Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+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


@dboltovskyi standart

@dboltovskyi You are right. Correct word is STANDARD

AKalinich-Luxoft · 2017-11-07T13:48:18Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+  - utils - folder for modules with utility functions (e.g.: data accessors, table functions, data converters, etc.)
+  - sequences - folder for modules with common sequences (e.g.: register/activate mobile application, policy update, put file, etc.)
+
+TBD: Names of the module files.


@dboltovskyi what is TBD?

AKalinich-Luxoft · 2017-11-07T13:50:36Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+### Follow new approach when developing new ATF test scripts
+
+  - In newly created ATF scripts use only functions from new "common_modules" folder and not from an old "user_modules" one
+  - If some utility or common sequence function doesn't exist create it in a new "common_modules" in appropriate module file using standard template


@dboltovskyi standart

AByzhynar · 2017-11-07T15:25:40Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+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


@dboltovskyi You are right. Correct word is STANDARD

AByzhynar · 2017-11-07T15:27:03Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+### Transfer most used common functions into a new folder
+
+Most used functions needs to be transferred from existing "user_modules" to a new "common_modules" folder in appropriate module file.


@dboltovskyi needs-> need as functions are plural

AByzhynar · 2017-11-07T15:29:19Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+### Follow new approach when developing new ATF test scripts
+
+  - In newly created ATF scripts use only functions from new "common_modules" folder and not from an old "user_modules" one
+  - If some utility or common sequence function doesn't exist create it in a new "common_modules" in appropriate module file using standard template


@dboltovskyi Use at least - between exist and create

aderiabin · 2017-11-07T15:41:52Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+### Transfer most used common functions into a new folder
+
+Most used functions needs to be transferred from existing "user_modules" to a new "common_modules" folder in appropriate module file.
+And they also need to be updated according to a new template.


@dboltovskyi I propose to avoid to start sentence from And.
I think Aslo they need to be updated... sounds better.

dboltovskyi · 2017-11-07T16:45:52Z

@Itileda , @dev-gh , @AByzhynar , @AKalinich-Luxoft please check new commit e932de8

dev-gh · 2017-11-08T08:13:44Z

@dboltovskyi
By asking "What is "Common modules" ?" I basically wanted you to mention ATF. Otherwise it sounds like "common modules of SomeFamousApplicationEverybodyShouldBeAwareOf"

dev-gh · 2017-11-08T08:19:41Z

proposals/NNNN-test-scripts-common-modules-refactoring.md

+
+The purpose of this proposal is to clean up these common modules.
+
+### Leave existing modules as is for backward compatibility


@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.

@dev-gh I would like to keep this point

@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

* Revision fixes fixing typos Updates after review #1 Update 0206-remote_atf_testing.md Minor updates Minor updates #2 minor text formatting * Fixes after Laura review * Update 0206-remote_atf_testing.md * Update 0206-remote_atf_testing.md * Update 0206-remote_atf_testing.md

dboltovskyi added 2 commits November 6, 2017 17:24

Initial version

a6f3f5b

Update

7fb7bc7

dboltovskyi changed the title ~~Test scripts common modules refactoring~~ Proposal for "Refactoring of Common Modules" Nov 7, 2017

dev-gh reviewed Nov 7, 2017

View reviewed changes

dboltovskyi requested review from AByzhynar, aderiabin, AKalinich-Luxoft, AStasiuk, vkushnirenko-luxoft and Itileda November 7, 2017 12:54

Itileda requested changes Nov 7, 2017

View reviewed changes

AKalinich-Luxoft requested changes Nov 7, 2017

View reviewed changes

AByzhynar requested changes Nov 7, 2017

View reviewed changes

aderiabin approved these changes Nov 7, 2017

View reviewed changes

Update according to comments in review

e932de8

GetmanetsIrina approved these changes Nov 8, 2017

View reviewed changes

AKalinich-Luxoft approved these changes Nov 8, 2017

View reviewed changes

dev-gh reviewed Nov 8, 2017

View reviewed changes

AByzhynar approved these changes Nov 30, 2017

View reviewed changes

dboltovskyi added 3 commits December 12, 2017 09:37

Update NNNN-test-scripts-common-modules-refactoring.md

2e83ef6

Update NNNN-test-scripts-common-modules-refactoring.md

6d721f6

Update NNNN-test-scripts-common-modules-refactoring.md

d024b86


		## Introduction

		ATF Test Scripts use a lot of commonly used functions. Such as:


		## Potential downsides

		Existing ATF test scripts may need to be updated if some function from new common modules is required.


		### Transfer most used common functions into a new folder

		Most used functions needs to be transferred from existing "user_modules" to a new "common_modules" folder in appropriate module file.


		The purpose of this proposal is to clean up these common modules.

		### Leave existing modules as is for backward compatibility

Proposal for "Refactoring of Common Modules" #1

Are you sure you want to change the base?

Proposal for "Refactoring of Common Modules" #1

Uh oh!

Conversation

dboltovskyi commented Nov 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dev-gh commented Nov 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dboltovskyi commented Nov 7, 2017

Uh oh!

dev-gh commented Nov 8, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dboltovskyi commented Nov 7, 2017 •

edited

Loading