Rename event serializers #2300

shreyamalviya · 2022-09-16T07:32:52Z

What does this PR do?

Fixes #2293

PR Checklist

Have you added an explanation of what your changes do and why you'd like to include them?
Is the TravisCI build passing?
~~Was the CHANGELOG.md updated to reflect the changes?~~
~~Was the documentation framework updated to reflect the changes?~~
Have you checked that you haven't introduced any duplicate code?

Testing Checklist

~~Added relevant unit tests?~~
Have you successfully tested your changes locally? Elaborate:

UTs pass
~~If applicable, add screenshots or log transcripts of the feature working~~

codecov · 2022-09-16T07:36:57Z

Codecov Report

Base: 59.37% // Head: 59.40% // Increases project coverage by +0.02% 🎉

Coverage data is based on head (dd2ed50) compared to base (54f1bd2).
Patch coverage: 81.60% of modified lines in pull request are covered.

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

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2300      +/-   ##
===========================================
+ Coverage    59.37%   59.40%   +0.02%     
===========================================
  Files          531      532       +1     
  Lines        13765    13774       +9     
===========================================
+ Hits          8173     8182       +9     
  Misses        5592     5592

Impacted Files	Coverage Δ
monkey/common/agent_event_serializers/consts.py	`100.00% <ø> (ø)`
monkey/common/agent_events/__init__.py	`100.00% <ø> (ø)`
monkey/common/agent_events/abstract_agent_event.py	`100.00% <ø> (ø)`
monkey/infection_monkey/exploit/mssqlexec.py	`0.00% <0.00%> (ø)`
monkey/infection_monkey/exploit/smbexec.py	`0.00% <0.00%> (ø)`
monkey/infection_monkey/exploit/tools/smb_tools.py	`0.00% <0.00%> (ø)`
monkey/infection_monkey/exploit/wmiexec.py	`0.00% <0.00%> (ø)`
monkey/infection_monkey/monkey.py	`0.00% <0.00%> (ø)`
...sland/cc/repository/zero_trust/IEventRepository.py	`0.00% <0.00%> (ø)`
monkey/monkey_island/cc/server_setup.py	`0.00% <0.00%> (ø)`
... and 30 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

VakarisZ

Maybe rename monkey/common/events to monkey/common/agent_events?

VakarisZ · 2022-09-16T08:25:06Z

monkey/infection_monkey/agent_event_forwarder.py:87
logger.debug(f"Sending agent events to Island at {self._server_address}: {events}")

VakarisZ · 2022-09-16T08:42:18Z

Maybe the resource should also be called AgentEvents, since it's the only thing it accepts? Alternativelly, maybe it can have /api/events/<string:type> url?

VakarisZ · 2022-09-16T08:43:45Z

monkey/monkey_island/cc/repository/i_event_repository.py should be called i_agent_event_repository.py?

mssalvatore · 2022-09-16T11:20:57Z

I agree with @VakarisZ . That being said, the issue was fairly tightly scoped. I'd say fix as many of those things as you can in 30 minutes and create a new issue for the rest.

…gistry

…egistry

…_registry.py

…erializer.py

…vent_serializer.py

…er in test_pydantic_agent_event_serializer.py

…alizers

…ializers

…zers

…alizer_registry.py

…ry in test_agent_event_serializer_registry.py

VakarisZ · 2022-09-16T13:27:27Z

vulture_allowlist.py

 from monkey_island.cc.repository.i_log_repository import ILogRepository
 from monkey_island.cc.repository.i_machine_repository import IMachineRepository
 from monkey_island.cc.repository.i_report_repository import IReportRepository
 from monkey_island.cc.repository.i_simulation_repository import ISimulationRepository
 from monkey_island.cc.repository.ICredentials import ICredentialsRepository
-from monkey_island.cc.repository.zero_trust.IEventRepository import IEventRepository
+from monkey_island.cc.repository.zero_trust.IAgentEventRepository import IAgentEventRepository


happy-noises

VakarisZ reviewed Sep 16, 2022

View reviewed changes

shreyamalviya force-pushed the 2293-rename-event-serializers branch from 6144b8e to d1654a4 Compare September 16, 2022 12:57

shreyamalviya added 23 commits September 16, 2022 08:58

Agent: Rename IEventSerializer -> IAgentEventSerializer

0e2b165

UT: Use IAgentEventSerializer in place of IEventSerializer

619dc68

Common:Rename i_event_serializer.py -> i_agent_event_serializer.py

3b22bf0

Agent: Fix import in agent_event_forwarder.py

c4ab5d9

Common: Rename EventSerializerRegistry -> AgentEventSerializerRegistry

6ced4af

Agent: Use AgentEventSerializerRegistry in place of EventSerializerRe…

19a59bf

…gistry

Island: Use AgentEventSerializerRegistry in place of EventSerializerR…

4a23f5a

…egistry

UT: Use AgentEventSerializerRegistry in place of EventSerializerRegistry

2568d52

Common: Rename event_serializer_registry.py -> agent_event_serializer…

940b479

…_registry.py

Project: Remove irrelevant Vulture allowlist entries

bf5e32a

Common: Rename PydanticEventSerializer -> PydanticAgentEventSerializer

43fd978

UT: Use PydanticAgentEventSerializer in place of PydanticEventSerializer

d729b51

Common: Rename pydantic_event_serializer.py -> pydantic_agent_event_s…

f5a0b42

…erializer.py

UT: Rename test_pydantic_event_serializer.py -> test_pydantic_agent_e…

d694591

…vent_serializer.py

UT: Change pydantic_event_serializer -> pydantic_agent_event_serializ…

2f74851

…er in test_pydantic_agent_event_serializer.py

Common: Rename event_serializers/ -> agent_event_serializers/

d732727

Agent: Fix import common.event_serializers -> common.agent_event_seri…

922db9c

…alizers

Island: Fix import common.event_serializers -> common.agent_event_ser…

91b973c

…ializers

UT: Fix import common.event_serializers -> common.agent_event_seriali…

7bfc2da

…zers

UT: Rename event_serializers/ -> agent_event_serializers/

edb1c97

UT: Rename test_event_serializer_registry.py -> test_agent_event_seri…

e6db64b

…alizer_registry.py

UT: Change event_serializer_registry -> agent_event_serializer_regist…

5ad5de9

…ry in test_agent_event_serializer_registry.py

Agent: Make log message more specific in agent_event_forwarder.py

edce35e

shreyamalviya and others added 17 commits September 16, 2022 08:58

Island: Rename resource Events -> AgentEvents

c37876c

UT: Use AgentEvents in place of Events in test_events.py

354d662

Island: Rename /api/events to /api/agent-events

cfc0905

Agent: /api/agent-events in place of /api/events

66eaccb

Chaneglog: Add entry for endpoint rename

ad30efc

Island: Rename cc/resources/events.py -> cc/resources/agent_events.py

f0d5545

Island: Rename IEventRepository -> IAgentEventRepository

0dccbd3

UT: Change IEventRepository -> IAgentEventRepository

be612ab

Project: Fix Vulture allowlist entries

c7fef90

Island: Rename i_event_repository.py -> i_agent_event_repository.py

89a8ed7

Project: Fix import in Vulture allowlist

e2fed84

Common: Rename common/events/ -> common/agent_events/

b5736fd

Agent: Fix imports common.events -> common.agent_events

c8d11cd

Island: Fix imports common.events -> common.agent_events

d93eb45

UT: Fix imports common.events -> common.agent_events

f8134e5

UT: Fix CredentialsStolenEvent event import

83279cb

UT: Rename common/events -> common/agent_events

f0e8691

mssalvatore force-pushed the 2293-rename-event-serializers branch from d1654a4 to f0e8691 Compare September 16, 2022 13:06

CHANGELOG: Fix /api/agent-events entry

dd2ed50

mssalvatore approved these changes Sep 16, 2022

View reviewed changes

Agent: Rename EVENTS_API_URL to AGENT_EVENTS_API_URL

998c1d7

VakarisZ reviewed Sep 16, 2022

View reviewed changes

VakarisZ approved these changes Sep 16, 2022

View reviewed changes

mssalvatore merged commit 4e1ca65 into develop Sep 16, 2022

mssalvatore deleted the 2293-rename-event-serializers branch September 16, 2022 15:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename event serializers #2300

Rename event serializers #2300

shreyamalviya commented Sep 16, 2022

codecov bot commented Sep 16, 2022 •

edited

Loading

VakarisZ left a comment

VakarisZ commented Sep 16, 2022

VakarisZ commented Sep 16, 2022

VakarisZ commented Sep 16, 2022

mssalvatore commented Sep 16, 2022

VakarisZ Sep 16, 2022

Rename event serializers #2300

Rename event serializers #2300

Conversation

shreyamalviya commented Sep 16, 2022

What does this PR do?

PR Checklist

Testing Checklist

codecov bot commented Sep 16, 2022 • edited Loading

Codecov Report

VakarisZ left a comment

Choose a reason for hiding this comment

VakarisZ commented Sep 16, 2022

VakarisZ commented Sep 16, 2022

VakarisZ commented Sep 16, 2022

mssalvatore commented Sep 16, 2022

VakarisZ Sep 16, 2022

Choose a reason for hiding this comment

codecov bot commented Sep 16, 2022 •

edited

Loading