Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add network, wireless, wireless AP and certificates deployment #313

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Ellerbach
Copy link
Member

Description

Add network, wireless, wireless AP and certificates deployment

Motivation and Context

  • Add network, wireless, wireless AP and certificates deployment
  • So that we can upload those configuration at flash time
  • Will be needed for hardware tests in pieplines

How Has This Been Tested?

On a real ESP32 S3 device

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
  • I have added new tests to cover my changes.

Copy link

coderabbitai bot commented Jan 27, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (11)
  • README.md is excluded by !**/*.md and included by none
  • nanoFirmwareFlasher.Library/DeploymentHelpers/DeviceHelper.cs is excluded by none and included by none
  • nanoFirmwareFlasher.Library/FileDeployment/FileDeploymentManager.cs is excluded by none and included by none
  • nanoFirmwareFlasher.Library/NetworkDeployment/Ethernet.cs is excluded by none and included by none
  • nanoFirmwareFlasher.Library/NetworkDeployment/NetworkDeploymentConfiguration.cs is excluded by none and included by none
  • nanoFirmwareFlasher.Library/NetworkDeployment/NetworkDeploymentManager.cs is excluded by none and included by none
  • nanoFirmwareFlasher.Library/NetworkDeployment/WirelessAccessPoint.cs is excluded by none and included by none
  • nanoFirmwareFlasher.Library/NetworkDeployment/WirelessConfiguration.cs is excluded by none and included by none
  • nanoFirmwareFlasher.Tests/nanoFirmwareFlasher.Tests.csproj is excluded by none and included by none
  • nanoFirmwareFlasher.Tool/Options.cs is excluded by none and included by none
  • nanoFirmwareFlasher.Tool/Program.cs is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@Ellerbach Ellerbach requested a review from Copilot January 27, 2025 16:33
Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good! I really thing that reusing those classes will improve this.

README.md Outdated Show resolved Hide resolved
/// <summary>
/// Represents the configuration for network deployment.
/// </summary>
internal class NetworkDeploymentConfiguration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not reuse the existing one in debugger lib NetworkConfigurationPropertiesBase @ nanoFramework.Tools.DebugLibrary.Shared\DeviceConfiguration\NetworkConfigurationPropertiesBase.cs?
This prevents duplicating code and ensure any changes (despite unlikely) are propagated to nanoff.

Same goes for all the other config classes. 😉

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not reuse the existing one in debugger lib NetworkConfigurationPropertiesBase

Because it cannot be reused properly! That's the very first thing I4ve been trying and the issue are the enums that will for example not support string as an example. It would require to write a specific deserializer that will be even more complex than the few prive classes. And there are elements that do not serialize/deserialize properly (some of the IP addresses). So, in short, I ended up creating a simplified version.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And also because it's confusing to have the network configuration of wifi outside of the wifi configuration! It's a source of mistakes and complications. At least, with this solution, you have all together making it more sense and being much simpler.
As another example, the certs, the size is not needed and will anyway to have to be processed again and the serialization of the string do not work properly. So, I preferred to offer base64 and path as options.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants