This repository was archived by the owner on Aug 18, 2021. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathindex.js
More file actions
168 lines (147 loc) · 4.78 KB
/
Copy pathindex.js
File metadata and controls
168 lines (147 loc) · 4.78 KB
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
const path = require('path');
const {
removeDuplicates,
getCodeJsonVersion,
getSchemaValidators,
getCleaner
} = require('./lib');
/**
* Return validator for specified schema indicated in the version field found in the codeJson.
* @param {object} codeJson
*/
function getValidator(codeJson) {
const version = getCodeJsonVersion(codeJson);
return new Validator(version);
}
class Validator {
constructor(version) {
this._version = version.match(/(2\.0)(\.0)?/)
? '2.0.0'
: version;
this.validators = {};
this.PATH_TO_SCHEMAS = path.join(__dirname, 'lib/schemas');
this.SCHEMAS = ['repo'];
this.SCHEMAS.forEach((schemaName) => {
const pathToSchemas = path.join(this.PATH_TO_SCHEMAS, schemaName, this._version);
this.validators[schemaName] = getSchemaValidators(pathToSchemas);
});
this.cleaner = getCleaner(path.join(this.PATH_TO_SCHEMAS, 'repo', this._version));
}
_validateRepo(repo, validatorType) {
let valid = this.validators.repo[validatorType](repo);
return Promise.resolve(
valid ? [] : this.validators.repo[validatorType].errors);
}
/**
* Validate the passed repo with a relaxed json schema.
* @param {Array} errors
* @param {object} repo
*/
_processErrors(errors, repo) {
if(errors.length > 0) {
return this._removeSpecialCases(repo, errors);
}
return [];
}
/**
* Validate the passed repo with a strict json schema.
* @param {Array} warnings
* @param {object} repo
* @param {Array} errors
*/
_processWarnings(warnings, repo, errors) {
if(warnings.length > 0) {
let cleanedWarnings = removeDuplicates(warnings, errors);
return this._removeSpecialCases(repo, cleanedWarnings);
}
return [];
}
/**
* Validate the repo with a enhanced json schema.
* @param {Array} enhancements
* @param {object} repo
* @param {Array} errors
* @param {Array} warnings
*/
_processEnhancements(enhancements, repo, errors, warnings) {
if(enhancements.length > 0) {
let cleanedEnhancements = removeDuplicates(enhancements, errors);
cleanedEnhancements = removeDuplicates(enhancements, warnings);
return this._removeSpecialCases(repo, cleanedEnhancements);
}
return [];
}
_isNotOpenSource(repo) {
if (repo.hasOwnProperty('permissions')) {
return repo.permissions.usageType !== 'openSource';
}
return false;
}
_propertyMissing(property, obj) {
if (obj.params && obj.params.hasOwnProperty('missingProperty')) {
return obj.params.missingProperty === property;
}
return false;
}
/**
* Remove errors that fall under specific special cases for warnings.
* @param {object} repo
* @param {object} validationItems
*/
_removeSpecialCases(repo, validationItems) {
return validationItems.filter((validationItem) => {
if (this._isNotOpenSource(repo)) {
const repoUrlMissingWaring = this._propertyMissing('repositoryURL', validationItem) ||
this._propertyMissing('repository', validationItem);
if (repoUrlMissingWaring) {
return false;
}
if(validationItem.dataPath === '.repositoryURL') {
return !(repo.repositoryURL === null || repo.repositoryURL === undefined);
}
const licencesMissing = this._propertyMissing('licences', validationItem);
if(licencesMissing) {
return false;
}
if(validationItem.dataPath === '.permissions') {
return !(repo.permissions.licenses === null || repo.permissions.licenses === undefined);
}
}
return true;
});
}
/**
* Validate a given repo's metadata structure.
* @param {object} repo Repository to validate for a given agency
* @param {object} agency Agency metadata
* @returns {object} With validation result.
*/
async validateRepo(repo, agency) {
let result = {
repoID: repo.repoID,
agency: agency.name,
organization: repo.organization,
project_name: repo.name,
issues: {
enhancements: [],
warnings: [],
errors: []
}
};
try {
const relaxedValidationErrors = await this._validateRepo(repo, 'relaxed');
result.issues.errors = this._processErrors(relaxedValidationErrors, repo);
const strictValidationErrors = await this._validateRepo(repo, 'strict');
result.issues.warnings = this._processWarnings(strictValidationErrors, repo, result.issues.errors);
const enhancedValidationErrors = await this._validateRepo(repo, 'enhanced');
result.issues.enhancements = this._processEnhancements(
enhancedValidationErrors, repo, result.issues.errors, result.issues.warnings);
} catch (error) {
return Promise.reject(error);
}
return Promise.resolve(result);
}
}
module.exports = {
getValidator
};