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
|
# ============LICENSE_START=======================================================
# csit-dcaegen2-collectors-hv-ves
# ================================================================================
# Copyright (C) 2018-2019 NOKIA
# ================================================================================
# 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.
# ============LICENSE_END=========================================================
import HttpRequests
import os
import docker
from robot.api import logger
from time import sleep
HV_VES_VERSION = os.getenv("HV_VES_VERSION")
HV_VES_COLLECTOR_NETWORK = os.getenv("CONTAINERS_NETWORK")
HV_VES_COLLECTOR_NAMESPACE = os.getenv("HV_VES_COLLECTOR_NAMESPACE")
HV_VES_GROUP_ID = os.getenv("HV_VES_GROUP_ID")
HV_VES_SERVICE_NAME = os.getenv("HV_VES_SERVICE_NAME")
UNENCRYPTED_HV_VES_SERVICE_NAME = os.getenv("UNENCRYPTED_HV_VES_SERVICE_NAME")
XNF_SIMULATOR_NAME = "xNF Simulator"
XNF_SIMULATOR_CONTAINER_PREFIX = os.getenv("XNF_SIMULATOR_IMAGE")
SIMULATOR_IMAGE_NAME = HV_VES_COLLECTOR_NAMESPACE + "/" + HV_VES_GROUP_ID + ".hv-collector-xnf-simulator"
SIMULATOR_IMAGE_FULL_NAME = os.getenv("DOCKER_REGISTRY_PREFIX") + SIMULATOR_IMAGE_NAME + ":" + HV_VES_VERSION
WORKSPACE_ENV = os.getenv("WORKSPACE")
CERTIFICATES_DIR_PATH = WORKSPACE_ENV + "/plans/dcaegen2-collectors-hv-ves/testsuites/collector/ssl/"
COLLECTOR_CERTS_LOOKUP_DIR = "/etc/ves-hv/"
ONE_SECOND_IN_NANOS = 10 ** 9
class XnfSimulatorLibrary:
def start_xnf_simulators(self, list_of_ports,
should_use_valid_certs=True,
should_disable_ssl=False,
should_connect_to_unencrypted_hv_ves=False):
logger.info("Creating " + str(len(list_of_ports)) + " xNF Simulator containers")
dockerClient = docker.from_env()
self.pullImageIfAbsent(dockerClient)
logger.info("Using image: " + SIMULATOR_IMAGE_FULL_NAME)
simulators_addresses = self.create_containers(dockerClient,
list_of_ports,
should_use_valid_certs,
should_disable_ssl,
should_connect_to_unencrypted_hv_ves)
self.assert_containers_startup_was_successful(dockerClient)
dockerClient.close()
return simulators_addresses
def pullImageIfAbsent(self, dockerClient):
try:
dockerClient.images.get(SIMULATOR_IMAGE_FULL_NAME)
except:
logger.console("Image " + SIMULATOR_IMAGE_FULL_NAME + " will be pulled from repository. "
"This can take a while.")
dockerClient.images.pull(SIMULATOR_IMAGE_FULL_NAME)
def create_containers(self,
dockerClient,
list_of_ports,
should_use_valid_certs,
should_disable_ssl,
should_connect_to_unencrypted_hv_ves):
simulators_addresses = []
for port in list_of_ports:
xnf = XnfSimulator(port, should_use_valid_certs, should_disable_ssl, should_connect_to_unencrypted_hv_ves)
container = self.run_simulator(dockerClient, xnf)
logger.info("Started container: " + container.name + " " + container.id)
simulators_addresses.append(container.name + ":" + xnf.port)
return simulators_addresses
def run_simulator(self, dockerClient, xnf):
xNF_startup_command = xnf.get_startup_command()
xNF_healthcheck_command = xnf.get_healthcheck_command()
port = xnf.port
logger.info("Startup command: " + str(xNF_startup_command))
logger.info("Healthcheck command: " + str(xNF_healthcheck_command))
return dockerClient.containers.run(SIMULATOR_IMAGE_FULL_NAME,
command=xNF_startup_command,
healthcheck=xNF_healthcheck_command,
detach=True,
network=HV_VES_COLLECTOR_NETWORK,
ports={port + "/tcp": port},
volumes=self.container_volumes(),
name=XNF_SIMULATOR_CONTAINER_PREFIX + port)
def container_volumes(self):
return {CERTIFICATES_DIR_PATH: {"bind": COLLECTOR_CERTS_LOOKUP_DIR, "mode": 'rw'}}
def assert_containers_startup_was_successful(self, dockerClient):
checks_amount = 6
check_interval_in_seconds = 5
for _ in range(checks_amount):
sleep(check_interval_in_seconds)
all_containers_healthy = True
for container in self.get_simulators_list(dockerClient):
all_containers_healthy = all_containers_healthy and self.is_container_healthy(container)
if (all_containers_healthy):
return
raise ContainerException("One of xNF simulators containers did not pass the healthcheck.")
def is_container_healthy(self, container):
container_health = container.attrs['State']['Health']['Status']
return container_health == 'healthy' and container.status == 'running'
def stop_and_remove_all_xnf_simulators(self, suite_name):
dockerClient = docker.from_env()
for container in self.get_simulators_list(dockerClient):
logger.info("Stopping and removing container: " + container.id)
log_filename = WORKSPACE_ENV + "/archives/containers_logs/" + \
suite_name.split(".")[-1] + "_" + container.name + ".log"
file = open(log_filename, "w+")
file.write(str(container.logs()))
file.close()
container.stop()
container.remove()
dockerClient.close()
def get_simulators_list(self, dockerClient):
return dockerClient.containers.list(filters={"ancestor": SIMULATOR_IMAGE_FULL_NAME}, all=True)
def send_messages(self, simulator_url, message_filepath):
logger.info("Reading message to simulator from: " + message_filepath)
file = open(message_filepath, "rb")
data = file.read()
file.close()
logger.info("POST at: " + simulator_url)
resp = HttpRequests.session_without_env().post(simulator_url, data=data, timeout=5)
HttpRequests.checkStatusCode(resp.status_code, XNF_SIMULATOR_NAME)
class XnfSimulator:
def __init__(self,
port,
should_use_valid_certs,
should_disable_ssl,
should_connect_to_unencrypted_hv_ves):
self.port = port
self.healthcheck_server_port = "6063"
cert_name_prefix = "" if should_use_valid_certs else "untrusted"
certificates_path_with_file_prefix = COLLECTOR_CERTS_LOOKUP_DIR + cert_name_prefix
self.key_store_path = certificates_path_with_file_prefix + "client.p12"
self.key_store_passwd_path = certificates_path_with_file_prefix + "client.pass"
self.trust_store_path = certificates_path_with_file_prefix + "trust.p12"
self.trust_store_passwd_path = certificates_path_with_file_prefix + "trust.pass"
self.disable_ssl = should_disable_ssl
self.hv_collector_host = UNENCRYPTED_HV_VES_SERVICE_NAME \
if should_connect_to_unencrypted_hv_ves else HV_VES_SERVICE_NAME
def get_startup_command(self):
startup_command = ["--listen-port", self.port,
"--health-check-api-port", self.healthcheck_server_port,
"--ves-host", self.hv_collector_host,
"--ves-port", "6061",
"--key-store", self.key_store_path,
"--trust-store", self.trust_store_path,
"--key-store-password-file", self.key_store_passwd_path,
"--trust-store-password-file", self.trust_store_passwd_path]
if self.disable_ssl:
startup_command.append("--ssl-disable")
return startup_command
def get_healthcheck_command(self):
return {
"interval": 5 * ONE_SECOND_IN_NANOS,
"timeout": 3 * ONE_SECOND_IN_NANOS,
"retries": 1,
"test": ["CMD", "curl", "--request", "GET",
"--fail", "--silent", "--show-error",
"localhost:" + self.healthcheck_server_port + "/health/ready"]
}
class ContainerException(Exception):
def __init__(self, message):
super(ContainerException, self).__init__(message)
|
