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

Fix formatting in issue 610 #8

Closed
wants to merge 3 commits into from
Closed

Fix formatting in issue 610 #8

wants to merge 3 commits into from

Conversation

dpino
Copy link
Owner

@dpino dpino commented Dec 5, 2016

Additional patch for fixing formatting in issue snabbco#610 (igalia/snabb).

Copy link

@teknico teknico left a comment

Choose a reason for hiding this comment

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

As mentioned inline, I don't like very long lines in documentation: they make diffs harder to read. I prefer hard-wrapped lines.

### How the system test works in detail

The way the test system works is by passing the input IPv4/IPv6 packets (via pre-recorded pcap-files) to the lwAFTR and comparing the expected packet output (pcap-file) to the packet output that the lwAFTR has generated.
The optional counters file is compared too to the actual counters file obtained after running the test. This is beeing reflected in snabbvmx check syntax:
Copy link

Choose a reason for hiding this comment

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

beeing -> being, or even remove it entirely.


`CONF V4-IN.PCAP V6-IN.PCAP V4-OUT.PCAP V6-OUT.PCAP [COUNTERS.LUA]`

V4-OUT.PCAP, V6-OUT.PCAP and COUNTERS.LUA are expected output. These output is compared to files stored temporarily in /tmp/endoutv4.pcap, /tmp/endoutv6.pcap and /tmp/counters.lua. These temporal files are the actual output produced by the lwAFTR after running a test. In order for a test to pass, the actual output must match the expected output. So it's not only that the counters file should match, but also the output .pcap files. (read: if a counters.lua file is provided, then it must still match the V4-OUT.PCAP and V6-OUT.PCAP)
Copy link

Choose a reason for hiding this comment

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

expected output -> expected outputs
These output is compared -> These outputs are compared
These temporal files -> These temporary files

- **V6-IN.PCAP** : Incoming IPv6 packets (from b4).
- **V4-OUT.PCAP** : Outgoing IPv4 packets (to Internet, decapsulated).
- **V6-OUT.PCAP** : Outgoing IPv6 packets (to b4, encapsulated)
- **[COUNTERS.LUA]** : Lua file with counter values. Will be regenerated via [-r] param
Copy link

Choose a reason for hiding this comment

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

Why adding a blank before colons in the above six lines? It does not look good.

configuration and binding table. With that information and knowing the error
report (ping to lwAFTR but it doesn't reply, valid softwire packet doesn't get
decapsulated, etc), you craft a hand-made packet that meets the testing case.
If you detected an error in the lwAFTR, the first step is to obtain the configuration file that SnabbVMX was using, as well as a copy of lwAFTR's configuration and binding table. With that information and knowing the error report (ping to lwAFTR but it doesn't reply, valid softwire packet doesn't get decapsulated, etc), you craft a hand-made packet that meets the testing case.
Copy link

Choose a reason for hiding this comment

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

I don't like very long lines: they make diffs harder to read. I prefer hard-wrapped lines.


**Some adoption of config-files is required**

The advantage of snabbvmx is the dynamic next-hop resolution via Junos. When running the the lwaftr or snabbvmx app standalone, then the next-hop resolution via Junos is missing. The config-files are required to get modified for static next-hop configuration.
Copy link

Choose a reason for hiding this comment

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

When running the the lwaftr -> When running the lwaftr

- lwaftr and snabbvmx configs
- binding-table
- input pcaps
With known input and results, the test can now be added to the scripted end-to-end.sh to be executed with all other tests to ensure snabbvmx behaves as it should. Furthermore, this end-to-end procedure can be ideally used to report issues!
Copy link

Choose a reason for hiding this comment

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

to the scripted end-to-end.sh -> to the "end-to-end.sh" script

@dpino
Copy link
Owner Author

dpino commented Dec 5, 2016

Thanks for the review @teknico . Fixed the issues and amended the commented issues. PTAL.

Copy link

@teknico teknico left a comment

Choose a reason for hiding this comment

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

Thank you for wrapping those long lines.

Copy link

@chrgraf chrgraf left a comment

Choose a reason for hiding this comment

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

@dpino @teknico
Thanks. I will avoid the large lines in future.

dpino pushed a commit that referenced this pull request Dec 8, 2016
dpino pushed a commit that referenced this pull request Jun 30, 2017
Implement the L7Spy application and "wall spy" command
@dpino dpino closed this Jun 30, 2017
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
dpino pushed a commit that referenced this pull request Apr 17, 2018
@dpino dpino deleted the issue-610 branch June 15, 2018 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants