ffc-pay-schemes 1.0.1

package/test/unit/create-split-invoice-number/index.test.js

@@ -0,0 +1,34 @@
+const { createSplitInvoiceNumber } = require('../../../app/create-split-invoice-number')
+const { createDefaultInvoiceNumber } = require('../../../app/create-split-invoice-number/create-default-invoice-number')
+const { createSitiAgriInvoiceNumber } = require('../../../app/create-split-invoice-number/create-siti-agri-invoice-number')
+const schemeIds = require('../../../app/constants/scheme-ids')
+
+describe('createSplitInvoiceNumber', () => {
+  const invoiceNumber = '1234567890123'
+  const splitId = 'A'
+  const sitiAgriSchemes = [
+    'SFI',
+    'SFI_PILOT',
+    'LUMP_SUMS',
+    'SFI23',
+    'DELINKED',
+    'SFI_EXPANDED'
+  ]
+
+  test.each(Object.entries(schemeIds))(
+    'uses the correct invoice format for %s',
+    (schemeKey, schemeId) => {
+      const expectedInvoiceNumber = sitiAgriSchemes.includes(schemeKey)
+        ? createSitiAgriInvoiceNumber(invoiceNumber, splitId)
+        : createDefaultInvoiceNumber(invoiceNumber, splitId)
+
+      expect(createSplitInvoiceNumber(invoiceNumber, splitId, schemeId))
+        .toBe(expectedInvoiceNumber)
+    }
+  )
+
+  test('uses the default format for an unknown schemeId', () => {
+    expect(createSplitInvoiceNumber(invoiceNumber, splitId, 'unknown-scheme'))
+      .toBe(createDefaultInvoiceNumber(invoiceNumber, splitId))
+  })
+})

package/test/unit/get-account-code-map/bps-map.test.js

@@ -0,0 +1,58 @@
+const bpsMap = require('../../../app/get-account-code-map/bps-map')
+const ap = require('../../../app/constants/account-codes/ap')
+const arAdmin = require('../../../app/constants/account-codes/ar-admin')
+const arIrregular = require('../../../app/constants/account-codes/ar-irregular')
+const descriptionCodes = require('../../../app/constants/description-codes')
+
+const expectedMappings = {
+  G00: ['SOS210', 'SOS330', 'SOS310'],
+  P01: ['SOS404', 'SOS465', 'SOS445'],
+  P02: ['SOS362', 'SOS450', 'SOS430'],
+  P03: ['SOS351', 'SOS451', 'SOS431'],
+  P04: ['SOS363', 'SOS452', 'SOS432'],
+  P05: ['SOS367', 'SOS453', 'SOS433'],
+  P06: ['SOS368', 'SOS454', 'SOS434'],
+  P07: ['SOS369', 'SOS455', 'SOS435'],
+  P08: ['SOS361', 'SOS456', 'SOS436'],
+  P09: ['SOS400', 'SOS457', 'SOS437'],
+  P10: ['SOS402', 'SOS458', 'SOS438'],
+  P11: ['SOS260', 'SOS466', 'SOS446'],
+  P12: ['SOS266', 'SOS267', 'SOS268'],
+  P13: ['SOS410', 'SOS459', 'SOS439'],
+  P14: ['SOS350', 'SOS464', 'SOS444'],
+  P15: ['SOS364', 'SOS336', 'SOS316'],
+  P16: ['SOS415', 'SOS460', 'SOS440'],
+  P17: ['SOS416', 'SOS461', 'SOS441'],
+  P18: ['SOS417', 'SOS462', 'SOS442'],
+  P19: ['SOS420', 'SOS463', 'SOS443'],
+  P20: ['SOS420', 'SOS463', 'SOS443'],
+  P21: ['SOS420', 'SOS463', 'SOS443'],
+  R00: ['SOS216', 'SOS217', 'SOS218'],
+  X01: ['SOS471', 'SOS471', 'SOS471'],
+  X02: ['SOS472', 'SOS472', 'SOS472'],
+  X03: ['SOS473', 'SOS473', 'SOS473'],
+  X04: ['SOS474', 'SOS474', 'SOS474']
+}
+
+describe('BPS account code map', () => {
+  test('contains all expected line codes', () => {
+    expect(bpsMap).toHaveLength(Object.keys(expectedMappings).length)
+
+    expect(bpsMap.map(item => item.lineCode)).toEqual(
+      Object.keys(expectedMappings).map(lineCode => descriptionCodes[lineCode])
+    )
+  })
+
+  test.each(Object.entries(expectedMappings))(
+    'returns the correct account codes for %s',
+    (lineCode, [apCode, arAdminCode, arIrregularCode]) => {
+      expect(bpsMap.find(item => item.lineCode === descriptionCodes[lineCode]))
+        .toEqual({
+          lineCode: descriptionCodes[lineCode],
+          ap: ap[apCode],
+          arAdmin: arAdmin[arAdminCode],
+          arIrregular: arIrregular[arIrregularCode]
+        })
+    }
+  )
+})

package/test/unit/get-account-code-map/cohtc-map.test.js

@@ -0,0 +1,32 @@
+const cohtcMap = require('../../../app/get-account-code-map/cohtc-map')
+const ap = require('../../../app/constants/account-codes/ap')
+const arAdmin = require('../../../app/constants/account-codes/ar-admin')
+const arIrregular = require('../../../app/constants/account-codes/ar-irregular')
+const descriptionCodes = require('../../../app/constants/description-codes')
+
+describe('COHTC account code map', () => {
+  test.each([
+    ['G00', 'SOS710', 'SOS750', 'SOS770'],
+    ['P02', 'SOS920', 'SOS940', 'SOS960'],
+    ['P24', 'SOS929', 'SOS949', 'SOS969']
+  ])(
+    'returns the correct account codes for %s',
+    (lineCode, apCode, arAdminCode, arIrregularCode) => {
+      expect(cohtcMap).toContainEqual({
+        lineCode: descriptionCodes[lineCode],
+        ap: ap[apCode],
+        arAdmin: arAdmin[arAdminCode],
+        arIrregular: arIrregular[arIrregularCode]
+      })
+    }
+  )
+
+  test('contains exactly the expected mappings', () => {
+    expect(cohtcMap).toHaveLength(3)
+    expect(cohtcMap.map(item => item.lineCode)).toEqual([
+      descriptionCodes.G00,
+      descriptionCodes.P02,
+      descriptionCodes.P24
+    ])
+  })
+})

package/test/unit/get-account-code-map/cs-map.test.js

@@ -0,0 +1,62 @@
+const csMap = require('../../../app/get-account-code-map/cs-map')
+const ap = require('../../../app/constants/account-codes/ap')
+const arAdmin = require('../../../app/constants/account-codes/ar-admin')
+const arIrregular = require('../../../app/constants/account-codes/ar-irregular')
+const descriptionCodes = require('../../../app/constants/description-codes')
+
+const expectedMappings = [
+  ['G00', 'SOS710', 'SOS750', 'SOS770', true, true, false],
+  ['G00', 'SOS228', 'SOS352', 'SOS352', true, true, true],
+  ['G00', 'SOS229', 'SOS352', 'SOS352', true, true, true],
+  ['P02', 'SOS929', 'SOS949', 'SOS969', true, false, false],
+  ['P02', 'SOS928', 'SOS948', 'SOS968', false, true, false],
+  ['P02', 'SOS231', 'SOS553', 'SOS553', true, true, true],
+  ['P05', 'SOS921', 'SOS941', 'SOS961', true, true, false],
+  ['P05', 'SOS233', 'SOS555', 'SOS555', true, true, true],
+  ['P06', 'SOS922', 'SOS942', 'SOS962', true, true, false],
+  ['P06', 'SOS234', 'SOS556', 'SOS556', true, true, true],
+  ['P08', 'SOS923', 'SOS943', 'SOS963', true, true, false],
+  ['P08', 'SOS239', 'SOS557', 'SOS557', true, true, true],
+  ['P14', 'SOS924', 'SOS944', 'SOS964', true, true, false],
+  ['P14', 'SOS236', 'SOS558', 'SOS558', true, true, true],
+  ['P22', 'SOS925', 'SOS945', 'SOS965', true, true, false],
+  ['P22', 'SOS237', 'SOS559', 'SOS559', true, true, true],
+  ['P23', 'SOS926', 'SOS946', 'SOS966', true, true, false],
+  ['P23', 'SOS238', 'SOS560', 'SOS560', true, true, true],
+  ['P24', 'SOS920', 'SOS940', 'SOS960', true, false, false],
+  ['P24', 'SOS927', 'SOS947', 'SOS967', false, true, false],
+  ['P24', 'SOS232', 'SOS554', 'SOS554', true, true, true]
+]
+
+describe('CS account code map', () => {
+  test('contains all expected mappings', () => {
+    const expected = expectedMappings.map(
+      ([lineCode, apCode, arAdminCode, arIrregularCode, capital, revenue, stateAid]) => ({
+        lineCode: descriptionCodes[lineCode],
+        ap: ap[apCode],
+        arAdmin: arAdmin[arAdminCode],
+        arIrregular: arIrregular[arIrregularCode],
+        capital,
+        revenue,
+        stateAid
+      })
+    )
+
+    expect(csMap).toEqual(expected)
+  })
+
+  test.each(expectedMappings)(
+    'contains the expected mapping for %s',
+    (lineCode, apCode, arAdminCode, arIrregularCode, capital, revenue, stateAid) => {
+      expect(csMap).toContainEqual({
+        lineCode: descriptionCodes[lineCode],
+        ap: ap[apCode],
+        arAdmin: arAdmin[arAdminCode],
+        arIrregular: arIrregular[arIrregularCode],
+        capital,
+        revenue,
+        stateAid
+      })
+    }
+  )
+})

package/test/unit/get-account-code-map/default-map.test.js

@@ -0,0 +1,60 @@
+const defaultMap = require('../../../app/get-account-code-map/default-map')
+const ap = require('../../../app/constants/account-codes/ap')
+const arAdmin = require('../../../app/constants/account-codes/ar-admin')
+const arIrregular = require('../../../app/constants/account-codes/ar-irregular')
+const descriptionCodes = require('../../../app/constants/description-codes')
+
+describe('default account code map', () => {
+  test('contains the expected account code mappings', () => {
+    expect(defaultMap).toEqual([
+      {
+        lineCode: descriptionCodes.G00,
+        ap: ap.SOS710,
+        arAdmin: arAdmin.SOS750,
+        arIrregular: arIrregular.SOS770
+      },
+      {
+        lineCode: descriptionCodes.P05,
+        ap: ap.SOS921,
+        arAdmin: arAdmin.SOS941,
+        arIrregular: arIrregular.SOS961
+      },
+      {
+        lineCode: descriptionCodes.P06,
+        ap: ap.SOS922,
+        arAdmin: arAdmin.SOS942,
+        arIrregular: arIrregular.SOS962
+      },
+      {
+        lineCode: descriptionCodes.P08,
+        ap: ap.SOS923,
+        arAdmin: arAdmin.SOS943,
+        arIrregular: arIrregular.SOS963
+      },
+      {
+        lineCode: descriptionCodes.P14,
+        ap: ap.SOS924,
+        arAdmin: arAdmin.SOS944,
+        arIrregular: arIrregular.SOS964
+      },
+      {
+        lineCode: descriptionCodes.P22,
+        ap: ap.SOS925,
+        arAdmin: arAdmin.SOS945,
+        arIrregular: arIrregular.SOS965
+      },
+      {
+        lineCode: descriptionCodes.P23,
+        ap: ap.SOS926,
+        arAdmin: arAdmin.SOS946,
+        arIrregular: arIrregular.SOS966
+      },
+      {
+        lineCode: descriptionCodes.P24,
+        ap: ap.SOS927,
+        arAdmin: arAdmin.SOS947,
+        arIrregular: arIrregular.SOS967
+      }
+    ])
+  })
+})

package/test/unit/get-account-code-map/delinked-map.test.js

@@ -0,0 +1,42 @@
+const delinkedMap = require('../../../app/get-account-code-map/delinked-map')
+const ap = require('../../../app/constants/account-codes/ap')
+const arAdmin = require('../../../app/constants/account-codes/ar-admin')
+const arIrregular = require('../../../app/constants/account-codes/ar-irregular')
+const descriptionCodes = require('../../../app/constants/description-codes')
+
+describe('Delinked account code map', () => {
+  test('contains the expected account code mappings', () => {
+    expect(delinkedMap).toEqual([
+      {
+        lineCode: descriptionCodes.G00,
+        ap: ap.SOS210,
+        arAdmin: arAdmin.SOS330,
+        arIrregular: arIrregular.SOS310
+      },
+      {
+        lineCode: descriptionCodes.X01,
+        ap: ap.SOS471,
+        arAdmin: arAdmin.SOS471,
+        arIrregular: arIrregular.SOS471
+      },
+      {
+        lineCode: descriptionCodes.X02,
+        ap: ap.SOS472,
+        arAdmin: arAdmin.SOS472,
+        arIrregular: arIrregular.SOS472
+      },
+      {
+        lineCode: descriptionCodes.X03,
+        ap: ap.SOS473,
+        arAdmin: arAdmin.SOS473,
+        arIrregular: arIrregular.SOS473
+      },
+      {
+        lineCode: descriptionCodes.X04,
+        ap: ap.SOS474,
+        arAdmin: arAdmin.SOS474,
+        arIrregular: arIrregular.SOS474
+      }
+    ])
+  })
+})

package/test/unit/get-account-code-map/index.test.js

@@ -0,0 +1,53 @@
+const { getAccountCodeMap } = require('../../../app/get-account-code-map')
+const schemeIds = require('../../../app/constants/scheme-ids')
+
+const defaultMap = require('../../../app/get-account-code-map/default-map')
+const sfiFrpsMap = require('../../../app/get-account-code-map/sfi-frps-map')
+const lumpSumsMap = require('../../../app/get-account-code-map/lump-sums-map')
+const vetVisitsMap = require('../../../app/get-account-code-map/vet-visits-map')
+const csMap = require('../../../app/get-account-code-map/cs-map')
+const bpsMap = require('../../../app/get-account-code-map/bps-map')
+const delinkedMap = require('../../../app/get-account-code-map/delinked-map')
+const cohtcMap = require('../../../app/get-account-code-map/cohtc-map')
+
+const expectedMaps = {
+  SFI: sfiFrpsMap,
+  SFI_PILOT: sfiFrpsMap,
+  LUMP_SUMS: lumpSumsMap,
+  VET_VISITS: vetVisitsMap,
+  CS: csMap,
+  BPS: bpsMap,
+  SFI23: sfiFrpsMap,
+  DELINKED: delinkedMap,
+  SFI_EXPANDED: sfiFrpsMap,
+  COHT_REVENUE: defaultMap,
+  COHT_CAPITAL: cohtcMap,
+  FPTT: sfiFrpsMap,
+  WMP: sfiFrpsMap
+}
+
+describe('getAccountCodeMap', () => {
+  test.each(Object.entries(expectedMaps))(
+    'returns the correct map for %s',
+    (schemeKey, expectedMap) => {
+      expect(getAccountCodeMap(schemeIds[schemeKey])).toBe(expectedMap)
+    }
+  )
+
+  test.each(['MANUAL', 'ES', 'FC', 'IMPS'])(
+    'throws an error for the unmapped %s scheme',
+    (schemeKey) => {
+      expect(() => getAccountCodeMap(schemeIds[schemeKey]))
+        .toThrow(`No account codes found for scheme ${schemeIds[schemeKey]}`)
+    }
+  )
+
+  test('throws an error when schemeId is not provided', () => {
+    expect(() => getAccountCodeMap()).toThrow('schemeId is required')
+  })
+
+  test('throws an error for an unknown schemeId', () => {
+    expect(() => getAccountCodeMap(999))
+      .toThrow('No account codes found for scheme 999')
+  })
+})

package/test/unit/get-account-code-map/lump-sums-map.test.js

@@ -0,0 +1,16 @@
+const lumpSumsMap = require('../../../app/get-account-code-map/lump-sums-map')
+const ap = require('../../../app/constants/account-codes/ap')
+const arAdmin = require('../../../app/constants/account-codes/ar-admin')
+const arIrregular = require('../../../app/constants/account-codes/ar-irregular')
+const descriptionCodes = require('../../../app/constants/description-codes')
+
+describe('Lump Sums account code map', () => {
+  test('contains the expected mapping', () => {
+    expect(lumpSumsMap).toEqual([{
+      lineCode: descriptionCodes.G00,
+      ap: ap.SOS210,
+      arAdmin: arAdmin.SOS330,
+      arIrregular: arIrregular.SOS310
+    }])
+  })
+})

package/test/unit/get-account-code-map/sfi-frps-map.test.js

@@ -0,0 +1,31 @@
+const sfiFrpsMap = require('../../../app/get-account-code-map/sfi-frps-map')
+const defaultMap = require('../../../app/get-account-code-map/default-map')
+const ap = require('../../../app/constants/account-codes/ap')
+const arAdmin = require('../../../app/constants/account-codes/ar-admin')
+const arIrregular = require('../../../app/constants/account-codes/ar-irregular')
+const descriptionCodes = require('../../../app/constants/description-codes')
+
+describe('SFI FRPS account code map', () => {
+  const p02Entry = {
+    lineCode: descriptionCodes.P02,
+    ap: ap.SOS920,
+    arAdmin: arAdmin.SOS940,
+    arIrregular: arIrregular.SOS960
+  }
+
+  test('contains the complete expected map', () => {
+    expect(sfiFrpsMap).toEqual([
+      defaultMap[0],
+      p02Entry,
+      ...defaultMap.slice(1)
+    ])
+  })
+
+  test.each(defaultMap)('contains default mapping %#', (entry) => {
+    expect(sfiFrpsMap).toContainEqual(entry)
+  })
+
+  test('contains the P02 mapping', () => {
+    expect(sfiFrpsMap).toContainEqual(p02Entry)
+  })
+})

package/test/unit/get-account-code-map/vet-visits-map.test.js

@@ -0,0 +1,16 @@
+const vetVisitsMap = require('../../../app/get-account-code-map/vet-visits-map')
+const ap = require('../../../app/constants/account-codes/ap')
+const arAdmin = require('../../../app/constants/account-codes/ar-admin')
+const arIrregular = require('../../../app/constants/account-codes/ar-irregular')
+const descriptionCodes = require('../../../app/constants/description-codes')
+
+describe('Vet Visits account code map', () => {
+  test('contains the expected mapping', () => {
+    expect(vetVisitsMap).toEqual([{
+      lineCode: descriptionCodes.G00,
+      ap: ap.SOS210,
+      arAdmin: arAdmin.SOS330,
+      arIrregular: arIrregular.SOS310
+    }])
+  })
+})

package/test/unit/get-scheme-batch-properties.test.js

@@ -0,0 +1,16 @@
+const { getSchemeBatchProperties } = require('../../app/get-scheme-batch-properties')
+const schemeBatchProperties = require('../../app/constants/scheme-batch-properties')
+
+describe('get scheme batch properties', () => {
+  test.each(schemeBatchProperties)(
+    'returns the batch properties for schemeId $schemeId',
+    (expectedProperties) => {
+      expect(getSchemeBatchProperties(expectedProperties.schemeId))
+        .toEqual(expectedProperties)
+    }
+  )
+
+  test('returns undefined for an unknown schemeId', () => {
+    expect(getSchemeBatchProperties('unknown-scheme')).toBeUndefined()
+  })
+})

package/test/unit/get-scheme-properties.test.js

@@ -0,0 +1,54 @@
+const { getSchemeProperties } = require('../../app/get-scheme-properties')
+const schemes = require('../../app/constants/schemes')
+const { MANUAL } = require('../../app/constants/scheme-ids')
+
+describe('getSchemeProperties', () => {
+  test.each(schemes)(
+    'returns the properties for schemeId $schemeId',
+    (expectedScheme) => {
+      expect(getSchemeProperties(expectedScheme.schemeId))
+        .toEqual(expectedScheme)
+    }
+  )
+
+  test.each(schemes)(
+    'returns the properties for schemeId $schemeId, even if sourceSystem does not match',
+    (expectedScheme) => {
+      expect(getSchemeProperties(expectedScheme.schemeId, 'made up source system'))
+        .toEqual(expectedScheme)
+    }
+  )
+
+  test.each(schemes)(
+    'returns the properties for sourceSystem $sourceSystem when schemeId is not present',
+    (expectedScheme) => {
+      expect(getSchemeProperties(null, expectedScheme.sourceSystem))
+        .toEqual(expectedScheme)
+    }
+  )
+
+  test('throws an error for an unknown schemeId and sourceSystem', () => {
+    expect(() => getSchemeProperties('unknown-scheme', 'unknown-source'))
+      .toThrow('Scheme with ID unknown-scheme, sourceSystem unknown-source not found')
+  })
+
+  test('uses the pillar delivery body and fund code for a manual scheme', () => {
+    const manualScheme = schemes.find(scheme => scheme.schemeId === MANUAL)
+    const pillarScheme = schemes.find(scheme => scheme.pillar)
+
+    expect(getSchemeProperties(MANUAL, null, pillarScheme.pillar))
+      .toEqual({
+        ...manualScheme,
+        pillar: pillarScheme.pillar,
+        deliveryBody: pillarScheme.deliveryBody,
+        fundCode: pillarScheme.fundCode
+      })
+  })
+
+  test('returns the manual scheme unchanged for an unknown pillar', () => {
+    const manualScheme = schemes.find(scheme => scheme.schemeId === MANUAL)
+
+    expect(getSchemeProperties(MANUAL, null, 'unknown-pillar'))
+      .toEqual(manualScheme)
+  })
+})

package/test/unit/get-schemes.test.js

@@ -0,0 +1,24 @@
+const { getSchemes } = require('../../app/get-schemes')
+const schemeIds = require('../../app/constants/scheme-ids')
+const schemeNames = require('../../app/constants/scheme-names')
+
+describe('getSchemes', () => {
+  test('returns all schemes with their IDs and names', () => {
+    expect(getSchemes()).toEqual(
+      Object.keys(schemeIds).map((schemeKey) => ({
+        schemeId: schemeIds[schemeKey],
+        schemeName: schemeNames[schemeKey]
+      }))
+    )
+  })
+
+  test.each(Object.keys(schemeIds))(
+    'returns the correct details for %s',
+    (schemeKey) => {
+      expect(getSchemes()).toContainEqual({
+        schemeId: schemeIds[schemeKey],
+        schemeName: schemeNames[schemeKey]
+      })
+    }
+  )
+})

package/test/unit/scheme-does-not-require-ppas.test.js

@@ -0,0 +1,17 @@
+const { schemeDoesNotRequirePPAs } = require('../../app/scheme-does-not-require-ppas')
+const schemeIds = require('../../app/constants/scheme-ids')
+const schemesNotRequiringPPAs = require('../../app/constants/schemes-not-requiring-ppas')
+
+describe('schemeDoesNotRequirePPAs', () => {
+  test.each(Object.entries(schemeIds))(
+    'returns the expected result for %s',
+    (schemeKey, schemeId) => {
+      expect(schemeDoesNotRequirePPAs(schemeId))
+        .toBe(schemesNotRequiringPPAs.includes(schemeId))
+    }
+  )
+
+  test('returns false for an unknown schemeId', () => {
+    expect(schemeDoesNotRequirePPAs(999)).toBe(false)
+  })
+})

package/test/unit/scheme-provides-accounting-values.test.js

@@ -0,0 +1,17 @@
+const { schemeProvidesAccountingValues } = require('../../app/scheme-provides-accounting-values')
+const schemeIds = require('../../app/constants/scheme-ids')
+const schemesProvidingAccountingValues = require('../../app/constants/schemes-providing-account-values')
+
+describe('schemeProvidesAccountingValues', () => {
+  test.each(Object.entries(schemeIds))(
+    'returns the expected result for %s',
+    (schemeKey, schemeId) => {
+      expect(schemeProvidesAccountingValues(schemeId))
+        .toBe(schemesProvidingAccountingValues.includes(schemeId))
+    }
+  )
+
+  test('returns false for an unknown schemeId', () => {
+    expect(schemeProvidesAccountingValues(999)).toBe(false)
+  })
+})