Skip to content

Commit 08e9a45

Browse files
committed
tests: doc: updated README - links to files
Thanks to @snrism (Sriram Natarajan) who pointed out errors in markdown source that caused creation of bad links. Text was modified a bit to clarify the meaning of mentioned files.
1 parent c03377d commit 08e9a45

File tree

1 file changed

+40
-39
lines changed

1 file changed

+40
-39
lines changed

netconf-tests/README.md

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Testing OF-CONFIG functionality
44
Testing environment
55
-------------------
66

7-
Test scripts work with installed netopeer-cli. Netopeer-cli comes from Netopeer package (https://code.google.com/p/netopeer).
7+
Test scripts work with installed netopeer-cli. Netopeer-cli comes from [Netopeer package](https://code.google.com/p/netopeer).
88

99
Scripts connect to localhost as current user.
1010
It is required to have working public-key authentication
@@ -38,22 +38,22 @@ Tested parts
3838
OF-CONFIG datastore & invalid capable-switch
3939
--------------------------------------------
4040

41-
* group_test_empty_ds.sh
41+
* [group_test_empty_ds.sh](group_test_empty_ds.sh)
4242
* candidate: delete, try to add switch without key, delete, try to add switch, delete
4343
* startup: backup to candidate, delete, try to add switch without key, delete, try to add switch, restore from candidate, delete candidate
4444
* running: clear (copy empty candidate), try to add switch without key, clear, try to add switch, copy startup to running
4545

4646
Port & Queue
4747
------------
4848

49-
* group_test_port.sh
50-
* reset configuration on start [reset.sh]
51-
* create and remove port [create_port_eth1.sh, remove_port_eth1.sh]
52-
* modify port configuration (admin-state, no-receive, no-packet-in, no-forward) [openflow_set.sh]
53-
* modify advertised [change_port_advertised.xml]
54-
* modify request-number [change_port_reqnum.xml]
55-
* create, modify, remove queue [create_modify_remove_queue.sh]
56-
* create, modify, remove port with tunnel configuration [create_modify_remove_tunnel.sh]
49+
* [group_test_port.sh](group_test_port.sh)
50+
* reset configuration on start, script implemented in [./reset.sh](./reset.sh)
51+
* create and remove port, scripts implemented in [./create_port_eth1.sh](./create_port_eth1.sh), [./remove_port_eth1.sh](./remove_port_eth1.sh)
52+
* modify port configuration (admin-state, no-receive, no-packet-in, no-forward), script implemented in [./openflow_set.sh](./openflow_set.sh)
53+
* modify advertised, takes data from [./change_port_advertised.xml](./change_port_advertised.xml)
54+
* modify request-number, takes data from [./change_port_reqnum.xml](./change_port_reqnum.xml)
55+
* create, modify, remove queue, script implemented in [./create_modify_remove_queue.sh](./create_modify_remove_queue.sh)
56+
* create, modify, remove port with tunnel configuration, script implemented in [./create_modify_remove_tunnel.sh](./create_modify_remove_tunnel.sh)
5757
* configuration after tests should be equal to state after reset (it is checked)
5858
* create multiple ports
5959
* create multiple queues
@@ -62,54 +62,55 @@ Port & Queue
6262

6363
Owned-certificate
6464
-----------------
65-
* group_test_owned_cert.sh
66-
* reset configuration on start [reset.sh]
67-
* create [create_owned_cert.sh] (expected change is checked)
68-
* modify [change_owned_cert.xml] (change of configuration is checked)
69-
* remove [remove_owned_cert.xml]
70-
* create malformed certificate [create_malform_certificates.xml]
65+
* [group_test_owned_cert.sh](group_test_owned_cert.sh)
66+
* reset configuration on start, script implemented in [./reset.sh](./reset.sh)
67+
* create (expected change is checked), script implemented in [./create_owned_cert.sh](./create_owned_cert.sh)
68+
* modify (change of configuration is checked), takes data from [./change_owned_cert.xml](./change_owned_cert.xml)
69+
* remove, takes data from [./remove_owned_cert.xml](./remove_owned_cert.xml)
70+
* create malformed certificate, takes data from [./create_malform_certificates.xml](./create_malform_certificates.xml)
7171
* configuration after tests should be equal to state after reset (it is checked)
7272

7373
External-certificate
7474
-----------------
75-
* group_test_ext_cert.sh
76-
* reset configuration on start [reset.sh]
77-
* create [create_ext_cert.sh] (expected change is checked)
78-
* modify [change_ext_cert.xml] (change of configuration is checked)
79-
* remove [remove_ext_cert.xml]
80-
* create malformed certificate [create_malform_certificates.xml]
75+
* [group_test_ext_cert.sh](group_test_ext_cert.sh)
76+
* reset configuration on start, script implemented in [./reset.sh](./reset.sh)
77+
* create (expected change is checked), script implemented in [./create_ext_cert.sh](./create_ext_cert.sh)
78+
* modify (change of configuration is checked), takes data from [./change_ext_cert.xml](./change_ext_cert.xml)
79+
* remove, takes data from [./remove_ext_cert.xml](./remove_ext_cert.xml)
80+
* create malformed certificate, takes data from [./create_malform_certificates.xml](./create_malform_certificates.xml)
8181
* configuration after tests should be equal to state after reset (it is checked)
8282

8383
Flow-table
8484
----------
8585

86-
* group_test_flowtable.sh
87-
* reset configuration on start [reset.sh]
88-
* create [create_flowtable.sh] (expected change is checked)
89-
* modify [change_flowtable.xml] (change of configuration is checked)
90-
* remove [remove_flowtable.xml]
91-
* create [create_flowtable.xml]
92-
* remove from Bridge (only) [remove_flowtable_from_bridge.xml]
86+
* [group_test_flowtable.sh](group_test_flowtable.sh)
87+
* reset configuration on start, script implemented in [./reset.sh](./reset.sh)
88+
* create (expected change is checked), script implemented in [./create_flowtable.sh](./create_flowtable.sh)
89+
* modify (change of configuration is checked), takes data from [./change_flowtable.xml](./change_flowtable.xml)
90+
* remove, takes data from [./remove_flowtable.xml](./remove_flowtable.xml)
91+
* create, takes data from [./create_flowtable.xml](./create_flowtable.xml)
92+
* remove from Bridge (only), takes data from [./remove_flowtable_from_bridge.xml](./remove_flowtable_from_bridge.xml)
9393
* configuration after tests should be equal to state after reset (it is checked)
94-
* create multiple flow-tables [create_flowtable_multiple.sh]
94+
* create multiple flow-tables, script implemented in [./create_flowtable_multiple.sh](./create_flowtable_multiple.sh)
9595
* configuration after tests should be equal to state after reset (it is checked)
9696

9797
Switch
9898
------
99-
* group_test_switch.sh
100-
* create [create_switch.xml] (expected change is checked)
101-
* modify (datapath-id, lost-connection-behavior) [change_switch.xml] (change of configuration is checked)
102-
* remove [remove_switch.xml]
99+
* [group_test_switch.sh](group_test_switch.sh)
100+
* create (expected change is checked), takes data from [./create_switch.xml](./create_switch.xml)
101+
* modify (datapath-id, lost-connection-behavior; change of configuration is checked), takes data from [./change_switch.xml](./change_switch.xml)
102+
* remove, takes data from [./remove_switch.xml](./remove_switch.xml)
103103
* configuration at this point should be equal to state after reset (it is checked)
104104
* create owned_cert ext_cert ipgre_tunnel_port queue flowtable port_eth1
105105
* remove ofc-bridge
106106

107107
Controller
108108
----------
109-
* group_test_controller.sh
110-
* reset configuration on start [reset.sh]
111-
* create controller [create_controller.xml] (expected change is checked)
112-
* modify controller (ip-address, port, local-ip-address, protocol) [change_controller.xml] (change of configuration is checked)
113-
* remove controller [remove_controller.xml]
109+
* [group_test_controller.sh](group_test_controller.sh)
110+
* reset configuration on start, script implemented in [./reset.sh](./reset.sh)
111+
* create controller (expected change is checked), takes data from [./create_controller.xml](./create_controller.xml)
112+
* modify controller (ip-address, port, local-ip-address, protocol; change of configuration is checked), takes data from [./change_controller.xml](./change_controller.xml)
113+
* remove controller, takes data from [./remove_controller.xml](./remove_controller.xml)
114114
* configuration after tests should be equal to state after reset (it is checked)
115115

116+

0 commit comments

Comments
 (0)