TestIt
While TDD is a better approach for development, many projects don't practice it and end up with low test coverage.
This project is here to help you improve your test coverage by reducing the effort spent on writing boilerplate code, allowing you to focus on writing the actual tests.
Use TestIt to generate unit testing boilerplate from kotlin files.
Getting Started
While you can run ./gradlew run --args "filepath", it might be more convenient to set up a shortcut to the provided helper script:
Install
- Get HomeBrew
- Run
brew install coreutils - Create a symbolic link:
sudo ln -s /path/to/testit /usr/local/bin
Note: your project would need to include mockito 2 and mockito-kotlin or MockK.
Usage
Once installed, running TestIt is as simple as
testit path/to/file.kt
Or, to generate parameterized tests:
testit -p path/to/file.kt
Output
TestIt generates a test file in the default expected path.
For example, when run against itself (testit app/src/main/java/com/mitteloupe/testit/TestIt.kt) - see source file - it generates the below file at app/src/test/java/com/mitteloupe/testit/TestItTest.kt:
package com.mitteloupe.testit
import com.mitteloupe.testit.config.PropertiesReader
import com.mitteloupe.testit.file.FileProvider
import com.mitteloupe.testit.generator.TestFilePathFormatter
import com.mitteloupe.testit.generator.TestsGeneratorFactory
import com.mitteloupe.testit.model.ClassTestCode
import com.mitteloupe.testit.parser.KotlinFileParser
import org.mockito.kotlin.mock
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import org.mockito.Mock
import org.mockito.junit.MockitoJUnitRunner
@RunWith(MockitoJUnitRunner::class)
class TestItTest {
private lateinit var cut: TestIt
@Mock
lateinit var propertiesReader: PropertiesReader
@Mock
lateinit var fileProvider: FileProvider
@Mock
lateinit var kotlinFileParser: KotlinFileParser
@Mock
lateinit var testFilePathFormatter: TestFilePathFormatter
@Mock
lateinit var testsGeneratorFactory: TestsGeneratorFactory
@Before
fun setUp() {
cut = TestIt(propertiesReader, fileProvider, kotlinFileParser, testFilePathFormatter, testsGeneratorFactory)
}
@Test
fun `Given _ when getTestsForFile then _`() {
// Given
val fileName = "fileName"
// When
val actualValue = cut.getTestsForFile(fileName)
// Then
TODO("Define assertions")
}
@Test
fun `Given _ when saveTestsToFile then _`() {
// Given
val sourceFileName = "sourceFileName"
val classTestCode = mock<ClassTestCode>()
// When
cut.saveTestsToFile(sourceFileName, classTestCode)
// Then
TODO("Define assertions")
}
@Test
fun `Given _ when showHelp then _`() {
// Given
// When
cut.showHelp()
// Then
TODO("Define assertions")
}
}
Features
- Automatically compiles a list of required imports
- Supports multiple classes in one Kotlin file
- Supports overloaded functions
- Supports both mockito 2 and MockK
- Generates test code for abstract classes
- Generates test code for extension functions
- Generates test code for static functions
- Generates parameterized tests code
- Generates test code for exceptions
- Configurable
Acknowledgments
This code uses a JAR from kotlin-grammar-tools to parse Kotlin code.
Created by
License
MIT © Eran Boudjnah
4 Sep 13, 2022
2 Dec 6, 2022
44 Oct 3, 2022
74 Dec 26, 2022
1 Jun 7, 2022
0 Dec 18, 2021
29 Oct 3, 2022
7 Nov 28, 2022
2.1k Jan 3, 2023
1 Dec 1, 2021
236 Nov 30, 2022
0 Nov 14, 2021
4 Mar 1, 2022
242 Dec 30, 2022
0 Feb 12, 2022
5 Jul 20, 2022