Refactor supplementary test code (#68)

https://eaflood.atlassian.net/browse/WATER-3854

We are about to [Update "create bill run" endpoint to create a bill run](#56). Currently, everything is happening in the controller whereas our convention is to do everything in a service and keep our controllers ['skinny'](https://blog.makersacademy.com/forget-fat-models-its-time-for-skinny-controllers-and-skinny-models-a9b84ec481b7).

So, we need a service, something like `SupplementaryService`. But oh no! It already exists.

This change is about refactoring the code currently in `SupplementaryService` to a more explicit testing version so we can free up the namespace. Whilst we're at it we also rename the `/test` path to `check/` as everyone was getting confused by seeing `test/` folders in various places in the code 😁

app/controllers/test/supplementary.controller.js → app/controllers/check/supplementary.controller.js

@@ -5,10 +5,10 @@
  * @module SupplementaryController
  */
 
-const SupplementaryService = require('../../services/supplementary-billing/supplementary.service.js')
+const SupplementaryDataService = require('../../services/check/supplementary-data.service.js')
 
 async function index (request, h) {
-  const result = await SupplementaryService.go(request.query.region)
+  const result = await SupplementaryDataService.go(request.query.region)
 
   return h.response(result).code(200)
 }

app/plugins/router.plugin.js

@@ -13,18 +13,18 @@
 
 const AssetRoutes = require('../routes/assets.routes.js')
 const BillRunRoutes = require('../routes/bill-runs.routes')
+const CheckRoutes = require('../routes/check.routes.js')
 const FilterRoutesService = require('../services/plugins/filter-routes.service.js')
 const HealthRoutes = require('../routes/health.routes.js')
 const RootRoutes = require('../routes/root.routes.js')
-const TestRoutes = require('../routes/test.routes.js')
 
 const AirbrakeConfig = require('../../config/airbrake.config.js')
 
 const routes = [
   ...RootRoutes,
   ...AssetRoutes,
   ...HealthRoutes,
-  ...TestRoutes,
+  ...CheckRoutes,
   ...BillRunRoutes
 ]
 

app/presenters/supplementary.presenter.js → app/presenters/check/supplementary-data.presenter.js

@@ -1,8 +1,8 @@
 'use strict'
 
 /**
- * Formats responses from the `SupplementaryService`
- * @module SupplementaryPresenter
+ * Formats responses from the `SupplementaryDataService`
+ * @module SupplementaryDataPresenter
  */
 
 function go (data) {

app/routes/check.routes.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const SupplementaryController = require('../controllers/check/supplementary.controller.js')
+
+const routes = [
+  {
+    method: 'GET',
+    path: '/check/supplementary',
+    handler: SupplementaryController.index,
+    options: {
+      description: 'Used by the delivery team to check the SROC supplementary billing logic'
+    }
+  }
+]
+
+module.exports = routes

app/services/supplementary-billing/supplementary.service.js → app/services/check/supplementary-data.service.js

@@ -1,18 +1,15 @@
 'use strict'
 
 /**
- * Determines the billing periods, licences and charge versions used to generate an SROC supplementary bill run
- *
- * WIP: This is currently being used to generate testing data to confirm we are understanding SROC supplementary
- * billing. We intend to refactor things so that the service starts representing what is actually required.
- * @module SupplementaryService
+ * Confirms the billing periods, licences and charge versions used to generate an SROC supplementary bill run
+ * @module SupplementaryDataService
  */
 
-const BillingPeriodService = require('./billing-period.service.js')
-const FetchChargeVersionsService = require('./fetch-charge-versions.service.js')
-const FetchLicencesService = require('./fetch-licences.service.js')
-const FetchRegionService = require('./fetch-region.service.js')
-const SupplementaryPresenter = require('../../presenters/supplementary.presenter.js')
+const BillingPeriodService = require('../supplementary-billing/billing-period.service.js')
+const FetchChargeVersionsService = require('../supplementary-billing/fetch-charge-versions.service.js')
+const FetchLicencesService = require('../supplementary-billing/fetch-licences.service.js')
+const FetchRegionService = require('../supplementary-billing/fetch-region.service.js')
+const SupplementaryDataPresenter = require('../../presenters/check/supplementary-data.presenter.js')
 
 async function go (naldRegionId) {
   const region = await FetchRegionService.go(naldRegionId)
@@ -29,7 +26,7 @@ async function go (naldRegionId) {
 }
 
 function _response (data) {
-  return SupplementaryPresenter.go(data)
+  return SupplementaryDataPresenter.go(data)
 }
 
 module.exports = {

test/controllers/test/supplementary.controller.test.js → test/controllers/check/supplementary.controller.test.js

@@ -9,7 +9,7 @@ const { describe, it, beforeEach, after } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Things we need to stub
-const SupplementaryService = require('../../../app/services/supplementary-billing/supplementary.service.js')
+const SupplementaryDataService = require('../../../app/services/check/supplementary-data.service.js')
 
 // For running our service
 const { init } = require('../../../app/server.js')
@@ -25,16 +25,16 @@ describe('Supplementary controller', () => {
     Sinon.restore()
   })
 
-  describe('GET /test/supplementary', () => {
+  describe('GET /check/supplementary', () => {
     const options = {
       method: 'GET',
-      url: '/test/supplementary?region=9'
+      url: '/check/supplementary?region=9'
     }
 
     let response
 
     beforeEach(async () => {
-      Sinon.stub(SupplementaryService, 'go').resolves({ billingPeriods: [], licences: [], chargeVersions: [] })
+      Sinon.stub(SupplementaryDataService, 'go').resolves({ billingPeriods: [], licences: [], chargeVersions: [] })
 
       response = await server.inject(options)
     })

test/presenters/supplementary.presenter.test.js → test/presenters/check/supplementary-data.presenter.test.js

@@ -8,7 +8,7 @@ const { describe, it, beforeEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Thing under test
-const SupplementaryPresenter = require('../../app/presenters/supplementary.presenter.js')
+const SupplementaryDataPresenter = require('../../../app/presenters/check/supplementary-data.presenter.js')
 
 describe('Supplementary presenter', () => {
   let data
@@ -44,7 +44,7 @@ describe('Supplementary presenter', () => {
     })
 
     it('correctly presents the data', () => {
-      const result = SupplementaryPresenter.go(data)
+      const result = SupplementaryDataPresenter.go(data)
 
       expect(result.billingPeriods).to.have.length(1)
       expect(result.billingPeriods[0]).to.equal(data.billingPeriods[0])
@@ -70,7 +70,7 @@ describe('Supplementary presenter', () => {
     })
 
     it('correctly presents the data', () => {
-      const result = SupplementaryPresenter.go(data)
+      const result = SupplementaryDataPresenter.go(data)
 
       expect(result.billingPeriods).to.be.empty()
       expect(result.licences).to.be.empty()

test/services/supplementary-billing/supplementary.service.test.js → test/services/check/supplementary-data.service.test.js

@@ -15,7 +15,7 @@ const FetchLicencesService = require('../../../app/services/supplementary-billin
 const FetchRegionService = require('../../../app/services/supplementary-billing/fetch-region.service.js')
 
 // Thing under test
-const SupplementaryService = require('../../../app/services/supplementary-billing/supplementary.service.js')
+const SupplementaryDataService = require('../../../app/services/check/supplementary-data.service.js')
 
 describe('Supplementary service', () => {
   const naldRegionId = 9
@@ -40,7 +40,7 @@ describe('Supplementary service', () => {
     })
 
     it('always includes the current billing period', async () => {
-      const result = await SupplementaryService.go(naldRegionId)
+      const result = await SupplementaryDataService.go(naldRegionId)
 
       expect(result.billingPeriods.length).to.equal(1)
       expect(result.billingPeriods[0]).to.equal(currentBillingPeriod)
@@ -63,7 +63,7 @@ describe('Supplementary service', () => {
       })
 
       it('returns the matching licences', async () => {
-        const result = await SupplementaryService.go(naldRegionId)
+        const result = await SupplementaryDataService.go(naldRegionId)
 
         expect(result.licences.length).to.equal(1)
         expect(result.licences[0].licenceId).to.equal(testRecords[0].licenceId)
@@ -76,7 +76,7 @@ describe('Supplementary service', () => {
       })
 
       it('returns no results', async () => {
-        const result = await SupplementaryService.go(naldRegionId)
+        const result = await SupplementaryDataService.go(naldRegionId)
 
         expect(result.licences).to.be.empty()
       })
@@ -102,7 +102,7 @@ describe('Supplementary service', () => {
       })
 
       it('returns the matching charge versions', async () => {
-        const result = await SupplementaryService.go(naldRegionId)
+        const result = await SupplementaryDataService.go(naldRegionId)
 
         expect(result.chargeVersions.length).to.equal(1)
         expect(result.chargeVersions[0].chargeVersionId).to.equal(testRecords[0].chargeVersionId)
@@ -115,7 +115,7 @@ describe('Supplementary service', () => {
       })
 
       it('returns no results', async () => {
-        const result = await SupplementaryService.go(naldRegionId)
+        const result = await SupplementaryDataService.go(naldRegionId)
 
         expect(result.chargeVersions).to.be.empty()
       })