feat: make driver to be more flexible and have modularity (#122)

Author: andostronaut

.gitignore

@@ -2,5 +2,6 @@ dist/
 .DS_Store
 .env
 drowser
+drowser.json
 drowser-reports.json
-/node_modules
+/node_modules

drowser.json

@@ -1,3 +1,3 @@
 {
-  "url": "http://localhost:3000"
+	"url": "http://localhost:3000"
 }

examples/basic.ts

@@ -1,27 +1,6 @@
 import { driver } from '../mod.ts'
 
-driver({ browser: 'chrome' })
-	.then(({ service }) => {
-		service.cases = [
-			{
-				name: 'Verify Failed Title',
-				fn: async ({ builder, assert }) => {
-					const title = await builder.getTitle()
-					assert.assertEquals(title, 'Drowsers')
-				},
-			},
-			{
-				name: 'Verify Title',
-				fn: async ({ builder, assert }) => {
-					const title = await builder.getTitle()
-					assert.assertEquals(title, 'Drowser')
-				},
-			},
-		]
-	})
-	.catch((error) => console.log(error))
-
-driver({ browser: 'firefox' })
+driver({ browser: 'safari' })
 	.then(({ service }) => {
 		service.cases = [
 			{

mod.ts

@@ -1,4 +1,4 @@
-import driver from './src/driver.ts'
+import driver from './src/driver/index.ts'
 import type Types from './src/types.ts'
 
 export { driver }

src/driver.ts

@@ -0,0 +1,28 @@
+import { isEmpty, join } from '../../deps.ts'
+import { isValidHttpUrl } from '../utils.ts'
+
+export const getConfig = async (): Promise<{ url: string }> => {
+	const configPath = join(Deno.cwd(), 'drowser.json')
+
+	try {
+		await Deno.stat(configPath)
+
+		const { url } = JSON.parse(await Deno.readTextFile(configPath))
+
+		if (isEmpty(url) || !isValidHttpUrl({ url })) {
+			throw new Error(
+				'An error occurred, please provide a valid url in drowser config',
+			)
+		}
+
+		return { url }
+	} catch (error) {
+		if (error instanceof Deno.errors.NotFound) {
+			throw new Error('An error occurred, please create drowser.json file.')
+		}
+
+		throw new Error(
+			'An error occurred, please provide a valid url drowser.json file.',
+		)
+	}
+}

src/driver/config.ts

@@ -6,23 +6,23 @@ import {
 	readJsonSync,
 	writeJson,
 	writeJsonSync,
-} from '../deps.ts'
+} from '../../deps.ts'
 import {
 	generateFileName,
 	getAverageDuration,
 	getCoverage,
 	getCurrentMonth,
 	getFlaky,
 	updateOrCreate,
-} from './utils.ts'
+} from '../utils.ts'
 import {
 	DataPoint,
 	DataResult,
 	DriverBrowser,
 	MonthCount,
 	MonthValue,
 	ReportSchema,
-} from './types.ts'
+} from '../types.ts'
 
 const exportGeneratedLog = (
 	{ results }: { results: Array<DataResult> },
@@ -40,8 +40,7 @@ const exportGeneratedLog = (
 
 		const writeResult = () =>
 			results.forEach((r) => {
-				const logRow =
-					`[${r.timestamp}] - Test with ${r.name} is ${r.status}`
+				const logRow = `[${r.timestamp}] - Test with ${r.name} is ${r.status}`
 				Deno.writeTextFile(logFilePath, `${logRow}\n`, { append: true })
 			})
 
@@ -84,12 +83,11 @@ const exportJSONReport = (
 			}
 		}
 
-		const flatedTotalTests =
-			jsonData.drowser.metadata.current_month === month
-				? jsonData.drowser.cases.flatMap((item) => item.cases).filter((
-					c,
-				) => c.month_of_test === month)
-				: []
+		const flatedTotalTests = jsonData.drowser.metadata.current_month === month
+			? jsonData.drowser.cases.flatMap((item) => item.cases).filter((
+				c,
+			) => c.month_of_test === month)
+			: []
 		const totalTests = [
 			...flatedTotalTests,
 			...results,

src/export.ts src/driver/export.tssrc/export.ts renamed to src/driver/export.ts

@@ -0,0 +1,81 @@
+import { assert, Builder, By, isEmpty, Kia } from '../../deps.ts'
+import type {
+	Data,
+	DriverParams,
+	DrowserDriverResponse,
+	DrowserServiceCase,
+	DrowserThenableWebDriver,
+} from '../types.ts'
+import { isValidHttpUrl } from '../utils.ts'
+import { driverBrowsers, seleniumExceptions } from '../constants.ts'
+import { exportGeneratedLog, exportJSONReport } from './export.ts'
+import { getConfig } from './config.ts'
+import { validateParams } from './validate.ts'
+import { processServiceCase } from './process.ts'
+
+const driver = async ({
+	browser,
+}: DriverParams): Promise<DrowserDriverResponse> => {
+	const data: Data = { url: '', results: [] }
+
+	const config = await getConfig()
+	data.url = config.url
+
+	validateParams({ browser })
+
+	return new Promise<DrowserDriverResponse>((resolve, reject) => {
+		if (isEmpty(data.url) || !isValidHttpUrl({ url: data.url })) reject()
+
+		const builder = new Builder()
+			.forBrowser(driverBrowsers[browser])
+			.build() as DrowserThenableWebDriver
+
+		const service = { cases: [] }
+
+		const kia = new Kia('Processing your tests')
+		kia.start()
+
+		builder
+			.get(data.url)
+			.then(() => resolve({ service }))
+			.catch((error: Record<string, string>) => {
+				kia.fail('An error occurred while running tests')
+				reject(seleniumExceptions[error.name])
+			})
+			.finally(() => {
+				const methodPromises: Promise<void>[] = []
+
+				service.cases.forEach((serviceCase: DrowserServiceCase) => {
+					if (typeof serviceCase === 'object') {
+						const methodPromise = processServiceCase(
+							serviceCase,
+							builder,
+							assert,
+							By,
+							browser,
+							data,
+						)
+						methodPromises.push(methodPromise)
+					}
+				})
+
+				const exportGeneratedFiles = () => {
+					exportGeneratedLog({ results: data.results })
+					exportJSONReport({
+						results: data.results,
+						browser,
+					})
+				}
+
+				Promise.allSettled(methodPromises)
+					.catch((error) => reject(error))
+					.finally(() => {
+						exportGeneratedFiles()
+						kia.succeed(`All tests completed on ${browser}`)
+						builder.quit()
+					})
+			})
+	})
+}
+
+export default driver