ric_robot_suite/README-nanobot

   1 #   Copyright (c) 2019 AT&T Intellectual Property.
   2 #   Copyright (c) 2019 Nokia.
   3 #
   4 #   Licensed under the Apache License, Version 2.0 (the "License");
   5 #   you may not use this file except in compliance with the License.
   6 #   You may obtain a copy of the License at
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #   Unless required by applicable law or agreed to in writing, software
  11 #   distributed under the License is distributed on an "AS IS" BASIS,
  12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #   See the License for the specific language governing permissions and
  14 #   limitations under the License.
  15
  16 In addition to the default robot framework container, this tree
  17 includes a minimal robot framework container called "nanobot" and
  18 intented for automated testing or resource-limited environments while
  19 supporting all testsuites implemented by the larger container.  The
  20 nanobot container lacks the xvfb-based browser and lighttpd/PHP
  21 dashboard.
  22
  23 To build the container, first check the following ENV values at the
  24 top of docker/nanobot/Dockerfile to ensure they reflect the RIC
  25 platform deployment environment:
  26
  27 ...
  28 ENV RICPLT_NAMESPACE=ricplatform
  29 ENV RICPLT_RELEASE_NAME=ric-full
  30 ENV RICPLT_COMPONENTS="appmgr rtmgr dbaas e2mgr e2term"
  31 ...
  32
  33 Then, in the test/ric_robot_suite directory,  build the container:
  34
  35 $ docker build -f docker/nanobot/Dockerfile -t nanobot:v0.1 .
  36
  37 To run the container:
  38
  39 $ docker run --name nanobot -d nanobot:latest
  40
  41 By default, once started the container simply sleeps forever.
  42
  43 The container does not include any testsuites; either copy your tests
  44 into a running container, or mount a directory of tests when starting
  45 the container.  For example:
  46
  47 $ docker run -v /opt/robot/testsuites:/robot/testsuites --name nanobot -d nanobot:latest
  48
  49 Once started, the container will simply sleep forever.  To run a test
  50 in the container, first copy a K8S credential file to
  51 /kubernetes-admin-conf in the container:
  52
  53 $ docker cp ${KUBECONFIG} nanobot:/kubernetes-admin-conf
  54
  55 ... then run the test:
  56
  57 $ docker exec nanobot robot /robot/testsuites/ricdeployment.robot
  58 ==============================================================================
  59 Ricdeployment :: Tests for the existence and functionality of RIC components
  60 ==============================================================================
  61 Deployments                                                           .ricplatform/ric-full-appmgr is available
  62 ricplatform/ric-full-rtmgr is available
  63 ricplatform/ric-full-dbaas is available
  64 ricplatform/ric-full-e2mgr is available
  65 ricplatform/ric-full-e2term is available
  66 Deployments                                                           | PASS |
  67 ------------------------------------------------------------------------------
  68 Ricdeployment :: Tests for the existence and functionality of RIC ... | PASS |
  69 1 critical test, 1 passed, 0 failed
  70 1 test total, 1 passed, 0 failed
  71 ==============================================================================
  72 Output:  /output.xml
  73 Log:     /log.html
  74 Report:  /report.html
  75
  76 A Helm chart for the container can be found in helm/nanobot.  See
  77 helm/nanobot/README for more information on the chart.