fix: add device.csr_path to cloud profiles by Ruadhri17 · Pull Request #3441 · thin-edge/thin-edge.io

Ruadhri17 · 2025-03-03T09:45:21Z

Proposed changes

As mentioned in #3413 user could not specified device.csr_path per cloud profile. This PR appends multi profile config with csr_path and replaces old approach of accessing config value in tedge cert create-csr.

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

device.csr_path can't be used under cloud profiles #3413

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 · 2025-03-03T09:57:50Z

Codecov Report

Attention: Patch coverage is 31.03448% with 20 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
.../tedge_config/src/tedge_config_cli/tedge_config.rs	34.61%	10 Missing and 7 partials ⚠️
crates/core/tedge/src/cli/certificate/cli.rs	0.00%	3 Missing ⚠️

Additional details and impacted files

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions · 2025-03-03T13:17:12Z

Robot Results

✅ Passed	❌ Failed	⏭️ Skipped	Total	Pass %	⏱️ Duration
584	0	3	584	100	1h37m45.292914999s

rina23q

Waiting for a system test. Can be added under /tests/RobotFramework/tests/tedge/certificate_signing_request.robot

crates/core/tedge/src/cli/certificate/cli.rs

Signed-off-by: Krzysztof Piotrowski <krzysztof.piotrowski@inetum.com>

didier-wenzek · 2025-03-05T10:21:05Z

tests/RobotFramework/tests/tedge/certificate_signing_request.robot

+    File Should Not Exist    /etc/tedge/device-certs/tedge-private-key.pem
+
+    Execute Command
+    ...    tedge config set c8y.device.csr_path    /etc/tedge/device-certs/example_dev_test0001-test1.csr


Extra spaces that are confusing robotframework ;-)

Suggested change

... tedge config set c8y.device.csr_path /etc/tedge/device-certs/example_dev_test0001-test1.csr

... tedge config set c8y.device.csr_path /etc/tedge/device-certs/example_dev_test0001-test1.csr

rina23q · 2025-03-05T14:53:36Z

tests/RobotFramework/tests/tedge/certificate_signing_request.robot

+    Execute Command
+    ...    tedge config set c8y.device.csr_path /etc/tedge/device-certs/example_dev_test0001-test1.csr
+
+    Execute Command    sudo tedge cert create-csr


For the failing test, the error message makes sense. Since there is no device certificate nor explicitly device ID is provided by --device-id option, there is no way for the command to know the CN.
So, either provide a device ID as the error message says, or create a certificate beforehand.

sudo tedge cert create-csr returned an unexpected exit code stdout: stderr: Error: missing configuration parameter Caused by: No device ID is provided. Use --device-id <name> option to specify the device ID.

Also adding c8y argument is forgotten. With the following change, the test will pass (confirmed in my local env).

Suggested change

Execute Command sudo tedge cert create-csr

Execute Command sudo tedge cert create-csr c8y --device-id test-user

Is this a new test though? If not, then the --device-id is not a mandatory flag, as it can pick up the value from the existing certificate or manually set device.id etc.

Is this a new test though?

=> It is.

If the test setup was with certificate, as @reubenmiller says, there would be no need to give --device-id. But I'd say it's ok to give --device-id and setup without cert. Not so important for the test purpose I think.

[Setup] Setup Without Certificate File Should Not Exist /etc/tedge/device-certs/tedge-certificate.pem File Should Not Exist /etc/tedge/device-certs/tedge-private-key.pem

rina23q

LGTM

didier-wenzek

Approved

Signed-off-by: Krzysztof Piotrowski <krzysztof.piotrowski@inetum.com>

Ruadhri17 requested review from albinsuresh, didier-wenzek, jarhodes314 and rina23q as code owners March 3, 2025 09:45

Ruadhri17 temporarily deployed to Test Pull Request March 3, 2025 09:45 — with GitHub Actions Inactive

Ruadhri17 added theme:c8y Theme: Cumulocity related topics theme:certificates Theme: Device certificate topics theme:aws Theme: AWS cloud related topics theme:az Theme: Azure IoT related topics bug Something isn't working and removed bug Something isn't working labels Mar 3, 2025

Ruadhri17 temporarily deployed to Test Auto March 3, 2025 13:00 — with GitHub Actions Inactive

rina23q reviewed Mar 3, 2025

View reviewed changes

crates/core/tedge/src/cli/certificate/cli.rs Show resolved Hide resolved

Ruadhri17 requested a review from a team as a code owner March 5, 2025 09:49

Ruadhri17 had a problem deploying to Test Pull Request March 5, 2025 09:49 — with GitHub Actions Failure

fix: add csr path to cloud profiles

d6bac57

Signed-off-by: Krzysztof Piotrowski <krzysztof.piotrowski@inetum.com>

Ruadhri17 force-pushed the fix-tedge-csr branch from 51f1586 to 8dfebd1 Compare March 5, 2025 09:50

Ruadhri17 temporarily deployed to Test Pull Request March 5, 2025 09:50 — with GitHub Actions Inactive

Ruadhri17 had a problem deploying to Test Auto March 5, 2025 10:01 — with GitHub Actions Failure

didier-wenzek reviewed Mar 5, 2025

View reviewed changes

Ruadhri17 force-pushed the fix-tedge-csr branch from 8dfebd1 to 85c152d Compare March 5, 2025 11:40

Ruadhri17 temporarily deployed to Test Pull Request March 5, 2025 11:41 — with GitHub Actions Inactive

Ruadhri17 had a problem deploying to Test Auto March 5, 2025 11:53 — with GitHub Actions Failure

rina23q reviewed Mar 5, 2025

View reviewed changes

Ruadhri17 temporarily deployed to Test Pull Request March 5, 2025 16:01 — with GitHub Actions Inactive

Ruadhri17 temporarily deployed to Test Auto March 5, 2025 16:07 — with GitHub Actions Inactive

rina23q approved these changes Mar 5, 2025

View reviewed changes

didier-wenzek approved these changes Mar 5, 2025

View reviewed changes

test: add test for generating CSR and using tedge config for output path

207b0de

Signed-off-by: Krzysztof Piotrowski <krzysztof.piotrowski@inetum.com>

Ruadhri17 force-pushed the fix-tedge-csr branch from 0bb9c97 to 207b0de Compare March 6, 2025 01:19

Ruadhri17 temporarily deployed to Test Pull Request March 6, 2025 01:20 — with GitHub Actions Inactive

Ruadhri17 enabled auto-merge March 6, 2025 01:20

Ruadhri17 temporarily deployed to Test Auto March 6, 2025 01:26 — with GitHub Actions Inactive

Ruadhri17 added this pull request to the merge queue Mar 6, 2025

Merged via the queue into thin-edge:main with commit 58f370e Mar 6, 2025
33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add device.csr_path to cloud profiles#3441

fix: add device.csr_path to cloud profiles#3441
Ruadhri17 merged 2 commits intothin-edge:mainfrom
Ruadhri17:fix-tedge-csr

Ruadhri17 commented Mar 3, 2025

Uh oh!

codecov bot commented Mar 3, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 3, 2025 •

edited

Loading

Uh oh!

rina23q left a comment

Uh oh!

Uh oh!

didier-wenzek Mar 5, 2025

Uh oh!

rina23q Mar 5, 2025 •

edited

Loading

Uh oh!

reubenmiller Mar 5, 2025 •

edited

Loading

Uh oh!

rina23q Mar 5, 2025 •

edited

Loading

Uh oh!

rina23q left a comment

Uh oh!

didier-wenzek left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	... tedge config set c8y.device.csr_path /etc/tedge/device-certs/example_dev_test0001-test1.csr
	... tedge config set c8y.device.csr_path /etc/tedge/device-certs/example_dev_test0001-test1.csr

	Execute Command sudo tedge cert create-csr
	Execute Command sudo tedge cert create-csr c8y --device-id test-user

Conversation

Ruadhri17 commented Mar 3, 2025

Proposed changes

Types of changes

Paste Link to the issue

Checklist

Further comments

Uh oh!

codecov bot commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Robot Results

Uh oh!

rina23q left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

didier-wenzek Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

rina23q Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reubenmiller Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rina23q Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rina23q left a comment

Choose a reason for hiding this comment

Uh oh!

didier-wenzek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Mar 3, 2025 •

edited

Loading

github-actions bot commented Mar 3, 2025 •

edited

Loading

rina23q Mar 5, 2025 •

edited

Loading

reubenmiller Mar 5, 2025 •

edited

Loading

rina23q Mar 5, 2025 •

edited

Loading