Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add a path exist check for rules_folder config var #519

Merged
merged 8 commits into from
Oct 28, 2021
Merged

add a path exist check for rules_folder config var #519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6203791
add a path exist check for rules_folder config var
AntoineBlaud Oct 21, 2021
6c034cc
add .empty
AntoineBlaud Oct 21, 2021
1421d23
Add simple test for invalid rules path
AntoineBlaud Oct 28, 2021
7cac908
fix tests (update check and pass py310)
AntoineBlaud Oct 28, 2021
8690ad3
Merge branch 'master' into master
jertel Oct 28, 2021
8027e2d
updated CHANGELOG.md
AntoineBlaud Oct 28, 2021
9be742f
Merge branch 'master' of https://github.com/AntoineBlaud/elastalert2
AntoineBlaud Oct 28, 2021
130e534
Correct changelog for PR 519
jertel Oct 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
- Upgrade to Python 3.10 and Sphinx 4.2.0 - [#501](https://github.com/jertel/elastalert2/pull/501) - @jertel
- max_scrolling_count now has a default value of 990 to avoid stack overflow crashes - [#509](https://github.com/jertel/elastalert2/pull/509) - @jertel
- Update pytest 6.2.5, pytest-cov 3.0.0, pytest-xdist 2.4.0, pylint<2.12, tox 3.24.4 - [#511](https://github.com/jertel/elastalert2/pull/511) - @nsano-rururu
- Added a check on the value of the path "rules_folder" to make sure it exists - [#519](https://github.com/jertel/elastalert2/pull/519) - @AntoineBlaud

# 2.2.2

Expand Down
2 changes: 2 additions & 0 deletions elastalert/loaders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,8 @@ def get_names(self, conf, use_rule=None):
rule_files = []
if 'scan_subdirectories' in conf and conf['scan_subdirectories']:
for ruledir in rule_folders:
if not os.path.exists(ruledir):
raise EAException('Specified rule_folder does not exist: %s ' % ruledir)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a test case for this branch?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added a simple test for invalid path, tests for valid path already exists

for root, folders, files in os.walk(ruledir, followlinks=True):
# Openshift/k8s configmap fix for ..data and ..2021_05..date directories that loop with os.walk()
folders[:] = [d for d in folders if not d.startswith('..')]
Expand Down
Empty file added tests/empty_folder_test/.empty
View file
Open in desktop
Empty file.
14 changes: 12 additions & 2 deletions tests/loaders_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from elastalert.loaders import RulesLoader
from elastalert.util import EAException

test_config = {'rules_folder': 'test_folder',
test_config = {'rules_folder': './empty_folder_test',
'run_every': {'minutes': 10},
'buffer_time': {'minutes': 10},
'es_host': 'elasticsearch.test',
Expand Down Expand Up @@ -168,7 +168,7 @@ def test_load_inline_alert_rule():


def test_file_rules_loader_get_names_recursive():
conf = {'scan_subdirectories': True, 'rules_folder': 'root'}
conf = {'scan_subdirectories': True, 'rules_folder': './empty_folder_test'}
rules_loader = FileRulesLoader(conf)
walk_paths = (('root', ['folder_a', 'folder_b'], ('rule.yaml',)),
('root/folder_a', [], ('a.yaml', 'ab.yaml')),
Expand All @@ -186,6 +186,16 @@ def test_file_rules_loader_get_names_recursive():
assert len(paths) == 4


def test_file_rules_loader_get_names_invalid_path():
conf = {'scan_subdirectories': True, 'rules_folder': './folder_missing#XYZ'}
try:
# folder missing so FileRulesLoader must throws an error
if FileRulesLoader(conf).get_names(conf):
assert False
except EAException:
pass


def test_file_rules_loader_get_names():

class MockDirEntry:
Expand Down