generated from Seekra/repository-template
Merge pull request 'Add settings validator unit test' (#113) from testing/settings-validator into main
Deploy on dev / Deploy on dev (push) Successful in 42s
Deploy on dev / Deploy on dev (push) Successful in 42s
Reviewed-on: #113 Reviewed-by: Jakob Gregory
This commit was merged in pull request #113.
This commit is contained in:
Gitea
@@ -0,0 +1,699 @@
|
||||
/*
|
||||
Copyright 2026 Seekra
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import { describe, test, expect } from 'vitest';
|
||||
import { validateSettingsConfig, validateEntry, validateSelectionOptions, assertType, assertString } from '../settingsValidator';
|
||||
|
||||
describe('validateSettingsConfig', () => {
|
||||
test.for([
|
||||
{ raw: false, expected: false },
|
||||
{ raw: true, expected: false },
|
||||
{ raw: 0, expected: false },
|
||||
{ raw: 42, expected: false },
|
||||
{ raw: '', expected: false },
|
||||
{ raw: ' ', expected: false },
|
||||
{ raw: 'a', expected: false },
|
||||
{ raw: {}, expected: false },
|
||||
{ raw: {
|
||||
contents: []
|
||||
}, expected: true },
|
||||
{ raw: {
|
||||
contents: [
|
||||
{
|
||||
type: 'section',
|
||||
name: 'general',
|
||||
i18n: 'settings.settings.general',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}, expected: true },
|
||||
{ raw: {
|
||||
contents: [
|
||||
{
|
||||
type: 'section',
|
||||
name: 'general',
|
||||
i18n: 'settings.settings.general',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'copyOfGeneral',
|
||||
i18n: 'settings.settings.copyOfGeneral',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
}, expected: true },
|
||||
{ raw: {
|
||||
contents: [
|
||||
{
|
||||
type: 'section',
|
||||
name: 'general',
|
||||
i18n: 'settings.settings.general',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'copyOfGeneral',
|
||||
i18n: 'settings.settings.copyOfGeneral',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
default: false,
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'aSection',
|
||||
i18n: 'settings.settings.aSection',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 43',
|
||||
i18n: 'settings.settings.aSection.enableFeature43'
|
||||
},
|
||||
{
|
||||
type: 'selection',
|
||||
name: 'language',
|
||||
i18n: 'settings.settings.aSection.language.label',
|
||||
default: 'en',
|
||||
options: [
|
||||
{ name: 'en', i18n: 'settings.settings.aSection.language.options.en' },
|
||||
{ name: 'de', i18n: 'settings.settings.aSection.language.options.de' },
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'section2',
|
||||
i18n: 'settings.settings.aSection.section2.label',
|
||||
content: [
|
||||
{
|
||||
type: 'string',
|
||||
name: 'string',
|
||||
i18n: 'settings.settings.aSection.sections.string',
|
||||
default: 'str'
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
},
|
||||
]
|
||||
}, expected: true },
|
||||
{ raw: {
|
||||
contents: [
|
||||
{
|
||||
type: 'section',
|
||||
name: 'general',
|
||||
i18n: 'settings.settings.general',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'copyOfGeneral',
|
||||
i18n: 'settings.settings.copyOfGeneral',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
default: false,
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'aSection',
|
||||
i18n: 'settings.settings.aSection',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 43',
|
||||
i18n: 'settings.settings.aSection.enableFeature43'
|
||||
},
|
||||
{
|
||||
type: 'selection',
|
||||
name: 'language',
|
||||
i18n: 'settings.settings.aSection.language.label',
|
||||
default: 'en',
|
||||
allowMultiple: false,
|
||||
options: [
|
||||
{ name: 'en', i18n: 'settings.settings.aSection.language.options.en' },
|
||||
{ name: 'de', i18n: 'settings.settings.aSection.language.options.de' },
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'section2',
|
||||
i18n: 'settings.settings.aSection.section2.label',
|
||||
content: [
|
||||
{
|
||||
type: 'string',
|
||||
name: 'string',
|
||||
i18n: 'settings.settings.aSection.sections.string',
|
||||
default: 'str'
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
},
|
||||
]
|
||||
}, expected: true },
|
||||
{ raw: {
|
||||
contents: [
|
||||
{
|
||||
type: 'section',
|
||||
name: 'general',
|
||||
i18n: 'settings.settings.general',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'copyOfGeneral',
|
||||
i18n: 'settings.settings.copyOfGeneral',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
default: false,
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'aSection',
|
||||
i18n: 'settings.settings.aSection',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 43',
|
||||
i18n: 'settings.settings.aSection.enableFeature43',
|
||||
default: 'true'
|
||||
},
|
||||
{
|
||||
type: 'selection',
|
||||
name: 'language',
|
||||
i18n: 'settings.settings.aSection.language.label',
|
||||
default: 'en',
|
||||
options: [
|
||||
{ name: 'en', i18n: 'settings.settings.aSection.language.options.en' },
|
||||
{ name: 'de', i18n: 'settings.settings.aSection.language.options.de' },
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'section2',
|
||||
i18n: 'settings.settings.aSection.section2.label',
|
||||
content: [
|
||||
{
|
||||
type: 'string',
|
||||
name: 'string',
|
||||
i18n: 'settings.settings.aSection.sections.string',
|
||||
default: 42
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
},
|
||||
]
|
||||
}, expected: false },
|
||||
{ raw: {
|
||||
content: [
|
||||
{
|
||||
type: 'section',
|
||||
name: 'general',
|
||||
i18n: 'settings.settings.general',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'copyOfGeneral',
|
||||
i18n: 'settings.settings.copyOfGeneral',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
default: false,
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'aSection',
|
||||
i18n: 'settings.settings.aSection',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 43',
|
||||
i18n: 'settings.settings.aSection.enableFeature43'
|
||||
},
|
||||
{
|
||||
type: 'selection',
|
||||
name: 'language',
|
||||
i18n: 'settings.settings.aSection.language.label',
|
||||
default: 'en',
|
||||
options: [
|
||||
{ name: 'en', i18n: 'settings.settings.aSection.language.options.en' },
|
||||
{ name: 'de', i18n: 'settings.settings.aSection.language.options.de' },
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'section2',
|
||||
i18n: 'settings.settings.aSection.section2.label',
|
||||
content: [
|
||||
{
|
||||
type: 'string',
|
||||
name: 'string',
|
||||
i18n: 'settings.settings.aSection.sections.string',
|
||||
default: 'str'
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
},
|
||||
]
|
||||
}, expected: false },
|
||||
{ raw: {
|
||||
content: [
|
||||
{
|
||||
type: 'sectio',
|
||||
name: 'general',
|
||||
i18n: 'settings.settings.general',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'copyOfGeneral',
|
||||
i18n: 'settings.settings.copyOfGeneral',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
default: false,
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'aSection',
|
||||
i18n: 'settings.settings.aSection',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 43',
|
||||
i18n: 'settings.settings.aSection.enableFeature43'
|
||||
},
|
||||
{
|
||||
type: 'selection',
|
||||
name: 'language',
|
||||
i18n: 'settings.settings.aSection.language.label',
|
||||
default: 'en',
|
||||
options: [
|
||||
{ name: 'en', i18n: 'settings.settings.aSection.language.options.en' },
|
||||
{ name: 'de', i18n: 'settings.settings.aSection.language.options.de' },
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'section2',
|
||||
i18n: 'settings.settings.aSection.section2.label',
|
||||
content: [
|
||||
{
|
||||
type: 'string',
|
||||
name: 'string',
|
||||
i18n: 'settings.settings.aSection.sections.string',
|
||||
default: 'str'
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
},
|
||||
]
|
||||
}, expected: false },
|
||||
{ raw: {
|
||||
content: [
|
||||
{
|
||||
type: 'sectio',
|
||||
name: 'general',
|
||||
i18n: 'settings.settings.general',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'copyOfGeneral',
|
||||
i18n: 'settings.settings.copyOfGeneral',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 42',
|
||||
default: false,
|
||||
i18n: 'settings.settings.general.enableFeature42'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'aSection',
|
||||
i18n: 'settings.settings.aSection',
|
||||
content: [
|
||||
{
|
||||
type: 'bool',
|
||||
name: 'Enable feature 43',
|
||||
i18n: 'settings.settings.aSection.enableFeature43'
|
||||
},
|
||||
{
|
||||
type: 'selection',
|
||||
name: 'language',
|
||||
i18n: 'settings.settings.aSection.language.label',
|
||||
default: 'en',
|
||||
allowMultiple: 'false',
|
||||
options: [
|
||||
{ name: 'en', i18n: 'settings.settings.aSection.language.options.en' },
|
||||
{ name: 'de', i18n: 'settings.settings.aSection.language.options.de' },
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'section',
|
||||
name: 'section2',
|
||||
i18n: 'settings.settings.aSection.section2.label',
|
||||
content: [
|
||||
{
|
||||
type: 'string',
|
||||
name: 'string',
|
||||
i18n: 'settings.settings.aSection.sections.string',
|
||||
default: 'str'
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
},
|
||||
]
|
||||
}, expected: false }
|
||||
])('returns valid: $expected', ({ raw, expected }) => {
|
||||
const result = validateSettingsConfig(raw);
|
||||
if (!result.valid) {
|
||||
console.error('Error message:', result.error);
|
||||
};
|
||||
expect(result.valid).toBe(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('validateEntry', () => {
|
||||
test.for([
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable' }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: true }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: false }],
|
||||
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label' }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: 42 }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: 0 }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: -42.7 }],
|
||||
|
||||
[{ name: 'aString', type: 'string', i18n: 'aString.label' }],
|
||||
[{ name: 'aString', type: 'string', i18n: 'aString.label', default: '' }],
|
||||
[{ name: 'aString', type: 'string', i18n: 'aString.label', default: 'Seekra is great!' }],
|
||||
|
||||
[{ name: 'selectSomething', type: 'selection', i18n: 'selectSomething.title', options: [
|
||||
{ name: 'yes', i18n: 'selectSomething.options.yes' },
|
||||
{ name: 'no', i18n: 'selectSomething.options.no' },
|
||||
{ name: 'maybe', i18n: 'selectSomething.options.maybe' }
|
||||
] }],
|
||||
|
||||
[{ name: 'selectSomething', type: 'selection', i18n: 'selectSomething.title', default: 'no', options: [
|
||||
{ name: 'yes', i18n: 'selectSomething.options.yes' },
|
||||
{ name: 'no', i18n: 'selectSomething.options.no' },
|
||||
{ name: 'maybe', i18n: 'selectSomething.options.maybe' }
|
||||
] }],
|
||||
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: [] }],
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: [
|
||||
{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: true }
|
||||
] }],
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: [
|
||||
{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: true },
|
||||
{ name: 'enableFeature43', type: 'bool', i18n: 'feature.43.enable', default: true }
|
||||
] }],
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: [
|
||||
{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: true },
|
||||
{ name: 'enableFeature43', type: 'bool', i18n: 'feature.43.enable', default: true },
|
||||
{ name: 'aSecondSection', type: 'section', i18n: 'sections.aSecondSection.title', content: [
|
||||
{ name: 'enableFeature44', type: 'bool', i18n: 'feature.44.enable', default: true },
|
||||
] }
|
||||
] }]
|
||||
])('throws no error for the entry %s', ([ entry ]) => {
|
||||
expect(() => validateEntry(entry)).not.throws(Error);
|
||||
});
|
||||
|
||||
test.for([
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: '' }],
|
||||
[{ name: 'enableFeature42', type: 'thisTypeDoesNotExistAndHasAVeryLongName', i18n: 'feature.42.enable' }],
|
||||
[{ name: '', type: 'thisTypeDoesNotExistAndHasAVeryLongName', i18n: 'feature.42.enable' }],
|
||||
[{ name: '', type: 'thisTypeDoesNotExistAndHasAVeryLongName', i18n: '' }],
|
||||
[{ name: '', type: 'bool', i18n: '' }],
|
||||
[{ name: '', type: 'bool', i18n: '' }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: 42 }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: '42' }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: 'Seekra' }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: 'true' }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: 'false' }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: 'undefined' }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: 'null' }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: [] }],
|
||||
[{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: {} }],
|
||||
[{ name: 'enableFeature42', type: '', i18n: 'feature.42.enable', default: {} }],
|
||||
|
||||
[{ name: '', type: 'number', i18n: 'aNumber.label' }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: '42' }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: 'zero' }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: 'undefined' }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: 'false' }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: true }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: false }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: [] }],
|
||||
[{ name: 'aNumber', type: 'number', i18n: 'aNumber.label', default: {} }],
|
||||
[{ name: 'aNumber', type: '', i18n: 'aNumber.label', default: {} }],
|
||||
[{ name: 'aNumber', type: '', i18n: 'aNumber.label', default: 42 }],
|
||||
|
||||
[{ name: 'aString', type: 'string', i18n: '' }],
|
||||
[{ name: 'aString', type: 'string', i18n: 'aString.label', default: 42 }],
|
||||
[{ name: 'aString', type: 'string', i18n: 'aString.label', default: true }],
|
||||
[{ name: 'aString', type: 'string', i18n: 'aString.label', default: false }],
|
||||
[{ name: 'aString', type: 'string', i18n: 'aString.label', default: [] }],
|
||||
[{ name: 'aString', type: 'string', i18n: 'aString.label', default: {} }],
|
||||
[{ name: 'aString', type: 'string', i18n: '', default: {} }],
|
||||
|
||||
[{ name: 'selectSomething', type: 'selection', i18n: 'selectSomething.title', default: 'a', options: true }],
|
||||
[{ name: 'selectSomething', type: 'selection', i18n: 'selectSomething.title', default: 'a', options: [] }],
|
||||
[{ name: 'selectSomething', type: 'selection', i18n: 'selectSomething.title', default: 'c', options: [
|
||||
{ name: 'a', i18n: 'a' },
|
||||
{ name: 'b', i18n: 'b' }
|
||||
] }],
|
||||
[{ name: 'selectSomething', type: 'selection', i18n: 'selectSomething.title', default: 'a', options: [
|
||||
{ name: 'a', i18n: 'a' },
|
||||
{ name: 'b', i18n: '' },
|
||||
{ name: 'c' }
|
||||
] }],
|
||||
[{ name: 'selectSomething', type: 'selection', i18n: 'selectSomething.title', default: 'a', allowMultiple: 'false', options: [
|
||||
{ name: 'a', i18n: 'a' },
|
||||
{ name: 'b', i18n: '' },
|
||||
{ name: 'c' }
|
||||
] }],
|
||||
|
||||
[{ name: 'selectSomething', type: 'selection', i18n: 'selectSomething.title', default: 'no', options: [
|
||||
{ name: 'yes', i18n: '' },
|
||||
{ name: '', i18n: 'selectSomething.options.no' },
|
||||
{ name: 'maybe', i18n: 'selectSomething.options.maybe' },
|
||||
{ name: '', i18n: '' },
|
||||
{ name: 42, i18n: 43 },
|
||||
{ name: '' },
|
||||
{ i18n: '' },
|
||||
{}
|
||||
] }],
|
||||
|
||||
[{ name: 'aSection', type: 'section', i18n: '', content: [] }],
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: '' }],
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: '[]' }],
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: 'a' }],
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: [
|
||||
{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: true },
|
||||
{ name: 'enableFeature43', type: 'bool', i18n: 'feature.42.enable', default: 0 },
|
||||
{ name: 'enableFeature44', type: 'bool' }
|
||||
] }],
|
||||
[{ name: 'aSection', type: 'section', i18n: 'sections.aSection.title', content: [
|
||||
{ name: 'enableFeature42', type: 'bool', i18n: 'feature.42.enable', default: true },
|
||||
{ name: 'enableFeature43', type: 'bool', i18n: 'feature.43.enable', default: true },
|
||||
{ name: 'aSecondSection', type: 'section', i18n: 'sections.aSecondSection.title', content: 'Hello' },
|
||||
{ name: 'aSecondSection', type: 'section', i18n: '', content: [] },
|
||||
{ name: 'aSecondSection', type: 'section', i18n: 'i18n', content: [] },
|
||||
{ name: 'aSecondSection', type: 'section', content: [] }
|
||||
] }]
|
||||
])('throws an error for the entry %s', ([ entry ]) => {
|
||||
expect(() => validateEntry(entry)).throws(Error);
|
||||
});
|
||||
});
|
||||
|
||||
describe('validateSelectionOptions', () => {
|
||||
test.for([
|
||||
[[{ name: 'test', i18n: 'test.label' }]],
|
||||
[[{ name: 'test', i18n: 'test.label' }, { name: 'test2', i18n: 'test2.label' }]],
|
||||
[[{ name: 'test', i18n: 'test.label' }, { name: 'test', i18n: 'test2.label' }, { name: 'test3', i18n: 'test.label' }]]
|
||||
])('throws no error for the options %s', ([ options ]) => {
|
||||
expect(() => validateSelectionOptions(options)).not.throws(Error);
|
||||
});
|
||||
|
||||
test.for([
|
||||
[[{}]],
|
||||
[[{ i18n: '' }]],
|
||||
[[{ i18n: 'a' }]],
|
||||
[[{ name: 'a' }]],
|
||||
[[{ name: '' }]],
|
||||
[[{ name: '', i18n: 'test.label' }]],
|
||||
[[{ name: 'test', i18n: '' }]],
|
||||
[[{ name: '', i18n: '' }]],
|
||||
[[{ name: '', i18n: 'test.label' }, { name: 'test2', i18n: '' }]],
|
||||
[[{ name: 'test', i18n: '' }, { name: '', i18n: 'test2.label' }, { name: '', i18n: ' ' }, { name: '42', i18n: '42.i18n' }]],
|
||||
[[]]
|
||||
])('throws an error for the options %s', ([ options ]) => {
|
||||
expect(() => validateSelectionOptions(options)).throws(Error);
|
||||
});
|
||||
});
|
||||
|
||||
describe('assertType', () => {
|
||||
test.for([
|
||||
['bool'],
|
||||
['number'],
|
||||
['string'],
|
||||
['selection'],
|
||||
['section']
|
||||
])('throws no error for the value %s', ([ value ]) => {
|
||||
expect(() => assertType(value)).not.throw(Error);
|
||||
});
|
||||
|
||||
test.for([
|
||||
[''],
|
||||
[' '],
|
||||
[' '],
|
||||
[' '],
|
||||
|
||||
['42'],
|
||||
['0'],
|
||||
['-42'],
|
||||
['-42.0'],
|
||||
['-0.0'],
|
||||
|
||||
['a'],
|
||||
['ab'],
|
||||
['SeekraIsGreat!'],
|
||||
['Seekra is great!'],
|
||||
|
||||
[undefined],
|
||||
[null]
|
||||
])('throws an error for the value %s', ([ value ]) => {
|
||||
expect(() => assertType(value)).throw(Error);
|
||||
});
|
||||
});
|
||||
|
||||
describe('assertString', () => {
|
||||
test.for([
|
||||
['a'],
|
||||
['b'],
|
||||
['ab'],
|
||||
|
||||
['0'],
|
||||
['42'],
|
||||
|
||||
['null'],
|
||||
['undefined'],
|
||||
|
||||
['()&%())']
|
||||
])('throws no error for the value %s', ([ value ]) => {
|
||||
expect(() => assertString(value)).not.throw(Error);
|
||||
});
|
||||
|
||||
test.for([
|
||||
[0],
|
||||
[1],
|
||||
[42],
|
||||
[-1],
|
||||
[-42],
|
||||
|
||||
[''],
|
||||
[' '],
|
||||
[' '],
|
||||
[' ']
|
||||
])('throws an error for the value %s', ([ value ]) => {
|
||||
expect(() => assertString(value)).throws(Error);
|
||||
});
|
||||
});
|
||||
@@ -16,13 +16,13 @@ limitations under the License.
|
||||
|
||||
const VALID_TYPES = ['bool', 'number', 'string', 'selection', 'section'];
|
||||
|
||||
function assertString(value, path) {
|
||||
export const assertString = function assertString (value, path) {
|
||||
if (typeof value !== 'string' || value.trim() === '') {
|
||||
throw new Error(`[settings] "${path}" must be a non-empty string`);
|
||||
}
|
||||
}
|
||||
|
||||
function assertType(value, path) {
|
||||
export const assertType = function assertType (value, path) {
|
||||
if (!VALID_TYPES.includes(value)) {
|
||||
throw new Error(
|
||||
`[settings] "${path}" has invalid type "${value}". Must be one of: ${VALID_TYPES.join(', ')}`
|
||||
@@ -30,21 +30,23 @@ function assertType(value, path) {
|
||||
}
|
||||
}
|
||||
|
||||
function validateSelectionOptions(options, path) {
|
||||
export const validateSelectionOptions = function validateSelectionOptions (options, path) {
|
||||
if (!Array.isArray(options) || options.length === 0) {
|
||||
throw new Error(`[settings] "${path}.options" must be a non-empty array`);
|
||||
}
|
||||
};
|
||||
options.forEach((opt, i) => {
|
||||
assertString(opt.name, `${path}.options[${i}].name`);
|
||||
assertString(opt.i18n, `${path}.options[${i}].i18n`);
|
||||
});
|
||||
}
|
||||
|
||||
function validateEntry(entry, path) {
|
||||
export const validateEntry = function validateEntry (entry, path) {
|
||||
assertType(entry.type, `${path}.type`);
|
||||
|
||||
assertString(entry.name, `${path}.name`);
|
||||
assertString(entry.i18n, `${path}.i18n`);
|
||||
|
||||
if (entry.type === 'section') {
|
||||
assertString(entry.name, `${path}.name`);
|
||||
if (!Array.isArray(entry.content)) {
|
||||
throw new Error(`[settings] "${path}.content" must be an array`);
|
||||
}
|
||||
@@ -54,25 +56,30 @@ function validateEntry(entry, path) {
|
||||
return;
|
||||
}
|
||||
|
||||
assertString(entry.name, `${path}.name`);
|
||||
assertString(entry.i18n, `${path}.i18n`);
|
||||
|
||||
if (entry.type === 'selection') {
|
||||
validateSelectionOptions(entry.options, path);
|
||||
if (typeof entry.allowMultiple !== 'boolean' && entry.allowMultiple) {
|
||||
throw new Error(`[settings] "${path}.allowMultiple" must be a boolean`);
|
||||
}
|
||||
};
|
||||
if (entry.default !== undefined) {
|
||||
if (entry.type === 'bool' && typeof entry.default !== 'boolean') {
|
||||
throw new Error(`[settings] "${path}.default" must be a boolean`);
|
||||
}
|
||||
if (entry.type === 'number' && typeof entry.default !== 'number') {
|
||||
throw new Error(`[settings] "${path}.default" must be a number`);
|
||||
}
|
||||
if (entry.type === 'string' && typeof entry.default !== 'string') {
|
||||
throw new Error(`[settings] "${path}.default" must be a string`);
|
||||
}
|
||||
if (entry.type === 'selection') {
|
||||
validateSelectionOptions(entry.options, path);
|
||||
if (typeof entry.allowMultiple !== 'boolean') {
|
||||
throw new Error(`[settings] "${path}.allowMultiple" must be a boolean`);
|
||||
}
|
||||
}
|
||||
throw new Error(`[settings] "${path}.default" must be a boolean`);
|
||||
}
|
||||
if (entry.type === 'number' && typeof entry.default !== 'number') {
|
||||
throw new Error(`[settings] "${path}.default" must be a number`);
|
||||
}
|
||||
if (entry.type === 'string' && typeof entry.default !== 'string') {
|
||||
throw new Error(`[settings] "${path}.default" must be a string`);
|
||||
}
|
||||
if (entry.type === 'selection') {
|
||||
if (typeof entry.default !== 'string') {
|
||||
throw new Error(`[settings] "${path}.default" must be a string`);
|
||||
};
|
||||
if (!entry.options.map((option) => option.name).includes(entry.default)) {
|
||||
throw new Error(`[settings] option "${path}.default" does not exist`);
|
||||
};
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user