CSEC_PUBLIC/securityonion
1
0
Fork 0
mirror of https://github.com/Security-Onion-Solutions/securityonion.git synced 2025-12-06 09:12:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

rename to removelistitem

Browse Source
This commit is contained in:
Josh Patterson
2025-12-02 15:01:32 -05:00
parent 89eb95c077
commit ef092e2893
2 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
salt/manager/tools/sbin/so-yaml.py
View File

@@ -17,7 +17,7 @@ def showUsage(args):
print('Usage: {} <COMMAND> <YAML_FILE> [ARGS...]'.format(sys.argv[0]), file=sys.stderr)
print(' General commands:', file=sys.stderr)
print(' append - Append a list item to a yaml key, if it exists and is a list. Requires KEY and LISTITEM args.', file=sys.stderr)
print(' removefromlist - Remove a list item from a yaml key, if it exists and is a list. Requires KEY and LISTITEM args.', file=sys.stderr)
print(' removelistitem - Remove a list item from a yaml key, if it exists and is a list. Requires KEY and LISTITEM args.', file=sys.stderr)
print(' add - Add a new key and set its value. Fails if key already exists. Requires KEY and VALUE args.', file=sys.stderr)
print(' get - Displays (to stdout) the value stored in the given key. Requires KEY arg.', file=sys.stderr)
print(' remove - Removes a yaml key, if it exists. Requires KEY arg.', file=sys.stderr)
@@ -58,10 +58,10 @@ def appendItem(content, key, listItem):
return 1
def removeFromList(content, key, listItem):
def removeListItem(content, key, listItem):
pieces = key.split(".", 1)
if len(pieces) > 1:
removeFromList(content[pieces[0]], pieces[1], listItem)
removeListItem(content[pieces[0]], pieces[1], listItem)
else:
try:
if not isinstance(content[key], list):
@@ -122,7 +122,7 @@ def append(args):
return 0
def removefromlist(args):
def removelistitem(args):
if len(args) != 3:
print('Missing filename, key arg, or list item to remove', file=sys.stderr)
showUsage(None)
@@ -133,7 +133,7 @@ def removefromlist(args):
listItem = args[2]
content = loadYaml(filename)
removeFromList(content, key, convertType(listItem))
removeListItem(content, key, convertType(listItem))
writeYaml(filename, content)
return 0
@@ -247,7 +247,7 @@ def main():
"help": showUsage,
"add": add,
"append": append,
"removefromlist": removefromlist,
"removelistitem": removelistitem,
"get": get,
"remove": remove,
"replace": replace,

54
salt/manager/tools/sbin/so-yaml_test.py
View File

@@ -459,23 +459,23 @@ class TestRemove(unittest.TestCase):
sysmock.assert_called_once_with(1)
class TestRemoveFromList(unittest.TestCase):
class TestRemoveListItem(unittest.TestCase):
def test_removefromlist_missing_arg(self):
def test_removelistitem_missing_arg(self):
with patch('sys.exit', new=MagicMock()) as sysmock:
with patch('sys.stderr', new=StringIO()) as mock_stderr:
sys.argv = ["cmd", "help"]
soyaml.removefromlist(["file", "key"])
soyaml.removelistitem(["file", "key"])
sysmock.assert_called()
self.assertIn("Missing filename, key arg, or list item to remove", mock_stderr.getvalue())
def test_removefromlist(self):
filename = "/tmp/so-yaml_test-removefromlist.yaml"
def test_removelistitem(self):
filename = "/tmp/so-yaml_test-removelistitem.yaml"
file = open(filename, "w")
file.write("{key1: { child1: 123, child2: abc }, key2: false, key3: [a,b,c]}")
file.close()
soyaml.removefromlist([filename, "key3", "b"])
soyaml.removelistitem([filename, "key3", "b"])
file = open(filename, "r")
actual = file.read()
@@ -484,13 +484,13 @@ class TestRemoveFromList(unittest.TestCase):
expected = "key1:\n child1: 123\n child2: abc\nkey2: false\nkey3:\n- a\n- c\n"
self.assertEqual(actual, expected)
def test_removefromlist_nested(self):
filename = "/tmp/so-yaml_test-removefromlist.yaml"
def test_removelistitem_nested(self):
filename = "/tmp/so-yaml_test-removelistitem.yaml"
file = open(filename, "w")
file.write("{key1: { child1: 123, child2: [a,b,c] }, key2: false, key3: [e,f,g]}")
file.close()
soyaml.removefromlist([filename, "key1.child2", "b"])
soyaml.removelistitem([filename, "key1.child2", "b"])
file = open(filename, "r")
actual = file.read()
@@ -499,13 +499,13 @@ class TestRemoveFromList(unittest.TestCase):
expected = "key1:\n child1: 123\n child2:\n - a\n - c\nkey2: false\nkey3:\n- e\n- f\n- g\n"
self.assertEqual(actual, expected)
def test_removefromlist_nested_deep(self):
filename = "/tmp/so-yaml_test-removefromlist.yaml"
def test_removelistitem_nested_deep(self):
filename = "/tmp/so-yaml_test-removelistitem.yaml"
file = open(filename, "w")
file.write("{key1: { child1: 123, child2: { deep1: 45, deep2: [a,b,c] } }, key2: false, key3: [e,f,g]}")
file.close()
soyaml.removefromlist([filename, "key1.child2.deep2", "b"])
soyaml.removelistitem([filename, "key1.child2.deep2", "b"])
file = open(filename, "r")
actual = file.read()
@@ -514,13 +514,13 @@ class TestRemoveFromList(unittest.TestCase):
expected = "key1:\n child1: 123\n child2:\n deep1: 45\n deep2:\n - a\n - c\nkey2: false\nkey3:\n- e\n- f\n- g\n"
self.assertEqual(actual, expected)
def test_removefromlist_item_not_in_list(self):
filename = "/tmp/so-yaml_test-removefromlist.yaml"
def test_removelistitem_item_not_in_list(self):
filename = "/tmp/so-yaml_test-removelistitem.yaml"
file = open(filename, "w")
file.write("{key1: [a,b,c]}")
file.close()
soyaml.removefromlist([filename, "key1", "d"])
soyaml.removelistitem([filename, "key1", "d"])
file = open(filename, "r")
actual = file.read()
@@ -529,54 +529,54 @@ class TestRemoveFromList(unittest.TestCase):
expected = "key1:\n- a\n- b\n- c\n"
self.assertEqual(actual, expected)
def test_removefromlist_key_noexist(self):
filename = "/tmp/so-yaml_test-removefromlist.yaml"
def test_removelistitem_key_noexist(self):
filename = "/tmp/so-yaml_test-removelistitem.yaml"
file = open(filename, "w")
file.write("{key1: { child1: 123, child2: { deep1: 45, deep2: [a,b,c] } }, key2: false, key3: [e,f,g]}")
file.close()
with patch('sys.exit', new=MagicMock()) as sysmock:
with patch('sys.stderr', new=StringIO()) as mock_stderr:
sys.argv = ["cmd", "removefromlist", filename, "key4", "h"]
sys.argv = ["cmd", "removelistitem", filename, "key4", "h"]
soyaml.main()
sysmock.assert_called()
self.assertEqual("The key provided does not exist. No action was taken on the file.\n", mock_stderr.getvalue())
def test_removefromlist_key_noexist_deep(self):
filename = "/tmp/so-yaml_test-removefromlist.yaml"
def test_removelistitem_key_noexist_deep(self):
filename = "/tmp/so-yaml_test-removelistitem.yaml"
file = open(filename, "w")
file.write("{key1: { child1: 123, child2: { deep1: 45, deep2: [a,b,c] } }, key2: false, key3: [e,f,g]}")
file.close()
with patch('sys.exit', new=MagicMock()) as sysmock:
with patch('sys.stderr', new=StringIO()) as mock_stderr:
sys.argv = ["cmd", "removefromlist", filename, "key1.child2.deep3", "h"]
sys.argv = ["cmd", "removelistitem", filename, "key1.child2.deep3", "h"]
soyaml.main()
sysmock.assert_called()
self.assertEqual("The key provided does not exist. No action was taken on the file.\n", mock_stderr.getvalue())
def test_removefromlist_key_nonlist(self):
filename = "/tmp/so-yaml_test-removefromlist.yaml"
def test_removelistitem_key_nonlist(self):
filename = "/tmp/so-yaml_test-removelistitem.yaml"
file = open(filename, "w")
file.write("{key1: { child1: 123, child2: { deep1: 45, deep2: [a,b,c] } }, key2: false, key3: [e,f,g]}")
file.close()
with patch('sys.exit', new=MagicMock()) as sysmock:
with patch('sys.stderr', new=StringIO()) as mock_stderr:
sys.argv = ["cmd", "removefromlist", filename, "key1", "h"]
sys.argv = ["cmd", "removelistitem", filename, "key1", "h"]
soyaml.main()
sysmock.assert_called()
self.assertEqual("The existing value for the given key is not a list. No action was taken on the file.\n", mock_stderr.getvalue())
def test_removefromlist_key_nonlist_deep(self):
filename = "/tmp/so-yaml_test-removefromlist.yaml"
def test_removelistitem_key_nonlist_deep(self):
filename = "/tmp/so-yaml_test-removelistitem.yaml"
file = open(filename, "w")
file.write("{key1: { child1: 123, child2: { deep1: 45, deep2: [a,b,c] } }, key2: false, key3: [e,f,g]}")
file.close()
with patch('sys.exit', new=MagicMock()) as sysmock:
with patch('sys.stderr', new=StringIO()) as mock_stderr:
sys.argv = ["cmd", "removefromlist", filename, "key1.child2.deep1", "h"]
sys.argv = ["cmd", "removelistitem", filename, "key1.child2.deep1", "h"]
soyaml.main()
sysmock.assert_called()
self.assertEqual("The existing value for the given key is not a list. No action was taken on the file.\n", mock_stderr.getvalue())