├── LICENSE ├── README.md └── src └── main └── java └── com └── arolla └── legacy └── testing ├── quotebot ├── AdSpace.java ├── Application.java ├── AutomaticQuoteBot.java ├── BlogAuctionTask.java └── TechBlogs.java └── thirdparty └── quotebot ├── MarketStudyVendor.java └── QuotePublisher.java /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, and 10 | distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by the copyright 13 | owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all other entities 16 | that control, are controlled by, or are under common control with that entity. 17 | For the purposes of this definition, "control" means (i) the power, direct or 18 | indirect, to cause the direction or management of such entity, whether by 19 | contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the 20 | outstanding shares, or (iii) beneficial ownership of such entity. 21 | 22 | "You" (or "Your") shall mean an individual or Legal Entity exercising 23 | permissions granted by this License. 24 | 25 | "Source" form shall mean the preferred form for making modifications, including 26 | but not limited to software source code, documentation source, and configuration 27 | files. 28 | 29 | "Object" form shall mean any form resulting from mechanical transformation or 30 | translation of a Source form, including but not limited to compiled object code, 31 | generated documentation, and conversions to other media types. 32 | 33 | "Work" shall mean the work of authorship, whether in Source or Object form, made 34 | available under the License, as indicated by a copyright notice that is included 35 | in or attached to the work (an example is provided in the Appendix below). 36 | 37 | "Derivative Works" shall mean any work, whether in Source or Object form, that 38 | is based on (or derived from) the Work and for which the editorial revisions, 39 | annotations, elaborations, or other modifications represent, as a whole, an 40 | original work of authorship. For the purposes of this License, Derivative Works 41 | shall not include works that remain separable from, or merely link (or bind by 42 | name) to the interfaces of, the Work and Derivative Works thereof. 43 | 44 | "Contribution" shall mean any work of authorship, including the original version 45 | of the Work and any modifications or additions to that Work or Derivative Works 46 | thereof, that is intentionally submitted to Licensor for inclusion in the Work 47 | by the copyright owner or by an individual or Legal Entity authorized to submit 48 | on behalf of the copyright owner. For the purposes of this definition, 49 | "submitted" means any form of electronic, verbal, or written communication sent 50 | to the Licensor or its representatives, including but not limited to 51 | communication on electronic mailing lists, source code control systems, and 52 | issue tracking systems that are managed by, or on behalf of, the Licensor for 53 | the purpose of discussing and improving the Work, but excluding communication 54 | that is conspicuously marked or otherwise designated in writing by the copyright 55 | owner as "Not a Contribution." 56 | 57 | "Contributor" shall mean Licensor and any individual or Legal Entity on behalf 58 | of whom a Contribution has been received by Licensor and subsequently 59 | incorporated within the Work. 60 | 61 | 2. Grant of Copyright License. 62 | 63 | Subject to the terms and conditions of this License, each Contributor hereby 64 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 65 | irrevocable copyright license to reproduce, prepare Derivative Works of, 66 | publicly display, publicly perform, sublicense, and distribute the Work and such 67 | Derivative Works in Source or Object form. 68 | 69 | 3. Grant of Patent License. 70 | 71 | Subject to the terms and conditions of this License, each Contributor hereby 72 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 73 | irrevocable (except as stated in this section) patent license to make, have 74 | made, use, offer to sell, sell, import, and otherwise transfer the Work, where 75 | such license applies only to those patent claims licensable by such Contributor 76 | that are necessarily infringed by their Contribution(s) alone or by combination 77 | of their Contribution(s) with the Work to which such Contribution(s) was 78 | submitted. If You institute patent litigation against any entity (including a 79 | cross-claim or counterclaim in a lawsuit) alleging that the Work or a 80 | Contribution incorporated within the Work constitutes direct or contributory 81 | patent infringement, then any patent licenses granted to You under this License 82 | for that Work shall terminate as of the date such litigation is filed. 83 | 84 | 4. Redistribution. 85 | 86 | You may reproduce and distribute copies of the Work or Derivative Works thereof 87 | in any medium, with or without modifications, and in Source or Object form, 88 | provided that You meet the following conditions: 89 | 90 | You must give any other recipients of the Work or Derivative Works a copy of 91 | this License; and 92 | You must cause any modified files to carry prominent notices stating that You 93 | changed the files; and 94 | You must retain, in the Source form of any Derivative Works that You distribute, 95 | all copyright, patent, trademark, and attribution notices from the Source form 96 | of the Work, excluding those notices that do not pertain to any part of the 97 | Derivative Works; and 98 | If the Work includes a "NOTICE" text file as part of its distribution, then any 99 | Derivative Works that You distribute must include a readable copy of the 100 | attribution notices contained within such NOTICE file, excluding those notices 101 | that do not pertain to any part of the Derivative Works, in at least one of the 102 | following places: within a NOTICE text file distributed as part of the 103 | Derivative Works; within the Source form or documentation, if provided along 104 | with the Derivative Works; or, within a display generated by the Derivative 105 | Works, if and wherever such third-party notices normally appear. The contents of 106 | the NOTICE file are for informational purposes only and do not modify the 107 | License. You may add Your own attribution notices within Derivative Works that 108 | You distribute, alongside or as an addendum to the NOTICE text from the Work, 109 | provided that such additional attribution notices cannot be construed as 110 | modifying the License. 111 | You may add Your own copyright statement to Your modifications and may provide 112 | additional or different license terms and conditions for use, reproduction, or 113 | distribution of Your modifications, or for any such Derivative Works as a whole, 114 | provided Your use, reproduction, and distribution of the Work otherwise complies 115 | with the conditions stated in this License. 116 | 117 | 5. Submission of Contributions. 118 | 119 | Unless You explicitly state otherwise, any Contribution intentionally submitted 120 | for inclusion in the Work by You to the Licensor shall be under the terms and 121 | conditions of this License, without any additional terms or conditions. 122 | Notwithstanding the above, nothing herein shall supersede or modify the terms of 123 | any separate license agreement you may have executed with Licensor regarding 124 | such Contributions. 125 | 126 | 6. Trademarks. 127 | 128 | This License does not grant permission to use the trade names, trademarks, 129 | service marks, or product names of the Licensor, except as required for 130 | reasonable and customary use in describing the origin of the Work and 131 | reproducing the content of the NOTICE file. 132 | 133 | 7. Disclaimer of Warranty. 134 | 135 | Unless required by applicable law or agreed to in writing, Licensor provides the 136 | Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, 137 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, 138 | including, without limitation, any warranties or conditions of TITLE, 139 | NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are 140 | solely responsible for determining the appropriateness of using or 141 | redistributing the Work and assume any risks associated with Your exercise of 142 | permissions under this License. 143 | 144 | 8. Limitation of Liability. 145 | 146 | In no event and under no legal theory, whether in tort (including negligence), 147 | contract, or otherwise, unless required by applicable law (such as deliberate 148 | and grossly negligent acts) or agreed to in writing, shall any Contributor be 149 | liable to You for damages, including any direct, indirect, special, incidental, 150 | or consequential damages of any character arising as a result of this License or 151 | out of the use or inability to use the Work (including but not limited to 152 | damages for loss of goodwill, work stoppage, computer failure or malfunction, or 153 | any and all other commercial damages or losses), even if such Contributor has 154 | been advised of the possibility of such damages. 155 | 156 | 9. Accepting Warranty or Additional Liability. 157 | 158 | While redistributing the Work or Derivative Works thereof, You may choose to 159 | offer, and charge a fee for, acceptance of support, warranty, indemnity, or 160 | other liability obligations and/or rights consistent with this License. However, 161 | in accepting such obligations, You may act only on Your own behalf and on Your 162 | sole responsibility, not on behalf of any other Contributor, and only if You 163 | agree to indemnify, defend, and hold each Contributor harmless for any liability 164 | incurred by, or claims asserted against, such Contributor by reason of your 165 | accepting any such warranty or additional liability. 166 | 167 | END OF TERMS AND CONDITIONS 168 | 169 | APPENDIX: How to apply the Apache License to your work 170 | 171 | To apply the Apache License to your work, attach the following boilerplate 172 | notice, with the fields enclosed by brackets "[]" replaced with your own 173 | identifying information. (Don't include the brackets!) The text should be 174 | enclosed in the appropriate comment syntax for the file format. We also 175 | recommend that a file or class name and description of purpose be included on 176 | the same "printed page" as the copyright notice for easier identification within 177 | third-party archives. 178 | 179 | Copyright [yyyy] [name of copyright owner] 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | http://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. 192 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | legacy-testing-kata-java 2 | ======================== 3 | 4 | A legacy codebase that resist a bit testing. 5 | 6 | First try to run it. 7 | 8 | Then your goal is to make it testable so that you can make changes (FIXME inside) and perhaps refactor it a bit. 9 | 10 | This code draws on a C# code kata authored by my distinguished colleague Nicolas Morbieu ; Thanks Nicolas for this ultra realistic kata! 11 | 12 | *Don't read further if you don't want to be spoiled.* 13 | 14 | -- 15 | If you hesitate where to start, here are some of the tricky bits that make it hard to test: 16 | 17 | Lack of dependency injection: 18 | - A static main with no args 19 | - Static service 20 | - Hard-coded instantiation of a service that itself instantiates its dependencies, and again 21 | 22 | Implementation issues: 23 | - Very slow service 24 | - Hidden dependency to a license key in env variable 25 | - Random return value -> non-deterministic test 26 | - Dialog poping up prompting for user input 27 | 28 | Other tricks: 29 | - New Date() in the middle of calculations -> non-deterministic test 30 | - High combinatorial of calculations lead to too many required test cases 31 | - Stateful behavior from internal cache: first call different from next calls 32 | - Heavy dependency called within a large loop with different values 33 | - Use a dependency or another depending on the passed parameter 34 | -------------------------------------------------------------------------------- /src/main/java/com/arolla/legacy/testing/quotebot/AdSpace.java: -------------------------------------------------------------------------------- 1 | package com.arolla.legacy.testing.quotebot; 2 | 3 | import java.util.Collection; 4 | import java.util.HashMap; 5 | import java.util.Map; 6 | 7 | public class AdSpace { 8 | 9 | private static Map> cache = new HashMap>(); 10 | 11 | public static Collection getAdSpaces() { 12 | if (cache.containsKey("blogs list")) { 13 | return cache.get("blogs list"); 14 | } 15 | // FIXME : only return blogs that start with a 'T' 16 | Collection listAllBlogs = TechBlogs.listAllBlogs(); 17 | cache.put("blogs list", listAllBlogs); 18 | return listAllBlogs; 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/com/arolla/legacy/testing/quotebot/Application.java: -------------------------------------------------------------------------------- 1 | package com.arolla.legacy.testing.quotebot; 2 | 3 | public class Application { 4 | public static void main(String[] args) { 5 | AutomaticQuoteBot bot = new AutomaticQuoteBot(); 6 | bot.sendAllQuotes("FAST"); 7 | } 8 | 9 | } 10 | -------------------------------------------------------------------------------- /src/main/java/com/arolla/legacy/testing/quotebot/AutomaticQuoteBot.java: -------------------------------------------------------------------------------- 1 | package com.arolla.legacy.testing.quotebot; 2 | 3 | import java.util.Collection; 4 | 5 | public class AutomaticQuoteBot { 6 | 7 | public void sendAllQuotes(String mode) { 8 | Collection blogs = AdSpace.getAdSpaces(); 9 | for (String blog : blogs) { 10 | BlogAuctionTask auctionTask = new BlogAuctionTask(); 11 | auctionTask.PriceAndPublish(blog, mode); 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/com/arolla/legacy/testing/quotebot/BlogAuctionTask.java: -------------------------------------------------------------------------------- 1 | package com.arolla.legacy.testing.quotebot; 2 | 3 | import java.util.Calendar; 4 | import java.util.Date; 5 | 6 | import com.arolla.legacy.testing.thirdparty.quotebot.MarketStudyVendor; 7 | import com.arolla.legacy.testing.thirdparty.quotebot.QuotePublisher; 8 | 9 | public class BlogAuctionTask { 10 | 11 | private final MarketStudyVendor marketDataRetriever; 12 | 13 | public BlogAuctionTask() { 14 | marketDataRetriever = new MarketStudyVendor(); 15 | } 16 | 17 | @SuppressWarnings("deprecation") 18 | public void PriceAndPublish(String blog, String mode) { 19 | double avgPrice = marketDataRetriever.averagePrice(blog); 20 | // FIXME should actually be +2 not +1 21 | double proposal = avgPrice + 1; 22 | double timeFactor = 1; 23 | if (mode.equals("SLOW")) { 24 | timeFactor = 2; 25 | } 26 | if (mode.equals("MEDIUM")) { 27 | timeFactor = 4; 28 | } 29 | if (mode.equals("FAST")) { 30 | timeFactor = 8; 31 | } 32 | if (mode.equals("ULTRAFAST")) { 33 | timeFactor = 13; 34 | } 35 | proposal = proposal % 2 == 0 ? 3.14 * proposal : 3.15 36 | * timeFactor 37 | * (new Date().getTime() - new Date(2000, Calendar.JANUARY, 1) 38 | .getTime()); 39 | QuotePublisher.INSTANCE.publish(proposal); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/main/java/com/arolla/legacy/testing/quotebot/TechBlogs.java: -------------------------------------------------------------------------------- 1 | package com.arolla.legacy.testing.quotebot; 2 | 3 | import java.util.Arrays; 4 | import java.util.Collection; 5 | 6 | import javax.swing.JOptionPane; 7 | 8 | public class TechBlogs { 9 | 10 | public static Collection listAllBlogs() { 11 | try { 12 | Thread.sleep(5000);// Access to DB are very slow 13 | } catch (InterruptedException e) { 14 | JOptionPane.showMessageDialog(null, e.getMessage(), 15 | "Unxepceted ecxeptoin", JOptionPane.WARNING_MESSAGE); 16 | } 17 | return Arrays.asList("HackerNews", "Reddit", "TechCrunch", "BuzzFeed", 18 | "TMZ", "TheHuffPost", "GigaOM"); 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/com/arolla/legacy/testing/thirdparty/quotebot/MarketStudyVendor.java: -------------------------------------------------------------------------------- 1 | package com.arolla.legacy.testing.thirdparty.quotebot; 2 | 3 | import java.util.Random; 4 | 5 | import javax.swing.JOptionPane; 6 | 7 | public class MarketStudyVendor { 8 | 9 | public double averagePrice(String blog) { 10 | if (System.getenv("license") == null) { 11 | JOptionPane.showMessageDialog(null, "Missing license !", 12 | "Stupid license", JOptionPane.WARNING_MESSAGE); 13 | throw new RuntimeException(""); 14 | } 15 | return ((double) blog.hashCode() * (new Random()).nextDouble()); 16 | } 17 | 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/arolla/legacy/testing/thirdparty/quotebot/QuotePublisher.java: -------------------------------------------------------------------------------- 1 | package com.arolla.legacy.testing.thirdparty.quotebot; 2 | 3 | import javax.swing.JOptionPane; 4 | 5 | public class QuotePublisher { 6 | 7 | public static final QuotePublisher INSTANCE = new QuotePublisher(); 8 | 9 | public void publish(double todayPrice) { 10 | JOptionPane 11 | .showMessageDialog( 12 | null, 13 | "You've pushed a dummy auction to a real ads platform, the business is upset!","Big fail!", 14 | JOptionPane.WARNING_MESSAGE); 15 | } 16 | } 17 | --------------------------------------------------------------------------------