abdallah
/
one-click-apps
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Validating v4

This commit is contained in:
Kasra Bigdeli 2020-08-16 08:58:13 -04:00
parent b643e1709a
commit 7bab4b4afc
4 changed files with 140 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/validate_json.yml → .github/workflows/validate_apps.yml vendored
View File

@ -16,6 +16,6 @@ jobs:
- uses: actions/setup-node@v1
with:
node-version: 14
- run: npm ci && npm run validate_json && npm run formatter
- run: npm ci && npm run validate_apps && npm run formatter
env:
GITHUB_PERSONAL_TOKEN: ${{secrets.GITHUB_PERSONAL_TOKEN}}

2
package.json
View File

@ -6,7 +6,7 @@
"formatter": "prettier --check './public/**/*.(json|yml)'",
"formatter-write": "prettier --write './public/**/*.(json|yml)'",
"build": "rm -rf ./dist/ && mkdir -p dist && node ./scripts/build_one_click_apps.js && node ./scripts/build_one_click_apps_from_v4.js",
"validate_json": "node ./scripts/validate_json.js",
"validate_apps": "node ./scripts/validate_apps.js",
"publish": "npm run build && ./scripts/publish-from-actions.sh"
},
"repository": {

138
scripts/validate_apps.js Normal file
View File

@ -0,0 +1,138 @@
/*jshint esversion: 6 */
const path = require('path');
const yaml = require('yaml');
const fs = require('fs-extra');
const PUBLIC = `public`;
const pathOfPublic = path.join(__dirname, '..', PUBLIC);
// validating version 4
function validateV4() {
const version = '4';
const pathOfVersion = path.join(pathOfPublic, 'v' + version);
const pathOfApps = path.join(pathOfVersion, 'apps');
return fs.readdir(pathOfApps)
.then(function (items) {
const apps = items.filter(v => v.includes('.yml'));
if (items.length !== apps.length) {
throw new Error('All files in v4 must end with .yml');
}
for (var i = 0; i < apps.length; i++) {
const contentString = fs.readFileSync(path.join(pathOfApps, apps[i]), 'utf-8');
const content = yaml.parse(contentString);
const captainVersion = (content.captainVersion + '');
const versionString = (version + '');
if (versionString !== captainVersion)
throw new Error(`unmatched versions ${versionString} ${captainVersion} for ${apps[i]}`);
apps[i] = apps[i].replace('.yml', '');
if (!content.caproverOneClickApp) {
throw new Error(`Cannot find caproverOneClickApp for ${apps[i]}`);
}
if (!content.caproverOneClickApp.description) {
throw new Error(`Cannot find description for ${apps[i]}`);
}
if (!content.caproverOneClickApp.instructions ||
!content.caproverOneClickApp.instructions.start ||
!content.caproverOneClickApp.instructions.end) {
throw new Error(`Cannot find instructions.start or instructions.end for ${apps[i]}`);
}
if (!content.services) {
throw new Error(`Cannot find services for ${apps[i]}`);
}
Object.keys(content.services).forEach(
(serviceName) => { // jshint ignore:line
const s = content.services[serviceName];
if (s.image && s.image.endsWith(':latest')) {
throw new Error(`"latest" tag is not allowed as it can change and break the setup, see ${apps[i]}`);
}
});
const logoFileName = apps[i] + '.png';
const logoFullPath = path.join(pathOfVersion, 'logos', logoFileName);
if (!fs.existsSync(logoFullPath) ||
!fs.statSync(logoFullPath).isFile()) {
let printablePath = logoFullPath;
printablePath = printablePath.substr(printablePath.indexOf(`/${PUBLIC}`));
throw new Error(`Cannot find logo for ${apps[i]} ${printablePath}`);
}
console.log(`Validated ${apps[i]}`);
}
});
}
// validating version 2
function validateV2() {
const version = '2';
const pathOfVersion = path.join(pathOfPublic, 'v' + version);
const pathOfApps = path.join(pathOfVersion, 'apps');
return fs.readdir(pathOfApps)
.then(function (items) {
const apps = items.filter(v => v.includes('.json'));
if (items.length !== apps.length) {
throw new Error('All files in v2 must end with .json');
}
for (var i = 0; i < apps.length; i++) {
const contentString = fs.readFileSync(path.join(pathOfApps, apps[i]));
const content = JSON.parse(contentString);
const captainVersion = (content.captainVersion + '');
const versionString = (version + '');
if (versionString !== captainVersion)
throw new Error(`unmatched versions ${versionString} ${captainVersion} for ${apps[i]}`);
apps[i] = apps[i].replace('.json', '');
if (!content.description) {
throw new Error(`Cannot find description for ${apps[i]}`);
}
const logoFileName = apps[i] + '.png';
const logoFullPath = path.join(pathOfVersion, 'logos', logoFileName);
if (!fs.existsSync(logoFullPath) ||
!fs.statSync(logoFullPath).isFile()) {
let printablePath = logoFullPath;
printablePath = printablePath.substr(printablePath.indexOf(`/${PUBLIC}`));
throw new Error(`Cannot find logo for ${apps[i]} ${printablePath}`);
}
console.log(`Validated ${apps[i]}`);
}
});
}
Promise.resolve()
.then(function () {
return validateV2();
})
.then(function () {
return validateV4();
})
.catch(function (err) {
console.error(err);
process.exit(127);
});

104
scripts/validate_json.js
View File

@ -1,104 +0,0 @@
/*jshint esversion: 6 */
const path = require('path');
const fs = require('fs-extra');
const PUBLIC = `public`;
const pathOfPublic = path.join(__dirname, '..', PUBLIC);
// validating version 4
// function validateV4() {
// const version = '2';
// const pathOfVersion = path.join(pathOfPublic, 'v' + version);
// const pathOfApps = path.join(pathOfVersion, 'apps');
// return fs.readdir(pathOfApps)
// .then(function (items) {
// const apps = items.filter(v => v.includes('.json'));
// for (var i = 0; i < apps.length; i++) {
// const contentString = fs.readFileSync(path.join(pathOfApps, apps[i]));
// const content = JSON.parse(contentString);
// const captainVersion = (content.captainVersion + '');
// const versionString = (version + '');
// if (versionString !== captainVersion)
// throw new Error(`unmatched versions ${versionString} ${captainVersion} for ${apps[i]}`);
// apps[i] = apps[i].replace('.json', '');
// if (!content.description){
// throw new Error(`Cannot find description for ${apps[i]}`);
// }
// const logoFileName = apps[i] + '.png';
// const logoFullPath = path.join(pathOfVersion, 'logos', logoFileName);
// if (!fs.existsSync(logoFullPath) ||
// !fs.statSync(logoFullPath).isFile()) {
// let printablePath = logoFullPath;
// printablePath = printablePath.substr(printablePath.indexOf(`/${PUBLIC}`));
// throw new Error(`Cannot find logo for ${apps[i]} ${printablePath}`);
// }
// console.log(`Validated ${apps[i]}`);
// }
// });
// }
// validating version 2
function validateV2() {
const version = '2';
const pathOfVersion = path.join(pathOfPublic, 'v' + version);
const pathOfApps = path.join(pathOfVersion, 'apps');
return fs.readdir(pathOfApps)
.then(function (items) {
const apps = items.filter(v => v.includes('.json'));
for (var i = 0; i < apps.length; i++) {
const contentString = fs.readFileSync(path.join(pathOfApps, apps[i]));
const content = JSON.parse(contentString);
const captainVersion = (content.captainVersion + '');
const versionString = (version + '');
if (versionString !== captainVersion)
throw new Error(`unmatched versions ${versionString} ${captainVersion} for ${apps[i]}`);
apps[i] = apps[i].replace('.json', '');
if (!content.description) {
throw new Error(`Cannot find description for ${apps[i]}`);
}
const logoFileName = apps[i] + '.png';
const logoFullPath = path.join(pathOfVersion, 'logos', logoFileName);
if (!fs.existsSync(logoFullPath) ||
!fs.statSync(logoFullPath).isFile()) {
let printablePath = logoFullPath;
printablePath = printablePath.substr(printablePath.indexOf(`/${PUBLIC}`));
throw new Error(`Cannot find logo for ${apps[i]} ${printablePath}`);
}
console.log(`Validated ${apps[i]}`);
}
});
}
Promise.resolve()
.then(function () {
return validateV2();
})
.catch(function (err) {
console.error(err);
process.exit(127);
});