Skip to Content.

rare-dev - Re: [rare-dev] [rare-freertr/freeRtr] Automating md files after each test run (Issue #8)

Subject: Rare project developers

List archive


Re: [rare-dev] [rare-freertr/freeRtr] Automating md files after each test run (Issue #8)


Chronological Thread 
  • From: mc36 <>
  • To: rare-freertr/freeRtr <>, Frederic LOUI <>, rare-freertr/freeRtr <>
  • Cc: mc36 <>, Mention <>, "" <>, "" <>
  • Subject: Re: [rare-dev] [rare-freertr/freeRtr] Automating md files after each test run (Issue #8)
  • Date: Mon, 29 Aug 2022 15:38:43 +0200



On 8/29/22 15:31, Frederic LOUI wrote:
Hi,

After regular tests run, new features are implemented and some of them have new entry in test cases page <http://www.freertr.org/tests.html>. Ideally this should update docs.freertr.org <http://docs.freertr.org/> references documentation section.

This references section needs the following updated files:
1- index.md
<https://github.com/rare-freertr/RARE-web/blob/master/docs/guides/reference/index.md>
my bad, i forgot to generate it, i'll be there starting the next run :)

2- tabbed.md
<https://github.com/rare-freertr/RARE-web/blob/master/docs/guides/reference/tabbed.md>
it's nothing but a linux shell expression over the csv file previously
attached

3- |_ALL_| test case md files in raw folder
<https://github.com/rare-freertr/RARE-web/tree/master/raw>
i once opened a commit for it and i did't got the email that it was merged

4- |json| files describing the topology (computed with test case definition
<http://sources.freertr.org/cfg/>)

i already generate the topology in the standard .dot format...
please understand that the simplest the better, and here you only need a
directed graph
basically that's what the spf also produce:

mchome-demo>show ipv4 ospf 1 graph 0
2022-08-29 15:36:06
sfdp -Tpng > net.png << EOF
graph net {
//AMS0001
"AMS0001" -- "FRA0001" [weight=10] [taillabel="10.1.12.1"]
"AMS0001" -- "POZ0001" [weight=10] [taillabel="10.1.14.1"]
"AMS0001" -- "PAR0101" [weight=10] [taillabel="10.1.110.1"]
"AMS0001" -- "TCD0021" [weight=10] [taillabel="10.12.14.1"]
"AMS0001" -- "SAO0021" [weight=10] [taillabel="10.19.16.1"]
"AMS0001" -- "PAR0001" [weight=10] [taillabel="10.22.0.1"]
"AMS0001" -- "CHI0041" [weight=10] [taillabel="10.30.68.1"]
"AMS0001" -- "10.1.1.1/32" [weight=10]
//FRA0001
"FRA0001" -- "AMS0001" [weight=10] [taillabel="10.1.12.2"]
"FRA0001" -- "BUD0001" [weight=10] [taillabel="10.1.23.2"]
"FRA0001" -- "PAR0101" [weight=10] [taillabel="10.1.210.1"]
"FRA0001" -- "TCD0021" [weight=10] [taillabel="10.12.13.1"]
"FRA0001" -- "GVA0001" [weight=10] [taillabel="10.55.9.1"]
"FRA0001" -- "10.2.2.2/32" [weight=10]
//BUD0001
"BUD0001" -- "POZ0001" [weight=10] [taillabel="10.1.34.3"]
"BUD0001" -- "FRA0001" [weight=10] [taillabel="10.1.23.3"]
"BUD0001" -- "PRA0101" [weight=10] [taillabel="10.3.12.3"]
"BUD0001" -- "mchome-demo" [weight=10] [taillabel="10.1.39.3"]
"BUD0001" -- "10.3.3.3/32" [weight=10]
//POZ0001
"POZ0001" -- "BUD0001" [weight=10] [taillabel="10.1.34.4"]
"POZ0001" -- "AMS0001" [weight=10] [taillabel="10.1.14.2"]
"POZ0001" -- "PRA0101" [weight=10] [taillabel="10.4.12.4"]
"POZ0001" -- "10.4.4.4/32" [weight=10]
//mchome-demo
"mchome-demo" -- "BUD0001" [weight=10] [taillabel="10.1.39.9"]
"mchome-demo" -- "10.5.5.5/32" [weight=10]
//PAR0001
"PAR0001" -- "AMS0001" [weight=10] [taillabel="10.22.0.2"]
"PAR0001" -- "10.6.6.6/32" [weight=10]
//GVA0001
"GVA0001" -- "FRA0001" [weight=10] [taillabel="10.55.9.2"]
"GVA0001" -- "E513-E-YECWH-1" [weight=10] [taillabel="10.12.97.1"]
"GVA0001" -- "10.7.7.7/32" [weight=10]
//CHI0041
"CHI0041" -- "AMS0001" [weight=10] [taillabel="10.30.68.200"]
"CHI0041" -- "BUR0051" [weight=10] [taillabel="10.8.14.1"]
"CHI0041" -- "RARE-FREERTR-MIA0001" [weight=10] [taillabel="10.8.15.1"]
"CHI0041" -- "10.0.8.0/31" [weight=10]
"CHI0041" -- "10.8.8.8/32" [weight=10]
//TCD0021
"TCD0021" -- "FRA0001" [weight=10] [taillabel="10.12.13.43"]
"TCD0021" -- "AMS0001" [weight=10] [taillabel="10.12.14.47"]
"TCD0021" -- "10.9.9.9/32" [weight=10]
//PAR0101
"PAR0101" -- "AMS0001" [weight=10] [taillabel="10.1.110.10"]
"PAR0101" -- "FRA0001" [weight=10] [taillabel="10.1.210.10"]
"PAR0101" -- "mjolnir" [weight=10] [taillabel="10.10.99.10"]
"PAR0101" -- "10.10.10.10/32" [weight=10]
//PRA0101
"PRA0101" -- "BUD0001" [weight=10] [taillabel="10.3.12.12"]
"PRA0101" -- "POZ0001" [weight=10] [taillabel="10.4.12.12"]
"PRA0101" -- "10.12.12.12/32" [weight=10]
//E513-E-YECWH-1
"E513-E-YECWH-1" -- "GVA0001" [weight=10] [taillabel="10.12.97.2"]
"E513-E-YECWH-1" -- "10.13.13.13/32" [weight=10]
//BUR0051
"BUR0051" -- "CHI0041" [weight=10] [taillabel="10.8.14.2"]
"BUR0051" -- "BUR0061" [weight=10] [taillabel="10.10.6.1"]
"BUR0051" -- "10.0.14.0/31" [weight=10]
"BUR0051" -- "10.14.14.14/32" [weight=10]
//RARE-FREERTR-MIA0001
"RARE-FREERTR-MIA0001" -- "SAO0021" [weight=10] [taillabel="10.15.16.1"]
"RARE-FREERTR-MIA0001" -- "CHI0041" [weight=10] [taillabel="10.8.15.2"]
"RARE-FREERTR-MIA0001" -- "10.0.15.0/31" [weight=10]
"RARE-FREERTR-MIA0001" -- "10.15.15.15/32" [weight=10]
//SAO0021
"SAO0021" -- "RARE-FREERTR-MIA0001" [weight=10] [taillabel="10.15.16.2"]
"SAO0021" -- "AMS0001" [weight=10] [taillabel="10.19.16.2"]
"SAO0021" -- "10.0.16.0/31" [weight=10]
"SAO0021" -- "10.16.16.16/32" [weight=10]
//BUR0061
"BUR0061" -- "BUR0051" [weight=10] [taillabel="10.10.6.2"]
"BUR0061" -- "10.17.17.17/32" [weight=10]
//mjolnir
"mjolnir" -- "PAR0101" [weight=10] [taillabel="10.10.99.99"]
"mjolnir" -- "10.99.99.99/32" [weight=10]
}
EOF

mchome-demo>

if you execute this on a linux, you'll get the _current_ (realtime)
topology!!!!!

so generating this graph takes me some ms, well, i already have a tree, and i
can do one or other graph 'fancier'
algorithm but it's typically a thing that should not be done at the router... KISS you
know from the "csaba is that you email" thread...



Is it possible to have these files generated after test run ?

surely i'll include the md files starting from today... my bad that i did not
that before

Once done, it will be possible is to automate docs.freertr.org <https://github.com/rare-freertr/docs.freertr.org> from RARE-web mkdocs <https://github.com/rare-freertr/RARE-web> with github action.
(If you are OK I'll do handle this part afterwards)

Therefore we will have an automated up to date reference document based on
freeRtr CI/CD
For now |1|,|2|,|3|,|4| is manually triggered through various post script here
<https://github.com/rare-freertr/RARE-web>

But considering the ultra, fast pace deployment, feature addition and evolution of freeRtr that @mc36 <https://github.com/mc36> is ensuring , manual trigger update of this documentation is not sustainable anymore. :)

Thanks !

Reply to this email directly, view it on GitHub <https://github.com/rare-freertr/freeRtr/issues/8>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AD2P4GYEYW3BRKYB5AOYYBTV3S3RRANCNFSM575Z5P5A>.
You are receiving this because you were mentioned.Message ID:
<>




Archive powered by MHonArc 2.6.19.

Top of Page