Skip to content

Commit

Permalink
Merge branch 'develop' of https://github.com/splunk/addonfactory-ucc-…
Browse files Browse the repository at this point in the history 
…generator into develop
  • Loading branch information
@rohanm-crest
rohanm-crest committed Dec 9, 2024
2 parents 0ae19f7 + 0c1ef99 commit a1d0212
Show file tree
Hide file tree
Showing 38 changed files with 805 additions and 300 deletions.
10 changes: 5 additions & 5 deletions docs/entity/modifyFieldsOnValue.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This feature allows to specify conditions to modify other fields based on curren

### Modification Object Properties

| Property | Type | Description |
| --------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------- |
| fieldValue<span class="required-asterisk">\*</span> | string | Value that will trigger the update, put `[[any_other_value]]` to trigger update for any other values than specified |
| mode | string | Mode that adds possibility to use modification only on certain mode |
| fieldsToModify | array | List of fields modifications that will be applied after com ponent value will match |
| Property | Type | Description |
| --------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------- |
| fieldValue<span class="required-asterisk">\*</span> | string | Value of current field that will trigger the update. Put `[[any_other_value]]` to make update for any other value than specified. |
| mode | string | Mode that adds possibility to use modification only on certain mode. One of ( `create` / `edit` / `clone` / `config` ) |
| fieldsToModify | array | List of fields modifications that will be applied after com ponent value will match. |

### fieldsToModify Properties

Expand Down
74 changes: 44 additions & 30 deletions splunk_add_on_ucc_framework/global_config_validator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ def _validate_groups(self) -> None:
f"Service {service['name']} uses group field {group_field} which is not defined in entity"
)

def _is_circular(
def _is_circular_modification(
self,
mods: List[Any],
visited: Dict[str, str],
Expand All @@ -551,61 +551,73 @@ def _is_circular(
# no more dependent modification fields
visited[current_field] = DEAD_END
return visited
else:
for influenced_field in current_field_mods["influenced_fields"]:
if influenced_field not in all_entity_fields:
raise GlobalConfigValidatorException(
f"""Modification in field '{current_field}' for not existing field '{influenced_field}'"""
)
if influenced_field == current_field:
raise GlobalConfigValidatorException(
f"""Field '{current_field}' tries to modify itself"""
)

if current_field in current_field_mods["influenced_fields_value_change"]:
# field can modify itself except "value" property
raise GlobalConfigValidatorException(
f"""Field '{current_field}' tries to modify itself value"""
)

for influenced_field in current_field_mods["influenced_fields"]:
if influenced_field not in all_entity_fields:
raise GlobalConfigValidatorException(
f"""Modification in field '{current_field}' for not existing field '{influenced_field}'"""
)

if influenced_field in current_field_mods["influenced_fields_value_change"]:
if visited[influenced_field] == VISITING:
raise GlobalConfigValidatorException(
f"""Circular modifications for field '{influenced_field}' in field '{current_field}'"""
)
else:
visited = self._is_circular(
mods, visited, all_entity_fields, influenced_field
)
# check next influenced by value change field
visited = self._is_circular_modification(
mods, visited, all_entity_fields, influenced_field
)

# All dependent modifications fields are dead_end
visited[current_field] = DEAD_END
return visited

def _check_if_circular(
def _check_if_circular_modification(
self,
all_entity_fields: List[Any],
fields_with_mods: List[Any],
modifications: List[Any],
) -> None:
visited = {field: "not_visited" for field in all_entity_fields}

for start_field in fields_with_mods:
# DFS algorithm for all fields with modifications
visited = self._is_circular(
visited = self._is_circular_modification(
modifications, visited, all_entity_fields, start_field
)

@staticmethod
def _get_mods_data_for_single_entity(
fields_with_mods: List[Any],
all_modifications: List[Any],
entity: Dict[str, Any],
) -> List[Any]:
"""
Add modification entity data to lists and returns them
Get modification entity data as lists
"""
entity_modifications = []
if "modifyFieldsOnValue" in entity:
influenced_fields_value_change = set()
influenced_fields = set()
fields_with_mods.append(entity["field"])
for mods in entity["modifyFieldsOnValue"]:
for mod in mods["fieldsToModify"]:
influenced_fields.add(mod["fieldId"])
all_modifications.append(
{"fieldId": entity["field"], "influenced_fields": influenced_fields}

if (
mod.get("value") is not None
): # circular deps are not a problem if not about value
influenced_fields_value_change.add(mod["fieldId"])
entity_modifications.append(
{
"fieldId": entity["field"],
"influenced_fields": influenced_fields,
"influenced_fields_value_change": influenced_fields_value_change,
}
)
return [fields_with_mods, all_modifications]
return entity_modifications

@staticmethod
def _get_all_entities(
Expand Down Expand Up @@ -638,11 +650,13 @@ def _get_all_modification_data(

entities = self._get_all_entities(collections)
for entity in entities:
self._get_mods_data_for_single_entity(
fields_with_mods, all_modifications, entity
)
all_fields.append(entity["field"])

if "modifyFieldsOnValue" in entity:
fields_with_mods.append(entity["field"])
entity_mods = self._get_mods_data_for_single_entity(entity)
all_modifications.extend(entity_mods)

return [fields_with_mods, all_modifications, all_fields]

def _validate_field_modifications(self) -> None:
Expand All @@ -664,7 +678,7 @@ def _validate_field_modifications(self) -> None:
all_fields_config,
) = self._get_all_modification_data(tabs)

self._check_if_circular(
self._check_if_circular_modification(
all_fields_config, fields_with_mods_config, all_modifications_config
)

Expand All @@ -678,7 +692,7 @@ def _validate_field_modifications(self) -> None:
all_fields_inputs,
) = self._get_all_modification_data(services)

self._check_if_circular(
self._check_if_circular_modification(
all_fields_inputs, fields_with_mods_inputs, all_modifications_inputs
)

Expand Down
2 changes: 1 addition & 1 deletion tests/unit/test_global_config_validator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ def test_config_validation_modifications_on_change():
[
(
"invalid_config_with_modification_for_field_itself.json",
"Field 'text1' tries to modify itself",
"Field 'text1' tries to modify itself value",
),
(
"invalid_config_with_modification_for_unexisiting_fields.json",
Expand Down
22 changes: 11 additions & 11 deletions tests/unit/testdata/invalid_config_with_modification_circular_modifications.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"fieldsToModify": [
{
"fieldId": "text2",
"disabled": false
"value": "modification"
}
]
},
Expand All @@ -62,7 +62,7 @@
"fieldsToModify": [
{
"fieldId": "text3",
"disabled": true
"value": "modification"
}
]
}
Expand All @@ -79,7 +79,7 @@
"fieldsToModify": [
{
"fieldId": "text3",
"disabled": false
"value": "modification"
}
]
},
Expand All @@ -88,7 +88,7 @@
"fieldsToModify": [
{
"fieldId": "text4",
"disabled": true
"value": "modification"
}
]
}
Expand All @@ -111,7 +111,7 @@
"fieldsToModify": [
{
"fieldId": "text5",
"disabled": false
"value": "modification"
}
]
},
Expand All @@ -120,7 +120,7 @@
"fieldsToModify": [
{
"fieldId": "text5",
"disabled": true
"value": "modification"
}
]
}
Expand All @@ -137,7 +137,7 @@
"fieldsToModify": [
{
"fieldId": "text6",
"disabled": false
"value": "modification"
}
]
},
Expand All @@ -146,7 +146,7 @@
"fieldsToModify": [
{
"fieldId": "text6",
"disabled": true
"value": "modification"
}
]
}
Expand All @@ -163,7 +163,7 @@
"fieldsToModify": [
{
"fieldId": "text7",
"disabled": false
"value": "modification"
}
]
},
Expand All @@ -172,7 +172,7 @@
"fieldsToModify": [
{
"fieldId": "text7",
"disabled": true
"value": "modification"
}
]
}
Expand All @@ -189,7 +189,7 @@
"fieldsToModify": [
{
"fieldId": "text1",
"disabled": false
"value": "modification"
}
]
}
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/testdata/invalid_config_with_modification_for_field_itself.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"fieldsToModify": [
{
"fieldId": "text1",
"disabled": false
"value": "value modification"
}
]
}
Expand Down
4 changes: 4 additions & 0 deletions tests/unit/testdata/valid_config_with_modification_on_value_change.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@
{
"fieldId": "text2",
"disabled": false
},
{
"fieldId": "text1",
"label": "change label for itself"
}
]
},
Expand Down
3 changes: 2 additions & 1 deletion ui/jest.setup.ts
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import '@testing-library/jest-dom';
import '@testing-library/jest-dom/jest-globals';

import { configure } from '@testing-library/react';

import { server } from './src/mocks/server';
import './src/tests/expectExtenders';

/**
* Configure test attributes
Expand Down
1 change: 1 addition & 0 deletions ui/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
"@testing-library/react": "^12.1.5",
"@testing-library/user-event": "^14.5.2",
"@types/jest": "^29.5.14",
"@types/jest-image-snapshot": "^6.4.0",
"@types/js-yaml": "^4.0.9",
"@types/node": "^20.17.6",
"@types/react": "^16.14.62",
Expand Down
9 changes: 4 additions & 5 deletions ui/src/components/AcceptModal/AcceptModal.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import React from 'react';
import Modal from '@splunk/react-ui/Modal';
import Message from '@splunk/react-ui/Message';
import styled from 'styled-components';
import { StyledButton } from '../../pages/EntryPageStyle';

import { UCCButton } from '../UCCButton/UCCButton';

const ModalWrapper = styled(Modal)`
width: 600px;
Expand Down Expand Up @@ -30,13 +31,11 @@ function AcceptModal(props: AcceptModalProps) {
</Message>
</Modal.Body>
<Modal.Footer>
<StyledButton
appearance="primary"
<UCCButton
onClick={() => props.handleRequestClose(false)}
label={props.declineBtnLabel || 'Cancel'}
/>
<StyledButton
appearance="primary"
<UCCButton
onClick={() => props.handleRequestClose(true)}
label={props.acceptBtnLabel || 'OK'}
/>
Expand Down
Loading

0 comments on commit a1d0212

Please sign in to comment.