added a basic performance test for v4 establishments and trusts

CypressTests/cypress/e2e/v1/healthchecks.cy.js

@@ -1,41 +1,35 @@
 describe("Health and Database Checks", () => {
-  let apiKey = Cypress.env('apiKey');
+  let apiKey = Cypress.env('apiKey')
   let url = Cypress.env('url')
 
   context('Health check endpoint', () => {
     it('should return a healthy response', () => {
       cy.api({
-        method: 'GET',
-        failOnStatusCode: false,
-        url: url + "/HealthCheck",
+        url: `${url}/HealthCheck`,
         headers: {
           ApiKey: apiKey,
           "Content-type": "application/json"
         }
       })
         .then((response) => {
-          expect(response.body).to.contain('Health check ok');
-          expect(response.status).to.eq(200);
-          cy.log(JSON.stringify(response.body));
+          expect(response.body).to.contain('Health check ok')
+          expect(response.status).to.eq(200)
         })
     })
   })
 
   context('Database check endpoint', () => {
     it('should return a healthy response', () => {
       cy.api({
-        method: 'GET',
-        failOnStatusCode: false,
-        url: url + "check_db",
+        url: `${url}/check_db`,
         headers: {
           ApiKey: apiKey,
           "Content-type": "application/json"
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
-          expect(response.body).to.eq(true);
-          cy.log("Database Check = " + JSON.stringify(response.body));
+          expect(response.status).to.eq(200)
+          expect(response.body).to.eq(true)
         })
     })
   })

CypressTests/cypress/e2e/v1/keyStagePerformance.cy.js

@@ -0,0 +1,24 @@
+describe('Key Stage Performance endpoint tests', () => {
+
+  const apiKey = Cypress.env('apiKey')
+  const url = Cypress.env('url')
+  const urn = '100000'
+  const schoolName = 'The Aldgate School'
+
+  it('Returns education performance data when URN supplied', () => {
+
+    cy.api({
+      method: 'GET',
+      url: `${url}/educationPerformance/${urn}`,
+      headers: {
+        ApiKey: apiKey,
+        "Content-type": "application/json"
+      }
+    })
+      .then((response) => {
+        expect(response.status).to.eq(200)
+        expect(response.body.schoolName).to.eq(schoolName)
+        expect(response.body).to.include.keys('schoolName', 'keyStage1', 'keyStage2', 'keyStage4', 'keyStage5')
+      })
+  })
+})

CypressTests/cypress/e2e/v2/baselineTracker.cy.js

@@ -0,0 +1,27 @@
+describe("Baseline Tracker endpoint", () => {
+
+  const apiKey = Cypress.env('apiKey')
+  const baseUrlV2 = `${Cypress.env('url')}/v2`
+
+  it("Should return a list of baseline trackers when default parameters set", () => {
+
+    // TODO change url endpoint when spelling mistake resolved
+    cy.api({
+      method: 'GET',
+      url: `${baseUrlV2}/basline-tracker`,
+      qs: {
+        page: 1,
+        count: 50
+      },
+      headers: {
+        ApiKey: apiKey,
+        "Content-type": "application/json"
+      }
+    })
+      .then((response) => {
+        expect(response.status).to.eq(200)
+        expect(response.body.data).to.have.lengthOf.at.least(1).and.lengthOf.at.most(50)
+      })
+  })
+
+})

CypressTests/cypress/e2e/v2/fssProjects.cy.js

@@ -0,0 +1,30 @@
+/// <reference types="Cypress"/>
+describe("Free Schools Store endpoint", () => {
+
+  const apiKey = Cypress.env('apiKey')
+  const baseUrlV2 = `${Cypress.env('url')}/v2`
+
+  it("Should return a valid response with data", () => {
+    cy.api({
+      url: `${baseUrlV2}/fss/projects`,
+      headers: {
+        ApiKey: apiKey,
+      }
+    })
+    .then((response) => {
+      expect(response.status).to.eq(200)
+      expect(response.body.data).to.have.lengthOf.at.least(1)
+      expect(response.body.data[0]).to.include.all.keys('localAuthority', 'projectId', 'projectStatus', 'trustId', 'trustName', 'urn')
+    })
+  })
+
+  it("Should return a valid 401 response when omitting API key", () => {
+    cy.api({
+      failOnStatusCode: false,
+      url: `${baseUrlV2}/fss/projects`,
+      headers: {
+        ApiKey: '',
+      }
+    }).its('status').should('eq', 401)
+  })
+})

CypressTests/cypress/e2e/v3/trusts.cy.js

@@ -0,0 +1,116 @@
+describe('Trusts endpoints tests', () => {
+
+  const apiKey = Cypress.env('apiKey')
+  const baseUrlV3 = `${Cypress.env('url')}/v3`
+  const companiesHouseNumber = '11082297'
+  const ukprn = '10067112'
+  const groupName = 'SOUTH YORK MULTI ACADEMY TRUST'
+
+  context('Search Trusts', () => {
+
+    it('should return a list of trusts when default search parameters set', () => {
+
+      cy.api({
+        method: 'GET',
+        url: `${baseUrlV3}/trusts`,
+        qs: {
+          page: 1,
+          count: 50
+        },
+        headers: {
+          ApiKey: apiKey,
+          "Content-type": "application/json"
+        }
+      })
+        .then((response) => {
+          expect(response.status).to.eq(200)
+          expect(response.body.data).to.have.lengthOf.at.least(1).and.lengthOf.at.most(50)
+          expect(response.body.paging.page).to.eq(1)
+        })
+    })
+
+    it('should return a single trust when group name set', () => {
+
+      cy.api({
+        method: 'GET',
+        url: `${baseUrlV3}/trusts`,
+        qs: {
+          groupName: groupName,
+          page: 1,
+          count: 50
+        },
+        headers: {
+          ApiKey: apiKey,
+          "Content-type": "application/json"
+        }
+      })
+        .then((response) => {
+          expect(response.status).to.eq(200)
+          expect(response.body.data[0].groupName).to.eq(groupName)
+        })
+    })
+
+    it('should return a single trust when UKPRN set', () => {
+
+      cy.api({
+        method: 'GET',
+        url: `${baseUrlV3}/trusts`,
+        qs: {
+          ukPrn: ukprn,
+          page: 1,
+          count: 50
+        },
+        headers: {
+          ApiKey: apiKey,
+          "Content-type": "application/json"
+        }
+      })
+        .then((response) => {
+          expect(response.status).to.eq(200)
+          expect(response.body.data[0].groupName).to.eq(groupName)
+        })
+    })
+
+    it('should return a single trust when Companies House Number set', () => {
+
+      cy.api({
+        method: 'GET',
+        url: `${baseUrlV3}/trusts`,
+        qs: {
+          companiesHouseNumber: companiesHouseNumber,
+          page: 1,
+          count: 50
+        },
+        headers: {
+          ApiKey: apiKey,
+          "Content-type": "application/json"
+        }
+      })
+        .then((response) => {
+          expect(response.status).to.eq(200)
+          expect(response.body.data[0].groupName).to.eq(groupName)
+          expect(response.body.data[0].companiesHouseNumber).to.eq(companiesHouseNumber)
+        })
+    })
+  })
+
+  context('Get Trust by UKPRN', () => {
+
+    it('should return a single trust when UKPRN set', () => {
+
+      cy.api({
+        method: 'GET',
+        url: `${baseUrlV3}/trust/${ukprn}`,
+        headers: {
+          ApiKey: apiKey,
+          "Content-type": "application/json"
+        }
+      })
+        .then((response) => {
+          expect(response.status).to.eq(200)
+          expect(response.body.data).to.include.keys('trustData', 'giasData', 'establishments')
+          expect(response.body.data.giasData.groupName).to.eq(groupName)
+        })
+    })
+  })
+})

CypressTests/cypress/e2e/v4/trusts.cy.js

@@ -1,6 +1,6 @@
 describe('Trusts endpoints tests', () => {
 
-  const apiKey = Cypress.env('apiKey');
+  const apiKey = Cypress.env('apiKey')
   const baseUrlV4 = `${Cypress.env('url')}/v4`
   const companiesHouseNumber = '11082297'
   const ukprns = ['10067112', '10067113']
@@ -24,7 +24,7 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
+          expect(response.status).to.eq(200)
           expect(response.body.data).to.have.lengthOf.at.least(1).and.lengthOf.at.most(10)
           expect(response.body.paging.page).to.eq(1)
         })
@@ -46,7 +46,7 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
+          expect(response.status).to.eq(200)
           expect(response.body.data[0].name).to.eq(groupName)
         })
     })
@@ -67,7 +67,7 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
+          expect(response.status).to.eq(200)
           expect(response.body.data[0].name).to.eq(groupName)
         })
     })
@@ -88,7 +88,7 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
+          expect(response.status).to.eq(200)
           expect(response.body.data[0].name).to.eq(groupName)
           expect(response.body.data[0].companiesHouseNumber).to.eq(companiesHouseNumber)
         })
@@ -108,7 +108,7 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
+          expect(response.status).to.eq(200)
           expect(response.body.name).to.eq(groupName)
         })
     })
@@ -130,7 +130,7 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
+          expect(response.status).to.eq(200)
           expect(response.body[0].name).to.eq(groupName)
           expect(response.body[0].ukprn).to.eq(ukprns[0])
         })
@@ -153,12 +153,14 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
-          // Response isn't in UKPRN order
-          expect(response.body[1].name).to.eq(groupName)
-          expect(response.body[1].ukprn).to.eq(ukprns[0])
-          expect(response.body[0].name).to.eq('THE BISHOP FRASER TRUST')
-          expect(response.body[0].ukprn).to.eq(ukprns[1])
+          expect(response.status).to.eq(200)
+          expect(response.body).to.have.lengthOf(2)
+          // Response isn't neccessarily in UKPRN order
+          const resBody = JSON.stringify(response.body)
+          expect(resBody).to.have.string(groupName)
+          expect(resBody).to.have.string(ukprns[0])
+          expect(resBody).to.have.string('THE BISHOP FRASER TRUST')
+          expect(resBody).to.have.string(ukprns[1])
         })
     })
   })
@@ -176,7 +178,7 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
+          expect(response.status).to.eq(200)
           expect(response.body.name).to.eq(groupName)
           expect(response.body.companiesHouseNumber).to.eq(companiesHouseNumber)
         })
@@ -196,7 +198,7 @@ describe('Trusts endpoints tests', () => {
         }
       })
         .then((response) => {
-          expect(response.status).to.eq(200);
+          expect(response.status).to.eq(200)
           expect(response.body.name).to.eq(groupName)
           expect(response.body.referenceNumber).to.eq(trustReferenceNumber)
         })

CypressTests/cypress/plugins/index.js

@@ -12,7 +12,7 @@
 // This function is called when a project is opened or re-opened (e.g. due to
 // the project's config changing)
 
-const { generateZapHTMLReport } = require('./generateZapReport');
+const { generateZapHTMLReport } = require('./generateZapReport')
 
 /**
  * @type {Cypress.PluginConfig}

CypressTests/cypress/support/commands.js

@@ -26,6 +26,6 @@
 
 
 
-import { validateSchema } from "./validate-schema-command";
+import { validateSchema } from "./validate-schema-command"
 
-Cypress.Commands.add("validateSchema", validateSchema);
+Cypress.Commands.add("validateSchema", validateSchema)