https://github.com/sylhare/randomk

Use randomK in your tests to create real objects with fake data automatically.
https://github.com/sylhare/randomk

kotlin kotlin-library test testing-library testing-tools

Last synced: 6 days ago
JSON representation

Use randomK in your tests to create real objects with fake data automatically.

• Host: GitHub
• URL: https://github.com/sylhare/randomk
• Owner: sylhare
• License: mit
• Created: 2021-08-05T18:09:31.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-21T19:39:26.000Z (almost 3 years ago)
• Last Synced: 2024-10-12T19:33:45.474Z (about 1 month ago)
• Topics: kotlin, kotlin-library, test, testing-library, testing-tools
• Language: Kotlin
• Homepage:
• Size: 181 KB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RandomK

Create random instance from a class. It

uses [`kotlin-reflect`](https://kotlinlang.org/docs/reflection.html#class-references)

to create by reflection the instance. (Using [KClass](https://kotlinlang.org/docs/reflection.html#class-references)

and [KType](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/))

> _Reflection_ is a set of language and library features that allows for introspecting the structure of your own program at runtime.

Based on [Marcin Moskala](https://github.com/MarcinMoskala) from [Kt Academy](https://kt.academy/) 's article:

- [Creating a random instance of any class in Kotlin](https://blog.kotlin-academy.com/creating-a-random-instance-of-any-class-in-kotlin-b6168655b64a)

## How to use

### Add the dependency

#### Create a GitHub Personal Access Token

To use the packages hosted on the GPR (GitHub Package Registry) you need your username/token. Add the GPR as a

repository inside your [build.gradle.kts](Example/build.gradle.kts):

```kotlin

maven {

    url = uri("https://maven.pkg.github.com/sylhare/RandomK")

    credentials {

        username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")

        password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")

    }

}

```

You can set those variables using:

```bash

export USERNAME="my-github-username"

export TOKEN="my-secret-personal-access-token-for-github"

```

Then add the randomK dependency:

```kotlin

dependencies {

    implementation("com.github.sylhare:randomk:$randomKVersion")

}

```

With the latest version available, check out the [_package_](https://github.com/sylhare/RandomK/packages/978387) section

😉

Find the full example [here](Example).

### In your code

Since we're using `typeOf()` fom kotlin-reflect to detect the retention type (introduced in kotlin v1.3), the library

is under the `@ExperimentalStdlibApi`.

You can create a random instance with `randomK` like:

```kotlin

private val example: Example = randomK()

private val otherExample = randomK()

```

It will create a random instance.