Adding test-read-write-hook Hook

Author: nigthknight

.github/workflows/ci.yaml

@@ -231,6 +231,14 @@ jobs:
           repository: scbexperimental/hook-imperative-subsequent-scans
           path: ./hooks/imperative-subsequent-scans/
           tag_with_ref: true
+      - uses: docker/build-push-action@v1
+        name: "Build & Push TestReadWriteHook Hook Image"
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          repository: scbexperimental/test-read-write-hook
+          path: ./hooks/test-read-write-hook/
+          tag_with_ref: true
   scannerImages:
     # Note we only build images for scanner that don't provider official public container images
     name: "Build / Scanner"

hooks/test-read-write-hook/.dockerignore

@@ -0,0 +1 @@
+node_modules/

hooks/test-read-write-hook/.gitignore

@@ -0,0 +1 @@
+node_modules

hooks/test-read-write-hook/.helmignore

@@ -0,0 +1,30 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
+# Node.js files
+node_modules/*
+package.json
+package-lock.json
+src/*
+config/*
+Dockerfile
+.dockerignore

hooks/test-read-write-hook/Chart.lock

@@ -0,0 +1,3 @@
+dependencies: []
+digest: sha256:643d5437104296e21d906ecb15b2c96ad278f20cfc4af53b12bb6069bd853726
+generated: "2020-05-26T16:56:03.119255+02:00"

hooks/test-read-write-hook/Chart.yaml

@@ -0,0 +1,11 @@
+apiVersion: v2
+name: test-read-write-hook-hook
+description: This hook is for integration testing only!
+
+type: application
+
+version: 0.1.0
+
+appVersion: latest
+
+dependencies: []

hooks/test-read-write-hook/Dockerfile

@@ -0,0 +1,3 @@
+FROM scbexperimental/hook-sdk-nodejs:latest
+WORKDIR /home/app/hook-wrapper/hook/
+COPY --chown=app:app ./hook.js ./hook.js

hooks/test-read-write-hook/hook.js

@@ -0,0 +1,18 @@
+async function handle({
+  getFindings,
+  updateFindings,
+  attributeName = process.env["ATTRIBUTE_NAME"],
+  attributeValue = process.env["ATTRIBUTE_VALUE"],
+}) {
+  const findings = await getFindings();
+
+  const newFindings = findings.map((finding) => {
+    finding.attributes[attributeName] = attributeValue;
+    return finding;
+  });
+
+  console.log(`Updated attributes on ${findings.length} findings`);
+
+  await updateFindings(newFindings);
+}
+module.exports.handle = handle;

hooks/test-read-write-hook/hook.test.js

@@ -0,0 +1,33 @@
+const { handle } = require("./hook");
+
+test("should send a post request to the url when fired", async () => {
+  const findings = [
+    {
+      name: "Open Port",
+      attributes: {
+        hostname: "foobar.com",
+      },
+    },
+  ];
+
+  const getFindings = async () => findings;
+
+  const updateFindings = jest.fn();
+
+  await handle({
+    getFindings,
+    updateFindings,
+    attributeName: "cluster",
+    attributeValue: "gke-internal",
+  });
+
+  expect(updateFindings).toBeCalledWith([
+    {
+      name: "Open Port",
+      attributes: {
+        hostname: "foobar.com",
+        cluster: "gke-internal",
+      },
+    },
+  ]);
+});

hooks/test-read-write-hook/templates/NOTES.txt

@@ -0,0 +1,3 @@
+TestReadWrite Hook deployed.
+This Hook is for testing only!
+This will add a attribute "{{ .Values.attribute.name }}: {{ .Values.attribute.value }}" on every finding in this namespace.