testing-webapp/backend/__tests__/gitBookApi.test.ts at 4dbf36bc01fb7d427f8b851a5d308e0cb56e6ad7 · GovStackWorkingGroup/testing-webapp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
import chai, { expect } from 'chai';
import request from 'supertest';
import mongoose from 'mongoose';
import { MongoMemoryServer } from 'mongodb-memory-server';
import app from '../server';
import BBRequirements from '../src/db/schemas/bbRequirements';
import fs from 'fs';
import path from 'path';
import GitBookPageContentManager from '../src/services/gitBookService/PageContentManager';
import { RequirementStatusEnum, StatusEnum } from '../src/db/schemas/compliance/complianceUtils';

describe('GitBook API', () => {
    let mongod;

    before(async () => {
        mongod = await MongoMemoryServer.create();
        const uri = mongod.getUri();

        if (mongoose.connection.readyState === 1) {
            await mongoose.disconnect();
        }
        await mongoose.connect(uri);

    });

    after(async () => {
        await mongoose.connection.dropDatabase();
        await mongoose.disconnect();
        await mongod.stop();
    });

    describe('GitBook - Functional Requirements', () => {
        it('should successfully process the data from the file and save it', async () => {
            // Read test data from JSON file
            const testDataPath = path.join(__dirname, 'testData', 'gitBookDocumentFunctionalRequirements.json');
            const testData = JSON.parse(fs.readFileSync(testDataPath, 'utf8'));

            // Process the data
            const contentManager = new GitBookPageContentManager();
            const result = contentManager.extractFunctionalRequirements(
                testData,
                'functional-requirements',
                'test-bb-key'
            );
            if ('error' in result) {
                throw result.error;
            }
            const { requirements } = result;

            expect(requirements).to.be.an('array').with.lengthOf(3);
            expect(requirements[0]).to.have.property('status', RequirementStatusEnum.REQUIRED);
            expect(requirements[0]).to.have.property('requirement');

            expect(requirements[1]).to.have.property('status', RequirementStatusEnum.RECOMMENDED);
            expect(requirements[1]).to.have.property('requirement');

            expect(requirements[2]).to.have.property('status', RequirementStatusEnum.OPTIONAL);
            expect(requirements[2]).to.have.property('requirement');

        });

        it('should successfully create bb requirements record with functional requirements', async () => {
            // Read test data from JSON file
            const testDataPath = path.join(__dirname, 'testData', 'gitBookDocumentFunctionalRequirements.json');
            const testData = JSON.parse(fs.readFileSync(testDataPath, 'utf8'));

            // Process the data
            const contentManager = new GitBookPageContentManager();
            const result = contentManager.extractFunctionalRequirements(
                testData,
                'functional-requirements',
                'some_key'
            );
            if ('error' in result) {
                throw result.error;
            }

            // Create and save BBRequirements instance
            const bbKey = 'some_key';
            const bbName = 'some_name';
            const spaceInfo = { version: '1.0.0' };
            const dateOfSave = new Date().toISOString().split('T')[0]; // To match the date format without time
            const bbRequirement = new BBRequirements({ bbKey, bbName, bbVersion: spaceInfo.version, dateOfSave, requirements: { functional: result.requirements } });
            await bbRequirement.save();

            // Assertions for the bbRequirement record
            expect(bbRequirement).to.have.property('bbKey', bbKey);
            expect(bbRequirement).to.have.property('bbName', bbName);
            expect(bbRequirement).to.have.property('bbVersion', spaceInfo.version);
            expect(bbRequirement).to.have.property('dateOfSave');
            expect(bbRequirement).to.have.property('requirements').that.is.an('object');
            // Further checking the structure of the requirements
            expect(bbRequirement.requirements).to.have.property('functional').that.is.an('array').with.lengthOf(3);

            // Assuming the first requirement should have status REQUIRED
            expect(bbRequirement.requirements?.functional[0]).to.have.property('status', RequirementStatusEnum.REQUIRED);

            // Assuming the second requirement should have status RECOMMENDED
            expect(bbRequirement.requirements?.functional[1]).to.have.property('status', RequirementStatusEnum.RECOMMENDED);

            // Assuming the third requirement should have status OPTIONAL
            expect(bbRequirement.requirements?.functional[2]).to.have.property('status', RequirementStatusEnum.OPTIONAL);
            expect(bbRequirement.requirements).to.have.property('crossCutting').that.is.an('array').with.lengthOf(0);

          });
    });

    describe('GitBook - Cross-Cutting Requirements', () => {
        it('should successfully process the data from the file and save it', async () => {
            // Read test data from JSON file
            const testDataPath = path.join(__dirname, 'testData', 'gitBookDocumentCrossCuttingRequirements.json');
            const testData = JSON.parse(fs.readFileSync(testDataPath, 'utf8'));

            // Process the data
            const contentManager = new GitBookPageContentManager();
            const result = contentManager.extractCrossCuttingRequirements(
                testData,
                null,
                'cross-cutting-requirements',
                'test-bb-key'
            );
            if ('error' in result) {
                throw result.error;
            }
            const { requirements } = result;

            expect(requirements).to.be.an('array').with.lengthOf(3);
            expect(requirements[0]).to.have.property('status', RequirementStatusEnum.REQUIRED);
            expect(requirements[0]).to.have.property('requirement');

            expect(requirements[1]).to.have.property('status', RequirementStatusEnum.RECOMMENDED);
            expect(requirements[1]).to.have.property('requirement');

            expect(requirements[2]).to.have.property('status', RequirementStatusEnum.OPTIONAL);
            expect(requirements[2]).to.have.property('requirement');

        });

        it('should successfully create bb requirements record with cross-cutting requirements', async () => {
            // Read test data from JSON file
            const testDataPath = path.join(__dirname, 'testData', 'gitBookDocumentCrossCuttingRequirements.json');
            const testData = JSON.parse(fs.readFileSync(testDataPath, 'utf8'));

            // Process the data
            const contentManager = new GitBookPageContentManager();
            const result = contentManager.extractCrossCuttingRequirements(
                testData,
                null,
                'cross-cutting-requirements',
                'test-bb-key'
            );
            if ('error' in result) {
                throw result.error;
            }

            // Create and save BBRequirements instance
            const bbKey = 'some_key_cross_cutting';
            const bbName = 'some_name_cross_cutting';
            const spaceInfo = { version: '1.0.0' };
            const dateOfSave = new Date().toISOString().split('T')[0]; // To match the date format without time
            const bbRequirement = new BBRequirements({ bbKey, bbName, bbVersion: spaceInfo.version, dateOfSave, requirements: { crossCutting: result.requirements } });
            await bbRequirement.save();

            // Assertions for the bbRequirement record
            expect(bbRequirement).to.have.property('bbKey', bbKey);
            expect(bbRequirement).to.have.property('bbName', bbName);
            expect(bbRequirement).to.have.property('bbVersion', spaceInfo.version);
            expect(bbRequirement).to.have.property('dateOfSave');
            expect(bbRequirement).to.have.property('requirements').that.is.an('object');

            // Further checking the structure of the requirements
            expect(bbRequirement.requirements).to.have.property('crossCutting').that.is.an('array').with.lengthOf(3);

            // Assuming the first requirement should have status REQUIRED
            expect(bbRequirement.requirements?.crossCutting[0]).to.have.property('status', RequirementStatusEnum.REQUIRED);

            // Assuming the second requirement should have status RECOMMENDED
            expect(bbRequirement.requirements?.crossCutting[1]).to.have.property('status', RequirementStatusEnum.RECOMMENDED);

            // Assuming the third requirement should have status OPTIONAL
            expect(bbRequirement.requirements?.crossCutting[2]).to.have.property('status', RequirementStatusEnum.OPTIONAL);
            expect(bbRequirement.requirements).to.have.property('functional').that.is.an('array').with.lengthOf(0);

          });
    });
});