chore(functions/helloworld): update to use FF testing layer (GoogleCloudPlatform#2659)

* chore(functions/helloworld): update to use FF testing layer * clean up * Update sample.integration.http.test.js

Author: averikitsch

functions/helloworld/index.js

@@ -34,7 +34,13 @@ functions.http('helloGET', (req, res) => {
 
 // [START functions_helloworld_http]
 
-// HTTP Cloud Function.
+/**
+ * Responds to an HTTP request using data from the request body parsed according
+ * to the "content-type" header.
+ *
+ * @param {Object} req Cloud Function request context.
+ * @param {Object} res Cloud Function response context.
+ */
 functions.http('helloHttp', (req, res) => {
  res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
 });

functions/helloworld/package.json

@@ -19,7 +19,7 @@
  },
  "dependencies": {
  "@google-cloud/debug-agent": "^5.0.0",
- "@google-cloud/functions-framework": "^3.0.0",
+ "@google-cloud/functions-framework": "^3.1.0",
  "escape-html": "^1.0.3"
  },
  "devDependencies": {
@@ -30,6 +30,7 @@
  "moment": "^2.24.0",
  "promise-retry": "^2.0.0",
  "sinon": "^13.0.0",
+ "supertest": "^6.0.0",
  "uuid": "^8.0.0",
  "wait-port": "^0.2.9"
  }

functions/helloworld/test/sample.integration.http.test.js

@@ -13,52 +13,35 @@
 // limitations under the License.
 
 // [START functions_http_integration_test]
-const assert = require('assert');
-const {exec} = require('child_process');
-const {request} = require('gaxios');
-const uuid = require('uuid');
-const waitPort = require('wait-port');
-
-const PORT = parseInt(parseInt(process.env.PORT)) || 8080;
-const BASE_URL = `http://localhost:${PORT}`;
+const supertest = require('supertest');
 
+const {getTestServer} = require('@google-cloud/functions-framework/testing');
 // [END functions_http_integration_test]
 
+require('../');
+
 describe('functions_helloworld_http HTTP integration test', () => {
  // [START functions_http_integration_test]
- let ffProc;
-
- // Run the functions-framework instance to host functions locally
- before(async () => {
- ffProc = exec(
- `npx functions-framework --target=helloHttp --signature-type=http --port ${PORT}`
- );
- await waitPort({host: 'localhost', port: PORT});
- });
-
- after(() => ffProc.kill());
-
- it('helloHttp: should print a name', async () => {
- const name = uuid.v4();
-
- const response = await request({
- url: `${BASE_URL}/helloHttp`,
- method: 'POST',
- data: {name},
- });
-
- assert.strictEqual(response.status, 200);
- assert.strictEqual(response.data, `Hello ${name}!`);
+ it('helloHttp: should print a name with req body', async () => {
+ const server = getTestServer('helloHttp');
+ await supertest(server)
+ .post('/')
+ .send({name: 'John'})
+ .set('Content-Type', 'application/json')
+ .expect(200)
+ .expect('Hello John!');
  });
  // [END functions_http_integration_test]
-
  it('helloHttp: should print hello world', async () => {
- const response = await request({
- url: `${BASE_URL}/helloHttp`,
- method: 'POST',
- data: {},
- });
- assert.strictEqual(response.status, 200);
- assert.strictEqual(response.data, 'Hello World!');
+ const server = getTestServer('helloHttp');
+ await supertest(server).post('/').send().expect(200).expect('Hello World!');
+ });
+ it('helloHttp: should print a name with query', async () => {
+ const server = getTestServer('helloHttp');
+ await supertest(server)
+ .post('/?name=John')
+ .send()
+ .expect(200)
+ .expect('Hello John!');
  });
 });

functions/helloworld/test/sample.unit.http.test.js

@@ -12,50 +12,52 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// FF testing layer for declarative signatures
 const {getFunction} = require('@google-cloud/functions-framework/testing');
 
 describe('functions_helloworld_http', () => {
  // [START functions_http_unit_test]
- const assert = require('assert');
  const sinon = require('sinon');
- const uuid = require('uuid');
+ const assert = require('assert');
+ require('../');
 
- require('..');
- const helloHttp = getFunction('helloHttp');
+ const getMocks = () => {
+  const req = {body: {}, query: {}};
 
- it('helloHttp: should print a name', () => {
- // Mock ExpressJS 'req' and 'res' parameters
- const name = uuid.v4();
- const req = {
- query: {},
- body: {
- name: name,
+ return {
+ req: req,
+ res: {
+ send: sinon.stub().returnsThis(),
  },
  };
- const res = {send: sinon.stub()};
+ };
+
+ it('helloHttp: should print a name', () => {
+ const mocks = getMocks();
 
- // Call tested function
- helloHttp(req, res);
+ const helloHttp = getFunction('helloHttp');
+ helloHttp(mocks.req, mocks.res);
 
- // Verify behavior of tested function
- assert.ok(res.send.calledOnce);
- assert.deepStrictEqual(res.send.firstCall.args, [`Hello ${name}!`]);
+ assert.strictEqual(mocks.res.send.calledOnceWith('Hello World!'), true);
  });
  // [END functions_http_unit_test]
+ it('helloHttp: should print a name with query', () => {
+ const mocks = getMocks();
+ mocks.req.query = {name: 'John'};
 
- it('helloHttp: should print hello world', () => {
- // Mock ExpressJS 'req' and 'res' parameters
- const req = {
- query: {},
- body: {},
- };
- const res = {send: sinon.stub()};
+ const helloHttp = getFunction('helloHttp');
+ helloHttp(mocks.req, mocks.res);
+
+ assert.strictEqual(mocks.res.send.calledOnceWith('Hello John!'), true);
+ });
+
+ it('helloHttp: should print a name with req body', () => {
+ const mocks = getMocks();
+ mocks.req.body = {name: 'John'};
 
- // Call tested function
- helloHttp(req, res);
+ const helloHttp = getFunction('helloHttp');
+ helloHttp(mocks.req, mocks.res);
 
- // Verify behavior of tested function
- assert.ok(res.send.calledOnce);
- assert.deepStrictEqual(res.send.firstCall.args, ['Hello World!']);
+ assert.strictEqual(mocks.res.send.calledOnceWith('Hello John!'), true);
  });
 });