search

eclipse-iceoryx / iceoryx2

Eclipse iceoryx2™ - true zero-copy inter-process-communication in pure Rust
https://iceoryx.io
Apache License 2.0
1.03k stars 40 forks source link

[#432] Implement CLI iox2-config #468

Open brosier01 opened 1 month ago

brosier01 commented 1 month ago

Notes for Reviewer

  1. Create a new CLI for iceoryx2 : iox2-config
  2. iox2-config can show the configuration currently in use and generate a new configuration file at the default location iceoryx2 is looking for.
  3. Remove the print_system_configuration() function in iceoryx2-bb/posix/src/system_configuration.rs file and move it into the CLI iox2-config

Pre-Review Checklist for the PR Author

  1. [x] Add sensible notes for the reviewer
  2. [x] PR title is short, expressive and meaningful
  3. [x] Relevant issues are linked in the References section
  4. [x] Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  5. [x] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  6. [x] Commits messages are according to this guideline
    • [x] Commit messages have the issue ID ([#123] Add posix ipc example)
    • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  7. [ ] Tests follow the best practice for testing
  8. [x] Changelog updated in the unreleased section including API breaking changes
  9. [x] Assign PR to reviewer
  10. [x] All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

Post-review Checklist for the PR Author

  1. [x] All open points are addressed and tracked via issues

References

Relates to #432

elfenpiff commented 1 month ago

@brosier01 don't close it - it looked good!

brosier01 commented 2 days ago

Hi @orecham @elfenpiff, is there any way to run CI locally?

elfenpiff commented 1 day ago

@brosier01 Yes there is. You can use the ./internal/scripts/iceoryx2_env.sh to enter the right docker container, depending on what target fails. The syntax is ./internal/scripts/iceoryx2_env.sh enter ubuntu:22.04 to start the ubuntu docker container for instance.

When you entered it you can run the usual cargo commands. Under .github/workflows/build-test.yml you find the test definitions. It is a bit hands on but we did not yet have time to add individual build & test scripts to ./internal/scripts/.