cloud: add oc_cloud_manager_stop_v1 function

[Danielius1922]

The function enables the caller to stop the cloud manager, but without clearing the cloud configuration.

Summary by CodeRabbit

• New Features

  • Added a function to check if cloud configuration exists.
  • Introduced functions to check and initialize the cloud registration context.
  • Implemented a function to stop cloud registration with an option to reset the configuration.
  • Added a test case to verify cloud configuration provisioning with a started cloud context.

• Bug Fixes

  • Enhanced cloud context handling during the stop process for improved stability.

[ocf-conformance-test-tool]

🎉 Thank you for your code contribution! To guarantee the change/addition is conformant to the OCF Specification, we would like to ask you to execute OCF Conformance Testing of your change ☝️ when your work is ready to be reviewed.

---

ℹ️ To verify your latest change (e9346de), label this PR with OCF Conformance Testing.

⚠️ Label is removed with every code change.

[coderabbitai]

Walkthrough

The recent updates focus on enhancing cloud configuration management in the API. These changes introduce new functionalities to improve flexibility and robustness in handling cloud interactions. Key enhancements include checking for existing cloud configurations, providing the option to stop cloud registrations with a reset capability, and conditional initialization of registration contexts. These updates aim to offer more control over cloud configuration settings based on specific requirements.

Changes

Files	Change Summary
api/cloud/oc_cloud.c...	- Added cloud_has_configuration function. - Modified oc_cloud_manager_stop to call oc_cloud_manager_stop_v1 with a reset flag. - Updated oc_cloud_manager_stop_v1 to handle configuration reset based on a flag. - Adjusted context handling in oc_cloud_manager_stop_v1 based on configuration presence.
api/cloud/oc_cloud_context.c, api/cloud/oc_cloud_context_internal.h	- Added oc_cloud_registration_context_init_if_not_set for conditional context initialization. - Included oc_cloud_registration_context_reset to reset temporary data.
api/cloud/unittest/cloud_manager_test.cpp	- Added a test case oc_cloud_manager_stop_v1 in the TestCloudManager suite to test stopping scenarios with specific settings.
api/cloud/unittest/cloud_test.cpp	- Introduced a test case oc_cloud_provision_conf_resource_with_started_cloud to test provisioning with a running cloud context.
include/oc_cloud.h	- Added oc_cloud_manager_stop_v1 to stop cloud registration with reset option.
swig/swig_interfaces/oc_cloud.i	- Added jni_cloud_manager_stop_v1 for Java-native code interaction with reset support. - Ignored certain cloud context registration functions in the SWIG interface.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 953fc15 and d7089cf.

Files selected for processing (7)

• api/cloud/oc_cloud.c (5 hunks)
• api/cloud/oc_cloud_context.c (2 hunks)
• api/cloud/oc_cloud_context_internal.h (1 hunks)
• api/cloud/unittest/cloud_manager_test.cpp (1 hunks)
• api/cloud/unittest/cloud_test.cpp (1 hunks)
• include/oc_cloud.h (2 hunks)
• swig/swig_interfaces/oc_cloud.i (2 hunks)

Files skipped from review as they are similar to previous changes (6)

• api/cloud/oc_cloud_context.c
• api/cloud/oc_cloud_context_internal.h
• api/cloud/unittest/cloud_manager_test.cpp
• api/cloud/unittest/cloud_test.cpp
• include/oc_cloud.h
• swig/swig_interfaces/oc_cloud.i

Additional Context Used

AST-based Instructions (1)

api/cloud/oc_cloud.c (1)

[warning] 153-153: Avoid 'memset()' function, it does not consider buffer boundaries and can lead to buffer overflows. Use 'memset_s()' instead.
Context: memset(ctx->cloud_ep, 0, sizeof(oc_endpoint_t));
Note: [CWE-14]: Compiler Removal of Code to Clear Buffers [OWASP A04:2021] Insecure Design [REFERENCES]
- https://cwe.mitre.org/data/definitions/14.html
- https://owasp.org/Top10/A02_2021-Cryptographic_Failures/

Additional comments not posted (4)

api/cloud/oc_cloud.c (4)

469-474: Ensure the new function cloud_has_configuration is robust against potential null pointers.

Verification successful

---

The function cloud_has_configuration checks if both the server URI and the access token are not null, which suggests that it inherently handles null checks for these components. This is evident from the implementation:

static bool
cloud_has_configuration(const oc_cloud_context_t *ctx)
{
  return oc_cloud_get_server_uri(ctx) != NULL &&
         cloud_context_has_access_token(ctx);
}

The function oc_cloud_get_server_uri and cloud_context_has_access_token are used here, and the check for != NULL ensures that the function cloud_has_configuration is robust against potential null pointers as long as these functions themselves are safely handling null inputs. This is a common pattern in C for ensuring that pointer dereferences are safe.

Given this implementation, it appears that the function is designed to be safe against null pointer dereferences, assuming that the functions it depends on (oc_cloud_get_server_uri and cloud_context_has_access_token) are themselves handling null inputs appropriately.

Since the script outputs show the context of usage and definition without any evident issues related to null pointer dereferences, and there are checks in place within cloud_has_configuration, it seems that the initial concern about null pointer safety is addressed within the code.

Conclusion: The function cloud_has_configuration appears to be robust against potential null pointers as it includes necessary checks.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Search for usages of `cloud_has_configuration` to ensure it's used safely.
ast-grep --lang c --pattern $'cloud_has_configuration($_)'

Length of output: 59

---

---

Script:

#!/bin/bash
# Check the implementation of `cloud_has_configuration` and its related functions
cat api/cloud/oc_cloud.c | grep -A 10 -B 10 "cloud_has_configuration"
cat api/cloud/oc_cloud.c | grep -A 10 -B 10 "oc_cloud_get_server_uri"
cat api/cloud/oc_cloud.c | grep -A 10 -B 10 "cloud_context_has_access_token"

Length of output: 2894

---

489-516: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [477-505]

Review the implementation of oc_cloud_manager_stop_v1.

• Ensure proper resource cleanup and state management when stopping the cloud manager.
• Consider adding more detailed debug logging to trace the state changes effectively.

---

451-455: Initialization of the registration context in oc_cloud_manager_start should be robust against potential failures.

• Consider adding error handling for the initialization function.

---

493-503: In oc_cloud_manager_stop_v1, ensure that the configuration reset logic is clear and well-documented.

• The conditional logic for resetting or maintaining the configuration could be made more explicit to avoid confusion.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

[coderabbitai]

Actionable comments posted: 0

Actionable comments outside the diff hunks (1)

api/cloud/oc_cloud.c (1)

Line range hint 153-153: Replace memset with memset_s to ensure buffer boundaries are respected and prevent potential buffer overflows.

-  memset(ctx->cloud_ep, 0, sizeof(oc_endpoint_t));
+  memset_s(ctx->cloud_ep, sizeof(oc_endpoint_t), 0, sizeof(oc_endpoint_t));

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
97.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud