fix: fixes site tools ignored (#60)

* fix: some tools enabled are ignored Fixes #58 * fix: ci actions tests * fix: ci init action * fix: 404 doublon types Co-authored-by: Julien Bouquillon <julien.bouquillon@sg.social.gouv.fr> Co-authored-by: Julien Bouquillon <julien.bouquillon@sg.social.gouv.fr>
SocialGouv · Sep 14, 2021 · e89872c · e89872c
1 parent 66c50d4
commit e89872c
Show file tree

Hide file tree

Showing 10 changed files with 131 additions and 85 deletions.
diff --git a/.github/workflows/init-matrix.yml b/.github/workflows/init-matrix.yml
@@ -27,7 +27,7 @@ jobs:
         uses: "./init"
       - id: test
         run: |
-          EXPECTED='[{url:https://www.free.fr,title:Free,repositories:[iliad/free-ui,iliad/free-api],tools:{screenshot:true,nmap:true,zaproxy:true,wappalyzer:true,http:true,testssl:true,lighthouse:true,thirdparties:true,nuclei:true,updownio:true,dependabot:true,codescan:true,stats:true}},{url:http://chez.com,repositories:[chez/chez-ui,chez/chez-api],tools:{screenshot:false,nmap:true,zaproxy:true,wappalyzer:true,http:true,testssl:true,lighthouse:true,thirdparties:true,nuclei:true,updownio:false,dependabot:true,codescan:true,stats:false}},{url:https://voila.fr,tools:{screenshot:true,nmap:true,zaproxy:true,wappalyzer:true,http:true,testssl:true,lighthouse:true,thirdparties:true,nuclei:true,updownio:true,dependabot:true,codescan:true,stats:true}}]'
+          EXPECTED="[{"url":"https://www.free.fr","title":"Free","repositories":["iliad/free-ui","iliad/free-api"],"tools":{"screenshot":true,"nmap":true,"zap":true,"wappalyzer":true,"http":true,"testssl":true,"lighthouse":true,"thirdparties":true,"nuclei":true,"updownio":true,"dependabot":true,"codescan":true,"stats":true}},{"url":"http://chez.com","repositories":["chez/chez-ui","chez/chez-api"],"tools":{"screenshot":false,"nmap":true,"zap":true,"wappalyzer":true,"http":true,"testssl":true,"lighthouse":true,"thirdparties":true,"nuclei":true,"updownio":false,"dependabot":true,"codescan":true,"stats":false}},{"url":"https://voila.fr","tools":{"screenshot":true,"nmap":true,"zap":true,"wappalyzer":true,"http":true,"testssl":true,"lighthouse":true,"thirdparties":true,"nuclei":true,"updownio":true,"dependabot":true,"codescan":true,"stats":true}}]"
           RESULT="${{ steps.init.outputs.sites }}"
           echo "RESULT=$RESULT"
           [[ "$EXPECTED" == "$RESULT" ]]
@@ -65,7 +65,7 @@ jobs:
           url: "https://www.free.fr,https://voila.fr"
       - id: test
         run: |
-          EXPECTED='[{url:https://www.free.fr,title:Free,repositories:[iliad/free-ui,iliad/free-api],tools:{screenshot:true,nmap:true,zaproxy:true,wappalyzer:true,http:true,testssl:true,lighthouse:true,thirdparties:true,nuclei:true,updownio:true,dependabot:true,codescan:true,stats:true}},{url:https://voila.fr,tools:{screenshot:true,nmap:true,zaproxy:true,wappalyzer:true,http:true,testssl:true,lighthouse:true,thirdparties:true,nuclei:true,updownio:true,dependabot:true,codescan:true,stats:true}}]'
+          EXPECTED="[{"url":"https://www.free.fr","title":"Free","repositories":["iliad/free-ui","iliad/free-api"],"tools":{"screenshot":true,"nmap":true,"zap":true,"wappalyzer":true,"http":true,"testssl":true,"lighthouse":true,"thirdparties":true,"nuclei":true,"updownio":true,"dependabot":true,"codescan":true,"stats":true}},{"url":"https://voila.fr","tools":{"screenshot":true,"nmap":true,"zap":true,"wappalyzer":true,"http":true,"testssl":true,"lighthouse":true,"thirdparties":true,"nuclei":true,"updownio":true,"dependabot":true,"codescan":true,"stats":true}}]"
           RESULT="${{ steps.init.outputs.sites }}"
           echo "RESULT=$RESULT"
           [[ "$EXPECTED" == "$RESULT" ]]

diff --git a/dashlord.yml b/dashlord.yml
@@ -5,7 +5,7 @@ footer: Powered by BetaGouv
 tools:
   screenshot: true
   nmap: true
-  zaproxy: true
+  zap: true
   wappalyzer: true
   http: true
   testssl: true

diff --git a/init/README.md b/init/README.md
@@ -45,16 +45,17 @@ title: Test 1
 tools:
   screenshot: true
   nmap: true
-  zaproxy: true
+  zap: true
   wappalyzer: true
-  httpobs: true
+  http: true
   testssl: true
   lighthouse: true
   thirdparties: true
   nuclei: false
   updownio: true
   dependabot: true
   codescan: true
+  404: true
 urls:
   - url: https://www.free.fr
     title: Free

diff --git a/init/dashlord.yml b/init/dashlord.yml
@@ -2,17 +2,18 @@ title: Test 1
 tools:
   screenshot: true
   nmap: true
-  zaproxy: true
+  zap: true
   wappalyzer: true
-  httpobs: true
-  testssl: true
+  http: true
+  testssl: false
   lighthouse: true
   thirdparties: true
   nuclei: false
   updownio: true
   dependabot: true
   codescan: true
   stats: true
+  404: true
 urls:
   - url: https://www.free.fr
     title: Free
@@ -28,4 +29,5 @@ urls:
       screenshot: false
       updownio: false
       stats: false
+      testssl: true
   - url: https://voila.fr
diff --git a/init/dist/index.js b/init/dist/index.js
diff --git a/init/dist/index.js.map b/init/dist/index.js.map
diff --git a/init/src/__snapshots__/index.test.js.snap b/init/src/__snapshots__/index.test.js.snap
@@ -9,19 +9,20 @@ Array [
     ],
     "title": "Free",
     "tools": Object {
+      "404": true,
       "codescan": true,
       "dependabot": true,
-      "httpobs": true,
+      "http": true,
       "lighthouse": true,
       "nmap": true,
       "nuclei": false,
       "screenshot": true,
       "stats": true,
-      "testssl": true,
+      "testssl": false,
       "thirdparties": true,
       "updownio": true,
       "wappalyzer": true,
-      "zaproxy": true,
+      "zap": true,
     },
     "url": "https://www.free.fr",
   },
@@ -31,9 +32,10 @@ Array [
       "chez/chez-api",
     ],
     "tools": Object {
+      "404": true,
       "codescan": true,
       "dependabot": true,
-      "httpobs": true,
+      "http": true,
       "lighthouse": true,
       "nmap": true,
       "nuclei": false,
@@ -43,7 +45,7 @@ Array [
       "thirdparties": true,
       "updownio": false,
       "wappalyzer": true,
-      "zaproxy": true,
+      "zap": true,
     },
     "url": "http://chez.com",
   },
@@ -59,19 +61,20 @@ Array [
     ],
     "title": "Free",
     "tools": Object {
+      "404": true,
       "codescan": true,
       "dependabot": true,
-      "httpobs": true,
+      "http": true,
       "lighthouse": true,
       "nmap": true,
       "nuclei": false,
       "screenshot": true,
       "stats": true,
-      "testssl": true,
+      "testssl": false,
       "thirdparties": true,
       "updownio": true,
       "wappalyzer": true,
-      "zaproxy": true,
+      "zap": true,
     },
     "url": "https://www.free.fr",
   },
@@ -81,9 +84,10 @@ Array [
       "chez/chez-api",
     ],
     "tools": Object {
+      "404": true,
       "codescan": true,
       "dependabot": true,
-      "httpobs": true,
+      "http": true,
       "lighthouse": true,
       "nmap": true,
       "nuclei": false,
@@ -93,25 +97,26 @@ Array [
       "thirdparties": true,
       "updownio": false,
       "wappalyzer": true,
-      "zaproxy": true,
+      "zap": true,
     },
     "url": "http://chez.com",
   },
   Object {
     "tools": Object {
+      "404": true,
       "codescan": true,
       "dependabot": true,
-      "httpobs": true,
+      "http": true,
       "lighthouse": true,
       "nmap": true,
       "nuclei": false,
       "screenshot": true,
       "stats": true,
-      "testssl": true,
+      "testssl": false,
       "thirdparties": true,
       "updownio": true,
       "wappalyzer": true,
-      "zaproxy": true,
+      "zap": true,
     },
     "url": "https://voila.fr",
   },
@@ -129,19 +134,20 @@ Array [
     ],
     "title": "Free",
     "tools": Object {
+      "404": true,
       "codescan": true,
       "dependabot": true,
-      "httpobs": true,
+      "http": true,
       "lighthouse": true,
       "nmap": true,
       "nuclei": false,
       "screenshot": true,
       "stats": true,
-      "testssl": true,
+      "testssl": false,
       "thirdparties": true,
       "updownio": true,
       "wappalyzer": true,
-      "zaproxy": true,
+      "zap": true,
     },
     "url": "https://www.free.fr",
   },

diff --git a/init/src/index.js b/init/src/index.js
@@ -2,17 +2,7 @@ const fs = require("fs");
 const core = require("@actions/core");
 const YAML = require("yaml");
 
-const getOutputs = () => {
-  const urlsInput =
-    core.getInput("url") &&
-    core
-      .getInput("url")
-      .split(",")
-      .map((s) => s.trim())
-      .filter(Boolean);
-
-  core.info(`urlsInput :${urlsInput}`);
-
+const getDashlordConfig = () => {
   let dashlordConfig;
   if (fs.existsSync("./dashlord.yml")) {
     core.info('----')
@@ -30,26 +20,43 @@ const getOutputs = () => {
   }
 
   core.info(JSON.stringify(dashlordConfig))
+  return dashlordConfig
+}
+
+const getSiteTools = (site) => {
+  core.info(`site=${JSON.stringify(site)}`)
+  core.info(`site.tools=${JSON.stringify(site.tools)}`)
+  let dashlordConfig = getDashlordConfig();
+  if (!dashlordConfig.tools) {
+    return {}
+  }
+  if (!site.tools) {
+    return dashlordConfig.tools;
+  }
+  return Object.keys(dashlordConfig.tools).reduce((siteTools, tool) => {
+    // tool status can be set at global or site level, if defined at site level and global then site level wins.
+    const isToolDisabled =
+      site.tools[tool] === undefined ? dashlordConfig.tools[tool] === false : site.tools[tool] === false;
+    return {
+      ...siteTools,
+      [tool]: !isToolDisabled,
+    };
+  }, {});
+};
 
-  const getSiteTools = (site) => {
-    if (!dashlordConfig.tools) {
-      return {}
-    }
-    if (!site.tools) {
-      return dashlordConfig.tools;
-    }
-    return Object.keys(dashlordConfig.tools).reduce((siteTools, tool) => {
-      // tool can be disabled at global or site level
-      const isToolDisabled =
-        dashlordConfig.tools[tool] === false || site.tools[tool] === false;
-      return {
-        ...siteTools,
-        [tool]: !isToolDisabled,
-      };
-    }, {});
-  };
+const getOutputs = () => {
+  const urlsInput =
+    core.getInput("url") &&
+    core
+      .getInput("url")
+      .split(",")
+      .map((s) => s.trim())
+      .filter(Boolean);
+
+  core.info(`urlsInput :${urlsInput}`);
 
   const isValid = (u) => u.url.match(/^https?:\/\//);
+  let dashlordConfig = getDashlordConfig();
   const sites = dashlordConfig.urls
     .filter(isValid)
     .filter((url) =>
@@ -83,4 +90,4 @@ if (require.main === module) {
   run();
 }
 
-module.exports = { run, getOutputs };
+module.exports = { run, getOutputs, getSiteTools };