feature/cif3-output

[mdavis332]

This pull request intends to add a new output bot for sending indicators to a Collective Intelligence Framework v3 instance API.

[sebix]

Thank you very much @mdavis332 for this excellent PR, both in terms of code quality as well as in terms of usefulness. I believe CIF3 was long on the wish list for many users.

I can't review the correctness of the code and docs as I don't have the resources to create a testing infrastructure for this. Happy if someone else @certtools/intelmq-contributors could do that.
Only some small remarks on the code, see the comments.

[sebix]

The pycodestyle test fails with:

intelmq/bots/outputs/cif3/output.py:12:80: W291 trailing whitespace
intelmq/bots/outputs/cif3/output.py:104:33: E127 continuation line over-indented for visual indent
intelmq/bots/outputs/cif3/output.py:105:33: E127 continuation line over-indented for visual indent
intelmq/bots/outputs/cif3/output.py:128:71: W291 trailing whitespace
intelmq/bots/outputs/cif3/output.py:129:21: E131 continuation line unaligned for hanging indent
intelmq/bots/outputs/cif3/output.py:130:17: W291 trailing whitespace
intelmq/bots/outputs/cif3/output.py:141:9: E303 too many blank lines (2)
intelmq/bots/outputs/cif3/output.py:174:14: E111 indentation is not a multiple of four
intelmq/bots/outputs/cif3/output.py:174:14: E117 over-indented
intelmq/bots/outputs/cif3/output.py:184:9: E303 too many blank lines (2)
intelmq/bots/outputs/cif3/output.py:196:1: W293 blank line contains whitespace
intelmq/bots/outputs/cif3/output.py:198:1: W293 blank line contains whitespace
intelmq/bots/outputs/cif3/output.py:201:5: E303 too many blank lines (3)
intelmq/bots/outputs/cif3/output.py:216:5: E303 too many blank lines (2)
intelmq/bots/outputs/cif3/output.py:233:1: W391 blank line at end of file

[codecov-commenter]

Codecov Report

Merging #2244 (db97e75) into develop (1a7a339) will decrease coverage by 0.70%.
The diff coverage is 25.00%.

❗ Current head db97e75 differs from pull request most recent head ac2d9a8. Consider uploading reports for the commit ac2d9a8 to get more accurate results

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@             Coverage Diff             @@
##           develop    #2244      +/-   ##
===========================================
- Coverage    76.91%   76.22%   -0.70%     
===========================================
  Files          454      456       +2     
  Lines        24120    24090      -30     
  Branches      3516     3812     +296     
===========================================
- Hits         18553    18362     -191     
- Misses        4793     4980     +187     
+ Partials       774      748      -26     

Impacted Files	Coverage Δ
intelmq/bots/outputs/cif3/output.py	23.85% <23.85%> (ø)
intelmq/tests/bots/outputs/cif3/test_output.py	66.66% <66.66%> (ø)

... and 15 files with indirect coverage changes

[mdavis332]

Thank you very much @mdavis332 for this excellent PR, both in terms of code quality as well as in terms of usefulness. I believe CIF3 was long on the wish list for many users.

Thanks @sebix for the thorough review. I've tried to resolve your suggestions or reply where feedback may still be helpful.

[sebix]

Thanks for the corrections. We're very close.

pycodestyle complains about:

intelmq/bots/outputs/cif3/output.py:96:17: E225 missing whitespace around operator
intelmq/bots/outputs/cif3/output.py:113:13: E128 continuation line under-indented for visual indent
intelmq/bots/outputs/cif3/output.py:114:13: E128 continuation line under-indented for visual indent
intelmq/bots/outputs/cif3/output.py:138:21: E131 continuation line unaligned for hanging indent
intelmq/bots/outputs/cif3/output.py:213:18: W291 trailing whitespace

[mdavis332]

Hi @sebix, apologies for the very long delay. I've tried to address the issues you noted. Please let me know if there's anything else you see that need to be finalized before merging.

[sebix]

I have fixed the remaining minor issues directly. After the tests pass, this PR is ready for merge

[sebix]

Thank you very much, Michael, for the will to contribute in the first place and all your time creating this PR and your endurance!