feat(api): add hash method in Module model

Co-authored-by: Diane Cordier <[email protected]>

Author: er-lim

api/src/devcomp/domain/models/module/Module.js

@@ -1,3 +1,5 @@
+import crypto from 'node:crypto';
+
 import { assertNotNullOrUndefined } from '../../../../shared/domain/models/asserts.js';
 import { ModuleInstantiationError } from '../../errors.js';
 
@@ -37,6 +39,12 @@ class Module {
       throw new ModuleInstantiationError('A module should have a list of grains');
     }
   }
+
+  hash() {
+    const hash = crypto.createHash('sha256');
+    hash.update(JSON.stringify(this));
+    return hash.copy().digest('hex');
+  }
 }
 
 export { Module };

api/tests/devcomp/unit/domain/models/module/Module_test.js

@@ -1,7 +1,9 @@
+import crypto from 'node:crypto';
+
 import { ModuleInstantiationError } from '../../../../../../src/devcomp/domain/errors.js';
 import { Module } from '../../../../../../src/devcomp/domain/models/module/Module.js';
 import { DomainError } from '../../../../../../src/shared/domain/errors.js';
-import { catchErrSync, expect } from '../../../../../test-helper.js';
+import { catchErrSync, expect, sinon } from '../../../../../test-helper.js';
 
 describe('Unit | Devcomp | Domain | Models | Module | Module', function () {
   describe('#constructor', function () {
@@ -138,4 +140,39 @@ describe('Unit | Devcomp | Domain | Models | Module | Module', function () {
       });
     });
   });
+
+  describe('#hash', function () {
+    it('returns hash of module content', function () {
+      // given
+      const id = 1;
+      const slug = 'les-adresses-email';
+      const title = 'Les adresses email';
+      const isBeta = false;
+      const grains = [Symbol('text')];
+      const transitionTexts = [];
+      const details = Symbol('details');
+      const module = new Module({ id, slug, title, isBeta, grains, details, transitionTexts });
+      const hashedResult = 'AZERTY123456';
+
+      const digestStub = sinon.stub().returns(hashedResult);
+      const updateStub = sinon.stub();
+      const createHashStub = sinon.stub(crypto, 'createHash').returns({
+        copy: () => {
+          return {
+            digest: digestStub,
+          };
+        },
+        update: updateStub,
+      });
+
+      // when
+      const result = module.hash();
+
+      // then
+      expect(result).to.deep.equal(hashedResult);
+      expect(createHashStub).to.have.been.calledOnceWith('sha256');
+      expect(updateStub).to.have.been.calledOnceWith(JSON.stringify(module));
+      expect(digestStub).to.have.been.calledOnceWith('hex');
+    });
+  });
 });