Oscon 2012 tdd_cassandra

Editor's Notes

• #2: \n
• #3: I’m Nate McCall, I’m platform development lead for the usergrid product at Apigee\n
• #4: I’m here to talk about just two things really...\n
• #5: \n
• #6: \n
• #7: \n
• #8: What is it? Well, by itself it can (and does) take up it’s own talk. But for a gross generalization, well start here.\n
• #9: When we talk test driven devlopment, we are really talking about unit testing code. We’ll talk about integration testing too, since that’s really what we care about for our case, but we’ll treat them as separate for now\n
• #10: Again, we don’t have much time, so I’m not going to go into this except to emphasize some of the core rules of unit testing. Another way to think about this is that unit testing is a method by which the smallest testable part of an application is validated. \n
• #11: Basically we want tests to be: fast, Isolated, Repeatable , Self-Validated (in that it asserts a condition ) and Timely (which really means we write them first so they stay in sync with the code).\n
• #12: For integration testing, we mean interfacing with external systems or processes really, to validate that components integrate correctly. pretty straight forward.\n
• #13: Generally there are fewer of them and, ideally, we run them less often because they are far more expensive\n
• #14: \n
• #15: \n
• #16: \n
• #17: For us, and are requirements here, there are 2 problems with that\n
• #18: Inherently makes it difficutlt to test locally. One of the things i really want to avoid is having developers needing to manage their own internal or external clusters of cassandra\n
• #19: It’s a service. Thus it’s an integration test. \n
• #20: To specific, here are some details.\n
• #21: Every operation sends whats called a ConsistencyLevel - essentially the level of sfety of an op\n
• #22: \n
• #23: \n
• #24: Writing for the key “P” then the primary node is down. The remaining replicas capture the a hint which will be “replayed” to the down node when it comes back. In a smaller cluster where a quorum is not possible, these operations would return an exception to the caller. Obviously this become difficult to test for\n\n\n
• #25: So we’re here to talk about applying test driven development to apache cassandra. I’m going to do this in a way that’s a little different\n
• #26: \n
• #27: I’m doing it wrong. \n
• #28: Here’s some output from a run of ‘mvn test’ on one module of the Usergrid codebase. Seems Typical. Tests ran, the passed, etc. But if we look a little closer...\n
• #29: We see some serious ugly.\n
• #30: I’ll be frank, that sucks.\n
• #31: This \n
• #32: \n
• #33: \n
• #34: \n
• #35: The worst result of all of this is that you end up in this situation in order just to get things completed. \n
• #36: If you do this, you will miss bugs. You will tie up cycles hunting down ‘blames’ on continous integration failures. The worst part about this is that it discourages test driven development in the first place. I’ve done this and it’s turned around to bite me.\n
• #37: So we’re in this situation - how do we get out of it? Taking this to the suits and trying to get time for it is extremely difficult.\n
• #38: Say that at your next priority meeting\n
• #39: This is a shockingly easy way to disquise a ton of refactoring work in “preparing for a conference”\n
• #40: \n
• #41: The first thing I needed to do was get a handle again on the test framework landscape without causing too much trauma to the code. \n
• #42: There’s really two way to approach this other than EmbeddedCassandraHelper. These two have been around for a year and are relatively stable and track recent cassandra releases.\n
• #43: \n
• #44: I should know better. I really should. \n
• #45: So let’s take a look at cassandra unit\n
• #46: The benefits are pretty straight forward\n
• #47: A couple of cons though. External instances is not going to work with one of my main requirements\n
• #48: Now cassandra maven plugin. Precisely what it says on the tin really, it’s a maven plugin designed to control cassandra instances. \n
• #49: Essentially, you can use maven to fork one or more cassandra instances in their own jvms. If you’ve never soon JVM forking in the wild, cassandra-maven-plugin is a decent example of using the commons-exec utility from the Apache Commons project\n
• #50: Thats great, but there’s some things missing\n
• #51: We need to speed up the test cycle so we dont throw the skipTest flag and miss bugs.\n
• #52: There is some low hanging fruit to address here that could speed things up for utility and mock-based test cases. \n
• #53: Basically things that are not integration tests. \nBy doing this, we can isolate those different requirements, inherently cutting time out of the test process.\n
• #54: There are two primary plugins used for test integration with maven. One is designed for unit testing, the other for integration testing.\n
• #55: If you get these confused your not alone. Who knows which is which?\n
• #56: \n
• #57: the names are not terribly descriptive. The documentation does not help much.\n
• #58: Even better: here is the surefire page. Note the URL, as this next slide is not very different.\n
• #59: Here is the failsafe page. Note the typos. They did manage one of out 3 find/replaces though. Note: I plan on submitting a patch to the site docs this evening to fix this. \n
• #60: Basically. The failsafe plugin is for integration testing.\n
• #61: Because failsafe is designed to continue after failures, here’s an easy way to remember that failsafe is for integration testing. \n
• #62: \n
• #63: Spend some time renaming to facilitate the Unit/integration test separation\n
• #64: Once you do this, there are some additional tweaks to really boost performance on test designed along FIRST guidelines\n
• #65: \n
• #66: The easy stuff’s out of the way, and we’ve shave some time off - particularly for the utility code. What else can we do?\n
• #67: Let’s look at our goals again... \n
• #68: \n
• #69: No. We can combine them.\n
• #70: \n
• #71: T\n
• #72: \n
• #73: Will see an example of this in a minute, but we need to attach a listener to the the build process to get this to fire off correct.\n
• #74: Here we are binding failsafe to the integration and verify phase\n
• #75: This configures our naming scheme - opposite of the surefire configuration - to run only the unit tests. We also have a regex on the bottom to exclude our RunListener from being invoked as a test case.\n
• #76: \n
• #77: Really straight forward. All configurations are handled by default for the simple cases, we only specify start and stop in order to bind to the integration and verify phases above.\n
• #78: \n
• #79: \n
• #80: \n
• #81: \n
• #82: \n
• #83: \n
• #84: \n
• #85: \n
• #86: \n
• #87: \n
• #88: \n
• #89: \n
• #90: \n
• #91: \n
• #92: \n
• #93: \n
• #94: \n
• #95: \n