Skip to content

Commit 2764578

Browse files
ozgengreenbonebot
authored andcommitted
applying review comments
1 parent 411990d commit 2764578

3 files changed

Lines changed: 64 additions & 62 deletions

File tree

agent_controller/agent_controller.c

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -466,72 +466,72 @@ dup_str_ptr_array (const GPtrArray *src)
466466
* The returned configuration is heap-allocated and must be freed
467467
* using agent_controller_agent_config_free().
468468
*
469-
* @param[in] base_cfg Agent providing the base configuration.
470-
* @param[in] update_cfg Optional configuration overrides. May be NULL.
469+
* @param[in] base_config The configuration to create a modified copy of.
470+
* @param[in] update_config The configuration containing updated values.
471471
*
472472
* @return Newly allocated merged configuration on success,
473473
* or NULL on error.
474474
*/
475475
static agent_controller_agent_config_t
476-
agent_controller_build_agent_config_with_defaults (
477-
const agent_controller_agent_config_t base_cfg,
478-
const agent_controller_agent_config_t update_cfg)
476+
agent_controller_build_updated_agent_config (
477+
const agent_controller_agent_config_t base_config,
478+
const agent_controller_agent_config_t update_config)
479479
{
480-
if (!base_cfg)
480+
if (!base_config)
481481
return NULL;
482482

483483
agent_controller_agent_config_t merged = agent_controller_agent_config_new ();
484484
if (!merged)
485485
return NULL;
486486

487487
/* Start from update if provided, otherwise start from agent defaults */
488-
if (update_cfg)
489-
*merged = *update_cfg;
488+
if (update_config)
489+
*merged = *update_config;
490490
else
491-
*merged = *base_cfg;
491+
*merged = *base_config;
492492

493493
merged->agent_script_executor.scheduler_cron_time = NULL;
494494

495495
/* Fill missing (0) values from agent's config */
496-
if (update_cfg)
496+
if (update_config)
497497
{
498498
if (merged->heartbeat.interval_in_seconds == 0)
499499
merged->heartbeat.interval_in_seconds =
500-
base_cfg->heartbeat.interval_in_seconds;
500+
base_config->heartbeat.interval_in_seconds;
501501

502502
if (merged->heartbeat.miss_until_inactive == 0)
503503
merged->heartbeat.miss_until_inactive =
504-
base_cfg->heartbeat.miss_until_inactive;
504+
base_config->heartbeat.miss_until_inactive;
505505

506506
if (merged->agent_control.retry.attempts == 0)
507507
merged->agent_control.retry.attempts =
508-
base_cfg->agent_control.retry.attempts;
508+
base_config->agent_control.retry.attempts;
509509

510510
if (merged->agent_control.retry.delay_in_seconds == 0)
511511
merged->agent_control.retry.delay_in_seconds =
512-
base_cfg->agent_control.retry.delay_in_seconds;
512+
base_config->agent_control.retry.delay_in_seconds;
513513

514514
if (merged->agent_control.retry.max_jitter_in_seconds == 0)
515515
merged->agent_control.retry.max_jitter_in_seconds =
516-
base_cfg->agent_control.retry.max_jitter_in_seconds;
516+
base_config->agent_control.retry.max_jitter_in_seconds;
517517

518518
if (merged->agent_script_executor.bulk_size == 0)
519519
merged->agent_script_executor.bulk_size =
520-
base_cfg->agent_script_executor.bulk_size;
520+
base_config->agent_script_executor.bulk_size;
521521

522522
if (merged->agent_script_executor.bulk_throttle_time_in_ms == 0)
523523
merged->agent_script_executor.bulk_throttle_time_in_ms =
524-
base_cfg->agent_script_executor.bulk_throttle_time_in_ms;
524+
base_config->agent_script_executor.bulk_throttle_time_in_ms;
525525

526526
if (merged->agent_script_executor.indexer_dir_depth == 0)
527527
merged->agent_script_executor.indexer_dir_depth =
528-
base_cfg->agent_script_executor.indexer_dir_depth;
528+
base_config->agent_script_executor.indexer_dir_depth;
529529
}
530530

531531
const GPtrArray *src_cron =
532-
(update_cfg && update_cfg->agent_script_executor.scheduler_cron_time)
533-
? update_cfg->agent_script_executor.scheduler_cron_time
534-
: base_cfg->agent_script_executor.scheduler_cron_time;
532+
(update_config && update_config->agent_script_executor.scheduler_cron_time)
533+
? update_config->agent_script_executor.scheduler_cron_time
534+
: base_config->agent_script_executor.scheduler_cron_time;
535535

536536
merged->agent_script_executor.scheduler_cron_time =
537537
dup_str_ptr_array (src_cron);
@@ -581,11 +581,11 @@ agent_controller_build_patch_payload (
581581

582582
/* config: prefer update->config if provided */
583583
cJSON *cfg_obj = NULL;
584-
if (agent_update && agent_update->config)
584+
if (agent_update && agent_update->update_config)
585585
{
586586
agent_controller_agent_config_t merged =
587-
agent_controller_build_agent_config_with_defaults (
588-
agent_update->base, agent_update->config);
587+
agent_controller_build_updated_agent_config (
588+
agent_update->base_config, agent_update->update_config);
589589
if (merged)
590590
{
591591
cfg_obj = agent_controller_agent_config_struct_to_cjson (merged);
@@ -971,7 +971,7 @@ agent_controller_agent_update_new (void)
971971

972972
update->authorized = -1;
973973
update->update_to_latest = -1;
974-
update->config = NULL;
974+
update->update_config = NULL;
975975

976976
return update;
977977
}
@@ -987,11 +987,11 @@ agent_controller_agent_update_free (agent_controller_agent_update_t update)
987987
if (!update)
988988
return;
989989

990-
if (update->config)
991-
agent_controller_agent_config_free (update->config);
990+
if (update->update_config)
991+
agent_controller_agent_config_free (update->update_config);
992992

993-
if (update->base)
994-
agent_controller_agent_config_free (update->base);
993+
if (update->base_config)
994+
agent_controller_agent_config_free (update->base_config);
995995

996996
if (update->agent_id)
997997
g_free (update->agent_id);

agent_controller/agent_controller.h

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -187,12 +187,14 @@ typedef struct agent_controller_agent_list *agent_controller_agent_list_t;
187187
*/
188188
struct agent_controller_agent_update
189189
{
190-
int authorized; ///< Authorization status for update
191-
int update_to_latest; ///< Automatically update the agent
192-
/// to the latest available version
193-
agent_controller_agent_config_t config; ///< The new agent scan config
194-
agent_controller_agent_config_t base; ///< The existing agent scan config
195-
gchar *agent_id; ///< Unique identifier of the agent
190+
int authorized; ///< Authorization status for update
191+
int update_to_latest; ///< Automatically update the agent
192+
/// to the latest available version
193+
agent_controller_agent_config_t update_config; ///< The updated values for
194+
/// the scan config
195+
agent_controller_agent_config_t base_config; ///< The existing agent
196+
/// scan config
197+
gchar *agent_id; ///< Unique identifier of the agent
196198
};
197199
typedef struct agent_controller_agent_update *agent_controller_agent_update_t;
198200

agent_controller/agent_controller_tests.c

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ Ensure (agent_controller, agent_update_new_initializes_defaults_correctly)
430430

431431
assert_that (update->authorized, is_equal_to (-1));
432432
assert_that (update->update_to_latest, is_equal_to (-1));
433-
assert_that (update->config, is_null);
433+
assert_that (update->update_config, is_null);
434434

435435
agent_controller_agent_update_free (update);
436436
}
@@ -440,7 +440,7 @@ Ensure (agent_controller, agent_update_free_handles_nested_schedule)
440440
agent_controller_agent_update_t update = agent_controller_agent_update_new ();
441441
assert_that (update, is_not_null);
442442

443-
update->config = agent_controller_agent_config_new ();
443+
update->update_config = agent_controller_agent_config_new ();
444444

445445
agent_controller_agent_update_free (update);
446446
assert_that (true, is_true);
@@ -972,12 +972,12 @@ Ensure (agent_controller, patch_payload_includes_config_with_defaults_from_base)
972972
agent_controller_agent_update_list_t updates =
973973
make_update_list_with_ids (ids, 1);
974974

975-
updates->updates[0]->base = make_agent_config ();
976-
updates->updates[0]->base->heartbeat.interval_in_seconds = 600;
977-
updates->updates[0]->base->heartbeat.miss_until_inactive = 9;
975+
updates->updates[0]->base_config = make_agent_config ();
976+
updates->updates[0]->base_config->heartbeat.interval_in_seconds = 600;
977+
updates->updates[0]->base_config->heartbeat.miss_until_inactive = 9;
978978

979-
updates->updates[0]->config = agent_controller_agent_config_new ();
980-
updates->updates[0]->config->heartbeat.interval_in_seconds = 42;
979+
updates->updates[0]->update_config = agent_controller_agent_config_new ();
980+
updates->updates[0]->update_config->heartbeat.interval_in_seconds = 42;
981981

982982
gchar *payload = agent_controller_build_patch_payload (updates);
983983

@@ -997,8 +997,8 @@ Ensure (agent_controller, patch_payload_omits_config_when_base_missing)
997997
agent_controller_agent_update_list_t updates =
998998
make_update_list_with_ids (ids, 1);
999999

1000-
updates->updates[0]->config = agent_controller_agent_config_new ();
1001-
updates->updates[0]->config->heartbeat.interval_in_seconds = 42;
1000+
updates->updates[0]->update_config = agent_controller_agent_config_new ();
1001+
updates->updates[0]->update_config->heartbeat.interval_in_seconds = 42;
10021002

10031003
gchar *payload = agent_controller_build_patch_payload (updates);
10041004

@@ -2687,7 +2687,7 @@ Ensure (agent_controller, get_scan_id_returns_dup_string_on_success)
26872687
g_free (sid);
26882688
}
26892689

2690-
Ensure (agent_controller, build_config_with_defaults_fills_zeros_from_base)
2690+
Ensure (agent_controller, build_updated_agent_config_fills_zeros_from_base)
26912691
{
26922692
agent_controller_agent_config_t base = make_agent_config ();
26932693
assert_that (base, is_not_null);
@@ -2698,7 +2698,7 @@ Ensure (agent_controller, build_config_with_defaults_fills_zeros_from_base)
26982698
upd->heartbeat.interval_in_seconds = 42;
26992699

27002700
agent_controller_agent_config_t merged =
2701-
agent_controller_build_agent_config_with_defaults (base, upd);
2701+
agent_controller_build_updated_agent_config (base, upd);
27022702

27032703
assert_that (merged, is_not_null);
27042704

@@ -2718,7 +2718,7 @@ Ensure (agent_controller, build_config_with_defaults_fills_zeros_from_base)
27182718
agent_controller_agent_config_free (base);
27192719
}
27202720

2721-
Ensure (agent_controller, build_config_with_defaults_deep_copies_update_cron)
2721+
Ensure (agent_controller, build_updated_agent_config_deep_copies_update_cron)
27222722
{
27232723
agent_controller_agent_config_t base = make_agent_config ();
27242724
assert_that (base, is_not_null);
@@ -2732,7 +2732,7 @@ Ensure (agent_controller, build_config_with_defaults_deep_copies_update_cron)
27322732
g_strdup ("0 0 * * *"));
27332733

27342734
agent_controller_agent_config_t merged =
2735-
agent_controller_build_agent_config_with_defaults (base, upd);
2735+
agent_controller_build_updated_agent_config (base, upd);
27362736

27372737
assert_that (merged, is_not_null);
27382738
assert_that (merged->agent_script_executor.scheduler_cron_time, is_not_null);
@@ -2759,7 +2759,7 @@ Ensure (agent_controller, build_config_with_defaults_deep_copies_update_cron)
27592759
}
27602760

27612761
Ensure (agent_controller,
2762-
build_config_with_defaults_deep_copies_base_cron_when_update_missing)
2762+
build_updated_agent_config_deep_copies_base_cron_when_update_missing)
27632763
{
27642764
agent_controller_agent_config_t base = make_agent_config ();
27652765
assert_that (base, is_not_null);
@@ -2768,7 +2768,7 @@ Ensure (agent_controller,
27682768
assert_that (upd, is_not_null);
27692769

27702770
agent_controller_agent_config_t merged =
2771-
agent_controller_build_agent_config_with_defaults (base, upd);
2771+
agent_controller_build_updated_agent_config (base, upd);
27722772

27732773
assert_that (merged, is_not_null);
27742774
assert_that (merged->agent_script_executor.scheduler_cron_time, is_not_null);
@@ -2801,15 +2801,15 @@ Ensure (agent_controller, patch_payload_config_zeros_default_to_base_values)
28012801

28022802
updates->updates[0]->authorized = 1;
28032803

2804-
updates->updates[0]->base = make_agent_config ();
2805-
assert_that (updates->updates[0]->base, is_not_null);
2804+
updates->updates[0]->base_config = make_agent_config ();
2805+
assert_that (updates->updates[0]->base_config, is_not_null);
28062806

28072807
/* Set base heartbeat to different values */
2808-
updates->updates[0]->base->heartbeat.interval_in_seconds = 600;
2809-
updates->updates[0]->base->heartbeat.miss_until_inactive = 9;
2808+
updates->updates[0]->base_config->heartbeat.interval_in_seconds = 600;
2809+
updates->updates[0]->base_config->heartbeat.miss_until_inactive = 9;
28102810

2811-
updates->updates[0]->config = agent_controller_agent_config_new ();
2812-
assert_that (updates->updates[0]->config, is_not_null);
2811+
updates->updates[0]->update_config = agent_controller_agent_config_new ();
2812+
assert_that (updates->updates[0]->update_config, is_not_null);
28132813

28142814
gchar *payload = agent_controller_build_patch_payload (updates);
28152815

@@ -2831,7 +2831,7 @@ Ensure (agent_controller,
28312831
assert_that (upd, is_not_null);
28322832

28332833
agent_controller_agent_config_t merged =
2834-
agent_controller_build_agent_config_with_defaults (NULL, upd);
2834+
agent_controller_build_updated_agent_config (NULL, upd);
28352835

28362836
assert_that (merged, is_null);
28372837

@@ -2848,7 +2848,7 @@ Ensure (agent_controller,
28482848
base->heartbeat.miss_until_inactive = 3;
28492849

28502850
agent_controller_agent_config_t merged =
2851-
agent_controller_build_agent_config_with_defaults (base, NULL);
2851+
agent_controller_build_updated_agent_config (base, NULL);
28522852

28532853
assert_that (merged, is_not_null);
28542854

@@ -2888,7 +2888,7 @@ Ensure (agent_controller,
28882888
upd->heartbeat.interval_in_seconds = 42;
28892889

28902890
agent_controller_agent_config_t merged =
2891-
agent_controller_build_agent_config_with_defaults (base, upd);
2891+
agent_controller_build_updated_agent_config (base, upd);
28922892

28932893
assert_that (merged, is_not_null);
28942894
assert_that (merged->heartbeat.interval_in_seconds, is_equal_to (42));
@@ -3360,12 +3360,12 @@ main (int argc, char **argv)
33603360
add_test_with_context (suite, agent_controller,
33613361
get_scan_id_returns_dup_string_on_success);
33623362
add_test_with_context (suite, agent_controller,
3363-
build_config_with_defaults_fills_zeros_from_base);
3363+
build_updated_agent_config_fills_zeros_from_base);
33643364
add_test_with_context (suite, agent_controller,
3365-
build_config_with_defaults_deep_copies_update_cron);
3365+
build_updated_agent_config_deep_copies_update_cron);
33663366
add_test_with_context (
33673367
suite, agent_controller,
3368-
build_config_with_defaults_deep_copies_base_cron_when_update_missing);
3368+
build_updated_agent_config_deep_copies_base_cron_when_update_missing);
33693369
add_test_with_context (suite, agent_controller,
33703370
patch_payload_config_zeros_default_to_base_values);
33713371
add_test_with_context (

0 commit comments

Comments
 (0)