ATOMS - Automatic Trivial Oxidized Model Spec #3361
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
See if it makes sense to simplify simple case of model testing
a) output is plain ascii, not yaml (TODO, it is yaml, and uses yaml_interpolate) b) we no longer do n^2 to figure out files, much more streamlined way to build test
Will make it easier to instantitate ATOMS test elsehwere too
This allows us to report why some test are skipped, for example if we failed to load a data file
Flat list of tests instead of hash of tests with type key
Simplify creating the result object
No point requiring it in each model test
Removes the need to always instantiate test first in the model specs
New names make it more convenient to choose which tests to run, eg: ``` ╰─ ruby -Ilib:test spec/model/model_atoms_spec.rb --name "/output:ios/" --verbose Run options: --name /output:ios/ --verbose --seed 41151 ATOMS tests#test_0017_output:ios:C9200L-24P-4G_17.09.04a has expected output = 1.01 s = . ATOMS tests#test_0019_output:ios:asr920_16.8.1b has expected output = 0.73 s = . ATOMS tests#test_0018_output:ios:C9800-L-F-K9_17.06.05 has expected output = 0.72 s = . Finished in 2.465471s, 1.2168 runs/s, 3.6504 assertions/s. 3 runs, 9 assertions, 0 failures, 0 errors, 0 skips Coverage report generated for RSpec to /home/ytti/git/oxidized/coverage/coverage.xml. 658 / 1146 LOC (57.42%) covered Coverage report generated for RSpec to /home/ytti/git/oxidized/coverage. Line Coverage: 57.42% (658 / 1146) ```
I did comment atoms.rb while reading & understanding it. Nice peace of code!
must_match is meant for a regexp, but test.output is plain text. When we use must_equal, we get a nice diff of the differences when the test fails.
"---" at the beginning of a YAML file is optional, and we have files with and files without ---. This commit makes all files comply to the decision (@ytti + @robertcheramy) not to use ---.
- Removing garderos_spec.rb as is it covered with ATOMS - Documenting atoms.rb further - We may need a fail_with_expect: but I would only implement it when we need it.
Avoids useless tests if previous tests about output would fail anyhow.
- include de command sets into device2yaml.rb / This could be solved in a better way - move examples/device-simulation/README.md to /docs/DeviceSimulation.md - adapt the documentation to the new path - remove examples/device-simulation - the YAML Simulation files do not have an oxidized_output: section anymore - spec/model/README.md is still to be updated
k = '' loop do k << 'a' end Wont work in future, because k is string literal, therefore frozen/immutable, and String#<< method tries to mutate it. Fixes are k = String.new k = '' + '' # expression is not string literal k = ''.dup
From ruby 3.5.0 forward ostruct won't be available by standard
- Preparing merge into master (some polishing is still needed)
- Adapt new tests from master (fsos and cumulus prompts) to ATOMS - Place the yaml files under spec/model/data - Remove command sets from master - The cumulus tests needs further development, which will be done after the merge, so the tests are skipped for now
- we don't need mutex_m as we have a newer version of minitest
|
@ytti - I'm ready to merge. Do you want to make a last review? |
|
Go for it and thank you. |
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
|
Caution Review failedThe pull request is closed. WalkthroughThis pull request introduces significant changes to the Oxidized project, focusing on enhancing model unit testing, device simulation, and documentation. The changes include moving the Changes
Poem
Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pre-Request Checklist
rubocop --auto-correct)rake test)Description
This PR introduces ATOMS (Automatic Trivial Oxidized Model Spec), which greatly simplifies model unit tests. Most of the code is from @ytti, @robertcheramy documented it and updated device2yaml.rb.
Note: the PR will be squashed & merged.
Summary by CodeRabbit
Based on the comprehensive summary, here are the release notes:
New Features
junosmodelapc_aosmodeldevice2yaml.rbtoextra/directory with enhanced command specification capabilitiesChanges
input/sshto improve debug character dumpingcumulusmodel to remove ANSI escape codes and improve prompt handlingDocumentation
Refactor