-
Notifications
You must be signed in to change notification settings - Fork 186
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add switch to toggle the use of custom branding (#4507)
* feat(settings): centralize the plugin settings Create the plugin setting schema Define the current plugin settings Remove refactored code * feat(settings): add setting services and replaced the references to constants * feat(settings): refactor the content of the default configuration file Use dynamically the definition of the plugin settings * feat(inputs): create new inputs components Add new hooks to manage when a input value or form has changed Add new inputs components * feat(configuration): refactor the form of Settings/Configuration Refactor Header, BottomBar, Configuration components Remove deprecated files * feat(settings): support updating multiple setting at the same time Changed the endpoint that updating the plugin setting to support multiple settings at the same time Refactor the getConfiguration service. Split the logic to: - Read the file and transform to JSON - Obfuscate the password key of the host configuration * feat: add validation to the plugin settings Create services to validate Add the validation to the plugin settings * feat(validation): add validation to the `PUT /utils/configuration` endpoint * feat(validation): add validation to the configuration form in `Settings/Configuration` * feat(validatio): remove no used import * clean: remove not used code * Add report header-footer configuration * fix: fixed category name in `Settings/Configuration` * fix(settings): Fix accessing to `validate` of undefined error * fix(settings): fixed error due to missing service * Add custom branding enabled switch * Fix custom logo ratio in PDF sheet * fix(settings): refactor the form and inputs of `Settings/Configuration` to control the global state of the form * fix: add value transformation for the form inputs and output of fields changed * fix: Fixed some settings validation * fix(settings): fixed validation of literals * fix(settings): removed unused import * fix(settings): renamed properties related to transform the value of the input * feat(settings): add description to the plugin setting definition properties * fix(settings): fix getConfiguration service when the configuration file has no `hosts` entry * fix(settings): Fixed error when do changes of the `useForm` hook an rename methods of this * tests(settings): add test related to the plugin settings and its configuration from the UI * feat(settings): rename plugin setting options of type select to match its type * feat(settings): add plugin settings services and enhance the description of the plugin settings in default configuration file and UI * tests(input-form): update tests of InputForm component * test(configuration-file): add tests of the default configuration file * feat(settings): remove `extensions.mitre` plugin setting * test(settings): add test to validate the plugin setting when updating it through PUT /utils/configuration fix some plugin settings validation * feat(settings): add documentation to some setting services and test some of them * fix: fixed documentation of setting service * doc(settings): move the documentation of the plugin setting properties * fix(settings): rename some plugin setting properties because of request changes - Rename plugin setting properties: - `default` to `defaultValue` - `defaultHidden` to `defaultValueIfNotSet` - `configurableFile` to `isConfigurableFromFile` - configurableUI` to `isConfigurableFromUI` - `requireHealthCheck` to `requiresRunningHealthCheck` - `requireReload` to `requiresReloadingBrowserTab` - `requireRestart` to `requiresRestartingPluginPlatform` - Fix tests * tests: fix tests of InputForm component * fix: response properties when saving the configuration * fix(settings): fix validation plugin settings value in the UI * fix(settings): fix `customization.reports.header` and `customization.reports.footer` setting properties * fix(settings): fix validation of numbers * fix(settings): fix validation of numbers * test(settings): Add tests related to validation for the `useForm` hook and the `InputForm` component * fix(settings): fix displaying toast to run the healthcheck when saving the configuration * test(settings): add tests for the `customization.reports.footer` and `customization.reports.header` settings * test(settings): Add tests for the `customization.enabled` setting * Added category sorting + description + docs link * Added settings sorting within their category * Fixed constant types definition * Checks if localCompare exists validation * fix(settings): fixed plugin setting description doesn't display the minimum number value when it is falsy (0) * fix(settings): fix setting type of `wazuh.monitoring.replicas` and limit the valid number for the number input * feat(settins): add plugin settings category description * fix(settings): fix a problem comparing the initial and current value for the plugin settings of the `number` type * fix(settings): fix wrong conflict resolution * fix(settings): fix typo in setting description * Add set custom header footer unit test * feat(settings): enhance the validation of plugin settings related to indices or index patterns taking in account the supported characters * feat(settings): add validation of setting values in the inputs * Added unit test to verify the PDF report integrity * fix(tests): format tables of the tests * fix: remove unnecessary import * test(endpoints): add test to GET /reports endpoint * test(settings): add test for `customization.enabled` setting in the form input * Improved report unit test with more cases * Fix small typo * fix(settings): fix a typo in a toast related to modify the plugin settings from UI * Changed Custom Branding documentation link * Merge centralize plugin settings PR * Fix white-labeling documentation link * Fix white-labeling documentation link * Code format * Delete unused imports * fix(settings): fix a problem with the useForm hook * fix(settings): refactor the settings validation function to a class and rename the file * feat(settings): add check for integer numbers and adapt the affected settings * changelog: Add PR entry * fix(settings): fix the customization settings do not apply when the `customization.enabled` setting is not defined in the configuration file * fix(settings): the `customization.logo.sidebar` is updated without reloading the browser tab. This solves an indirect problem when the `customization.enabled` setting is changed from the UI, that should have in account the rest of the `customization.*` settings to display some action. This change enhances the UX because the change is instant and doesn't require to reload the browser tab. * Fix customization.enable on GET api/logos endpoint * fix: revert unused change * fix: revert the updating of the `customization.logo.sidebar` when the setting was changed or removed * fix: removed unused code and removed space * fix: undone unwanted changes * fix: resolve setting when it is an empty string * fix: request changes and rename function * fix: fix settings tests Co-authored-by: Antonio David Gutiérrez <[email protected]> Co-authored-by: Álex <[email protected]> (cherry picked from commit c1c39b3)
- Loading branch information
1 parent
2ffa5a4
commit a97462b
Showing
15 changed files
with
134 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
import { | ||
formatLabelValuePair, | ||
formatSettingValueToFile | ||
formatSettingValueToFile, | ||
getCustomizationSetting | ||
} from "./settings"; | ||
|
||
describe('[settings] Methods', () => { | ||
|
@@ -31,4 +32,29 @@ describe('[settings] Methods', () => { | |
expect(formatSettingValueToFile(input)).toBe(expected); | ||
}); | ||
}); | ||
|
||
describe('getCustomizationSetting: Get the value for the "customization." settings depending on the "customization.enabled" setting', () => { | ||
it.each` | ||
customizationEnabled | settingKey | configValue | expected | ||
${true} | ${'customization.logo.app'} | ${'custom-image-app.png'} | ${'custom-image-app.png'} | ||
${true} | ${'customization.logo.app'} | ${''} | ${''} | ||
${false} | ${'customization.logo.app'} | ${'custom-image-app.png'} | ${''} | ||
${false} | ${'customization.logo.app'} | ${''} | ${''} | ||
${true} | ${'customization.reports.footer'} | ${'Custom footer'} | ${'Custom footer'} | ||
${true} | ${'customization.reports.footer'} | ${''} | ${'Copyright © 2022 Wazuh, Inc.'} | ||
${false} | ${'customization.reports.footer'} | ${'Custom footer'} | ${'Copyright © 2022 Wazuh, Inc.'} | ||
${false} | ${'customization.reports.footer'} | ${''} | ${'Copyright © 2022 Wazuh, Inc.'} | ||
${false} | ${'customization.reports.footer'} | ${''} | ${'Copyright © 2022 Wazuh, Inc.'} | ||
${true} | ${'customization.reports.header'} | ${'Custom header'} | ${'Custom header'} | ||
${true} | ${'customization.reports.header'} | ${''} | ${'[email protected]\nhttps://wazuh.com'} | ||
${false} | ${'customization.reports.header'} | ${'Custom header'} | ${'[email protected]\nhttps://wazuh.com'} | ||
${false} | ${'customization.reports.header'} | ${''} | ${'[email protected]\nhttps://wazuh.com'} | ||
`(`customizationEnabled: $customizationEnabled | settingKey: $settingKey | configValue: $configValue | expected: $expected`, ({ configValue, customizationEnabled, expected, settingKey }) => { | ||
const configuration = { | ||
'customization.enabled': customizationEnabled, | ||
[settingKey]: configValue | ||
}; | ||
expect(getCustomizationSetting(configuration, settingKey)).toBe(expected); | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters