christopheranderson/azure-functions-node-harness

Easily invoke your NodeJS Azure Functions during unit tests

👨‍💻 Chris(topher) Anderson

Howdy! 👋

• 💬 Ask me about JavaScript, serverless, NoSQL, PM culture, project ops, etc.
• 📫 How to reach me: DM me on twitter
• 😄 Pronouns: he/him/they
• Fun fact: I've got 3 chonky cat children 😼😽😾

azure-functions-node-harness's Issues

Handle log tracing level functions

Currently if you have the following in your function under test:

context.log.info("Invalid response");

you will get an error:

context.log.info is not a function

Handle for:

• error(message)
• warn(message)
• info(message)
• verbose(message)

Parallel async triggers

Hey,

So, I have this function.

const delay = time => new Promise(resolve => setTimeout(resolve, time))

module.exports = async (context, req) => {
  await delay(500)

  const { query: { name } } = req

  if (name) {
    context.res = {
      status: 200,
      body: `Hello, ${name}`
    }
  } else {
    context.res = {
      status: 400,
      body: 'Name missing'
    }
  }

  context.done()
}

delay puts the function to sleep for a bit, before processing. Just trying out async capabilities of Azure Functions.

And here are my ava tests.

const test = require('ava')
const func = require('azure-functions-node-harness')

test('valid', async t => {
  const helloWorld = func('HelloWorld')

  const name = 'Ali'

  const context = await helloWorld.invokeHttpTrigger({
    query: {
      name
    }
  })

  const { res: { body, status } } = context

  t.deepEqual(status, 200)
  t.deepEqual(body, `Hello, ${name}`)
})

test('invalid', async t => {
  const helloWorld = func('HelloWorld')

  const context = await helloWorld.invokeHttpTrigger()

  const { res: { body, status } } = context

  t.deepEqual(status, 400)
  t.deepEqual(body, 'Name missing')
})

When these tests are ran in parallel, which is the default ava behavior, valid fails claiming that status is 400, while the test expects it to be 200.

But if I run the tests serially with test.serial(), they both pass just fine.

How can I run them in parallel, and make sure they don't overlap? Or whatever is going on right now.

Thanks!

Use funtion.json to figure out trigger type

Use function.json to figure out trigger type. This would be useful for http context scenarios. One possibility is to load the sample.dat and pass it to unit test as default request body.

Add functionality to generate a http request

A user currently has to generate all of the following. Instead give them a helper to pass just the body.

Properties on request object (https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-node#http-triggers-and-bindings):

• body An object that contains the body of the request.
• headers An object that contains the request headers.
• method The HTTP method of the request.
• originalUrl The URL of the request.
• params An object that contains the routing parameters of the request.
• query An object that contains the query parameters.
• rawBody The body of the message as a string.

Sample helper would be something like (not complete example):

httpRequest: function(body){
        return{
            method: "POST",
            body:body,
            rawBody: JSON.stringify(body),
        };
    }

Could potentially fill load info like method from function.json

Handle binding directions for inputs and outputs. (may just work but should test)

Input bindings work, but add support for writing to output bindings.

Add more trigger binding support

Add functionality and tests for all the different trigger bindings where it makes sense. Here is a list from the functions docs:

• Schedule Azure Functions
• HTTP (REST or webhook) Azure Functions
• Blob Storage Azure Storage
• Events Azure Event Hubs
• Queues Azure Storage
• Queues and topics Azure Service Bus
• Storage tables Azure Storage
• SQL tables Azure Mobile Apps
• No-SQL DB Azure DocumentDB
• Push Notifications Azure Notification Hubs
• Twilio SMS Text Twilio
• SendGrid email

Handle all three cases for accessing the response object

It is possible to set the response in three different ways:

1. context.bindings.response = { status: 201, body: "Insert succeeded." };
2. context.res = { status: 202, body: 'You successfully ordered more coffee!' };
3. context.done(null, res);

https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-node#accessing-the-request-and-response