Merge pull request #23 from gemini-testing/HERMIONE-1382.pass_answers

feat: pass generalAnswers to configure plugins
gemini-testing · Feb 14, 2024 · 1fb705a · 1fb705a
2 parents 8e5c983 + ee10ac0
commit 1fb705a
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 21 deletions.
diff --git a/__fixtures/config/withExpressions.js b/__fixtures/config/withExpressions.js
@@ -4,5 +4,7 @@ module.exports = {
     baz: '4',
     array: [
         Boolean(100 + 500 * 1)
-    ]
+    ],
+    specials: /\n\t\r/g,
+    extraSlash: /\, \, \\/g
 };
diff --git a/src/configBuilder.test.ts b/src/configBuilder.test.ts
@@ -5,7 +5,7 @@ import defaultHermioneConfig from "./constants/defaultHermioneConfig";
 import { ConfigBuilder } from "./configBuilder";
 import fsUtils from "./fsUtils";
 import defaultPluginsConfig from "./pluginsConfig";
-import type { GeneralPrompt, HermioneConfig } from "./types";
+import type { Answers, GeneralPrompt, HermioneConfig } from "./types";
 
 jest.mock("inquirer");
 
@@ -104,14 +104,21 @@ describe("configBuilder", () => {
         });
 
         it("should use default pluginsConfig, if not specified", async () => {
+            const generalAnswers: Answers = { _path: "/", _language: "ts" };
             defaultPluginsConfig["html-reporter/hermione"] = jest.fn().mockImplementation((config: HermioneConfig) => {
                 _.set(config, "htmlReporterIsSet", true);
             });
 
-            await configBuilder.configurePlugins(["html-reporter/hermione"]);
+            await configBuilder.configurePlugins({
+                pluginNames: ["html-reporter/hermione"],
+                generalAnswers,
+            });
 
             expectConfig({ ...defaultHermioneConfig, htmlReporterIsSet: true });
-            expect(defaultPluginsConfig["html-reporter/hermione"]).toBeCalledWith(defaultHermioneConfig);
+            expect(defaultPluginsConfig["html-reporter/hermione"]).toBeCalledWith(
+                defaultHermioneConfig,
+                generalAnswers,
+            );
         });
 
         it("should use overwrited pluginsConfig, if specified", async () => {
@@ -125,7 +132,11 @@ describe("configBuilder", () => {
                     },
                 });
 
-            await configBuilder.configurePlugins(["html-reporter/hermione"], cb);
+            await configBuilder.configurePlugins({
+                pluginNames: ["html-reporter/hermione"],
+                createPluginsConfig: cb,
+                generalAnswers: { _path: "/", _language: "ts" },
+            });
 
             expectConfig({ ...defaultHermioneConfig, foo: "bar" });
         });

diff --git a/src/configBuilder.ts b/src/configBuilder.ts
@@ -5,11 +5,17 @@ import defaultPluginsConfig from "./pluginsConfig";
 import defaultToolOpts from "./constants/defaultToolOpts";
 import defaultHermioneConfig from "./constants/defaultHermioneConfig";
 import type { HermioneConfig, Language } from "./types/hermioneConfig";
-import type { HandleGeneralPromptsCallback } from "./types/toolOpts";
+import type { Answers, HandleGeneralPromptsCallback } from "./types/toolOpts";
 import type { CreateBaseConfigCallback, CreatePluginsConfigCallback } from ".";
 import type { GeneralPrompt } from "./types/toolOpts";
 import { getTemplate } from "./utils/configTemplates";
 
+type ConfigurePluginsOpts = {
+    pluginNames: string[];
+    createPluginsConfig?: CreatePluginsConfigCallback;
+    generalAnswers: Answers;
+};
+
 export class ConfigBuilder {
     static create(createBaseConfig?: CreateBaseConfigCallback, opts?: { language: Language }): ConfigBuilder {
         return new this(createBaseConfig, opts);
@@ -30,9 +36,14 @@ export class ConfigBuilder {
         promts: GeneralPrompt[],
         handlers: HandleGeneralPromptsCallback[],
         { path, noQuestions }: { path: string; noQuestions: boolean },
-    ): Promise<void> {
+    ): Promise<Answers> {
+        const answers: Answers = {
+            _path: path,
+            _language: this._config.__template!.language,
+        };
+
         if (_.isEmpty(promts) || _.isEmpty(handlers)) {
-            return;
+            return answers;
         }
 
         const defaults = promts.reduce((acc, prompt) => {
@@ -45,23 +56,23 @@ export class ConfigBuilder {
 
         const promptsToAsk = noQuestions ? promts.filter(prompt => _.isUndefined(prompt.default)) : promts;
         const inquirerAnswers = await inquirer.prompt(promptsToAsk);
-        const answers = noQuestions ? { ...defaults, ...inquirerAnswers } : inquirerAnswers;
 
-        answers._path = path;
-        answers._language = this._config.__template!.language;
+        Object.assign(answers, defaults, inquirerAnswers, answers);
 
         for (const handler of handlers) {
             this._config = await handler(this._config, answers);
         }
+
+        return answers;
     }
 
-    async configurePlugins(pluginNames: string[], createPluginsConfig?: CreatePluginsConfigCallback): Promise<void> {
+    async configurePlugins({ pluginNames, createPluginsConfig, generalAnswers }: ConfigurePluginsOpts): Promise<void> {
         const pluginsConfig = createPluginsConfig ? createPluginsConfig(defaultPluginsConfig) : defaultPluginsConfig;
 
         this._config.plugins ||= {};
 
         for (const plugin of pluginNames) {
-            await pluginsConfig[plugin](this._config);
+            await pluginsConfig[plugin](this._config, generalAnswers);
         }
     }
 

diff --git a/src/fsUtils.test.ts b/src/fsUtils.test.ts
@@ -68,6 +68,8 @@ describe("fsUtils", () => {
                 bar: 4,
                 baz: "4",
                 array: ["__expression: Boolean(100 + 500 * 1)"],
+                specials: "__expression: /\n\t\r/g",
+                extraSlash: "__expression: /\\, \\, \\\\/g",
             } as unknown as HermioneConfig;
 
             await expectConfig(withExpressionsConfig, configs["withExpressions"]);

diff --git a/src/fsUtils.ts b/src/fsUtils.ts
@@ -67,11 +67,15 @@ export const writeHermioneConfig = async (dirPath: string, hermioneConfig: Hermi
         const quote = template.quote;
         const expressionRegExp = new RegExp(`${quote}__expression: (.*)${quote}(,?)$`, "gm");
 
-        // unescapes and restores double quotes in expressions
-        const withRestoredQuotesConfigStr = configStr.replace(expressionRegExp, match => match.replace(/\\"/g, '"'));
+        const repairQuotes = (match: string): string => match.replace(/\\"/g, '"');
+        const repairSlash = (match: string): string => match.replace(/\\\\/g, "\\");
+
+        const repairedConfig = configStr
+            .replace(expressionRegExp, repairQuotes) // unescapes and restores double quotes in expressions
+            .replace(expressionRegExp, repairSlash); // restores '\\' in expressions
 
         // strings like '__expression: <expression>' are turned into <expression>
-        return withRestoredQuotesConfigStr.replace(expressionRegExp, "$1$2");
+        return repairedConfig.replace(expressionRegExp, "$1$2");
     };
 
     const getObjectRepr = _.flow([toIndentedJson, withComments, withReplacedQuotes, withExpressions]);

diff --git a/src/index.ts b/src/index.ts
@@ -65,13 +65,13 @@ export const run = async ({
         ? [baseGeneralPromptsHandler, generalPromptsHandler]
         : [baseGeneralPromptsHandler];
 
-    await configBuilder.handleGeneralQuestions(generalPrompts, generalPromptsHandlers, opts);
+    const generalAnswers = await configBuilder.handleGeneralQuestions(generalPrompts, generalPromptsHandlers, opts);
 
     const { pluginNames, configNotes } = await getPluginNames(opts);
-    const extraPackages = getExtraPackagesToInstall ? getExtraPackagesToInstall() : { names: [], notes: [] };
 
-    await configBuilder.configurePlugins(pluginNames, createPluginsConfig);
+    await configBuilder.configurePlugins({ pluginNames, createPluginsConfig, generalAnswers });
 
+    const extraPackages = getExtraPackagesToInstall ? getExtraPackagesToInstall() : { names: [], notes: [] };
     const packageNamesToInstall = pluginNames.concat(extraPackages.names);
 
     if (opts.language === "ts") {

diff --git a/src/package.ts b/src/package.ts
@@ -89,7 +89,7 @@ export const installPackages = async (
     pluginsToInstall: string[],
     registry: string,
 ): Promise<string> => {
-    const spinner = ora("Installing packages").start();
+    const spinner = ora("Installing packages (this may take a while)").start();
 
     const pluginsPackages = pluginsToInstall.map(packageNameFromPlugin).join(" ");
 

diff --git a/src/types/pluginsConfig.ts b/src/types/pluginsConfig.ts
@@ -1,5 +1,6 @@
 import type { HermioneConfig } from "./hermioneConfig";
+import type { Answers } from "./toolOpts";
 
 export interface PluginsConfig {
-    [plugin: string]: (config: HermioneConfig) => void | Promise<void>;
+    [plugin: string]: (config: HermioneConfig, generalAnswers?: Answers) => void | Promise<void>;
 }