1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
|
.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
(the "License"); you may not use this documentation except in compliance
with the License. You may obtain a copy of the License at
.. https://creativecommons.org/licenses/by/4.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.
OPNFV Verfied Program Badging for VNFs
--------------------------------------
OPNFV Verified Program Overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The `OPNFV Verified Program (OVP) <https://www.lfnetworking.org/OVP/>`__ is
an open source, community-led compliance and verification program to
demonstrate the readiness and availability of commercial NFV products and
services, including NFVI and VNFs, using OPNFV and ONAP components.
-- Source: OVP
The program currently offers verification badges for NFVI, VNFs, and Labs. The
VNF badge aims to verify that a given VNF is compatible and interoperable with
a given release of ONAP and an ONAP-compatible NFVI.
Relationship to ONAP
^^^^^^^^^^^^^^^^^^^^
The ONAP VNF Requirements project defines the mandatory and recommended
requirements for a VNF to be successfully orchestrated by ONAP. At this time,
the OPNFV VNF badge automates the verification of a subset of these
requirements with plans to expand the scope over verified requirements over
time.
Currently, the `OPNFV VNF badge <https://vnf-verified.lfnetworking.org/#/>`__
covers the following:
* Compliance checks of the contents of a VNF onboarding package for :ref:`Heat-based <heat_requirements>`
or :ref:`TOSCA-based <tosca_requirements>` VNFs.
* Validation of the packages are, respectively, performed by the ONAP VVP
and ONAP VNFSDK projects.
* Validation that the package can be onboarded, modeled, configured, deployed,
and instantiated on an ONAP-compatible NFVI (currently OpenStack)
How to Receive a ONPFV VNF Badge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ONAP platform includes a set of automated tests that can be setup and
executed for a given VNF to verify its compliance with the in-scope VNF
Requirements. This test suite will produce a result file that is compatible
for submission to the OPNFV Verified Program. Please refer to the
`OPNFV VNF Portal <https://vnf-verified.lfnetworking.org/#/>`__ for more details
on registering for the program and submitting your results.
The following section will describe how to setup and execute the tests.
Executing the OPNFV Verified Compliance and Validation Tests
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The instructions related to setting up and executing the tests vary based on
whether the VNF is modeled in OpenStack Heat or in TOSCA. Please refer
to the appropriate section based on your VNF.
* :ref:`heat_vnf_validation`
* :ref:`tosca_vnf_validation`
.. _heat_vnf_validation:
Heat-based VNF Validation
~~~~~~~~~~~~~~~~~~~~~~~~~
This section describes how to setup and execute the validation tests against
a VNF that is described using OpenStack Heat.
Prerequisites
+++++++++++++
- ONAP El Alto Release deployed via :doc:`OOM <../../../../oom.git/docs/oom_quickstart_guide>`
- An OpenStack deployment is available and privisioned as ONAP's Cloud Site
- `kubectl <https://kubernetes.io/docs/tasks/tools/install-kubectl/>`__ is
installed on the system used to start the testing
- bash
- VNF Heat Templates
- Preload JSON files
After deploying ONAP, you need to configure ONAP with:
- A cloud owner
- A cloud region
- A subscriber
- A service type
- A project name
- An owning entity
- A platform
- A line of business
- A cloud site
If you're not familiar with how to configure ONAP, there are guides that use
:doc:`Robot <../../../../integration.git/docs/docs_robot>` or
`REST API calls <https://wiki.onap.org/pages/viewpage.action?pageId=25431491>`__
to handle the setup (including adding a new OpenStack site to ONAP).
Validation Setup
++++++++++++++++
On your local machine, or the system from which you will run the tests, you will need to clone the
ONAP OOM project repo:
.. code-block:: bash
git clone --branch 5.0.1-ONAP ssh://<username>@gerrit.onap.org:29418/oom --recurse-submodules
VNF Preparation
+++++++++++++++
The VNF lifecycle validation test suite requires the VNF to be packaged into a
specific directory hierarchy, shown below.
.. code-block::
vnf_folder
├── /templates
| └── base.yaml
| └── base.env
| └── incremental_0.yaml
| └── incremental_0.env
| └── ...
├── /preloads
| └── base_preload.json
| └── incremental_0_preload.json
| └── ...
└── vnf-details.json
- The name for ``vnf_folder`` is free-form, and can be located anywhere on your
computer. The path to this folder will be passed to the test suite as an
argument.
- ``/templates`` should contain your VVP-compliant VNF heat templates.
- ``/preloads`` should contain a preload file for each VNF module
- For a VNF-API preload: ``vnf-name``, ``vnf-type``, ``generic-vnf-type``,
and ``generic-vnf-name`` should be empty strings.
- For a GR-API preload: ``vnf-name``, ``vnf-type``, ``vf-module-type``,
and ``vf-module-name`` should be empty strings.
- This information will be populated at runtime by the test suite.
- ``vnf-details`` should be a JSON file with the information that will be used
by ONAP to instantiate the VNF. The structure of ``vnf-details`` is shown below.
- VNF disk image must be uploaded and available in the OpenStack project being
managed by ONAP
- ``modules`` must contain an entry for each module of the VNF. Only one module
can be a base module.
- ``api_type`` should match the format of the preloads (``vnf_api``
or ``gr_api``) that are provided in the package.
- The other information should match what was used to configure ONAP during the
pre-requisite section of this guide.
.. code-block:: json
{
"vnf_name": "The Vnf Name",
"description": "Description of the VNF",
"modules": [
{
"filename": "base.yaml",
"isBase": "true",
"preload": "base_preload.json"
},
{
"filename": "incremental_0.yaml",
"isBase": "false",
"preload": "incremental_0.json"
},
],
"api_type": "[gr_api] or [vnf_api]",
"subscriber": "<subscriber name>",
"service_type": "<service type>",
"tenant_name": "<name of tenant>",
"region_id": "<name of region>",
"cloud_owner": "<name of cloud owner>",
"project_name": "<name of project>",
"owning_entity": "<name of owning entity>",
"platform": "<name of platform>",
"line_of_business": "<name of line of business>",
"os_password": "<openstack password>"
}
Running the HEAT VNF Test
+++++++++++++++++++++++++
The ONAP OOM Robot framework will run the test, using ``kubectl`` to manage the
execution. The framework will copy your VNF template files to the Robot
container required to execute the test.
.. code-block:: bash
cd oom/kubernetes/robot
$ ./instantiate-k8s.sh --help
./instantiate-k8s.sh [options]
required:
-n, --namespace <namespace> namespace that robot pod is running under.
-f, --folder <folder> path to folder containing heat templates, preloads, and vnf-details.json.
additional options:
-p, --poll some cloud environments (like azure) have a short time out value when executing
kubectl. If your shell exits before the test suite finishes, using this option
will poll the test suite logs every 30 seconds until the test finishes.
-t, --tag <tag> robot testcase tag to execute (default is instantiate_vnf).
This script executes the VNF instantiation robot test suite.
- It copies the VNF folder to the robot container that is part of the ONAP deployment.
- It models, distributes, and instantiates a heat-based VNF.
- It copies the logs to an output directory, and creates a tarball for upload to the OVP portal.
**Sample execution:**
.. code-block:: bash
$ ./instantiate-k8s.sh --namespace onap --folder /tmp/vnf-instantiation/examples/VNF_API/pass/multi_module/ --poll
...
...
...
...
------------------------------------------------------------------------------
test suites.Vnf Instantiation :: The main driver for instantiating ... | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
test suites | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
Output: /share/logs/0003_ete_instantiate_vnf/output.xml
+ set +x
test suite has finished
Copying Results from pod...
/tmp/vnf-instantiation /tmp/vnf-instantiation
a log.html
a results.json
a stack_report.json
a validation-scripts.json
/tmp/vnf-instantiation
VNF test results: /tmp/vnfdata.46749/vnf_heat_results.tar.gz
The test suite takes about 10-15 minutes for a simple VNF, and will take longer
for a more complicated VNF.
Reporting Results
+++++++++++++++++
Once the test suite is finished, it will create a directory and tarball in
``/tmp`` (the name of the directory and file is shown at the end of the stdout
of the script). There will be a ``results.json`` file in that directory
that has the ultimate outcome of the test, in the structure shown below.
**Log Files**
The output tar file will have 4 log files in it.
- ``results.json``: This is high-level results file of all of the test steps,
and is consumed by the OVP portal.
- ``report.json``: This is the output of the VVP validation scripts.
- ``stack_report.json``: This is the output from querying OpenStack to validate
the Heat modules.
- ``log.html``: This is the Robot test log, and contains each execution step of
the test case.
If the result is ``"PASS"``, that means the test suite was successful and the
tarball is ready for submission to the OVP portal.
**results.json**
.. code-block:: json
{
"vnf_checksum": "afc57604a3b3b7401d5b8648328807b594d7711355a2315095ac57db4c334a50",
"build_tag": "vnf-validation-7055d30b-9a2e-4ca2-9409-499131cc86db",
"version": "2019.12",
"test_date": "2019-09-04 17:50:10.575",
"duration": 437.002,
"vnf_type": "heat",
"testcases_list": [
{
"mandatory": "true",
"name": "onap-vvp.validate.heat",
"result": "PASS",
"objective": "onap heat template validation",
"sub_testcase": [],
"portal_key_file": "report.json"
},
{
"mandatory": "true",
"name": "onap-vvp.lifecycle_validate.heat",
"result": "PASS",
"objective": "onap vnf lifecycle validation",
"sub_testcase": [
{
"name": "model-and-distribute",
"result": "PASS"
},
{
"name": "instantiation",
"result": "PASS"
}
],
"portal_key_file": "log.html"
},
{
"mandatory": "true",
"name": "stack_validation",
"result": "PASS",
"objective": "onap vnf openstack validation",
"sub_testcase": [],
"portal_key_file": "stack_report.json"
}
]
}
Examples
++++++++
Example VNFs and setup files have been created as a starting point for your
validation.
* :download:`Passing Single Volume VNF using VNF API <input-VNF-API-pass-single_module.zip>`
* :download:`Failing Single Volume VNF using VNF API <input-VNF-API-fail-single_module.zip>`
Additional Resources
++++++++++++++++++++
- `ONAP VVP Project <https://wiki.onap.org/display/DW/VNF+Validation+Program+Project>`_
.. _tosca_vnf_validation:
TOSCA-based VNF Testing
~~~~~~~~~~~~~~~~~~~~~~~
VNF Test Platform (VTP) provides an platform to on-board different test cases
required for OVP for various VNF testing provided by VNFSDK (for TOSCA) projects
in ONAP. And it generates the test case outputs which would be uploaded into
OVP portal for VNF badging.
TOSCA VNF Test Environment
++++++++++++++++++++++++++
As pre-requestsite steps, it is assumed that, successful ONAP, Vendor VNFM and
OpenStack cloud are already available. Below installation steps help to setup
VTP components and CLI.
.. image:: tosca_vnf_test_environment.png
:align: center
Installation
++++++++++++
Clone the VNFSDK repo.
.. code-block:: bash
git clone --branch elalto https://git.onap.org/vnfsdk/refrepo
Install the VTP by using script
``refrepo/vnfmarket-be/deployment/install/vtp_install.sh``
Follow the steps as below (in sequence):
- ``vtp_install.sh --download``: It will download all required artifacts into
``/opt/vtp_stage``
- ``vtp_install.sh --install``: It will install VTP (``/opt/controller``) and
CLI (``/opt/oclip``)
- ``vtp_install.sh --start``: It will start VTP controller as Tomcat service
and CLI as ``oclip`` service
- ``vtp_install.sh --verify``: It will verify the setup is done properly by
running some test cases.
Last step (verify) would check the health of VTP components and TOSCA VNF
compliance and validation test cases.
Check Available Test Cases
++++++++++++++++++++++++++
VTP supports to check the compliance of VNF and PNF based on ONAP VNFRQTS.
To check:
- Go to command console
- Run command ``oclip``
- Now it will provide a command prompt:
``oclip:open-cli>``
Now run command as below and check the supported compliance test cases for
VNFRQTS.
- ``csar-validate`` - Helps to validate given VNF CSAR for all configured
VNFRQTS.
- ``csar-validate-rxxx`` - Helps to validate given VNF CSAR for a given
VNFRQTS requirement number.
.. code-block:: bash
oclip:open-cli>schema-list --product onap-dublin --service vnf-compliance
+--------------+----------------+------------------------+--------------+----------+------+
|product |service |command |ocs-version |enabled |rpc |
+--------------+----------------+------------------------+--------------+----------+------+
|onap-dublin |vnf-compliance |csar-validate-r10087 |1.0 |true | |
+--------------+----------------+------------------------+--------------+----------+------+
|onap-dublin |vnf-compliance |csar-validate |1.0 |true | |
+--------------+----------------+------------------------+--------------+----------+------+
|onap-dublin |vnf-compliance |csar-validate-r26885 |1.0 |true | |
+--------------+----------------+------------------------+--------------+----------+------+
|onap-dublin |vnf-compliance |csar-validate-r54356 |1.0 |true | |
...
To know the details of each VNFRQTS, run as below.
.. code-block:: bash
oclip:open-cli>use onap-dublin
oclip:onap-dublin>csar-validate-r54356 --help
usage: oclip csar-validate-r54356
Data types used by NFV node and is based on TOSCA/YAML constructs specified in draft GS NFV-SOL 001.
The node data definitions/attributes used in VNFD MUST comply.
Now run command as below and check the supported validation testcases
.. code-block:: bash
oclip:onap-dublin>use open-cli
oclip:open-cli>schema-list --product onap-dublin --service vnf-validation
+--------------+----------------+----------------------+--------------+----------+------+
|product |service |command |ocs-version |enabled |rpc |
+--------------+----------------+----------------------+--------------+----------+------+
|onap-dublin |vnf-validation |vnf-tosca-provision |1.0 |true | |
+--------------+----------------+----------------------+--------------+----------+------+
Configure ONAP with required VNFM and cloud details
+++++++++++++++++++++++++++++++++++++++++++++++++++
**1. Setup the OCOMP profile onap-dublin**
Run following command to configure the ONAP service URL and credentials as
given below, which will be used by VTP while executing the test cases
.. code-block:: bash
oclip:open-cli>use onap-dublin
oclip:onap-dublin>profile onap-dublin
oclip:onap-dublin>set sdc.onboarding:host-url=http://159.138.8.8:30280
oclip:onap-dublin>set sdc.onboarding:host-username=cs0008
oclip:onap-dublin>set sdc.onboarding:host-password=demo123456!
oclip:onap-dublin>set sdc.catalog:host-url=http://159.138.8.8:30205
oclip:onap-dublin>set sdc.catalog:host-password=demo123456\!
oclip:onap-dublin>set sdc.catalog:host-username=cs0008
oclip:onap-dublin>set sdc.catalog:service-model-approve:host-username=gv0001
oclip:onap-dublin>set sdc.catalog:service-model-distribute:host-username=op0001
oclip:onap-dublin>set sdc.catalog:service-model-test-start:host-username=jm0007
oclip:onap-dublin>set sdc.catalog:service-model-test-accept:host-username=jm0007
oclip:onap-dublin>set sdc.catalog:service-model-add-artifact:host-username=ocomp
oclip:onap-dublin>set sdc.catalog:vf-model-add-artifact:host-username=ocomp
oclip:onap-dublin>set aai:host-url=https://159.138.8.8:30233
oclip:onap-dublin>set aai:host-username=AAI
oclip:onap-dublin>set aai:host-password=AAI
oclip:onap-dublin>set vfc:host-url=http://159.138.8.8:30280
oclip:onap-dublin>set multicloud:host-url=http://159.138.8.8:30280
NOTE: Mostly all above entries value would be same except the IP address used
in the URL, which would be ONAP Kubernetes cluster IP.
By default, SDC onboarding service does not provide node port, which is
available to access from external ONAP network. To enable for external access,
register the SDC onboarding service into MSB and use MSB url for
sdc.onboarding:host-url.
.. code-block:: bash
oclip:onap-dublin> microservice-create --service-name sdcob --service-version v1.0 --service-url /onboarding-api/v1.0 --path /onboarding-api/v1.0 --node-ip 172.16.1.0 --node-port 8081
NOTE: To find the node-ip and node-port, use the following steps.
Find out SDC onboarding service IP and port details as given here:
.. code-block:: bash
[root@onap-dublin-vfw-93996-50c1z ~]# kubectl get pods -n onap -o wide | grep sdc-onboarding-be
dev-sdc-sdc-onboarding-be-5564b877c8-vpwr5 2/2 Running 0 29d 172.16.1.0 192.168.2.163 <none> <none>
dev-sdc-sdc-onboarding-be-cassandra-init-mtvz6 0/1 Completed 0 29d 172.16.0.220 192.168.2.163 <none> <none>
[root@onap-dublin-vfw-93996-50c1z ~]#
Note down the IP address for sdc-onboarding-be 172.16.1.0
.. code-block:: bash
[root@onap-dublin-vfw-93996-50c1z ~]# kubectl get services -n onap -o wide | grep sdc-onboarding-be
sdc-onboarding-be ClusterIP 10.247.198.92 <none> 8445/TCP,8081/TCP 29d app=sdc-onboarding-be,release=dev-sdc
[root@onap-dublin-vfw-93996-50c1z ~]#
Note down the port for sdc-onboarding-be 8445 8081
Similarly, other service IP and Port could be discovered like above, in case not
know earlier :)
Verify these details once by typing 'set'
.. code-block:: bash
oclip:onap-dublin> set
This profile would be used by user while running the test cases with ONAP setup
configured in it, as below oclip --profile onap-dublin vnf-tosca-provision ....
**2. Setup SDC consumer**
SDC uses consumer concept to configure required VN model and service model
artifacts. So following commands required to run, which will create consumer
named ocomp, which is already configured in onap-dublin profile created in above
steps.
.. code-block:: bash
oclip --product onap-dublin --profile onap-dublin sdc-consumer-create --consumer-name ocomp
NOTE: command oclip could be used in scripting mode as above or in interactive
mode as used in earlier steps
**3. Update the cloud and vnfm driver details**
In the configuration file /opt/oclip/conf/vnf-tosca-provision.json, update the
cloud and VNFM details.
.. code-block:: json
{ "cloud": {
"identity-url": "http://10.12.11.1:5000/v3",
"username": "admin",
"password": "password",
"region": "RegionOVP",
"version": "ocata",
"tenant": "ocomp"
},
"vnfm":{
"hwvnfmdriver":{
"version": "v1.0",
"url": "http://159.138.8.8:38088",
"username": "admin",
"password": "xxxx"
},
"gvnfmdriver":{
"version": "v1.0",
"url": "http://159.138.8.8:30280"
}
}
}
**4.Configure the decided VNFRES (optional)**
VTP allows to configure the set of VNFRQTS to be considered while running the
VNF compliance test cases in the configuration file
``/opt/oclip/conf/VNFRQTS.properties.``
If not available, please create this file with following entries:
.. code-block:: bash
VNFRQTS.enabled=r02454,r04298,r07879,r09467,r13390,r23823,r26881,r27310,r35851,r40293,r43958,r66070,r77707,r77786,r87234,r10087,r21322,r26885,r40820,r35854,r65486,r17852,r46527,r15837,r54356,r67895,r95321,r32155,r01123,r51347,r787965,r130206
pnfreqs.enabled=r10087,r87234,r35854,r15837,r17852,r293901,r146092,r57019,r787965,r130206
# ignored all chef and ansible related tests
vnferrors.ignored=
pnferrors.ignored=
Running the TOSCA VNF Test
++++++++++++++++++++++++++
Every test provided in VTP is given with guidelines on how to use it. On every
execution of test cases, use the following additional arguments based on
requirements
- ``--product onap-dublin`` - It helps VTP choose the test cases written for
onap-dublin version
- ``--profile onap-dublin`` - It helps VTP to use the profile settings provided
by admin (optional)
- ``--request-id`` - It helps VTP to track the progress of the test cases
execution and user could use this id for same. (optional)
So, final test case execution would be as below. To find the test case
arguments details, run second command below.
.. code-block:: bash
oclip --product onap-dublin --profile onap-dublin --request-id req-1 <test case name> <test case arguments>
oclip --product onap-dublin <test case name> --help
Running TOSCA VNF Compliance Testing
++++++++++++++++++++++++++++++++++++
To run compliance test as below with given CSAR file
.. clode-block:: bash
oclip --product onap-dublin csar-validate --csar <csar file complete path>
It will produce the result format as below:
.. code-block:: json
{
"date": "Fri Sep 20 17:34:24 CST 2019",
"criteria": "PASS",
"contact": "ONAP VTP Team onap-discuss@lists.onap.org",
"results": [
{
"description": "V2.4.1 (2018-02)",
"passed": true,
"vnfreqName": "SOL004",
"errors": []
},
{
"description": "If the VNF or PNF CSAR Package utilizes Option 2 for package security, then the complete CSAR file MUST be digitally signed with the VNF or PNF provider private key. The VNF or PNF provider delivers one zip file consisting of the CSAR file, a signature file and a certificate file that includes the VNF or PNF provider public key. The certificate may also be included in the signature container, if the signature format allows that. The VNF or PNF provider creates a zip file consisting of the CSAR file with .csar extension, signature and certificate files. The signature and certificate files must be siblings of the CSAR file with extensions .cms and .cert respectively.\n",
"passed": true,
"vnfreqName": "r787965",
"errors": []
}
],
"platform": "VNFSDK - VNF Test Platform (VTP) 1.0",
"vnf": {
"mode": "WITH_TOSCA_META_DIR",
"vendor": "ONAP",
"name": null,
"type": "TOSCA",
"version": null
}
}
In case of errors, the errors section will have list of details as below. Each
error block, will be given with error code and error details. Error code would
be very useful to provide the troubleshooting guide in future. Note, to
generate the test result in OVP archieve format, its recommended to run this
compliance test with request-id similar to running validation test as below.
.. code-block:: bash
[
{
"vnfreqNo": "R66070",
"code": "0x1000",
"message": "MissinEntry-Definitions file",
"lineNumber": -1
}
]
Running TOSCA VNF Validation Testing
++++++++++++++++++++++++++++++++++++
VTP provides validation test case with following modes:
.. image:: tosca_vnf_test_flow.png
:align: center
* **setup**: Create requires Vendor, Service Subscription and VNF cloud in
ONAP
* **standup**: From the given VSP csar, VNF csar and NS csar, it creates VF
Model, NS Model and NS service
* **cleanup**: Remove those entries created during provision
* **provision**: Runs setup -> standup
* **validate**: Runs setup -> standup -> cleanup
* **checkup**: mode helps to verify automation is deployed properly.
For OVP badging, validate mode would be used as below:
.. code-block:: bash
oclip --request-id WkVVu9fD--product onap-dublin --profile onap-dublin vnf-tosca-provision --vsp <vsp csar> --vnf-csar <v
Validation testing would take for a while to complete the test execution, so
user could use the above given ``request-id``, to tracking the progress as
below:
.. code-block:: bash
oclip execution-list --request-id WkVVu9fD
+------------+------------------------+--------------+------------------+------------------------------+--------------+------------+--------------------------+--------------------------+
|request-id |execution-id |product |service |command |profile |status |start-time |end-time |
+------------+------------------------+--------------+------------------+------------------------------+--------------+------------+--------------------------+--------------------------+
|WkVVu9fD |WkVVu9fD-1568731678753 |onap-dublin |vnf-validation |vnf-tosca-provision | |in-progress |2019-09-17T14:47:58.000 | |
+------------+------------------------+--------------+------------------+------------------------------+--------------+------------+--------------------------+--------------------------+
|WkVVu9fD |WkVVu9fD-1568731876397 |onap-dublin |sdc.catalog |service-model-test-request |onap-dublin |in-progress |2019-09-17T14:51:16.000 | |
+------------+------------------------+--------------+------------------+------------------------------+--------------+------------+--------------------------+--------------------------+
|WkVVu9fD |WkVVu9fD-1568731966966 |onap-dublin |sdc.onboarding |vsp-archive |onap-dublin |completed |2019-09-17T14:52:46.000 |2019-09-17T14:52:47.000 |
+------------+------------------------+--------------+------------------+------------------------------+--------------+------------+--------------------------+--------------------------+
|WkVVu9fD |WkVVu9fD-1568731976982 |onap-dublin |aai |subscription-delete |onap-dublin |completed |2019-09-17T14:52:56.000 |2019-09-17T14:52:57.000 |
+------------+------------------------+--------------+------------------+------------------------------+--------------+------------+--------------------------+--------------------------+
|WkVVu9fD |WkVVu9fD-1568731785780 |onap-dublin |aai |vnfm-create |onap-dublin |completed |2019-09-17T14:49:45.000 |2019-09-17T14:49:46.000 |
......
While executing the test cases, VTP provides unique execution-id (2nd column)
for each step. As you note in the example above, some steps are in-progress,
while others are completed already. If there is error then status will be set
to failed.
To find out the foot-print of each step, following commands are available:
.. code-block:: bash
oclip execution-show-out --execution-id WkVVu9fD-1568731785780 - Reports the standard output logs
oclip execution-show-err --execution-id WkVVu9fD-1568731785780 - Reports the standard error logs
oclip execution-show-debug --execution-id WkVVu9fD-1568731785780 - Reports the debug details like HTTP request and responseoclip execution-show --execution-id WkVVu9fD-1568731785780 - Reports the complete foot-print of inputs, outputs of steps
Track the progress of the vnf-tosca-provision test cases until its completed.
Then the out of the validation test cases could be retrieved as below:
.. code-block:: bash
oclip execution-show --execution-id WkVVu9fD-1568731678753 - use vnf tosca test case execution id here
It will provides the output format as below:
.. code-block:: json
{
"output": {
"ns-id": null,
"vnf-id": "",
"vnfm-driver": "hwvnfmdriver",
"vnf-vendor-name": "huawei",
"onap-objects": {
"ns_instance_id": null,
"tenant_version": null,
"service_type_id": null,
"tenant_id": null,
"subscription_version": null,
"esr_vnfm_id": null,
"location_id": null,
"ns_version": null,
"vnf_status": "active",
"entitlement_id": null,
"ns_id": null,
"cloud_version": null,
"cloud_id": null,
"vlm_version": null,
"esr_vnfm_version": null,
"vlm_id": null,
"vsp_id": null,
"vf_id": null,
"ns_instance_status": "active",
"service_type_version": null,
"ns_uuid": null,
"location_version": null,
"feature_group_id": null,
"vf_version": null,
"vsp_version": null,
"agreement_id": null,
"vf_uuid": null,
"ns_vf_resource_id": null,
"vsp_version_id": null,
"customer_version": null,
"vf_inputs": null,
"customer_id": null,
"key_group_id": null,
},
"vnf-status": "active",
"vnf-name": "vgw",
"ns-status": "active"
},
"input": {
"mode": "validate",
"vsp": "/tmp/data/vtp-tmp-files/1568731645518.csar",
"vnfm-driver": "hwvnfmdriver",
"config-json": "/opt/oclip/conf/vnf-tosca-provision.json",
"vnf-vendor-name": "huawei",
"ns-csar": "/tmp/data/vtp-tmp-files/1568731660745.csar",
"onap-objects": "{}",
"timeout": "600000",
"vnf-name": "vgw",
"vnf-csar": "/tmp/data/vtp-tmp-files/1568731655310.csar"
},
"product": "onap-dublin",
"start-time": "2019-09-17T14:47:58.000",
"service": "vnf-validation",
"end-time": "2019-09-17T14:53:46.000",
"request-id": "WkVVu9fD-1568731678753",
"command": "vnf-tosca-provision",
"status": "completed"
}
Reporting Results
+++++++++++++++++
VTP provides translation tool to migrate the VTP result into OVP portal format
and generates the tar file for the given test case execution. Please refer
`<https://github.com/onap/vnfsdk-refrepo/tree/master/vnfmarket-be/deployment/vtp2ovp>`_
for more details.
Once tar is generated, it can be used to submit into OVP portal
`<https://vnf-verified.lfnetworking.org/>`_
.. References
.. _`OVP VNF portal`: https://vnf-verified.lfnetworking.org
|