Merge pull request #75 from marmelab/main

Deploy v2.0.0

Author: benoitchazoule

.envfile

@@ -0,0 +1,2 @@
+GREENFRAME_MY_VAR_ONE=envfile_value_one
+GREENFRAME_MY_VAR_TWO=envfile_value_two

.eslintrc

@@ -50,11 +50,12 @@
         "unicorn/prefer-module": "off",
         // Skipped for now
         "unicorn/no-array-for-each": "off",
+        "unicorn/expiring-todo-comments": "off",
         "array-callback-return": "off",
         "unicorn/no-new-array": "off",
         "unicorn/consistent-function-scoping": "off",
         "unicorn/prefer-top-level-await": "off",
         "no-promise-executor-return": "off",
-        "node/no-extraneous-require": "off",
+        "node/no-extraneous-require": "off"
     }
 }

README.md

@@ -54,17 +54,7 @@ You can run a custom scenario instead of the "visit" scenario by passing a scena
 $ greenframe analyze https://marmelab.com ./my-scenario.js
 ```
 
-GreenFrame uses [PlayWright](https://playwright.dev/) to run scenarios. A custom PlayWright scenario looks like the following:
-
-```js
-// in my-scenario.js
-async (page) => {
-    await page.goto('', { waitUntil: 'networkidle' }); // Go to the baseUrl
-    await page.waitForTimeout(3000); // Wait for 3 seconds
-    await page.scrollToElement('footer'); // Scroll to the footer (if present)
-    await page.waitForNetworkIdle(); // Wait every request has been answered as a normal user.
-};
-```
+GreenFrame uses [PlayWright](https://playwright.dev/) to run scenarios. To discover what a custom PlayWright scenario looks alike, you can refer to our [documentation](https://docs.greenframe.io/scenario/).
 
 Check [the PlayWright documentation on writing tests](https://playwright.dev/docs/writing-tests) for more information.
 
@@ -182,7 +172,7 @@ scenarios:
       threshold: 0.1
 projectName: YOUR_PROJECT_NAME
 samples: 3
-distant: false
+//distant: "This option has been deprecated due to security issues"
 useAdblock: true
 ignoreHTTPSErrors: true
 locale: 'fr-FR',
@@ -191,7 +181,11 @@ containers:
     - 'CONTAINER_NAME'
     - 'ANOTHER_CONTAINER_NAME'
 databaseContainers:
-    - 'DATABASE_CONTAINER_NAME'
+    - 'DATABASE_CONTAINER_NAME',
+envFile: PATH_TO_YOUR_ENVIRONMENT_VAR_FILE
+envVar:
+    - envVarA: 'An environment variable needed for the scenario (ie : a secret-key)',
+    - envVarB: 'Another environment variable needed'
 ```
 
 ## More Information / Troubleshooting
@@ -243,21 +237,22 @@ Create an analysis on GreenFrame server.
 ```
 USAGE
   $ greenframe analyze [BASEURL] [SCENARIO] [-C <value>] [-K <value>] [-t <value>] [-p <value>] [-c <value>]
-    [--commitId <value>] [-b <value>] [-s <value>] [-d] [-a] [-i] [--locale] [--timezoneId] [--dockerdHost <value>]
-    [--dockerdPort <value>] [--containers <value>] [--databaseContainers <value>] [--kubeContainers <value>]
-    [--kubeDatabaseContainers <value>]
+    [--commitId <value>] [-b <value>] [-s <value>] [-a] [-i] [--locale] [--timezoneId] [-e <value>] [-E <value>]
+    [--dockerdHost <value>] [--dockerdPort <value>] [--containers <value>] [--databaseContainers <value>]
+    [--kubeContainers <value>] [--kubeDatabaseContainers <value>]
 
 ARGUMENTS
   BASEURL   Your baseURL website
   SCENARIO  Path to your GreenFrame scenario
 
 FLAGS
   -C, --configFile=<value>          Path to config file
+  -E, --envFile=<value>             File of environment vars
   -K, --kubeConfig=<value>          Path to kubernetes client config file
   -a, --useAdblock                  Use an adblocker during analysis
   -b, --branchName=<value>          Pass branch name manually
   -c, --commitMessage=<value>       Pass commit message manually
-  -d, --distant                     Run a distant analysis on GreenFrame Server instead of locally
+  -e, --envVar=<value>...           List of environment vars to read in the scenarios
   -i, --ignoreHTTPSErrors           Ignore HTTPS errors during analysis
   -p, --projectName=<value>         Project name
   -s, --samples=<value>             Number of runs done for the score computation
@@ -276,7 +271,7 @@ DESCRIPTION
   Create an analysis on GreenFrame server.
 ```
 
-_See code: [dist/commands/analyze.ts](https://github.com/marmelab/greenframe-cli/blob/v1.6.8/dist/commands/analyze.ts)_
+_See code: [dist/commands/analyze.ts](https://github.com/marmelab/greenframe-cli/blob/v1.7.0/dist/commands/analyze.ts)_
 
 ## `greenframe kube-config`
 
@@ -293,13 +288,11 @@ FLAGS
 
 DESCRIPTION
   Configure kubernetes cluster to collect greenframe metrics
-
   ...
-
   greenframe kube-config
 ```
 
-_See code: [dist/commands/kube-config.ts](https://github.com/marmelab/greenframe-cli/blob/v1.6.8/dist/commands/kube-config.ts)_
+_See code: [dist/commands/kube-config.ts](https://github.com/marmelab/greenframe-cli/blob/v1.7.0/dist/commands/kube-config.ts)_
 
 ## `greenframe open [BASEURL] [SCENARIO]`
 
@@ -322,13 +315,11 @@ FLAGS
 
 DESCRIPTION
   Open browser to develop your GreenFrame scenario
-
   ...
-
   greenframe analyze ./yourScenario.js https://greenframe.io
 ```
 
-_See code: [dist/commands/open.ts](https://github.com/marmelab/greenframe-cli/blob/v1.6.8/dist/commands/open.ts)_
+_See code: [dist/commands/open.ts](https://github.com/marmelab/greenframe-cli/blob/v1.7.0/dist/commands/open.ts)_
 
 ## `greenframe update [CHANNEL]`
 
@@ -343,13 +334,11 @@ ARGUMENTS
 
 DESCRIPTION
   Update GreenFrame to the latest version
-
   ...
-
   greenframe update
 ```
 
-_See code: [dist/commands/update.ts](https://github.com/marmelab/greenframe-cli/blob/v1.6.8/dist/commands/update.ts)_
+_See code: [dist/commands/update.ts](https://github.com/marmelab/greenframe-cli/blob/v1.7.0/dist/commands/update.ts)_
 <!-- commandsstop -->
 
 ## Development

e2e/.greenframe.fullstack.broken.yml

@@ -1,7 +1,6 @@
-scenario: '../src/examples/greenframe.js'
+scenario: '../../src/examples/greenframe.js'
 baseURL: 'https://greenframe.io'
 samples: 2
-distant: false
 projectName: 'GreenFrame'
 containers:
     - 'enterprise_api'

e2e/.greenframe.fullstack.emptyScenario.yml

@@ -1,6 +1,5 @@
 baseURL: 'https://greenframe.io'
 samples: 2
-distant: false
 projectName: 'GreenFrame'
 containers:
     - 'enterprise_api'

e2e/.greenframe.fullstack.k8s.yml

@@ -1,7 +1,6 @@
 scenario: '../src/examples/greenframe.js'
 baseURL: 'https://greenframe.io'
 samples: 2
-distant: false
 projectName: 'GreenFrame'
 kubeContainers:
     - 'default:app=api'

e2e/.greenframe.fullstack.multiple.yml

@@ -7,7 +7,6 @@ scenarios:
       threshold: 0.05
 baseURL: 'https://greenframe.io'
 samples: 2
-distant: false
 projectName: 'GreenFrame'
 containers:
     - 'enterprise_api'

e2e/.greenframe.fullstack.yml

@@ -1,7 +1,6 @@
 scenario: '../src/examples/greenframe.js'
 baseURL: 'https://greenframe.io'
 samples: 2
-distant: false
 projectName: 'GreenFrame'
 containers:
     - 'enterprise_api'

e2e/.greenframe.single.adblock.yml

@@ -1,6 +1,5 @@
-scenario: '../src/examples/greenframe.js'
+scenario: '../../src/examples/greenframe.js'
 baseURL: 'https://greenframe.io'
 samples: 2
 projectName: 'GreenFrame'
-distant: false
 useAdblock: true

e2e/.greenframe.single.en.yml

@@ -1,7 +1,6 @@
-scenario: '../src/examples/marmelab.en.js'
+scenario: '../../src/examples/marmelab.en.js'
 baseURL: 'https://marmelab.com'
 samples: 2
 projectName: 'Marmelab'
-distant: false
 useAdblock: true
 locale: en-US

e2e/.greenframe.single.fr.yml

@@ -1,7 +1,6 @@
-scenario: '../src/examples/marmelab.fr.js'
+scenario: '../../src/examples/marmelab.fr.js'
 baseURL: 'https://marmelab.com'
 samples: 2
 projectName: 'Marmelab'
-distant: false
 useAdblock: true
 locale: fr-FR

e2e/.greenframe.single.multiple.distant.yml

@@ -7,5 +7,4 @@ scenarios:
       threshold: 0.05
 baseURL: 'https://greenframe.io'
 samples: 2
-distant: true
 projectName: 'GreenFrame'

e2e/greenframe.io/analyze.spec.js

@@ -26,88 +26,51 @@ describe.skip('[GREENFRAME.IO] greenframe analyze', () => {
                 expect(stdout).toContain('✅ main scenario completed');
             });
 
-            it('should set greenframe browser locale right', async () => {
-                const { stdout: enStdout } = await exec(
-                    `${BASE_COMMAND} -C ./e2e/.greenframe.single.en.yml`
-                );
-                expect(enStdout).toContain('✅ main scenario completed');
-                const { stdout: frStdout } = await exec(
-                    `${BASE_COMMAND} -C ./e2e/.greenframe.single.fr.yml`
+            it('should work with env vars inline command', async () => {
+                const { stdout } = await exec(
+                    `GREENFRAME_MY_VAR_ONE=inline_value_one GREENFRAME_MY_VAR_TWO=inline_value_two ${BASE_COMMAND} https://www.google.fr ../../src/examples/envvar.inline.isolated.js -e GREENFRAME_MY_VAR_ONE -e GREENFRAME_MY_VAR_TWO`
                 );
-                expect(frStdout).toContain('✅ main scenario completed');
+                expect(stdout).toContain('✅ main scenario completed');
             });
 
-            it('should run an analysis command with adblocker', async () => {
-                const { error, stdout } = await exec(
-                    `${BASE_COMMAND} -C ./e2e/.greenframe.adblock.yml`
+            it('should work with env file inline command', async () => {
+                const { stdout } = await exec(
+                    `${BASE_COMMAND} https://www.google.fr ../../src/examples/envvar.inline.envfile.js -E ./src/examples/.envfile`
                 );
                 expect(stdout).toContain('✅ main scenario completed');
-                expect(stdout).toContain('The estimated footprint is');
-                expect(error).toBeUndefined();
             });
-        });
-        describe('distant analysis', () => {
-            it('should run an analysis command correctly', async () => {
-                const { error, stdout } = await exec(
-                    `${BASE_COMMAND} ../../src/examples/greenframe.js https://greenframe.io -p GreenFrame -d -s 2`
-                );
 
+            it('should work with env vars and config file', async () => {
+                const { stdout } = await exec(
+                    `GREENFRAME_MY_VAR_ONE=inline_value_one GREENFRAME_MY_VAR_TWO=inline_value_two ${BASE_COMMAND} https://www.google.fr -C ../../src/examples/envvar.config.isolated.yml`
+                );
                 expect(stdout).toContain('✅ main scenario completed');
-                expect(stdout).toContain('The estimated footprint is');
-                expect(stdout).toContain('Check the details of your analysis at');
-                expect(error).toBeUndefined();
             });
 
-            it('should run an analysis command below a threshold', async () => {
-                const { error, stdout } = await exec(
-                    `${BASE_COMMAND} ../../src/examples/greenframe.js https://greenframe.io -s 2 -p GreenFrame -d -t 0.1`
+            it('should work with env file and config file', async () => {
+                const { stdout } = await exec(
+                    `${BASE_COMMAND} https://www.google.fr -C ../../src/examples/envvar.config.envfile.yml`
                 );
                 expect(stdout).toContain('✅ main scenario completed');
-                expect(stdout).toContain('The estimated footprint at');
-                expect(stdout).toContain(
-                    'is under the limit configured at 0.1 g eq. co2.'
+            });
+
+            it('should set greenframe browser locale right', async () => {
+                const { stdout: enStdout } = await exec(
+                    `${BASE_COMMAND} -C ./e2e/.greenframe.single.en.yml`
                 );
-                expect(stdout).toContain('Check the details of your analysis at');
-                expect(error).toBeUndefined();
+                expect(enStdout).toContain('✅ main scenario completed');
+                const { stdout: frStdout } = await exec(
+                    `${BASE_COMMAND} -C ./e2e/.greenframe.single.fr.yml`
+                );
+                expect(frStdout).toContain('✅ main scenario completed');
             });
 
             it('should run an analysis command with adblocker', async () => {
                 const { error, stdout } = await exec(
-                    `${BASE_COMMAND} ../../src/examples/greenframe.js https://greenframe.io -s 2 -p GreenFrame -d -a`
+                    `${BASE_COMMAND} -C ./e2e/.greenframe.adblock.yml`
                 );
                 expect(stdout).toContain('✅ main scenario completed');
                 expect(stdout).toContain('The estimated footprint is');
-                expect(stdout).toContain('Check the details of your analysis at');
-                expect(error).toBeUndefined();
-            });
-
-            it('should run an analysis and fail with higher measure than threshold', async () => {
-                expect.assertions(3);
-                try {
-                    await exec(
-                        `${BASE_COMMAND} ../../src/examples/greenframe.js https://greenframe.io -s 2 -p GreenFrame -d -t 0.001`
-                    );
-                } catch (error) {
-                    expect(error.stderr).toContain('❌ main scenario failed');
-                    expect(error.stderr).toContain('The estimated footprint at');
-                    expect(error.stderr).toContain(
-                        'passes the limit configured at 0.001 g eq. co2.'
-                    );
-                }
-            });
-
-            it('should run an analysis with multiple scenario', async () => {
-                const { error, stdout } = await exec(
-                    `${BASE_COMMAND} -C ./e2e/.greenframe.single.multiple.distant.yml`
-                );
-                expect(stdout).toContain('✅ Scenario 1 completed');
-                expect(stdout).toContain(
-                    'is under the limit configured at 0.1 g eq. co2.'
-                );
-                expect(stdout).toContain('✅ Scenario 2 completed');
-                expect(stdout).toContain(
-                    'is under the limit configured at 0.05 g eq. co2.'
-                );
                 expect(error).toBeUndefined();
             });
         });
@@ -223,20 +186,6 @@ describe.skip('[GREENFRAME.IO] greenframe analyze', () => {
                 expect(error).toBeUndefined();
             });
 
-            it('should fail because distant mode is not compatible with multi containers', async () => {
-                expect.assertions(2);
-                try {
-                    await exec(
-                        `${BASE_COMMAND} -C ./e2e/.greenframe.fullstack.yml -d -s 2`
-                    );
-                } catch (error) {
-                    expect(error.stderr).toContain('❌ Failed!');
-                    expect(error.stderr).toContain(
-                        '"distant" mode is incompatible with parameters "containers" or "databaseContainers"'
-                    );
-                }
-            });
-
             it('should run a k8s analysis command correctly', async () => {
                 const { error, stdout } = await exec(
                     `${BASE_COMMAND} -C ./e2e/.greenframe.fullstack.k8s.yml`
@@ -248,19 +197,5 @@ describe.skip('[GREENFRAME.IO] greenframe analyze', () => {
                 expect(error).toBeUndefined();
             });
         });
-
-        describe('distant analysis', () => {
-            it('should fail because distant mode is not compatible with multi containers', async () => {
-                expect.assertions(2);
-                try {
-                    await exec(`${BASE_COMMAND} -C ./.greenframe.e2e.yml -d -s 2`);
-                } catch (error) {
-                    expect(error.stderr).toContain('❌ Failed!');
-                    expect(error.stderr).toContain(
-                        '"distant" mode is incompatible with parameters "containers" or "databaseContainers"'
-                    );
-                }
-            });
-        });
     });
 });