Adds v2 test lab triggers (#1017)

* converting test lab samples to v2

* replacing functions config with secrets

Author: colerogers

2nd-gen/test-complete/README.md

@@ -0,0 +1,31 @@
+# Log test complete
+
+This sample demonstrates how to trigger a function in response to the
+completion of a Test Matrix in Firebase Test Lab.
+
+## Setting up the sample
+
+1. Clone or download this repo and open the `2nd-gen/test-complete`
+   directory.
+1. You must have the Firebase CLI installed. If you don't have it install it
+   with `npm install -g firebase-tools` and then configure it with
+   `firebase login`.
+1. Configure the CLI locally by using `firebase use --add` and select your
+   project in the list.
+1. Install Cloud Functions dependencies locally by running:
+   `cd functions; npm install; cd -`
+
+## Deploy and test
+
+1.  Deploy your function using `firebase deploy --only functions`
+1.  Navigate to the
+    [Test Lab](https://console.firebase.google.com/u/0/project/_/testlab/histories)
+    section of the Firebase Console and start a test.
+1.  Once the test finishes running,
+    [view the functions logs](https://console.firebase.google.com/u/0/project/_/functions/logs?severity=DEBUG)
+    for your project, and check that the test run status was logged.
+
+## Next Steps
+
+To see how to post to Slack instead of just `console.log`-ing, check out
+[this sample](https://github.com/firebase/functions-samples/tree/main/2nd-gen/testlab-to-slack).

2nd-gen/test-complete/firebase.json

@@ -0,0 +1 @@
+{}

2nd-gen/test-complete/functions/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "google",
+  ],
+  rules: {
+    quotes: ["error", "double"],
+  },
+};

2nd-gen/test-complete/functions/index.js

@@ -0,0 +1,38 @@
+/**
+ * Copyright 2022 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+'use strict';
+
+// [START all]
+// [START import]
+// The Cloud Functions for Firebase SDK to create v2 Cloud Functions and set up triggers.
+const { onTestMatrixCompleted } = require('firebase-functions/v2/testLab');
+const { logger } = require('firebase-functions');
+// [END import]
+
+// [START logtestcomplete]
+exports.logtestcomplete = onTestMatrixCompleted((event) => {
+  // Obtain Test Matrix properties from the CloudEvent
+  const { testMatrixId, createTime, state, outcomeSummary } = event.data;
+
+  // Log the properties of the completed Test Matrix
+  logger.log(
+    `TEST ${testMatrixId} (created at ${createTime}): ${state}. ${
+      outcomeSummary || ''
+    }`
+  );
+});
+// [END logtestcomplete]
+// [END all]

2nd-gen/test-complete/functions/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "functions",
+  "description": "Cloud Functions for Firebase",
+  "scripts": {
+    "lint": "eslint .",
+    "serve": "firebase emulators:start --only functions",
+    "shell": "firebase functions:shell",
+    "start": "npm run shell",
+    "deploy": "firebase deploy --only functions",
+    "logs": "firebase functions:log",
+    "compile": "cp ../../../tsconfig.template.json ./tsconfig-compile.json && tsc --project tsconfig-compile.json"
+  },
+  "engines": {
+    "node": "16"
+  },
+  "dependencies": {
+    "firebase-admin": "^10.2.0",
+    "firebase-functions":  "^4.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^6.8.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "firebase-functions-test": "^2.0.0"
+  },
+  "private": true
+}

2nd-gen/testlab-to-slack/README.md

@@ -0,0 +1,43 @@
+# Post Test Lab Results to Slack channel
+
+This sample demonstrates how to post to a Slack channel in response to the
+completion of a Test Matrix in Firebase Test Lab. The message will look like
+this:
+
+![example Slack message with Test Lab status](https://i.imgur.com/9DTL19x.png)
+
+## Setting up the sample
+
+1.  [Add an **Incoming Webhook**](https://my.slack.com/services/new/incoming-webhook/) to your Slack channel and take note of the **Webhook URL**.
+1.  Clone or download this repo and open this directory in a terminal:
+
+    ```shell
+    cd 2nd-gen/testlab-to-slack
+    ```
+
+1.  You must have the latest Firebase CLI installed. If you don't have it,
+    install it with `npm install -g firebase-tools` and then sign in with
+    `firebase login`.
+1.  Configure the CLI locally by using `firebase use --add` and select your
+    project in the list.
+1.  Install Cloud Functions dependencies locally by running:
+    `cd functions; npm install; cd -`
+1.  Set the following environment variables so that the function can
+    authenticate with Slack and post to the correct room:
+
+    ```bash
+    firebase functions:secrets:set SLACK_WEBHOOK_URL
+    ```
+    
+    Enter the value of your Slack url to save it into Secret Manager.
+
+## Deploy and test
+
+This sample comes with a web-based UI for testing the function. To test it out:
+
+1.  Deploy your function using `firebase deploy --only functions`
+1.  Navigate to the
+    [Test Lab](https://console.firebase.google.com/u/0/project/_/testlab/histories)
+    section of the Firebase Console and start a test.
+1.  Once the test finishes running, check your Slack channel and view the new
+    post!

2nd-gen/testlab-to-slack/firebase.json

@@ -0,0 +1 @@
+{}

2nd-gen/testlab-to-slack/functions/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "google",
+  ],
+  rules: {
+    quotes: ["error", "double"],
+  },
+};

2nd-gen/testlab-to-slack/functions/index.js

@@ -0,0 +1,108 @@
+/**
+ * Copyright 2022 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+'use strict';
+
+// [START all]
+// [START import]
+// The Cloud Functions for Firebase SDK to create v2 Cloud Functions and set up triggers.
+const { onTestMatrixCompleted } = require('firebase-functions/v2/testLab');
+const { logger } = require('firebase-functions');
+// The Axios client to send web requests to Slack.
+const axios = require('axios');
+// [END import]
+
+// [START postToSlack]
+function postToSlack(title, details) {
+  return axios.post(
+    process.env.SLACK_WEBHOOK_URL,
+    {
+      blocks: [
+        {
+          type: 'section',
+          text: {
+            type: 'mrkdwn',
+            text: title
+          }
+        },
+        {
+          type: 'divider'
+        },
+        {
+          type: 'section',
+          text: {
+            type: 'mrkdwn',
+            text: details
+          }
+        }
+      ]
+    }
+  );
+}
+// [END postToSlack]
+
+// [START getSlackmoji]
+function getSlackmoji(term) {
+  switch (term) {
+    case 'SUCCESS':
+      return ':tada:';
+    case 'FAILURE':
+      return ':broken_heart:';
+    case 'INCONCLUSIVE':
+      return ':question:';
+    case 'SKIPPED':
+      return ':arrow_heading_down:';
+    case 'VALIDATING':
+      return ':thought_balloon:';
+    case 'PENDING':
+      return ':soon:';
+    case 'FINISHED':
+      return ':white_check_mark:';
+    case 'ERROR':
+      return ':red_circle:';
+    case 'INVALID':
+      return ':large_orange_diamond:';
+    default:
+      return '';
+  }
+}
+// [END getSlackmoji]
+
+// [START posttestresultstoslack]
+exports.posttestresultstoslack = onTestMatrixCompleted(
+  { secrets: ["SLACK_WEBHOOK_URL"] },
+  async (event) => {
+    // Obtain Test Matrix properties from the CloudEvent
+    const { testMatrixId, state, outcomeSummary } = event.data;
+
+    // Create the title of the message
+    const title = `${getSlackmoji(state)} ${getSlackmoji(
+      outcomeSummary
+    )} ${testMatrixId}`;
+    
+    // Create the details of the message
+    const details = `Status: *${state}* ${getSlackmoji(
+      state
+    )}\nOutcome: *${outcomeSummary}* ${getSlackmoji(outcomeSummary)}
+    `;
+
+    // Post the message to slack
+    const slackResponse = await postToSlack(title, details);
+    
+    // Log the response
+    logger.log(JSON.stringify(slackResponse.data));
+  });
+// [END posttestresultstoslack]
+// [END all]

2nd-gen/testlab-to-slack/functions/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "functions",
+  "description": "Cloud Functions for Firebase",
+  "scripts": {
+    "lint": "eslint .",
+    "serve": "firebase emulators:start --only functions",
+    "shell": "firebase functions:shell",
+    "start": "npm run shell",
+    "deploy": "firebase deploy --only functions",
+    "logs": "firebase functions:log",
+    "compile": "cp ../../tsconfig.template.json ./tsconfig-compile.json && tsc --project tsconfig-compile.json"
+  },
+  "engines": {
+    "node": "16"
+  },
+  "dependencies": {
+    "axios": "^0.19.2",
+    "firebase-admin": "^10.2.0",
+    "firebase-functions":  "^4.0.0"
+  },
+  "devDependencies": {
+    "firebase-functions-test": "^2.0.0",
+    "eslint": "^6.8.0",
+    "eslint-plugin-promise": "^4.2.1"
+  },
+  "private": true
+}