Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eranboudjnah/testit

Generate unit testing boilerplate from kotlin files.
https://github.com/eranboudjnah/testit

generator junit junit4 kotlin mockito mockito-kotlin mockk unit-test unit-testing unit-tests unittest

Last synced: about 2 months ago
JSON representation

Generate unit testing boilerplate from kotlin files.

Awesome Lists containing this project

README 

        
# TestIt



![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/EranBoudjnah/TestIt/test.yml)

[![License](https://img.shields.io/github/license/EranBoudjnah/Solid)](https://github.com/EranBoudjnah/TestIt/blob/master/LICENSE)



While [TDD](https://en.wikipedia.org/wiki/Test-driven_development) 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



1. Get [HomeBrew](https://brew.sh/)

2. Run `brew install coreutils`

3. Create a symbolic link: `sudo ln -s /path/to/testit /usr/local/bin`



Note: your project would need to include [mockito 2](https://site.mockito.org/) and [mockito-kotlin](https://github.com/nhaarman/mockito-kotlin) or [MockK](https://mockk.io/).



## 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](https://github.com/EranBoudjnah/TestIt/blob/master/app/src/main/java/com/mitteloupe/testit/TestIt.kt) -

it generates the below file at `app/src/test/java/com/mitteloupe/testit/TestItTest.kt`:



```kotlin

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()



        // 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](https://site.mockito.org/) and [MockK](https://mockk.io/)

* 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](https://github.com/Kotlin/grammar-tools) to parse Kotlin code.



## Created by

[Eran Boudjnah](https://www.linkedin.com/in/eranboudjnah)



## License

MIT © [Eran Boudjnah](https://www.linkedin.com/in/eranboudjnah)