Skip to content

Commit

Permalink
UG: Replace validator example image by text
Browse files Browse the repository at this point in the history
  • Loading branch information
senier committed Nov 9, 2023
1 parent 7194d25 commit 54e76c6
Show file tree
Hide file tree
Showing 81 changed files with 50 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/user_guide/20-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ Raw packets can, e.g., be exported from packet analyzers like Wireshark or extra
To facilitate execution within a CI/CD pipeline, the `--abort-on-error` switch causes the tool to exit with an error code if any samples are rejected.
Upon completion, the Validator will produce a report, with an option to display how much of a message has been covered:

.. image:: images/RecordFlux-Validator_Example.png
.. literalinclude:: validator_example.txt
:language: console

If more complex validation beyond checking messages is required, the Simulator can be used.
It allows loading RecordFlux message specifications into a Python program and using the resulting model to parse and generate messages at runtime.
Expand Down
Binary file not shown.
48 changes: 48 additions & 0 deletions doc/user_guide/validator_example.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
$ rflx validate \
--coverage \
-i tests/examples/data/http_2/frame/invalid \
-v tests/examples/data/http_2/frame/valid \
examples/specs/http_2.rflx HTTP_2::Frame

Parsing examples/specs/http_2.rflx
Processing HTTP_2
[...]
Verifying HTTP_2::Frame
tests/examples/data/http_2/frame/valid/GOAWAY_58.raw PASSED
tests/examples/data/http_2/frame/valid/GOAWAY_66.raw PASSED
tests/examples/data/http_2/frame/valid/HEADERS_26.raw PASSED
[...]
tests/examples/data/http_2/frame/valid/PING_44.raw PASSED
tests/examples/data/http_2/frame/valid/PING_45.raw PASSED
tests/examples/data/http_2/frame/valid/PING_48.raw PASSED
tests/examples/data/http_2/frame/valid/PING_49.raw PASSED
tests/examples/data/http_2/frame/valid/PUSH_PROMISE_63.raw PASSED
tests/examples/data/http_2/frame/valid/RST_STREAM_64.raw PASSED
tests/examples/data/http_2/frame/valid/SETTINGS_0.raw PASSED
[...]
tests/examples/data/http_2/frame/valid/WINDOW_UPDATE_10.raw PASSED
[...]

--------------------------------------------------------------------------------
RecordFlux Validation Coverage Report
Directory: .
--------------------------------------------------------------------------------
File Links Used Coverage
http_2.rflx 56 37 66.07%
--------------------------------------------------------------------------------
TOTAL 56 37 66.07%
--------------------------------------------------------------------------------

================================================================================
Uncovered Links
================================================================================

http_2.rflx
--------------------------------------------------------------------------------
http_2.rflx:141:13: missing link Stream_Identifier -> Pad_Length
http_2.rflx:143:13: missing link Stream_Identifier -> Application_Data
http_2.rflx:146:13: missing link Stream_Identifier -> Exclusive_Flag
http_2.rflx:151:13: missing link Stream_Identifier -> Exclusive_Flag
http_2.rflx:170:13: missing link Pad_Length -> Application_Data
[...]
http_2.rflx:69:13: missing link Settings_Value_Enable_Push -> Final

0 comments on commit 54e76c6

Please sign in to comment.