feat: connect @testplane/testing-library

Author: KuznetsovRoman

src/configBuilder.ts

@@ -4,7 +4,7 @@ import defaultPluginsConfig from "./pluginsConfig";
 import defaultToolOpts from "./constants/defaultToolOpts";
 import defaultTestplaneConfig from "./constants/defaultTestplaneConfig";
 import { getTemplate } from "./utils/configTemplates";
-import { inquirerPrompt } from "./utils";
+import { connectTestingLibraryToTestplaneConfig, inquirerPrompt } from "./utils";
 import type { TestplaneConfig, Language } from "./types/testplaneConfig";
 import type { Answers, HandleGeneralPromptsCallback } from "./types/toolOpts";
 import type { CreateBaseConfigCallback, CreatePluginsConfigCallback } from ".";
@@ -29,9 +29,14 @@ export class ConfigBuilder {
     ) {
         this._config = createBaseConfig ? createBaseConfig(defaultTestplaneConfig, opts) : defaultTestplaneConfig;
 
+        this._config.__language = opts.language;
         this._config.__template = getTemplate(opts.language);
     }
 
+    connectTestingLibrary(): void {
+        connectTestingLibraryToTestplaneConfig(this._config);
+    }
+
     async handleGeneralQuestions(
         promts: GeneralPrompt[],
         handlers: HandleGeneralPromptsCallback[],

src/index.ts

@@ -65,6 +65,8 @@ export const run = async ({
         ? [baseGeneralPromptsHandler, generalPromptsHandler]
         : [baseGeneralPromptsHandler];
 
+    configBuilder.connectTestingLibrary();
+
     const generalAnswers = await configBuilder.handleGeneralQuestions(generalPrompts, generalPromptsHandlers, opts);
 
     const { pluginNames, configNotes } = await getPluginNames(opts);

src/package.ts

@@ -111,7 +111,7 @@ export const installPackages = async (
     return new Promise<string>((resolve, reject) => {
         exec(
             PMS[packageManager].withRegistry(
-                `${packageManager} ${PMS[packageManager].install} testplane ${pluginsPackages}`,
+                `${packageManager} ${PMS[packageManager].install} testplane @testplane/testing-library ${pluginsPackages}`,
                 registry,
             ),
             {

src/utils/index.ts

@@ -105,11 +105,27 @@ Inside that directory, you can run:
 
 export const writeTestExample = async (dirPath: string, ext: Language): Promise<void> => {
     const testExample = `
-describe("test", () => {
-    it("example", async ({browser}) => {
-        await browser.url("https://github.com/gemini-testing/testplane");
+describe("test examples", () => {
+    it("docs search test", async ({browser}) => {
+        await browser.openAndWait("https://testplane.io/");
 
-        await expect(browser.$(".f4.my-3")).toHaveText("Testplane (ex-hermione) browser test runner based on mocha and wdio");
+        // Find by tag name
+        const navBar = await browser.$("nav");
+
+        // Find by aria-label
+        await navBar.$("aria/Search").click();
+
+        // Find by placeholder
+        const fileSearchInput = await browser.findByPlaceholderText("Search docs");
+        await fileSearchInput.setValue("config");
+
+        // Find by id
+        const fileSearchResults = await browser.$("#docsearch-list");
+
+        // Find by role
+        const fileSearchResultsItems = await fileSearchResults.findAllByRole("option");
+
+        expect(fileSearchResultsItems.length).toBeGreaterThan(1);
     });
 });
 `;
@@ -145,11 +161,31 @@ export const addModule = (
 
 export const asExpression = (value: string): string => `__expression: ${value}`;
 
+export const connectTestingLibraryToTestplaneConfig = (config: TestplaneConfig): void => {
+    addModule(config, "{ setupBrowser }", "@testplane/testing-library");
+
+    if (config.__language === "js") {
+        const prepareBrowserJsFunction = asExpression("browser => { setupBrowser(browser) }");
+
+        _.set(config, "prepareBrowser", prepareBrowserJsFunction);
+    } else if (config.__language === "ts") {
+        addModule(config, "type { WdioBrowser }", "testplane");
+
+        const prepareBrowserTsFunction = asExpression("(browser: WdioBrowser) => { setupBrowser(browser) }");
+
+        _.set(config, "prepareBrowser", prepareBrowserTsFunction);
+    }
+};
+
 export const extendWithTypescript = async (packageNamesToInstall: string[], appPath: string): Promise<void> => {
     packageNamesToInstall.push("typescript");
 
     const testplaneTsConfigPath = path.join(appPath, defaultTestplaneTestsDir, "tsconfig.json");
-    const defaultTestplaneTsConfig = _.set({}, ["compilerOptions", "types"], ["testplane"]);
+    const defaultTestplaneTsConfig = _.set(
+        {},
+        ["compilerOptions", "types"],
+        ["testplane", "@testplane/testing-library"],
+    );
 
     await fsUtils.writeJson(testplaneTsConfigPath, defaultTestplaneTsConfig);
 };