add initializer for device props (#2392)

Author: danewalton-msft

sdk/inc/azure/iot/az_iot_adu_client.h

@@ -130,6 +130,10 @@ typedef struct
 
 /**
  * @brief      Holds the ADU agent device properties.
+ *
+ * az_iot_adu_client_device_properties_default() must be called to first initialize the
+ * device properties.
+ *
  * @remarks    These properties are used by the ADU service for matching
  *             update groups and verifying the current update deployed.
  * https://docs.microsoft.com/azure/iot-hub-device-update/device-update-plug-and-play
@@ -455,6 +459,15 @@ typedef struct
  */
 AZ_NODISCARD az_iot_adu_client_options az_iot_adu_client_options_default();
 
+/**
+ * @brief Gets the default #az_iot_adu_client_device_properties.
+ * @details Call this to obtain an initialized #az_iot_adu_client_device_properties structure that
+ * can be afterwards modified and passed to necessary APIs.
+ *
+ * @return #az_iot_adu_client_device_properties.
+ */
+AZ_NODISCARD az_iot_adu_client_device_properties az_iot_adu_client_device_properties_default();
+
 /**
  * @brief Initializes an Azure IoT ADU Client.
  *

sdk/src/azure/iot/az_iot_adu_client.c

@@ -101,6 +101,17 @@ AZ_NODISCARD az_iot_adu_client_options az_iot_adu_client_options_default()
                                       = default_compatibility_properties };
 }
 
+AZ_NODISCARD az_iot_adu_client_device_properties az_iot_adu_client_device_properties_default()
+{
+  return (az_iot_adu_client_device_properties){ .manufacturer = AZ_SPAN_LITERAL_EMPTY,
+                                                .model = AZ_SPAN_LITERAL_EMPTY,
+                                                .custom_properties = NULL,
+                                                .adu_version = AZ_SPAN_LITERAL_EMPTY,
+                                                .delivery_optimization_agent_version
+                                                = AZ_SPAN_LITERAL_EMPTY,
+                                                .update_id = AZ_SPAN_LITERAL_EMPTY };
+}
+
 AZ_NODISCARD az_result
 az_iot_adu_client_init(az_iot_adu_client* client, az_iot_adu_client_options* options)
 {

sdk/tests/iot/adu/test_az_iot_adu.c

@@ -56,12 +56,8 @@ static uint8_t expected_agent_state_long_payload_with_retry[]
       "\"installedUpdateId\":\"{\\\"provider\\\":\\\"Contoso\\\",\\\"name\\\":\\\"Foobar\\\","
       "\\\"version\\\":\\\"1.0\\\"}\"}}}";
 
-az_iot_adu_client_device_properties adu_device_properties
-    = { .manufacturer = AZ_SPAN_LITERAL_FROM_STR(TEST_ADU_DEVICE_MANUFACTURER),
-        .model = AZ_SPAN_LITERAL_FROM_STR(TEST_ADU_DEVICE_MODEL),
-        .adu_version = AZ_SPAN_LITERAL_FROM_STR(TEST_AZ_IOT_ADU_CLIENT_AGENT_VERSION),
-        .delivery_optimization_agent_version = AZ_SPAN_LITERAL_EMPTY,
-        .update_id = AZ_SPAN_LITERAL_FROM_STR(TEST_ADU_DEVICE_UPDATE_ID) };
+// Initialized in setup() below.
+static az_iot_adu_client_device_properties adu_device_properties;
 
 static uint8_t send_response_valid_payload[]
     = "{\"deviceUpdate\":{\"__t\":\"c\",\"service\":{\"ac\":200,\"av\":1,\"value\":{}}}}";
@@ -457,6 +453,20 @@ static uint8_t file_url_contoso[]
       "westus2/contoso-adu-instance--contoso-adu/9f9bdc01a5cd49c09e79e35505a913c5/"
       "contoso-v1.1.bin";
 
+static int setup(void** state)
+{
+  (void)state;
+
+  adu_device_properties = az_iot_adu_client_device_properties_default();
+  adu_device_properties.manufacturer = AZ_SPAN_FROM_STR(TEST_ADU_DEVICE_MANUFACTURER);
+  adu_device_properties.model = AZ_SPAN_FROM_STR(TEST_ADU_DEVICE_MODEL);
+  adu_device_properties.adu_version = AZ_SPAN_FROM_STR(TEST_AZ_IOT_ADU_CLIENT_AGENT_VERSION);
+  adu_device_properties.delivery_optimization_agent_version = AZ_SPAN_EMPTY;
+  adu_device_properties.update_id = AZ_SPAN_FROM_STR(TEST_ADU_DEVICE_UPDATE_ID);
+
+  return 0;
+}
+
 #ifndef AZ_NO_PRECONDITION_CHECKING
 ENABLE_PRECONDITION_CHECK_TESTS()
 
@@ -1425,5 +1435,5 @@ int test_az_iot_adu()
     cmocka_unit_test(test_az_iot_adu_client_parse_update_manifest_payload_too_many_file_ids_fail),
     cmocka_unit_test(test_az_iot_adu_client_parse_update_manifest_payload_too_many_total_files_fail)
   };
-  return cmocka_run_group_tests_name("az_iot_adu", tests, NULL, NULL);
+  return cmocka_run_group_tests_name("az_iot_adu", tests, setup, NULL);
 }