feat: add operation mapping for device profile

[Ruadhri17]

Proposed changes

TODO:

• test for main device mapping
• test for child device mapping
• doc test for c8y deserializer
• test deserilaizer

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
• Documentation Update (if none of the other choices apply)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

• support device profile operation #2921
• feat: support device profile operation #2920

Checklist

• I have read the CONTRIBUTING doc
• I have signed the CLA (in all commits with git commit -s)
• I ran cargo fmt as mentioned in CODING_GUIDELINES
• I used cargo clippy as mentioned in CODING_GUIDELINES
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

[codecov]

Codecov Report

Attention: Patch coverage is 95.41640% with 71 lines in your changes missing coverage. Please review.

Project coverage is 78.5%. Comparing base (dc7c336) to head (5358ddc).
Report is 3 commits behind head on main.

Files	Patch %	Lines
...pper_ext/src/operations/handlers/device_profile.rs	96.6%	4 Missing and 38 partials ⚠️
...xtensions/c8y_mapper_ext/src/operations/convert.rs	83.6%	6 Missing and 2 partials ⚠️
crates/core/tedge_api/src/device_profile.rs	84.6%	6 Missing ⚠️
crates/extensions/c8y_mapper_ext/src/converter.rs	57.1%	5 Missing and 1 partial ⚠️
crates/core/c8y_api/src/json_c8y_deserializer.rs	98.3%	1 Missing and 2 partials ⚠️
crates/core/tedge_api/src/commands.rs	33.3%	2 Missing ⚠️
.../tedge_config/src/tedge_config_cli/tedge_config.rs	75.0%	0 Missing and 1 partial ⚠️
crates/extensions/c8y_mapper_ext/src/config.rs	0.0%	1 Missing ⚠️
...xtensions/c8y_mapper_ext/src/operations/handler.rs	83.3%	0 Missing and 1 partial ⚠️
...ions/c8y_mapper_ext/src/operations/handlers/mod.rs	66.6%	1 Missing ⚠️

Additional details and impacted files

Files	Coverage Δ
crates/core/c8y_api/src/smartrest/inventory.rs	70.2% <100.0%> (+0.9%)	⬆️
...core/c8y_api/src/smartrest/smartrest_serializer.rs	90.4% <100.0%> (+<0.1%)	⬆️
crates/core/tedge_api/src/lib.rs	100.0% <ø> (ø)
crates/core/tedge_api/src/mqtt_topics.rs	88.5% <100.0%> (+1.2%)	⬆️
crates/extensions/c8y_mapper_ext/src/lib.rs	90.0% <100.0%> (+1.1%)	⬆️
crates/extensions/c8y_mapper_ext/src/tests.rs	92.7% <100.0%> (-0.1%)	⬇️
.../tedge_config/src/tedge_config_cli/tedge_config.rs	73.6% <75.0%> (+<0.1%)	⬆️
crates/extensions/c8y_mapper_ext/src/config.rs	51.5% <0.0%> (-0.3%)	⬇️
...xtensions/c8y_mapper_ext/src/operations/handler.rs	95.1% <83.3%> (-0.2%)	⬇️
...ions/c8y_mapper_ext/src/operations/handlers/mod.rs	77.0% <66.6%> (-0.1%)	⬇️
... and 6 more

... and 7 files with indirect coverage changes

[rina23q]

Some suggestions

[albinsuresh]

The mapping logic looks fine in general. But spotted a few corner cases.

The device profile payload may or may not contain all of software, firmware and configuration values at all times. If firmware is not included, it won't even be there in the cloud payload. But the current logic expects that key at all times, failing to convert otherwise. software and configuration can be empty arrays as well but not absent. But, I'd be defensive and code against their absence as well. Also, it'd also be nice if those entries are excluded from the mapped tedge command payload when those arrays are empty as well, just to reduce noise. But that'd be a secondary improvement.

Also, improve the test coverage for softwareType conversions as well, by using type suffixes in versions.

[github-actions]

Robot Results

✅ Passed	❌ Failed	⏭️ Skipped	Total	Pass %	⏱️ Duration
491	0	2	491	100	1h23m39.204247999s

[albinsuresh]

The only major missing piece is the status update mapping.

Although the test coverage has improved, a few more cases can be added as highlighted. Also, note that the codecov report isn't favourable either. You'll have to make it happy as well.

[rina23q]

While I am testing end-to-end, I found that handling for the device_profile command metadata is missing. This means, c8y_DeviceProfile is never declared in 114 message...

This match needs to be expanded. The implementation should be very similar to the case OperationType::Restart.

thin-edge.io/crates/extensions/c8y_mapper_ext/src/converter.rs

Lines 1123 to 1149 in 1c68fab

	Channel::CommandMetadata { operation } => {
	self.validate_operation_supported(operation, &source)?;
	match operation {
	OperationType::Restart => self.register_restart_operation(&source).await,
	OperationType::SoftwareList => {
	self.register_software_list_operation(&source, message)
	.await
	}
	OperationType::SoftwareUpdate => {
	self.register_software_update_operation(&source).await
	}
	OperationType::LogUpload => self.convert_log_metadata(&source, message),
	OperationType::ConfigSnapshot => {
	self.convert_config_snapshot_metadata(&source, message)
	}
	OperationType::ConfigUpdate => {
	self.convert_config_update_metadata(&source, message)
	}
	OperationType::FirmwareUpdate => {
	self.register_firmware_update_operation(&source)
	}
	OperationType::Custom(c8y_op_name) => {
	self.register_custom_operation(&source, c8y_op_name)
	}
	_ => Ok(vec![]),
	}
	}

I'll let you decide if you address this in this PR or a follow-up PR.

[rina23q]

Another problem: c8y-mapper doesn't subscribe to ../cmd/device_profile topic and ../cmd/device_profile/+ topic. You have to add something like below

 if capabilities.device_profile { 
     topics.add_all(crate::operations::device_profile::topic_filter(&mqtt_schema)); 
 } 

to this file

thin-edge.io/crates/extensions/c8y_mapper_ext/src/config.rs

Lines 201 to 218 in 1c68fab

	if capabilities.log_upload {
	topics.add_all(crate::operations::log_upload::log_upload_topic_filter(
	&mqtt_schema,
	));
	}
	if capabilities.config_snapshot {
	topics.add_all(crate::operations::config_snapshot::topic_filter(
	&mqtt_schema,
	));
	}
	if capabilities.config_update {
	topics.add_all(crate::operations::config_update::topic_filter(&mqtt_schema));
	}
	if capabilities.firmware_update {
	topics.add_all(
	crate::operations::firmware_update::firmware_update_topic_filter(&mqtt_schema),
	);
	}

[rina23q]

I confirmed both issue were fixed. Thank you.

[albinsuresh]

The feature is working as expected. But, the codecov report is not at all favourable. Something needs to be done to get it in shape.

[gligorisaev]

The feature is working as expected, QA checked the functionality according description