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

make process method always return a result object #609

Merged
merged 40 commits into from
Jul 12, 2024
Merged

make process method always return a result object #609

merged 40 commits into from
Jul 12, 2024

Conversation

djkhl
Copy link
Collaborator

@djkhl djkhl commented Jun 17, 2024 •
edited by dtrai2
Loading

closes #512

ToDos

  • add extra data to result object
  • add errors to result object
  • add warnings to result object
  • check rulecorustester
  • add changelog entry

@djkhl djkhl self-assigned this Jun 17, 2024
@djkhl djkhl linked an issue Jun 17, 2024 that may be closed by this pull request
Make Processor.process always return a Result Object #512
Closed
@djkhl djkhl changed the title make processor.process() alway return a result object make process method alway return a result object Jun 17, 2024
@djkhl djkhl marked this pull request as ready for review June 19, 2024 11:24
@djkhl djkhl requested a review from ekneg54 June 19, 2024 11:24
@djkhl djkhl marked this pull request as draft June 20, 2024 12:24
@djkhl djkhl force-pushed the 512-make-processorprocess-always-return-a-result-object branch from db2fdfa to e973f14 Compare June 20, 2024 12:55
@ekneg54 ekneg54 changed the title make process method alway return a result object make process method always return a result object Jun 20, 2024
@djkhl djkhl force-pushed the 512-make-processorprocess-always-return-a-result-object branch 4 times, most recently from 48c07fb to 8c1378a Compare June 25, 2024 10:13
@djkhl djkhl marked this pull request as ready for review June 25, 2024 10:44
ekneg54
ekneg54 requested changes Jun 26, 2024
View reviewed changes
Copy link
Collaborator

@ekneg54 ekneg54 left a comment

Choose a reason for hiding this comment

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

Thanks for your work. I have some changes for your.

logprep/framework/pipeline.py Outdated Show resolved Hide resolved
logprep/framework/pipeline.py Outdated Show resolved Hide resolved
logprep/framework/pipeline.py Outdated Show resolved Hide resolved
tests/unit/framework/test_pipeline.py Show resolved Hide resolved
logprep/framework/pipeline.py Outdated Show resolved Hide resolved
logprep/framework/pipeline.py Outdated Show resolved Hide resolved
logprep/framework/pipeline.py Outdated Show resolved Hide resolved
tests/unit/framework/test_pipeline.py Outdated Show resolved Hide resolved
@djkhl djkhl marked this pull request as draft June 27, 2024 07:59
@djkhl djkhl force-pushed the 512-make-processorprocess-always-return-a-result-object branch from ee47c10 to cbbeae7 Compare June 27, 2024 08:13
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 94.17476% with 6 lines in your changes missing coverage. Please review.

Project coverage is 94.45%. Comparing base (8311e0f) to head (6a6845c).
Report is 18 commits behind head on main.

Files Patch % Lines
...p/util/auto_rule_tester/auto_rule_corpus_tester.py 80.95% 4 Missing ⚠️
logprep/abc/processor.py 95.00% 1 Missing ⚠️
logprep/framework/pipeline.py 98.03% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #609      +/-   ##
==========================================
- Coverage   94.47%   94.45%   -0.03%     
==========================================
  Files         145      147       +2     
  Lines       10124     9953     -171     
==========================================
- Hits         9565     9401     -164     
+ Misses        559      552       -7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

djkhl and others added 4 commits June 27, 2024 14:44
@djkhl
add test for separately logging warnings and errors
17cff96
@djkhl @ekneg54
Update tests/unit/framework/test_pipeline.py
f9a82d5 
Co-authored-by: Jörg Zimmermann <101292599+ekneg54@users.noreply.github.com>
@djkhl
fix test readability
84f6c9f
@djkhl
Merge branch '512-make-processorprocess-always-return-a-result-object…
7801e0f 
…' of github.com:fkie-cad/Logprep into 512-make-processorprocess-always-return-a-result-object
@djkhl djkhl marked this pull request as ready for review June 27, 2024 13:20
@djkhl djkhl requested a review from ekneg54 June 27, 2024 13:20
dtrai2
dtrai2 reviewed Jul 2, 2024
View reviewed changes
.github/workflows/testing.yml Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
logprep/abc/processor.py Outdated Show resolved Hide resolved
logprep/framework/pipeline.py Outdated Show resolved Hide resolved
logprep/framework/pipeline.py Outdated Show resolved Hide resolved
logprep/framework/pipeline.py Outdated Show resolved Hide resolved
tests/unit/framework/test_pipeline.py Outdated Show resolved Hide resolved
tests/unit/framework/test_pipeline.py Outdated Show resolved Hide resolved
tests/unit/framework/test_pipeline.py Outdated Show resolved Hide resolved
tests/unit/processor/selective_extractor/test_selective_extractor.py Show resolved Hide resolved
dtrai2 and others added 6 commits July 2, 2024 10:17
@dtrai2
implement review remarks
713df6e
@dtrai2
fix mysql-connector-python dependency to 8.4.0
472448e
@dtrai2
improve mock_create in test_pipeline.py
1819608
@dtrai2
simplify process_event method in pipeline.py
92ef6da
@ekneg54
add attributes to processor result (#630)
2c46f5e 
* add outputs, event to processor_result and rename name to processor_name
* add tests for collecting errors in result object
* add tests for event reference
* refactor pipeline_result
* refactor result and remove lock from pipeline
@ekneg54
Merge branch 'main' into 512-make-processorprocess-always-return-a-re…
ed30612 
…sult-object
@ekneg54 ekneg54 merged commit 8c1a340 into main Jul 12, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dtrai2 dtrai2 dtrai2 left review comments

@ekneg54 ekneg54 ekneg54 approved these changes

Assignees

@djkhl djkhl

@dtrai2 dtrai2

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make Processor.process always return a Result Object
4 participants
@djkhl @codecov-commenter @dtrai2 @ekneg54