@defra/bng-utils-lib 0.60.0 → 0.62.0

package/.jest/setup.js

@@ -0,0 +1,9 @@
+const ORIGINAL_ENV = process.env
+
+beforeEach(() => {
+  jest.resetAllMocks()
+})
+
+afterEach(() => {
+  process.env = ORIGINAL_ENV
+})

package/.jest/test.env.js

@@ -0,0 +1,10 @@
+process.env.AZURE_STORAGE_ACCOUNT='devstoreaccount1'
+process.env.AZURE_STORAGE_ACCESS_KEY='Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=='
+process.env.AZURE_BLOB_SERVICE_URL='http://127.0.0.1:10000/devstoreaccount1'
+process.env.AZURE_QUEUE_SERVICE_URL='http://127.0.0.1:10001/devstoreaccount1'
+process.env.POSTGRES_HOST='localhost'
+process.env.POSTGRES_USER='postgres'
+process.env.POSTGRES_PASSWORD='postgres'
+process.env.POSTGRES_DATABASE='bng'
+process.env.POSTGRES_PORT='5432'
+process.env.POSTGRES_SSL_MODE=''

package/jest.config.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+  rootDir: '.',
+  setupFiles: ['<rootDir>/.jest/test.env.js'],
+  setupFilesAfterEnv: ['<rootDir>/.jest/setup.js']
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/bng-utils-lib",
-  "version": "0.60.0",
+  "version": "0.62.0",
   "type": "module",
   "private": false,
   "description": "A library of utilities for the Biodiversity Net Gain Service",
@@ -16,7 +16,9 @@
   "author": "Department for Environment, Food and Rural Affairs <https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs>",
   "license": "OGL-UK-3.0",
   "dependencies": {
+    "@azure/identity": "^3.1.3",
+    "@defra/bng-connectors-lib": "0.62.0",
     "axios": "^1.3.2"
   },
-  "gitHead": "605bc0ac56444c99545adaad8f5e377f8cc468a7"
+  "gitHead": "f7e885a598331721c7333efd848eda6db0ac0605"
 }

package/src/helpers/__tests__/get-db-connection-spec.js

@@ -0,0 +1,60 @@
+jest.mock('../db-config.js')
+jest.mock('@azure/identity')
+jest.mock('@defra/bng-connectors-lib')
+
+describe('Database connection retrieval', () => {
+  it('Should request DB access token if no password supplied for database', done => {
+    jest.isolateModules(async () => {
+      try {
+        const dbConfig = require('../db-config.js')
+        dbConfig.default = {
+          host: process.env.POSTGRES_HOST,
+          user: process.env.POSTGRES_USER,
+          database: process.env.POSTGRES_DATABASE,
+          port: process.env.POSTGRES_PORT,
+          ssl: !!process.env.POSTGRES_SSL_MODE
+        }
+        const getDBConnection = require('../get-db-connection.js').default
+        const { DefaultAzureCredential } = require('@azure/identity')
+        DefaultAzureCredential.prototype.getToken = jest.fn().mockImplementation(() => {
+          return {
+            token: 'test'
+          }
+        })
+        await getDBConnection()
+        expect(DefaultAzureCredential.prototype.getToken.mock.calls).toHaveLength(1)
+        done()
+      } catch (err) {
+        done(err)
+      }
+    })
+  })
+
+  it('Should not request DB access token if password supplied for database', done => {
+    jest.isolateModules(async () => {
+      const dbConfig = require('../db-config.js')
+      dbConfig.default = {
+        host: process.env.POSTGRES_HOST,
+        user: process.env.POSTGRES_USER,
+        password: process.env.POSTGRES_PASSWORD,
+        database: process.env.POSTGRES_DATABASE,
+        port: process.env.POSTGRES_PORT,
+        ssl: !!process.env.POSTGRES_SSL_MODE
+      }
+      try {
+        const getDBConnection = require('../get-db-connection.js').default
+        const { DefaultAzureCredential } = require('@azure/identity')
+        DefaultAzureCredential.prototype.getToken = jest.fn().mockImplementation(() => {
+          return {
+            token: 'test'
+          }
+        })
+        await getDBConnection()
+        expect(DefaultAzureCredential.prototype.getToken.mock.calls).toHaveLength(0)
+        done()
+      } catch (err) {
+        done(err)
+      }
+    })
+  })
+})

package/src/helpers/db-config.js

@@ -0,0 +1,10 @@
+const dbConfig = {
+  host: process.env.POSTGRES_HOST,
+  user: process.env.POSTGRES_USER,
+  password: process.env.POSTGRES_PASSWORD,
+  database: process.env.POSTGRES_DATABASE,
+  port: process.env.POSTGRES_PORT,
+  ssl: !!process.env.POSTGRES_SSL_MODE
+}
+
+export default dbConfig

package/src/helpers/get-db-connection.js

@@ -0,0 +1,15 @@
+import { postgresConnector } from '@defra/bng-connectors-lib'
+import { DefaultAzureCredential } from '@azure/identity'
+import DbConfig from './db-config.js'
+
+const getDBConnection = async () => {
+  // Clone so that we don't store the token (which will expire)
+  const dbConfig = JSON.parse(JSON.stringify(DbConfig))
+  if (!dbConfig.password) {
+    const credential = new DefaultAzureCredential()
+    dbConfig.password = (await credential.getToken('https://ossrdbms-aad.database.windows.net')).token
+  }
+  return new postgresConnector.Db(dbConfig)
+}
+
+export default getDBConnection

package/src/utils.js

@@ -1,3 +1,4 @@
 import getBearerToken from './helpers/get-bearer-token.js'
+import getDBConnection from './helpers/get-db-connection.js'
 
-export { getBearerToken }
+export { getBearerToken, getDBConnection }