docs/docs_usecases.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License. http://creativecommons.org/licenses/by/4.0
   3
   4 .. _docs_usecases:
   5
   6 Verified Use Cases and Functional Requirements
   7 ----------------------------------------------
   8
   9 Description
  10 ~~~~~~~~~~~
  11 This session includes use cases and functional requirements which have been
  12 officially verified in Frankfurt release by the ONAP community.
  13
  14 For each use case or functional requirement, you can find contact names and a
  15 link to the associated documentation.
  16
  17 This documentation deals with
  18
  19   1. What has been implemented
  20   2. Step by step instructions to deploy and execute the tests, including the
  21      links to download the related assets and resources
  22   3. Known issues and workarounds
  23
  24 The final testing status can be found at `Frankfurt Release Integration Testing
  25 Status <https://wiki.onap.org/display/DW/2%3A+Frankfurt+Release+Integration+Testing+Status>`_
  26
  27 31 use cases/functional requirements have been considered for the Frankfurt release.
  28
  29 Use cases
  30 ~~~~~~~~~
  31
  32 .. csv-table:: use case table
  33    :file: usecases.csv
  34    :widths: 60,20,20
  35    :header-rows: 1
  36
  37 Functional Requirements
  38 ~~~~~~~~~~~~~~~~~~~~~~~
  39
  40 .. csv-table:: functional requirements table
  41     :file: functional-requirements.csv
  42     :widths: 60,20,20
  43     :header-rows: 1
  44
  45 .. csv-table:: 5G functional requirements table
  46     :file: functional-requirements-5g.csv
  47     :widths: 60,20,20
  48     :header-rows: 1
  49
  50 Automated Use Cases
  51 ~~~~~~~~~~~~~~~~~~~
  52
  53 Most of the use cases include some automation through robot or bash scripts.
  54 These scripts are detailed in the documentation.
  55
  56 Some use cases have been integrated in ONAP gates. It means the tests are run on
  57 each daily or gating CI chain. The goal is to detect any regression as soon as
  58 possible and demonstrate the ability to automate the use cases.
  59
  60 .. csv-table:: automated use cases table
  61     :file: automated-usecases.csv
  62     :widths: 10,80,10
  63     :delim: ;
  64     :header-rows: 1
  65
  66 The robot scripts can be found in ONAP testsuite repository, an execution
  67 run-time is provided through the robot pod.
  68
  69 The python onap_tests framework is hosted on
  70 https://gitlab.com/Orange-OpenSource/lfn/onap/onap-tests. Please not that this
  71 framework is valid up to Frankfurk and will be deprecated in Guilin. It will
  72 be replaced by scenarios leveraging python-onapsdk
  73 https://gitlab.com/Orange-OpenSource/lfn/onap/python-onapsdk.
  74
  75 Deprecated Use Cases
  76 ~~~~~~~~~~~~~~~~~~~~
  77
  78 The following use cases were included in El Alto or previous release but have
  79 not been tested in Frankfurt, usually due to a lack of resources.
  80 The resources are still available in previous branches, some adaptations may
  81 however be needed for Frankfurt.
  82
  83 .. csv-table:: deprecated use case table
  84     :file: usecases-deprecated.csv
  85     :widths: 50,20,10,20
  86     :header-rows: 1