Rewrite vs Refactor (AgileIndia 2021)
0 likes213 views
The document discusses the differences between rewriting and refactoring code, particularly in the context of test automation. It highlights the importance of understanding existing code, assessing challenges, and ensuring that automation adds value, while also addressing common anti-patterns in coding practices. Strategies for improving test automation practices and achieving objectives are outlined, emphasizing the need for clear objectives, increased awareness, and proper coding standards.
![package HelloWorld;
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
@BagmarAnand
Hello World](https://image.slidesharecdn.com/rewritevsrefactor-agileindia2021-211120063431/85/Rewrite-vs-Refactor-AgileIndia-2021-20-320.jpg)
![@BagmarAnand
Start afresh
package HelloWorld;
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
http://coastalbend.edu/uploadedImages/CBC/Content/Instructional_Services/Dual_Credit/hard_working_on_computer_anim_500_clr_7364.gif](https://image.slidesharecdn.com/rewritevsrefactor-agileindia2021-211120063431/85/Rewrite-vs-Refactor-AgileIndia-2021-24-320.jpg)
Rewrite vs Refactor (AgileIndia 2021)
- 1. Rewrite Vs Refactor @BagmarAnand Anand Bagmar Software Quality Evangelist, Essence Of Testing
- 4. We will focus on code for Test Automation @BagmarAnand
- 5. Applicable for any type of code you write @BagmarAnand
- 6. @BagmarAnand https://www.liberaldictionary.com/wp-content/uploads/2018/11/begin.jpg
- 8. • Revamp Testing Practices • Automate everything! @BagmarAnand Charter https://i.pinimg.com/474x/ec/8a/17/ec8a176036490a3338f806172a23e4b3.jpg
- 9. @BagmarAnand Assessment https://media.istockphoto.com/vectors/assessment-infographic-with-8-steps-parts-options-vector-id640310008 • Validate the charter! • Understand by investigation: • What is working well, • The challenges, and, • The (real & false) constraints
- 10. @BagmarAnand Assessment: Investigation https://media.istockphoto.com/vectors/assessment-infographic-with-8-steps-parts-options-vector-id640310008 • Speak with the team members • Code reviews • Run the tests yourself! • Validate / Challenge Assumptions • Challenges • Setup / Infra issues
- 11. @BagmarAnand Assessment: Finding https://media.istockphoto.com/vectors/assessment-infographic-with-8-steps-parts-options-vector-id640310008 • No CI • Automation working with lot of manual interventions • Setup / execution all over the place • Large & separate codebase
- 12. • Revamp Testing Quality Practices • Automate everything that makes sense to automate! @BagmarAnand Evolved Charter https://storage.needpix.com/rsynced_images/smile-2352472_1280.png
- 14. • Fast feedback (from 1000s of automated UI tests) • Clarity of intent – know what is being tested • Maintainable & Scalable Automation @BagmarAnand Charter https://i.pinimg.com/474x/ec/8a/17/ec8a176036490a3338f806172a23e4b3.jpg
- 15. @BagmarAnand Assessment: Investigation https://media.istockphoto.com/vectors/assessment-infographic-with-8-steps-parts-options-vector-id640310008 • Speak with the team members • Code reviews • Run the tests yourself! • Validate / Challenge Assumptions • Challenges • Setup / Infra issues
- 16. @BagmarAnand Assessment: Finding • Automation code quality is sub-par • Excessive duplication, massive files, no encapsulation • Excessive use of “sleep” • Extremely complex code • No test execution trend analysis • Too much focus on UI / end-2-end automation • No idea what is being tested (without reading a lot of code)
- 17. • Fast feedback (from 1000s of automated UI tests) • Clarity of intent – know what is being tested • Maintainable & Scalable Automation • Focus on automating tests at lower level • Unit Test Automation • API / Component Test Automation • API Workflow Automation @BagmarAnand Evolved Charter https://storage.needpix.com/rsynced_images/smile-2352472_1280.png
- 18. Details of the Analysis @BagmarAnand
- 19. Evolution of the code-base @BagmarAnand
- 20. package HelloWorld; public class HelloWorld { public static void main(String[] args) { System.out.println("Hello World"); } } @BagmarAnand Hello World
- 23. In few cases …. @BagmarAnand
- 24. @BagmarAnand Start afresh package HelloWorld; public class HelloWorld { public static void main(String[] args) { System.out.println("Hello World"); } } http://coastalbend.edu/uploadedImages/CBC/Content/Instructional_Services/Dual_Credit/hard_working_on_computer_anim_500_clr_7364.gif
- 25. In most cases …. @BagmarAnand
- 26. https://149351115.v2.pressablecdn.com/wp-content/uploads/2018/08/codebase_project_management-1200x675.png @BagmarAnand Work on existing code-base http://2.bp.blogspot.com/-ntk4QrnZT48/UoYoBG6XNlI/AAAAAAAANx0/Rtjng1VZFQY/s1600/LabVIEW_spaghetti_code.png
- 27. Where you will …. @BagmarAnand
- 28. https://149351115.v2.pressablecdn.com/wp-content/uploads/2018/08/codebase_project_management-1200x675.png @BagmarAnand Extend & evolve such code http://2.bp.blogspot.com/-ntk4QrnZT48/UoYoBG6XNlI/AAAAAAAANx0/Rtjng1VZFQY/s1600/LabVIEW_spaghetti_code.png
- 30. https://149351115.v2.pressablecdn.com/wp-content/uploads/2018/08/codebase_project_management-1200x675.png @BagmarAnand Multiple copies of such code http://2.bp.blogspot.com/-ntk4QrnZT48/UoYoBG6XNlI/AAAAAAAANx0/Rtjng1VZFQY/s1600/LabVIEW_spaghetti_code.png • Multiple repos • Multiple and long living branches
- 32. What is the typical reaction when you see existing code? @BagmarAnand
- 33. http://cdn.tinybuddha.com/wp-content/uploads/2015/11/Exploding-Head.jpg @BagmarAnand
- 36. https://lifeboat.com/blog.images/overlooked-brain-region-key-to-complex-thought2.jpg Complexity of thought process @BagmarAnand
- 39. https://40rik02ft2xye26xv2i0y0yc-wpengine.netdna-ssl.com/wp-content/uploads/2016/04/AdobeStock_99227409-1110x699.jpeg Documentation – sparse / outdated @BagmarAnand • It is important to have lean and meaningful documentation • Do not just add comments in code for the sake of “documenting the implementation logic” – your code should be readable and understandable
- 41. https://i.ytimg.com/vi/9n2tmNWn1ec/maxresdefault.jpg @BagmarAnand Perception – State of Mind
- 43. https://i.ytimg.com/vi/L6Edb1-l5x0/maxresdefault.jpg @BagmarAnand Perception – Point of view
- 45. https://webstockreview.net/images/diversity-clipart-business-group-10.png @BagmarAnand Perception – Experience from Diversity
- 47. What was good yesterday, may not necessarily be good today as well! @BagmarAnand http://www.hptx.org/images/InfoAdvanced/70/brain%20gears.png
- 49. https://orlandoespinosa.files.wordpress.com/2018/11/learn-from-mistakes-orlando-espinosa.png @BagmarAnand Learn from past experiences
- 50. https://empxtrack.com/wp-content/uploads/2016/05/come_join_the_team_500_wht_10876.gif @BagmarAnand @BagmarAnand Changes in Team Dynamics • People leave • New people join
- 52. http://2.bp.blogspot.com/-ntk4QrnZT48/UoYoBG6XNlI/AAAAAAAANx0/Rtjng1VZFQY/s1600/LabVIEW_spaghetti_code.png If you need to work on such code …. @BagmarAnand
- 54. When you find where change needs to happen, then… @BagmarAnand
- 55. @BagmarAnand What is the impact of change going to be? http://textbook.stpauls.br/Business_Organization/images/pic311.jpg
- 56. Pressure of getting it done on Time! https://newsatjama.files.wordpress.com/2018/07/hourglass-clock-on-light-blue-background-thinkstockphotos-479876312.jpg?w=1200 https://miro.medium.com/max/5600/1*frbsX4eY4Sj2mla2vszKPA.jpeg @BagmarAnand
- 58. @BagmarAnand Anti-pattern: Forget past lessons learnt https://storage.needpix.com/rsynced_images/reminder-23771_1280.png
- 60. @BagmarAnand Anti-pattern: Reinvent the wheel https://external-preview.redd.it/ZVPjiFo_Ubl4JeiU63SaTjdIoq5zveSnNZimKpgn2I8.png?auto=webp&s=bf32c94b630befa121075c1ae99b2599af6dedc5 • Don’t want to modify existing code
- 61. @BagmarAnand Anti-pattern: Reinvent the wheel https://storage.needpix.com/rsynced_images/traveller-3213992_1280.jpg • Unable to find what you were looking for
- 63. @BagmarAnand Anti-pattern: Sleep to reduce flakiness https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Zzz_sleep.svg/1024px-Zzz_sleep.svg.png https://upload.wikimedia.org/wikipedia/commons/thumb/7/76/Evil_red.svg/1200px-Evil_red.svg.png https://storage.needpix.com/rsynced_images/snail-2383080_1280.jpg
- 64. Why do we end up using these anti-patters? @BagmarAnand
- 65. Because …. It (still) works! https://www.linkedin.com/posts/bhagyaitrecruiteratgmail_activity-6642620864221274112-NnWI @BagmarAnand
- 66. @BagmarAnand Let someone else figure out a better way… later https://lh3.googleusercontent.com/proxy/MuzrRuna5ts_O-FX_KPUcsC-2SA_blkGTlwPUBfLS9uWo11NN5RLhI8dUBucVrGUtTvQs5FP-AGlBrLTXI0VnZzBT0C30E7HvWtOHyqd8TP3QIeJCg
- 69. Refactoring is an essential practice when evolving existing code @BagmarAnand
- 70. But … we may end up creating another mess IF @BagmarAnand
- 71. @BagmarAnand Refactoring without clear objective https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcRPV-74mTtTdR8VcenNpVhYM5AQq7PWuEkr2hW5jTlrqnaFfBrQ
- 74. @BagmarAnand Automation does not provide enough value! https://4.bp.blogspot.com/-dgoCWivfsb8/XDcqaFvQC2I/AAAAAAAAF2o/qz5zcKCf9lcD6ExCo3p16YsFCwkQsCxjgCLcBGAs/s1600/DRC-falling-robot.png • Difficult to add new features / tests • Difficult to scale • Supposedly simple changes take long time, and have unexpected behavior
- 75. @BagmarAnand Manual, repeated effort keeps increasing http://logico4576.blogspot.com/2012/03/bertrand-russell-para-que-repetir-los.html
- 77. @BagmarAnand Assessment – The Summary! • Testing was QA team responsibility • Automation not adding any value
- 78. @BagmarAnand Assessment – The Report!
- 79. @BagmarAnand Assessment – The Report!
- 80. @BagmarAnand Overall challenges from Testing perspective • Process / Way of Working & Ownership of Testing • Understanding of Automation • Experience & Skillset • Coding skills • Time pressure • CI
- 81. • Device & Driver management • Run on demand, on QA machine • Slow (100s of sleeps) • Static methods, no-OOPS • Sequential • Branching nightmare! @BagmarAnand Reality of existing Automated Tests https://i.stack.imgur.com/SDmtn.png
- 82. Code Analysis & Execution @BagmarAnand
- 83. @BagmarAnand Test Code Snippets • Methods returning default value • Extremely complex method (deep nesting of loops) • Lack of naming conventions • Swallowing of exceptions, returning Null • Sleeps, static members / methods
- 85. @BagmarAnand Excessive cyclomatic complexity in method: 46 warnings Java analysis: 10 errors, 6212 warnings Test Code Analysis
- 86. @BagmarAnand Excessive cyclomatic complexity in method: 126 warnings Java analysis: 20 errors, 10355 warnings Test Code Analysis
- 88. How to turn the ship around in such cases? @BagmarAnand https://upload.wikimedia.org/wikipedia/commons/7/72/Container_ship_Reecon_Whale_on_Black_Sea_near_Constan%C8%9Ba_Romania.jpg
- 90. @BagmarAnand How do we achieve our objectives? https://www.expandgh.com/wp-content/uploads/2018/04/Set-Objectives-for-Each-Person.jpg
- 91. @BagmarAnand How do we achieve our objectives? https://www.expandgh.com/wp-content/uploads/2018/04/Set-Objectives-for-Each-Person.jpg Know your objectives first!
- 92. • Fast in execution and feedback • Independent tests • Executed on every change • Know what is being tested, as the customer / consumer • Able to release with confidence! @BagmarAnand Expectations from Automated Tests
- 93. @BagmarAnand Approach • Increase awareness • Upskill (pairing, training) • Evolved way-of-working • In initial stages, you may want to consider Automation rewrite as a separate, independent project
- 94. @BagmarAnand Approach - Automation • Identify Design Patterns that will help • Setup Coding guidelines and coding styles • Use powerful IDEs • Automate Infrastructure setup for test execution • Keep Tests Independent
- 95. 95
- 96. Criteria for automating tests scenarios @BagmarAnand https://chiefexecutive.net/wp-content/uploads/2019/02/AdobeStock_82846171.jpeg
- 97. @BagmarAnand What are you automating? • Know your users • Simulate user behavior
- 98. @BagmarAnand Criteria for Implementing Automation • Clear & visible intent of the automated test • Multi-browser & multi-device support • Run on every (local & deployed) change (local, CI & cloud) • Fast feedback (parallel execution) • Rich execution reports & Trend Analysis • https://www.infoq.com/articles/test-automation-ai-ml/
- 100. Will team be able to refactor, while other projects are going on, and get value from automation, the way it is supposed to be? @BagmarAnand https://lh3.googleusercontent.com/proxy/3JFWJGTlmTym_g9xCZpHIFNLN3rQZu3js8f7iJDHFc6CCeTDb4hpLJaaQm1YCe2BfxyuA_7Lv3B4Clt7MpICbe_Ay09TY8k
- 102. https://empresas.blogthinkbig.com/wp-content/uploads/2019/11/Tecnicas-negociaci%C3%B3n.jpg @BagmarAnand My approach “Rewrite with Selective Reuse”
- 104. @BagmarAnand Approach for Rewrite with Reuse … • Formed team of 2 people initially • Automated test execution environment setup script • Created new repository • Implemented 2 tests • Parallel execution • Triggered automatically via CI • No manual setup / intervention
- 105. @BagmarAnand Approach for Rewrite with Reuse • Used tools / frameworks / libraries that can achieve the objectives of the test • Build Vs Buy / Reuse • Hard discussions around duplication Vs complexity of specific modules – ex: test data setup for product • Rewrite everything, or reuse some existing implementation?
- 107. • IDEs provide you lot of information about the code automatically • Additional plugins can be installed / used • Free / Open-Source plugins may also be available • Static Code Analysis can be setup in VCS / CI pipelines @BagmarAnand Maintain Code Quality
- 108. @BagmarAnand Remember, and watch out for … https://i.pinimg.com/originals/0e/0b/1f/0e0b1f8c2b36404e4740b6f733097f19.jpg