examples/ncclient: update readme with <validate> example

Change-Id: Id5aa173292d00aee0dd37d0853d46cb98e2cce05
Signed-off-by: Marek Gradzki <[email protected]>

diff --git a/examples/ncclient/Readme.adoc b/examples/ncclient/Readme.adoc
index cc1d63e..ec856c6 100644 (file)
--- a/examples/ncclient/Readme.adoc
+++ b/examples/ncclient/Readme.adoc
@@ -24,22 +24,42 @@ git fetch https://git.opendaylight.org/gerrit/netconf refs/changes/81/71181/1 &&
 mvn clean install -pl netconf/netconf-util,netconf/netconf-netty-util,netconf/mdsal-netconf-connector
 ----
 
-== Custom HC2VPP build
+=== <validate> support:
 
 [source]
 ----
-git clone https://gerrit.fd.io/r/hc2vpp
-cd hc2vpp
+git fetch https://git.opendaylight.org/gerrit/netconf refs/changes/56/72756/4 && git cherry-pick FETCH_HEAD
+git fetch https://git.opendaylight.org/gerrit/netconf refs/changes/34/73034/2 && git cherry-pick FETCH_HEAD
+git fetch https://git.opendaylight.org/gerrit/netconf refs/changes/95/74795/3 && git cherry-pick FETCH_HEAD
+mvn clean install -pl netconf/mdsal-netconf-connector
 ----
 
-1. Checkout desired branch or use master branch, e.g.
+== Custom Honeycomb build
+
+Clone project, checkout desired branch or use master branch:
 [source]
 ----
-git checkout -b stable1804 origin/stable/1804
+git clone https://gerrit.fd.io/r/honeycomb
+cd honeycomb
 ----
 
-2. Build vpp-integration module from hc2vpp project:
+=== <validate> support:
+[source]
+----
+git fetch ssh://[email protected]:29418/honeycomb refs/changes/40/14040/3 && git cherry-pick FETCH_HEAD
+mvn clean install -pl infra/data-impl
+----
+
+== Custom HC2VPP build
 
+1. Clone project, checkout desired branch or use master branch:
+[source]
+----
+git clone https://gerrit.fd.io/r/hc2vpp
+cd hc2vpp
+----
+
+2. Build vpp-integration module from hc2vpp project:
 [source]
 ----
 mvn clean install -pl vpp-integration/minimal-distribution
@@ -67,21 +87,30 @@ Start vpp.
 Start honeycomb
 (either from hc2vpp builddir or using package built in previous steps).
 
-Then invoke:
+NOTE: Remember that HC by default persists config and restores it after restart.
+You can disable this behaviour using config/honeycomb.json.
+
+== <copy-config> examples
 
-ACL:
+=== ACL
 [source]
 ----
 ./acl/test_acl.sh
 ./acl/test_acl_updates.sh
 ----
 
-NAT:
+=== NAT
 [source]
 ----
 ./acl/test_nat.sh
 ./acl/test_nat_updates.sh
 ----
 
-NOTE: Remember that HC by default persists config and restores it after restart.
-You can disable this behaviour using config/honeycomb.json.
+== <validate> examples
+
+== ACL <edit-config> + <validate>
+[source]
+----
+./edit_config.py --validate acl/config_invalid_acl.xml
+----
+

diff --git a/examples/ncclient/acl/copy_config_acl.xml b/examples/ncclient/acl/config_acl.xml
similarity index 100%
rename from examples/ncclient/acl/copy_config_acl.xml
rename to examples/ncclient/acl/config_acl.xml

diff --git a/examples/ncclient/acl/copy_config_acl_update.xml b/examples/ncclient/acl/config_acl_update.xml
similarity index 100%
rename from examples/ncclient/acl/copy_config_acl_update.xml
rename to examples/ncclient/acl/config_acl_update.xml

diff --git a/examples/ncclient/acl/copy_config_unsupported-acl-type.xml b/examples/ncclient/acl/config_invalid_acl.xml
similarity index 100%
rename from examples/ncclient/acl/copy_config_unsupported-acl-type.xml
rename to examples/ncclient/acl/config_invalid_acl.xml

diff --git a/examples/ncclient/acl/test_acl.sh b/examples/ncclient/acl/test_acl.sh
index aedb842..e55296e 100755 (executable)
--- a/examples/ncclient/acl/test_acl.sh
+++ b/examples/ncclient/acl/test_acl.sh
@@ -15,4 +15,4 @@
 
 DIR_NAME=$(dirname $0)
 
-${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/copy_config_acl.xml ${DIR_NAME}/expected_config_acl.xml
+${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/config_acl.xml ${DIR_NAME}/expected_config_acl.xml

diff --git a/examples/ncclient/acl/test_acl_update.sh b/examples/ncclient/acl/test_acl_update.sh
index 6dedbfe..cb62c18 100755 (executable)
--- a/examples/ncclient/acl/test_acl_update.sh
+++ b/examples/ncclient/acl/test_acl_update.sh
@@ -15,6 +15,6 @@
 
 DIR_NAME=$(dirname $0)
 
-${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/copy_config_acl.xml ${DIR_NAME}/expected_config_acl.xml
+${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/config_acl.xml ${DIR_NAME}/expected_config_acl.xml
 
-${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/copy_config_acl_update.xml ${DIR_NAME}/expected_config_acl_update.xml
+${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/config_acl_update.xml ${DIR_NAME}/expected_config_acl_update.xml

diff --git a/examples/ncclient/acl/test_invalid_acl.sh b/examples/ncclient/acl/test_invalid_acl.sh
deleted file mode 100755 (executable)
index aedb842..0000000
--- a/examples/ncclient/acl/test_invalid_acl.sh
+++ /dev/null
@@ -1,18 +0,0 @@
-#!/bin/bash
-#
-# Copyright (c) 2018 Cisco and/or its affiliates.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at:
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-DIR_NAME=$(dirname $0)
-
-${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/copy_config_acl.xml ${DIR_NAME}/expected_config_acl.xml

diff --git a/examples/ncclient/nat/copy_config_nat.xml b/examples/ncclient/nat/config_nat.xml
similarity index 100%
rename from examples/ncclient/nat/copy_config_nat.xml
rename to examples/ncclient/nat/config_nat.xml

diff --git a/examples/ncclient/nat/copy_config_nat_update.xml b/examples/ncclient/nat/config_nat_update.xml
similarity index 100%
rename from examples/ncclient/nat/copy_config_nat_update.xml
rename to examples/ncclient/nat/config_nat_update.xml

diff --git a/examples/ncclient/nat/test_nat.sh b/examples/ncclient/nat/test_nat.sh
index 272a1d6..b9ec896 100755 (executable)
--- a/examples/ncclient/nat/test_nat.sh
+++ b/examples/ncclient/nat/test_nat.sh
@@ -15,4 +15,4 @@
 
 DIR_NAME=$(dirname $0)
 
-${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/copy_config_nat.xml ${DIR_NAME}/expected_config_nat.xml
+${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/config_nat.xml ${DIR_NAME}/expected_config_nat.xml

diff --git a/examples/ncclient/nat/test_nat_update.sh b/examples/ncclient/nat/test_nat_update.sh
index b37e4c6..c5ae446 100755 (executable)
--- a/examples/ncclient/nat/test_nat_update.sh
+++ b/examples/ncclient/nat/test_nat_update.sh
@@ -15,6 +15,6 @@
 
 DIR_NAME=$(dirname $0)
 
-${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/copy_config_nat.xml ${DIR_NAME}/expected_config_nat.xml
+${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/config_nat.xml ${DIR_NAME}/expected_config_nat.xml
 
-${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/copy_config_nat_update.xml ${DIR_NAME}/expected_config_nat_update.xml
+${DIR_NAME}/../test_copy_config.sh ${DIR_NAME}/config_nat_update.xml ${DIR_NAME}/expected_config_nat_update.xml