Feature: Monitor user Groups and Templates scripts #52

nshandra · 2024-07-07T18:07:30Z

📌 References

Issue: Implementation of the highest risk (the ones in green) events logging into MSTeams

📝 Implementation

This script will compare the metadata of the monitored userGroups or user templates with the version stored in the datastore and generate a report of the changes. This report will be sent to the MS Teams channel set in the webhook config section. Then the new version of the metadata will be stored in the datastore.

Execution:

yarn install

yarn build

yarn start usermonitoring [run-user-groups-monitoring | user-templates-monitoring] --config-file config.json

# To get the debug logs and store them in a file use:
LOG_LEVEL=debug yarn start usermonitoring [run-user-groups-monitoring | user-templates-monitoring] --config-file config.json &> monitoring.log

Parameters:

--config-file: Connection and webhook config file.
-s | --set-datastore: Write monitored data to datastore, use in script setup. It assumes there is a monitoring config in d2-tools/[user-groups-monitoring | user-templates-monitoring]

Requirements:

A config file with the access info of the server and the message webhook details:

{
    "URL": {
        "username": "user",
        "password": "passwd",
        "server": "https://dhis.url/"
    },
    "WEBHOOK": {
        "ms_url": "http://webhook.url/",
        "proxy": "http://proxy.url/",
        "server_name": "INSTANCE_NAME"
    }
}

Sample user-groups-monitoring datastore:

{
  "lastExecution": "timestamp",
  "monitoredUserGroups": [{
    "id1.UserGroup data": "......"
  },
  {
    "id2.UserGroup data": "......"
  }],
  "groupsToMonitor": [
    "id1",
    "id2"
  ]
}

Sample user-templates-monitoring datastore:

{
  "lastExecution": "timestamp",
  "monitoredUserTemplates": [{
    "username1.template data": "......"
  },
  {
    "username2.template data": "......"
  }],
  "templatesToMonitor": [
    "username1.template",
    "username2.template"
  ]
}

This reports stores data into the d2-tools.[user-groups-monitoring | user-templates-monitoring] datastore. This key needs to be setup before the first run to get a correct report.
Its possible to leave monitoredUserGroups | monitoredUserTemplates empty and use the -s flag to populate it.

The report, potentially, has tree sections for each user group:

New entries: JSON with the properties that were unset or empty and changed.
Modified fields: This section has two JSONs, one showing the old values and one with the news.
User assignment changes: This section will show the users lost and added to the group or the template roles and group.

If a section is empty it will be omited.

…nd minor fixes to user group monitoring files.

…ring for consistency

tokland

[code only review] Very close, cool to have tests. Mostly minor issues:

README.md

src/data/user-monitoring/user-groups-monitoring/UserGroupD2Repository.ts

...ain/usecases/user-monitoring/user-groups-monitoring/SaveUserGroupsMonitoringConfigUseCase.ts

src/domain/usecases/user-monitoring/user-templates-monitoring/MonitorUserTemplatesUseCase.ts

...ecases/user-monitoring/user-templates-monitoring/SaveUserTemplatesMonitoringConfigUseCase.ts

src/scripts/commands/usermonitoring.ts

typos and repeated lines in README usermonitoring.ts => userMonitoring.ts userMonitoring: config_file => configFile UserGroup/TemplateDiff replace _Lost/Added to camel case CompareUserTemplatesUseCase.specs move noChangesDiff to data folder CompareUserGroupsUseCase.data add usersChanges to the user difference test

Rework User and UserGroup entities and D2Repositories. Fix and improve some tests.

tokland

Just some very minor details and we are ready to go

src/domain/usecases/user-monitoring/GetLogFormatDate.ts

tokland · 2024-09-23T10:02:20Z

src/domain/usecases/user-monitoring/user-groups-monitoring/MonitorUserGroupsUseCase.ts

@@ -75,7 +73,7 @@ export class MonitorUserGroupsUseCase {
        log.info(`Get user groups with ids: ${options.groupsToMonitor.join(", ")}`);

        const getGroupsUseCase = new GetUserGroupsUseCase(this.userGroupRepository);
-        const compareUserGroupsUseCase = new CompareUserGroupsUseCase();
+        const compareUserGroupsUseCase = new CompareUserGroups();


we can now remove UseCase from the name

Yeah, sorry about that...

tokland · 2024-09-23T10:02:31Z

...ain/usecases/user-monitoring/user-groups-monitoring/SaveUserGroupsMonitoringConfigUseCase.ts


 export class SaveUserGroupsMonitoringConfigUseCase {
    constructor(private configRepository: UserGroupsMonitoringConfigRepository) {}

    async execute(options: UserGroupsMonitoringOptions, monitoredUserGroups: UserGroup[]): Async<void> {
-        options.lastExecution = new GetLogFormatDateUseCase().execute(new Date());
-        options.monitoredUserGroups = monitoredUserGroups;
+        const new_options = {


Fixed, there were some other snake case names that are changed too.

tokland · 2024-09-23T10:02:54Z

.../usecases/user-monitoring/user-groups-monitoring/__tests__/CompareUserGroupsUseCase.specs.ts

@@ -12,7 +12,7 @@ import {

 describe("CompareUserGroupsUseCase", () => {
    it("Should return empty array when comparing the same objects", () => {
-        const useCase = new CompareUserGroupsUseCase();
+        const useCase = new CompareUserGroups();


tokland · 2024-09-23T10:03:19Z

src/domain/usecases/user-monitoring/user-templates-monitoring/MonitorUserTemplatesUseCase.ts

@@ -97,7 +97,7 @@ export class MonitorUserTemplatesUseCase {
        log.info(`Get user groups with usernames: ${options.templatesToMonitor.join(", ")}`);

        const getTemplatesUseCase = new GetUserTemplatesUseCase(this.usersRepository);
-        const compareUserTemplatesUseCase = new CompareUserTemplatesUseCase();
+        const compareUserTemplatesUseCase = new CompareUserTemplates();


tokland · 2024-09-23T10:03:29Z

...ecases/user-monitoring/user-templates-monitoring/SaveUserTemplatesMonitoringConfigUseCase.ts


 export class SaveUserTemplatesMonitoringConfigUseCase {
    constructor(private configRepository: UserTemplatesMonitoringConfigRepository) {}

    async execute(options: UserTemplatesMonitoringOptions, monitoredUserTemplates: User[]): Async<void> {
-        options.lastExecution = new GetLogFormatDateUseCase().execute(new Date());
-        options.monitoredUserTemplates = monitoredUserTemplates;
+        const new_options = {


tokland · 2024-09-23T10:03:49Z

...ses/user-monitoring/user-templates-monitoring/__tests__/CompareUserTemplatesUseCase.specs.ts


    beforeEach(() => {
-        useCase = new CompareUserTemplatesUseCase();
+        useCase = new CompareUserTemplates();


Simplify getLogFormatDate, naming and casing. Fix userRoles repeating in userCredentials.

tokland

All good! 👍

nshandra added 2 commits July 6, 2024 17:25

feat: userGroup monitoring script

e519b8e

feat: add README, enable commented code

4d0946a

nshandra requested review from xurxodev and ifoche July 7, 2024 18:07

nshandra self-assigned this Jul 7, 2024

nshandra added 9 commits July 7, 2024 20:27

fix: update tests

c6fb23f

fix: add missing changes

8f0d708

fix: remove old useCase and test

42494f5

Merge branch 'development' into feature/monitor_usergroups

25d3159

feat: add run-user-template-monitoring command, clean up UserGroups a…

14080ed

…nd minor fixes to user group monitoring files.

feat: finish UserGroups compare test

672eef8

feat: finish run-user-template-monitoring tests

3f0bd6d

feat: make MessageMSTeamsRepository common.

691685c

fix: clean-up leftovers in tests.

a6b222f

nshandra changed the title ~~Feature: Monitor userGroups script~~ Feature: Monitor user Groups and Templates scripts Sep 5, 2024

nshandra requested review from tokland and removed request for xurxodev September 5, 2024 11:41

nshandra added 4 commits September 5, 2024 13:58

fix: change run-user-template-monitoring to run-user-templates-monito…

99fa144

…ring for consistency

feat: Add README for run-user-templates-monitoring

f85b244

fix: make folder naming consistent with script name, fix typos

8ceeade

fix: remove unused import

4aa8b83

nshandra marked this pull request as ready for review September 6, 2024 06:48

tokland reviewed Sep 9, 2024

View reviewed changes

nshandra added 5 commits September 13, 2024 14:04

fix: address PR#52 comments round 2

ad425cf

Rework User and UserGroup entities and D2Repositories. Fix and improve some tests.

fix: change $all for the actual fields

b0475cb

fix: address PR#52 comments round 3

51789d3

fix: no changes check was failing

11f770c

nshandra requested a review from tokland September 23, 2024 08:26

tokland reviewed Sep 23, 2024

View reviewed changes

fix: address PR#52 comments round 4

3d1e216

Simplify getLogFormatDate, naming and casing. Fix userRoles repeating in userCredentials.

nshandra requested a review from tokland September 24, 2024 19:31

tokland approved these changes Sep 26, 2024

View reviewed changes

ifoche merged commit 141301b into development Sep 26, 2024
1 check passed

ifoche deleted the feature/monitor_usergroups branch September 26, 2024 12:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Monitor user Groups and Templates scripts #52

Feature: Monitor user Groups and Templates scripts #52

nshandra commented Jul 7, 2024 •

edited

Loading

tokland left a comment

tokland left a comment •

edited

Loading

tokland Sep 23, 2024

nshandra Sep 24, 2024

tokland Sep 23, 2024

nshandra Sep 24, 2024

tokland Sep 23, 2024

tokland Sep 23, 2024

tokland Sep 23, 2024

tokland Sep 23, 2024

tokland left a comment

Feature: Monitor user Groups and Templates scripts #52

Feature: Monitor user Groups and Templates scripts #52

Conversation

nshandra commented Jul 7, 2024 • edited Loading

📌 References

📝 Implementation

Execution:

Parameters:

Requirements:

tokland left a comment

Choose a reason for hiding this comment

tokland left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tokland left a comment

Choose a reason for hiding this comment

nshandra commented Jul 7, 2024 •

edited

Loading

tokland left a comment •

edited

Loading