[O2B-805] Fix broken FLP API tests and remove unutilized and broken FLP Log implementation (#1282)

SandroBoelsz · web-flow · commit a86f45661eb1 · 2023-12-07T17:38:25.000+01:00
* refactor: remove unutilized and broken FLP Log Implementation
* refactor: remove test cases for non-existent functionality and fix broken test cases
* include FLP API tests in the API test suites
diff --git a/lib/server/controllers/flps.controller.js b/lib/server/controllers/flps.controller.js
@@ -15,7 +15,6 @@ const {
     flp: {
         GetAllFlpsUseCase,
         GetFlpUseCase,
-        GetLogsByFlpUseCase,
         CreateFlpUseCase,
         UpdateFlpUseCase,
     },
@@ -97,40 +96,6 @@ const getFlpById = async (request, response) => {
     }
 };
 
-/**
- * Get all logs with flp.
- *
- * @param {Object} request The *request* object represents the HTTP request and has properties for the request query
- *                         string, parameters, body, HTTP headers, and so on.
- * @param {Object} response The *response* object represents the HTTP response that an Express app sends when it gets an
- *                          HTTP request.
- * @returns {undefined}
- */
-const getLogsByFlpId = async (request, response) => {
-    const value = await dtoValidator(GetFlpDto, request, response);
-    if (!value) {
-        return;
-    }
-
-    const logs = await new GetLogsByFlpUseCase()
-        .execute(value);
-
-    if (logs === null) {
-        response.status(404).json({
-            errors: [
-                {
-                    status: '404',
-                    title: `Flp with this id (${value.params.flpId}) could not be found`,
-                },
-            ],
-        });
-    } else {
-        response.status(200).json({
-            data: logs,
-        });
-    }
-};
-
 /**
  * Create a new flp.
  *
@@ -184,7 +149,6 @@ const update = async (request, response) => {
 module.exports = {
     getFlpById,
     listFlps,
-    getLogsByFlpId,
     create,
     update,
 };
diff --git a/lib/server/routers/flps.router.js b/lib/server/routers/flps.router.js
@@ -23,13 +23,6 @@ module.exports = {
             method: 'get',
             path: ':flpId',
             controller: FlpsController.getFlpById,
-            children: [
-                {
-                    method: 'get',
-                    path: 'logs',
-                    controller: FlpsController.getLogsByFlpId,
-                },
-            ],
         },
         {
             method: 'post',
diff --git a/lib/usecases/flp/GetLogsByFlpUseCase.js b/lib/usecases/flp/GetLogsByFlpUseCase.js
diff --git a/lib/usecases/flp/index.js b/lib/usecases/flp/index.js
@@ -13,14 +13,12 @@
 
 const GetAllFlpsUseCase = require('./GetAllFlpsUseCase');
 const GetFlpUseCase = require('./GetFlpUseCase');
-const GetLogsByFlpUseCase = require('./GetLogsByFlpUseCase');
 const CreateFlpUseCase = require('./CreateFlpUseCase');
 const UpdateFlpUseCase = require('./UpdateFlpUseCase');
 
 module.exports = {
     GetAllFlpsUseCase,
     GetFlpUseCase,
-    GetLogsByFlpUseCase,
     CreateFlpUseCase,
     UpdateFlpUseCase,
 };
diff --git a/test/api/flps.test.js b/test/api/flps.test.js
@@ -84,8 +84,7 @@ module.exports = () => {
 
                     const { errors } = res.body;
                     const titleError = errors.find((err) => err.source.pointer === '/data/attributes/query/page/limit');
-                    expect(titleError.detail).to.equal('"query.page.limit" must be larger than or equal to 1');
-
+                    expect(titleError.detail).to.equal('"query.page.limit" must be greater than or equal to 1');
                     done();
                 });
         });
@@ -109,40 +108,6 @@ module.exports = () => {
                     done();
                 });
         });
-
-        it('should support sorting, name DESC', (done) => {
-            request(server)
-                .get('/api/flps?sort[name]=desc')
-                .expect(200)
-                .end((err, res) => {
-                    if (err) {
-                        done(err);
-                        return;
-                    }
-
-                    const { data } = res.body;
-                    expect(data[0].name).to.be.greaterThan(data[1].name);
-
-                    done();
-                });
-        });
-
-        it('should support sorting, name ASC', (done) => {
-            request(server)
-                .get('/api/flps?sort[name]=asc')
-                .expect(200)
-                .end((err, res) => {
-                    if (err) {
-                        done(err);
-                        return;
-                    }
-
-                    const { data } = res.body;
-                    expect(data[1].name).to.be.greaterThan(data[0].name);
-
-                    done();
-                });
-        });
     });
 
     describe('GET /api/flps/:flpId', () => {
@@ -233,65 +198,6 @@ module.exports = () => {
         });
     });
 
-    describe('GET /api/flps/:flpId/logs', () => {
-        it('should return 400 if the flp id is not a number', (done) => {
-            request(server)
-                .get('/api/flps/abc/logs')
-                .expect(400)
-                .end((err, res) => {
-                    if (err) {
-                        done(err);
-                        return;
-                    }
-
-                    const { errors } = res.body;
-                    const titleError = errors.find((err) => err.source.pointer === '/data/attributes/params/flpId');
-                    expect(titleError.detail).to.equal('"params.flpId" must be a number');
-
-                    done();
-                });
-        });
-
-        it('should return 404 if the flp could not be found', (done) => {
-            request(server)
-                .get('/api/flps/999999999/logs')
-                .expect(404)
-                .end((err, res) => {
-                    if (err) {
-                        done(err);
-                        return;
-                    }
-
-                    expect(res.body.errors[0].title).to.equal('Flp with this id (999999999) could not be found');
-
-                    done();
-                });
-        });
-
-        it('should return 200 in all other cases', (done) => {
-            request(server)
-                .get('/api/flps/1/logs')
-                .expect(200)
-                .end((err, res) => {
-                    if (err) {
-                        done(err);
-                        return;
-                    }
-
-                    expect(res.body.data).to.be.an('array');
-                    expect(res.body.data).to.have.lengthOf(4);
-
-                    expect(res.body.data[0].id).to.equal(1);
-                    expect(res.body.data[0].flps).to.deep.equal([
-                        {
-                            id: 1,
-                        },
-                    ]);
-                    done();
-                });
-        });
-    });
-
     describe('POST api/flps', () => {
         it('should return 400 if no name or hostname is provided', (done) => {
             request(server)
@@ -320,6 +226,7 @@ module.exports = () => {
                 .send({
                     name: 'FLPIEE',
                     hostname: 'www.home.cern',
+                    runNumber: 106,
                 })
                 .expect(201)
                 .end((err, res) => {
@@ -330,6 +237,7 @@ module.exports = () => {
 
                     expect(res.body.data.name).to.equal('FLPIEE');
                     expect(res.body.data.hostname).to.equal('www.home.cern');
+                    expect(res.body.data.runNumber).to.equal(106);
 
                     done();
                 });
diff --git a/test/api/index.js b/test/api/index.js
@@ -17,7 +17,7 @@ const DetectorsSuite = require('./detectors.test.js');
 const DPLProcessSuite = require('./dplProcess.test.js');
 const EnvironmentsSuite = require('./environments.test.js');
 const EosReportSuite = require('./eosReport.test.js');
-// TODO [O2B-805] const FlpSuite = require('./flps.test.js');
+const FlpSuite = require('./flps.test.js');
 const StatusSuite = require('./status.test.js');
 const LogsSuite = require('./logs.test.js');
 const LhcFillSuite = require('./lhcFills.test.js');
@@ -37,7 +37,7 @@ module.exports = () => {
     describe('DPL Process API', DPLProcessSuite);
     describe('Environments API', EnvironmentsSuite);
     describe('EOS report API', EosReportSuite);
-    // TODO [O2B-805] describe('FLP API', FlpSuite);
+    describe('FLP API', FlpSuite);
     describe('LhcFills API', LhcFillSuite);
     describe('Logs API', LogsSuite);
     describe('Runs API', RunsSuite);
diff --git a/test/lib/usecases/flp/GetAllFlpsUseCase.test.js b/test/lib/usecases/flp/GetAllFlpsUseCase.test.js
diff --git a/test/lib/usecases/flp/index.js b/test/lib/usecases/flp/index.js
@@ -12,11 +12,9 @@
  */
 
 const CreateFlpUseCase = require('./CreateFlpUseCase.test.js');
-const GetAllFlpsUseCase = require('./GetAllFlpsUseCase.test.js');
 const GetFlpUseCase = require('./GetFlpUseCase.test.js');
 
 module.exports = () => {
     describe('CreateFlpUseCase', CreateFlpUseCase);
-    describe('GetAllFlpsUseCase', GetAllFlpsUseCase);
     describe('GetFlpUseCase', GetFlpUseCase);
 };
