Welcome to the first lesson of our course on Test Driven Development (TDD) in Scala using ScalaTest. TDD is an iterative software development process where tests are written before developing the actual functionality. This approach helps developers focus on the requirements first, leading to more reliable and maintainable code.
In this lesson, we'll introduce you to the essential elements of TDD, including the Red-Green-Refactor cycle, which serves as the core structure of this methodology. We'll be utilizing tools specially suited for Scala: ScalaTest, a popular testing framework that integrates seamlessly with Scala, and Mockito, a mocking framework widely used in the Scala ecosystem, which we'll explore later in this path. Let's start by investigating TDD’s core components with a hands-on example.
The TDD process begins with writing a test that fails, marking the "Red" phase. This step allows you to crystallize what the code should achieve before writing the actual implementation. Let's write a test for a sum
method that should eventually add two numbers.
Create a file named MathFunSuite.scala
in the src/test/scala
directory:
This test script:
- Uses
test
to denote a single test case. - Calls the
sum
method and checks if the result equals5
. assert(condition)
verifies that the actual result matches the expected value.
This immediate failure highlights the importance of the "Red" phase in TDD, as it confirms that our test is effectively identifying missing features and setting clear implementation goals.
Expected output:
This is a normal failure, illustrating that our test is effectively identifying unimplemented features.
Our next objective is to write the simplest code possible to make the test pass — the "Green" step. In TDD, this means implementing minimal functionality to satisfy the test conditions. Let’s define the sum
method in a new file Math.scala
under the src/main/scala
directory:
This version seems superficial since it doesn't actually add two numbers, but it highlights the TDD focus on passing the test with minimal implementation. By doing so, we've met the test condition.
Re-running the test will produce the following result:
Seeing the test pass confirms our code meets the given test scenario. Future test cases will guide us to refine the implementation.
The last step, "Refactor," involves refining the code while ensuring existing behavior remains unchanged. In this instance, our sum
function is quite efficient, but we can improve our test readability by separating the execution from the assertion. This involves extracting the output of the sum
function into a variable:
This small refactoring illustrates how minor adjustments can enhance clarity, as it isolates the act (execution) from the assertion (verification). When dealing with more complex functions, refactoring might involve breaking down a function, renaming variables for clarity, or improving test readability. Our Red-Green-Refactor cycle for this example is now complete.
To run the ScalaTest
tests, you can use the sbt
build tool. Run the following command:
This command executes the test suite and provides immediate feedback on the results. However, in the upcoming practice section, you don’t need to run tests manually, as they will execute automatically with a live-watcher.
In this lesson, we've explored the basic principles of TDD using the Red-Green-Refactor workflow with Scala and ScalaTest. Let's recap:
- Red: Start by writing a test that initially fails.
- Green: Add minimal code to pass the test.
- Refactor: Improve the code, ensuring all tests still pass.
As you practice TDD in upcoming exercises, you’ll reinforce your understanding and gain the ability to craft robust, maintainable Scala code. Remember to apply these concepts in your coding routine to boost code quality and reliability.
With this foundation, you’re prepared to tackle more complex scenarios in future lessons. Continue honing your skills to excel in TDD practices using Scala.
