feat(functions/helloPubSub): use new FF testing layer (GoogleCloudPlatform#2645)

* updated helloPubSub to use new FF testing layer * removed console from integration test & renames * updated integration test * fixed lint * updated region tag in test * removed unused dependencies * Copyright year Co-authored-by: Averi Kitsch <akitsch@google.com> Co-authored-by: Ace Nassri <anassri@google.com> Co-authored-by: Averi Kitsch <akitsch@google.com>

Author: 3 people

functions/v2/helloPubSub/package.json

@@ -12,14 +12,13 @@
  "node": ">=12.0.0"
  },
  "scripts": {
- "test": "mocha test/index.test.js"
+ "test": "mocha test/*.test.js --timeout=60000"
  },
  "dependencies": {
  "@google-cloud/functions-framework": "^3.0.0"
  },
  "devDependencies": {
  "mocha": "^9.1.3",
- "p-retry": "^4.6.1",
  "sinon": "^13.0.0",
  "supertest": "^6.0.0",
  "uuid": "^8.3.2"

functions/v2/helloPubSub/test/index.test.js renamed to functions/v2/helloPubSub/test/integration.test.js

@@ -12,41 +12,25 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const assert = require('assert');
-const sinon = require('sinon');
 const supertest = require('supertest');
-
 const functionsFramework = require('@google-cloud/functions-framework/testing');
 
-beforeEach(() => {
- // require the module that includes the functions we are testing
- require('../index');
-
- // stub the console so we can use it for side effect assertions
- sinon.stub(console, 'log');
- sinon.stub(console, 'error');
-});
-
-afterEach(() => {
- // restore the console stub
- console.log.restore();
- console.error.restore();
-});
+require('../index');
 
 describe('functions_cloudevent_pubsub', () => {
  it('should process a CloudEvent', async () => {
- const event = {
- data: {
- message: 'd29ybGQ=', // 'World' in base 64
- },
+ const cloudEventData = {data: {message: {}}};
+
+ const name = 'Cecil';
+ cloudEventData.data.message = {
+ data: Buffer.from(name).toString('base64'),
  };
 
  const server = functionsFramework.getTestServer('helloPubSub');
  await supertest(server)
  .post('/')
- .send(event)
+ .send(cloudEventData)
  .set('Content-Type', 'application/json')
  .expect(204);
- assert(console.log.calledWith('Hello, World!'));
  });
 });

functions/v2/helloPubSub/test/unit.test.js

@@ -0,0 +1,60 @@
+// Copyright 2022 Google LLC
+//
+// 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.
+
+const {getFunction} = require('@google-cloud/functions-framework/testing');
+require('..');
+
+describe('functions_cloudevent_pubsub', () => {
+ const assert = require('assert');
+ const uuid = require('uuid');
+ const sinon = require('sinon');
+
+ const stubConsole = function () {
+ sinon.stub(console, 'error');
+ sinon.stub(console, 'log');
+ };
+
+ const restoreConsole = function () {
+ console.log.restore();
+ console.error.restore();
+ };
+
+ beforeEach(stubConsole);
+ afterEach(restoreConsole);
+
+ it('should print a name from the pubsub message', () => {
+ // Create mock Pub/Sub event
+ const cloudEvent = {data: {message: {}}};
+ const name = uuid.v4();
+ cloudEvent.data.message = {
+ data: Buffer.from(name).toString('base64'),
+ };
+
+ // Call tested function and verify its behavior
+ const helloPubSub = getFunction('helloPubSub');
+ helloPubSub(cloudEvent);
+ assert.ok(console.log.calledWith(`Hello, ${name}!`));
+ });
+
+ it('helloPubSub: should print hello world', () => {
+ // Create mock Pub/Sub event, in the event where a
+ // PubSub message is empty but message has an attribute
+ const cloudEvent = {data: {message: {data: null}}};
+
+ // Call tested function and verify its behavior
+ const helloPubSub = getFunction('helloPubSub');
+ helloPubSub(cloudEvent);
+ assert.ok(console.log.calledWith('Hello, World!'));
+ });
+});