Merge pull request #59 from marmelab/test-config-file

Add controls on config file
marmelab · Sep 4, 2023 · 66a3f3a · 66a3f3a
2 parents 62dab4d + 3ae018d
commit 66a3f3a
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/src/commands/analyze.ts b/src/commands/analyze.ts
@@ -9,6 +9,7 @@ import ERROR_CODES from '../services/errors/errorCodes';
 import logErrorOnSentry from '../services/errors/Sentry';
 
 import { DEFAULT_SAMPLES } from '../constants';
+export const DEFAULT_CONFIG_FILE = './.greenframe.yml';
 
 import createNewAnalysis from '../tasks/createNewAnalysis';
 import detectDockerVersion from '../tasks/detectDockerVersion';
@@ -34,7 +35,7 @@ class AnalyzeCommand extends Command {
     ];
 
     static defaultFlags = {
-        configFile: './.greenframe.yml',
+        configFile: DEFAULT_CONFIG_FILE,
         samples: DEFAULT_SAMPLES,
         distant: false,
         useAdblock: false,

diff --git a/src/examples/greenframe.js b/src/examples/greenframe.js
@@ -7,8 +7,8 @@ const greenframe = async (page) => {
         page.waitForNavigation({
             /* url: 'https://greenframe.io/', */ waitUntil: 'networkidle',
         }),
-        page.scrollToElement('text=Try for free'),
-        page.click('text=Try for free'),
+        page.scrollToElement('text=Try it for free'),
+        page.click('text=Try it for free'),
     ]);
     await page.addMilestone('Go Back home');
 

diff --git a/src/services/parseConfigFile.js b/src/services/parseConfigFile.js
@@ -2,13 +2,29 @@ const fs = require('node:fs');
 const yaml = require('js-yaml');
 const util = require('node:util');
 const ConfigurationError = require('./errors/ConfigurationError');
+const analyze = require('../commands/analyze');
+const FILE_NOT_FOUND = 'ENOENT';
 
 const readFile = util.promisify(fs.readFile);
 
+const isMissingDefaultConfigFile = (path, error) => {
+    return path === analyze.DEFAULT_CONFIG_FILE && error.code === FILE_NOT_FOUND;
+};
+
 const parseConfigFile = async (path) => {
     try {
         const file = await readFile(path, 'utf8');
+        let fileContent;
+
         if (file) {
+            fileContent = yaml.load(file);
+        }
+
+        if (typeof fileContent !== 'object') {
+            throw new yaml.YAMLException(`${path} is not a valid yaml`);
+        }
+
+        if (fileContent) {
             const {
                 scenario,
                 scenarios,
@@ -31,7 +47,8 @@ const parseConfigFile = async (path) => {
                 ignoreHTTPSErrors,
                 locale,
                 timezoneId,
-            } = yaml.load(file);
+            } = fileContent;
+
             return {
                 args: {
                     scenarios,
@@ -60,8 +77,12 @@ const parseConfigFile = async (path) => {
                 },
             };
         }
-    } catch {
-        // Do Nothing
+    } catch (error) {
+        if (error.name === 'YAMLException') {
+            throw new yaml.YAMLException(`${path} is not a valid yaml`);
+        } else if (!isMissingDefaultConfigFile(path, error)) {
+            throw error;
+        }
     }
 };