cleanup and test refactor

Author: amychisholm03

lib/utilization/azurefunction-info.js

@@ -24,23 +24,21 @@ function fetchAzureFunctionInfo(agent, callback) {
   }
 
   // Detect if Azure Function.
-  if (process.env.REGION_NAME && process.env.WEBSITE_OWNER_NAME && process.env.WEBSITE_SITE_NAME) {
-    // Derive vendor metadata from environment variables.
-    const subscriptionId = process.env.WEBSITE_OWNER_NAME.split('+')[0]
-    const resourceGroupName = process.env.WEBSITE_RESOURCE_GROUP ?? process.env.WEBSITE_OWNER_NAME.split('+').pop().split('-Linux').shift()
-    const azureFunctionAppName = process.env.WEBSITE_SITE_NAME
-    if (subscriptionId && resourceGroupName) {
-      results = {
-        'faas.app_name': `/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.Web/sites/${azureFunctionAppName}`,
-        'cloud.region': process.env.REGION_NAME
-      }
-    }
-  } else {
+  const { REGION_NAME, WEBSITE_OWNER_NAME, WEBSITE_SITE_NAME, WEBSITE_RESOURCE_GROUP } = process.env
+  if (!REGION_NAME || !WEBSITE_OWNER_NAME || !WEBSITE_SITE_NAME) {
     logger.debug('Azure Function metadata was invalid.')
-    // TODO: Create NAMES.UTILIZATION.AZUREFUNCTION_ERROR ?
     agent.metrics.getOrCreateMetric(NAMES.UTILIZATION.AZURE_ERROR).incrementCallCount()
+    return setImmediate(callback, null, null)
+  }
+
+  // Derive vendor metadata from environment variables.
+  const subscriptionId = WEBSITE_OWNER_NAME.split('+')[0]
+  const resourceGroupName = WEBSITE_RESOURCE_GROUP ?? WEBSITE_OWNER_NAME.split('+').pop().split('-Linux').shift() ?? 'unknown'
+  const azureFunctionAppName = WEBSITE_SITE_NAME
+  results = {
+    'faas.app_name': `/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.Web/sites/${azureFunctionAppName}`,
+    'cloud.region': REGION_NAME
   }
 
-  // Call back!
   callback(null, results)
 }

test/integration/utilization/azurefunction-info.test.js

@@ -7,16 +7,29 @@
 
 const test = require('node:test')
 const assert = require('assert')
+const helper = require('../../lib/agent_helper')
 const fetchAzureFunctionInfo = require('../../../lib/utilization/azurefunction-info')
 
-test('fetchAzureFunctionInfo should return null if detect_azurefunction is disabled', (t, end) => {
-  const agent = {
+test.beforeEach((ctx) => {
+  const agent = helper.loadMockedAgent({
     config: {
       utilization: {
-        detect_azurefunction: false
+        detect_azurefunction: true
       }
     }
-  }
+  })
+  ctx.nr = { agent }
+})
+
+test.afterEach((ctx) => {
+  helper.unloadAgent(ctx.nr.agent)
+  ctx.nr.agent = null
+  fetchAzureFunctionInfo.clearCache()
+})
+
+test('should return null if detect_azurefunction is disabled', (ctx, end) => {
+  const agent = ctx.nr.agent
+  agent.config.utilization.detect_azurefunction = false
 
   fetchAzureFunctionInfo(agent, (err, result) => {
     assert.strictEqual(err, null)
@@ -25,20 +38,23 @@ test('fetchAzureFunctionInfo should return null if detect_azurefunction is disab
   })
 })
 
-test('fetchAzureFunctionInfo should derive metadata from required environment variables', (t, end) => {
-  const agent = {
-    config: {
-      utilization: {
-        detect_azurefunction: true
-      }
-    }
-  }
+test('should return null if required environment variables are missing', (ctx, end) => {
+  const agent = ctx.nr.agent
+
+  fetchAzureFunctionInfo(agent, (err, result) => {
+    assert.strictEqual(err, null)
+    assert.strictEqual(result, null)
+    end()
+  })
+})
+
+test('should derive metadata from required environment variables', (ctx, end) => {
+  const agent = ctx.nr.agent
 
   process.env.REGION_NAME = 'Central US'
   process.env.WEBSITE_OWNER_NAME = '12345+resource-group'
   process.env.WEBSITE_SITE_NAME = 'my-function-app'
 
-  fetchAzureFunctionInfo.clearCache()
   fetchAzureFunctionInfo(agent, (err, result) => {
     assert.strictEqual(err, null)
     assert.deepStrictEqual(result, {
@@ -49,25 +65,18 @@ test('fetchAzureFunctionInfo should derive metadata from required environment va
   })
 })
 
-test('fetchAzureFunctionInfo should derive metadata from required and optional environment variables', (t, end) => {
-  const agent = {
-    config: {
-      utilization: {
-        detect_azurefunction: true
-      }
-    }
-  }
+test('should derive metadata from required and optional environment variables', (ctx, end) => {
+  const agent = ctx.nr.agent
 
   process.env.REGION_NAME = 'Central US'
-  process.env.WEBSITE_RESOURCE_GROUP = 'resource-group'
+  process.env.WEBSITE_RESOURCE_GROUP = 'resource-group-actual'
   process.env.WEBSITE_OWNER_NAME = '12345+resource-group'
   process.env.WEBSITE_SITE_NAME = 'my-function-app'
 
-  fetchAzureFunctionInfo.clearCache()
   fetchAzureFunctionInfo(agent, (err, result) => {
     assert.strictEqual(err, null)
     assert.deepStrictEqual(result, {
-      'faas.app_name': '/subscriptions/12345/resourceGroups/resource-group/providers/Microsoft.Web/sites/my-function-app',
+      'faas.app_name': '/subscriptions/12345/resourceGroups/resource-group-actual/providers/Microsoft.Web/sites/my-function-app',
       'cloud.region': 'Central US'
     })
     end()