Fix: Markdown and CSV output do not show projects

Author: wsbrs

spec/output/csv.spec.js

@@ -0,0 +1,89 @@
+const moment = require('moment');
+const config = require('../../src/include/config');
+const Report = require('../../src/models/report');
+const Sinon = require('sinon');
+const { describe } = require('mocha');
+const Csv = require('csv-string');
+const csv = require('../../src/output/csv');
+const { assert } = require('chai');
+
+describe('csv output', () => {
+    /**
+     * @type {Sinon.SinonSpyStatic}
+     */
+    let csvSpy;
+
+    beforeEach(() => {
+        csvSpy = Sinon.spy(Csv, 'stringify')
+    })
+
+    afterEach(() => {
+        csvSpy.restore();
+    })
+
+    it('renders projects if more than one', () => {
+        const issues = [
+            {
+                times: [
+                    {
+                        user: "user1",
+                        project_namespace: "project1",
+                        seconds: 360,
+                        date: moment('2024-06-06 00:00:00')
+                    },
+                    {
+                        user: "user2",
+                        project_namespace: "project2",
+                        seconds: 720,
+                        date: moment('2024-06-06 00:00:00')
+                    }
+                ],
+                stats: {time_estimate: 0, total_time_spent: 0}
+            }
+        ];
+    
+        const projectsMatcher = Sinon.match((value) => {
+            return Array.isArray(value) && Array.isArray(value[0]) && value[0].includes('project1') && value[0].includes('project2')
+        }, 'Both projects exist')
+
+        let reportConfig = new config();
+        reportConfig.set('report', ['stats'])
+        let report = new Report(reportConfig);
+        report.issues = issues;
+        report.mergeRequests = [];
+
+        let out = new csv(reportConfig, report);
+        out.make();
+        assert(csvSpy.calledWith(projectsMatcher), 'Not called properly')
+    })
+
+    it('does not render single project', () => {
+        const issues = [
+            {
+                times: [
+                    {
+                        user: "user2",
+                        project_namespace: "project2",
+                        seconds: 720,
+                        date: moment('2024-06-06 00:00:00')
+                    }
+                ],
+                stats: {time_estimate: 0, total_time_spent: 0}
+            }
+        ];
+    
+        const projectsMatcher = Sinon.match((value) => {
+            return Array.isArray(value) && Array.isArray(value[0]) && !value[0].includes('project2')
+        }, 'Project does not exist')
+
+        let reportConfig = new config();
+        reportConfig.set('report', ['stats'])
+        let report = new Report(reportConfig);
+        report.issues = issues;
+        report.mergeRequests = [];
+
+        let out = new csv(reportConfig, report);
+        out.make();
+        assert(csvSpy.calledWith(projectsMatcher), 'Not called properly')
+    })
+})

spec/output/markdown.spec.js

@@ -0,0 +1,75 @@
+const moment = require('moment');
+const config = require('../../src/include/config');
+const Report = require('../../src/models/report');
+const markdown = require('../../src/output/markdown');
+const Sinon = require('sinon');
+
+describe('markdown class', () => {
+    it('Renders projects if more than one', () => {
+        const issues = [
+            {
+                times: [
+                    {
+                        user: "user1",
+                        project_namespace: "project1",
+                        seconds: 360,
+                        date: moment('2024-06-06 00:00:00')
+                    },
+                    {
+                        user: "user2",
+                        project_namespace: "project2",
+                        seconds: 720,
+                        date: moment('2024-06-06 00:00:00')
+                    }
+                ],
+                stats: {time_estimate: 0, total_time_spent: 0}
+            }
+        ];
+    
+        const projectsMatcher = Sinon.match('project1').and(Sinon.match('project2'))
+        let reportConfig = new config();
+        reportConfig.set('report', ['stats'])
+        let report = new Report(reportConfig);
+        report.issues = issues;
+        report.mergeRequests = [];
+
+        let out = new markdown(reportConfig, report);
+        let mdMock = Sinon.mock(out);
+        mdMock.expects('headline').once();
+        mdMock.expects('write').once().withArgs(projectsMatcher);
+        out.make();
+    });
+
+    it('Does not render projects if one project only', () => {
+        const issues = [
+            {
+                times: [
+                    {
+                        user: "user2",
+                        project_namespace: "project2",
+                        seconds: 720,
+                        date: moment('2024-06-06 00:00:00')
+                    }
+                ],
+                stats: {time_estimate: 0, total_time_spent: 0}
+            }
+        ];
+    
+        const projectsMatcher = Sinon.match(function(value) {
+            return ((typeof(value) === 'string') && (/project2/.test(value) === false));
+        })
+
+        let reportConfig = new config();
+        reportConfig.set('report', ['stats'])
+        let report = new Report(reportConfig);
+        report.issues = issues;
+        report.mergeRequests = [];
+
+        let out = new markdown(reportConfig, report);
+        let mdMock = Sinon.mock(out);
+        mdMock.expects('headline').once();
+        mdMock.expects('write').once().withArgs(projectsMatcher);
+        out.make();
+    });
+});
+

src/output/csv.js

@@ -17,7 +17,7 @@ class csv extends Base {
             stats[1].push(time);
         });
 
-        if (this.projects.length > 1) {
+        if (Object.keys(this.projects).length > 1) {
             _.each(this.projects, (time, name) => {
                 stats[0].push(name);
                 stats[1].push(time);
@@ -101,4 +101,4 @@ class csv extends Base {
     }
 }
 
-module.exports = csv;
+module.exports = csv;

src/output/markdown.js

@@ -25,8 +25,8 @@ class markdown extends Base {
         _.each(this.stats, (time, name) => stats += `\n* **${name}**: ${time}`);
         stats += `\n`;
 
-        if (this.projects.length > 1) {
-            _.each(this.projects, (time, name) => stats += `\n* **${name.red}**: ${time}`);
+        if (Object.keys(this.projects).length > 1) {
+            _.each(this.projects, (time, name) => stats += `\n* **${name}**: ${time}`);
             stats += `\n`;
         }
 
@@ -69,4 +69,4 @@ class markdown extends Base {
     }
 }
 
-module.exports = markdown;
+module.exports = markdown;