feat(random): add support for custom generators

Author: coderbyheart

src/random.spec.ts

@@ -3,7 +3,7 @@ import assert from 'node:assert/strict'
 import { runFolder } from '@nordicsemiconductor/bdd-markdown'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
-import { steps } from './random.js'
+import { steps, UUIDv4, email, IMEI } from './random.js'
 const __dirname = fileURLToPath(new URL('.', import.meta.url))
 
 void describe('Random', () => {
@@ -12,7 +12,14 @@ void describe('Random', () => {
 			folder: path.join(__dirname, 'test-data', 'random'),
 			name: 'Random',
 		})
-		runner.addStepRunners(...steps)
+		runner.addStepRunners(
+			...steps({
+				UUIDv4,
+				email,
+				IMEI,
+				color: () => 'red',
+			}),
+		)
 		const ctx = {}
 		const result = await runner.run(ctx)
 		assert.equal(result.ok, true)
@@ -30,5 +37,12 @@ void describe('Random', () => {
 				),
 			true,
 		)
+		assert.equal(
+			'imei' in ctx &&
+				typeof ctx.imei === 'string' &&
+				parseInt(ctx.imei, 10) >= 350006660000000,
+			true,
+		)
+		assert.equal('color' in ctx && ctx.color, 'red')
 	})
 })

src/random.ts

@@ -5,34 +5,36 @@ import {
 import { Type } from '@sinclair/typebox'
 import { generateCode } from '@hello.nrfcloud.com/proto/fingerprint'
 
-export const email = regExpMatchedStep(
-	{
-		regExp: /^I have a random email in `(?<storeName>[^`]+)`$/,
-		schema: Type.Object({
-			storeName: Type.String({ minLength: 1 }),
-		}),
-	},
-	async ({ match: { storeName }, log: { progress }, context }) => {
-		const randomEmail = `${generateCode()}@example.com`
-		progress(randomEmail)
+const random = (
+	id: string,
+	generator: () => string,
+): StepRunner<Record<string, any>> =>
+	regExpMatchedStep(
+		{
+			regExp: new RegExp(`^I have a random ${id} in \`(?<storeName>[^\`]+)\`$`),
+			schema: Type.Object({
+				storeName: Type.String({ minLength: 1 }),
+			}),
+		},
+		async ({ match: { storeName }, log: { progress }, context }) => {
+			const randomString = generator()
+			progress(randomString)
 
-		context[storeName] = randomEmail
-	},
-)
+			context[storeName] = randomString
+		},
+	)
 
-export const uuidv4 = regExpMatchedStep(
-	{
-		regExp: /^I have a random UUIDv4 in `(?<storeName>[^`]+)`$/,
-		schema: Type.Object({
-			storeName: Type.String({ minLength: 1 }),
-		}),
-	},
-	async ({ match: { storeName }, log: { progress }, context }) => {
-		const randomUUIDv4 = crypto.randomUUID()
-		progress(randomUUIDv4)
+export const UUIDv4 = (): string => crypto.randomUUID()
+export const email = (): string => `${generateCode()}@example.com`
+export const IMEI = (): string =>
+	(350006660000000 + Math.floor(Math.random() * 10000000)).toString()
 
-		context[storeName] = randomUUIDv4
+export const steps: (
+	generators?: Record<string, () => string>,
+) => StepRunner<Record<string, any>>[] = (
+	generators = {
+		email,
+		UUIDv4,
+		IMEI,
 	},
-)
-
-export const steps: StepRunner<Record<string, any>>[] = [email, uuidv4]
+) => Object.entries(generators).map(([id, generator]) => random(id, generator))

src/test-data/random/Random.feature.md

@@ -7,3 +7,11 @@ Given I have a random email in `email`
 ## Store an id
 
 Given I have a random UUIDv4 in `uuid`
+
+## Store an IMEI
+
+Given I have a random IMEI in `imei`
+
+## Custom example
+
+Given I have a random color in `color`