You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Random Class Instance ARBs](#random-class-instance-arb)
13
+
14
+
## About
15
+
16
+
Kotlin-faker `blns` artifact provides convenience functions for returning strings from [The Big List of Naughty Strings](https://github.com/minimaxir/big-list-of-naughty-strings) - a list of strings which have a high probability of causing issues when used as user-input data, and can therefore be quite useful in testing.
17
+
18
+
## Disclaimer
19
+
20
+
> The Big List of Naughty Strings is intended to be used for _software you own and manage_. Some of the Naughty Strings can indicate security vulnerabilities, and as a result using such strings with third-party software may be a crime. The maintainer is not responsible for any negative actions that result from the use of the list.
21
+
>
22
+
> Additionally, the Big List of Naughty Strings is not a fully-comprehensive substitute for formal security/penetration testing for your service.
23
+
24
+
## Usage
25
+
26
+
### Installation
27
+
28
+
- ① add the core `kotlin-faker` dependency to the test classpath
29
+
- ② then add the dependency for the `kotlin-faker-blns` extension
30
+
31
+
{% tabs %}
32
+
33
+
{% kotlin "Kotlin" %}
34
+
{% filter compileAs('md') %}
35
+
36
+
```kotlin
37
+
dependencies {
38
+
testImplementation("io.github.serpro69:kotlin-faker:$fakerVersion") // ①
39
+
testImplementation("io.github.serpro69:kotlin-faker-blns:$fakerVersion") // ②
40
+
}
41
+
```
42
+
43
+
{% endfilter %}
44
+
{% endkotlin %}
45
+
46
+
{% endtabs %}
47
+
48
+
{% btc %}{% endbtc %}
49
+
50
+
<br>
51
+
52
+
### Using the Big List of Naughty Strings
53
+
54
+
The `Blns` class provides properties and functions to get all strings, as well as a sublist of strings, and a single random string.
55
+
56
+
There is also corresponding functionality for getting base64-encoded strings.
57
+
58
+
For example, using [JUnit5 Parameterized Testing](https://junit.org/junit5/docs/current/user-guide/#writing-tests-parameterized-tests) capabilities:
59
+
60
+
- ① Create an instance of `Blns` class
61
+
- ② Get `all` strings
62
+
- ③ Get a `sublist` of strings
63
+
- ④ Get a `random` string
64
+
- ⑤ `get` strings by a `Category`
65
+
- ⑥ Test your inputs
66
+
- Profit 💸
67
+
68
+
{% tabs %}
69
+
70
+
{% kotlin "Kotlin" %}
71
+
{% filter compileAs('md') %}
72
+
73
+
```kotlin
74
+
classTest {
75
+
@ParameterizedTest
76
+
@MethodSource("allStrings") // ⑥
77
+
fun`test input with a naughty string`(s:String) {
78
+
inputField.sendKeys(s) // ⑥
79
+
}
80
+
81
+
companionobject {
82
+
privateval blns = blns { /*faker configuration*/ } // ①
83
+
@JvmStatic privatefunallStrings() = blns.all.stream() // ②
84
+
@JvmStatic privatefunallBase64 () = blns.allBase64.stream() // ②
85
+
@JvmStatic privatefunsublist() = blns.sublist(10).stream() // ③
86
+
@JvmStatic privatefunsublistBase64() = blns.sublist(10, base64 =true).stream() // ③
87
+
val randomString:String get() = blns.random() // ④
88
+
val randomBase64String:String get() = blns.random(base64 =true) // ④
89
+
val emojiStrings = blns.get(Category.EMOJI) // ⑤
90
+
val emojiAndKaomojiStrings = blns.get(Category.EMOJI, Category.KAOMOJI) // ⑤
91
+
val basicCategories = blns.get(Category.RESERVED, Category.NUMERIC, Category.SPECIAL) // ⑤
92
+
}
93
+
}
94
+
```
95
+
96
+
{% endfilter %}
97
+
{% endkotlin %}
98
+
99
+
{% endtabs %}
100
+
101
+
{% btc %}{% endbtc %}
102
+
103
+
<br>
104
+
105
+
## Credits
106
+
107
+
The input for this extension is maintained by [github.com/minimaxir](https://github.com/minimaxir) at https://github.com/minimaxir/big-list-of-naughty-strings.
Copy file name to clipboardexpand all lines: docs/src/orchid/resources/wiki/extensions.md
+12-3
Original file line number
Diff line number
Diff line change
@@ -13,18 +13,27 @@ The extension modules require the [main `kotlin-faker` dependency]({{ link(colle
13
13
14
14
## ToC
15
15
16
+
-[BLNS](#blns)
16
17
-[Kotest Property](#kotest-property)
17
18
18
19
<br>
19
20
21
+
## BLNS
22
+
23
+
Kotlin-faker `blns` artifact provides convenience functions for returning strings from [The Big List of Naughty Strings](https://github.com/minimaxir/big-list-of-naughty-strings) - a list of strings which have a high probability of causing issues when used as user-input data, and can therefore be quite useful in testing.
24
+
25
+
See the [Big List of Naughty Strings Extension]({{ link(collectionType='pages', collectionId='extensions', itemId='Blns Extension') }}) page for usage details.
26
+
27
+
{% btc %}{% endbtc %}
28
+
29
+
<br>
30
+
20
31
## Kotest Property
21
32
22
-
Kotlin-faker`kotest-property` and `kotest-property-ksp` artifacts provide faker-based [`Arb` generators](https://kotest.io/docs/proptest/property-test-generators.html)extensions via [KSP](https://kotlinlang.org/docs/ksp-overview.html) compiler plugin for[kotest property testing](https://kotest.io/docs/proptest/property-based-testing.html).
33
+
`kotlin-faker-kotest-property` artifact extends [`Arb` generators](https://kotest.io/docs/proptest/property-test-generators.html)and provides an easy way to use kotlin-faker functionality with[kotest property testing](https://kotest.io/docs/proptest/property-based-testing.html).
23
34
24
35
See the [Kotest Property Extension]({{ link(collectionType='pages', collectionId='extensions', itemId='Kotest Property Extension') }}) page for usage details.
25
36
26
-
A full working example can also be found in the [kotest-property-test](https://github.com/serpro69/kotlin-faker/tree/master/extension/kotest-property-test) project.
`kotlin-faker-blns` module provides extensions for the [big-list-of-naughty-strings](https://github.com/minimaxir/big-list-of-naughty-strings), a list of strings which have a high probability of causing issues when used as user-input data, and can therefore be quite useful in testing.
7
+
8
+
## Usage
9
+
10
+
Documentation for this extension is available at [serpro69.github.io/kotlin-faker/](https://serpro69.github.io/kotlin-faker/extensions/blns-extension).
0 commit comments