aboutsummaryrefslogtreecommitdiffstats
path: root/ci/prepare_env.py
blob: 5754a62b2ed9ce7ba704b1c60c53149a5b3fdd9c (plain)
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
#!/usr/bin/env python
#
# Author: Jose Lausuch (jose.lausuch@ericsson.com)
#
# Installs the Functest framework within the Docker container
# and run the tests automatically
#
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
#

import argparse
import os
import re
import subprocess
import sys
import yaml

import functest.utils.functest_logger as ft_logger
import functest.utils.functest_utils as ft_utils
import functest.utils.generate_defaults as gen_def
import functest.utils.openstack_utils as os_utils


""" arguments """
actions = ['start', 'check']
parser = argparse.ArgumentParser()
parser.add_argument("action", help="Possible actions are: "
                    "'{d[0]}|{d[1]}' ".format(d=actions))
parser.add_argument("-d", "--debug", help="Debug mode", action="store_true")
args = parser.parse_args()


""" logging configuration """
logger = ft_logger.Logger("prepare_env").getLogger()


""" global variables """
INSTALLERS = ['fuel', 'compass', 'apex', 'joid']
CI_INSTALLER_TYPE = ""
CI_INSTALLER_IP = ""
CI_SCENARIO = ""
CI_DEBUG = False
REPOS_DIR = os.getenv('repos_dir')
FUNCTEST_REPO = REPOS_DIR + '/functest/'

with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
    functest_yaml = yaml.safe_load(f)

FUNCTEST_CONF_DIR = functest_yaml.get("general").get(
    "directories").get("dir_functest_conf")

FUNCTEST_DATA_DIR = functest_yaml.get("general").get(
    "directories").get("dir_functest_data")
FUNCTEST_RESULTS_DIR = functest_yaml.get("general").get(
    "directories").get("dir_results")
DEPLOYMENT_MAME = functest_yaml.get("rally").get("deployment_name")
TEMPEST_REPO_DIR = functest_yaml.get("general").get(
    "directories").get("dir_repo_tempest")

ENV_FILE = FUNCTEST_CONF_DIR + "/env_active"


def print_separator():
    logger.info("==============================================")


def check_env_variables():
    print_separator()
    logger.info("Checking environment variables...")
    global CI_INSTALLER_TYPE
    global CI_INSTALLER_IP
    global CI_DEBUG
    global CI_SCENARIO
    CI_INSTALLER_TYPE = os.getenv('INSTALLER_TYPE')
    CI_INSTALLER_IP = os.getenv('INSTALLER_IP')
    CI_SCENARIO = os.getenv('DEPLOY_SCENARIO')
    CI_NODE = os.getenv('NODE_NAME')
    CI_BUILD_TAG = os.getenv('BUILD_TAG')
    CI_DEBUG = os.getenv('CI_DEBUG')

    if CI_INSTALLER_TYPE is None:
        logger.warning("The env variable 'INSTALLER_TYPE' is not defined.")
        CI_INSTALLER_TYPE = "undefined"
    else:
        if os.getenv('INSTALLER_TYPE') not in INSTALLERS:
            logger.warning("INSTALLER_TYPE=%s is not a valid OPNFV installer. "
                           "Available OPNFV Installers are : %s."
                           "Setting INSTALLER_TYPE=undefined." % INSTALLERS)
            CI_INSTALLER_TYPE = "undefined"
        else:
            logger.info("    INSTALLER_TYPE=%s" % CI_INSTALLER_TYPE)

    if CI_INSTALLER_IP is None:
        logger.warning("The env variable 'INSTALLER_IP' is not defined. "
                       "It is needed to fetch the OpenStack credentials. "
                       "If the credentials are not provided to the "
                       "container as a volume, please add this env variable "
                       "to the 'docker run' command.")
    else:
        logger.info("    INSTALLER_IP=%s" % CI_INSTALLER_IP)

    if CI_SCENARIO is None:
        logger.warning("The env variable 'DEPLOY_SCENARIO' is not defined. "
                       "Setting CE_SCENARIO=undefined.")
        CI_SCENARIO = "undefined"
    else:
        logger.info("    DEPLOY_SCENARIO=%s" % CI_SCENARIO)
    if CI_DEBUG:
        logger.info("    CI_DEBUG=%s" % CI_DEBUG)

    if CI_NODE:
        logger.info("    NODE_NAME=%s" % CI_NODE)

    if CI_BUILD_TAG:
        logger.info("    BUILD_TAG=%s" % CI_BUILD_TAG)


def create_directories():
    print_separator()
    logger.info("Creating needed directories...")
    if not os.path.exists(FUNCTEST_CONF_DIR):
        os.makedirs(FUNCTEST_CONF_DIR)
        logger.info("    %s created." % FUNCTEST_CONF_DIR)
    else:
        logger.debug("   %s already exists." % FUNCTEST_CONF_DIR)

    if not os.path.exists(FUNCTEST_DATA_DIR):
        os.makedirs(FUNCTEST_DATA_DIR)
        logger.info("    %s created." % FUNCTEST_DATA_DIR)
    else:
        logger.debug("   %s already exists." % FUNCTEST_DATA_DIR)

    ODL_RESULTS_DIR = FUNCTEST_RESULTS_DIR + "/ODL/"
    if not os.path.exists(ODL_RESULTS_DIR):
        os.makedirs(ODL_RESULTS_DIR)
        logger.info("    %s created." % ODL_RESULTS_DIR)
    else:
        logger.debug("   %s already exists." % ODL_RESULTS_DIR)


def source_rc_file():
    print_separator()
    logger.info("Fetching RC file...")
    rc_file = os.getenv('creds')
    if rc_file is None:
        logger.warning("The environment variable 'creds' must be set and"
                       "pointing to the local RC file. Using default: "
                       "/home/opnfv/functest/conf/openstack.creds ...")
        rc_file = "/home/opnfv/functest/conf/openstack.creds"

    if not os.path.isfile(rc_file):
        logger.info("RC file not provided. "
                    "Fetching it from the installer...")
        if CI_INSTALLER_IP is None:
            logger.error("The env variable CI_INSTALLER_IP must be provided in"
                         " order to fetch the credentials from the installer.")
            sys.exit("Missing CI_INSTALLER_IP.")
        if CI_INSTALLER_TYPE not in INSTALLERS:
            logger.error("Cannot fetch credentials. INSTALLER_TYPE=%s is "
                         "not a valid OPNFV installer. Available "
                         "installers are : %s." % INSTALLERS)
            sys.exit("Wrong INSTALLER_TYPE.")

        cmd = ("/home/opnfv/repos/releng/utils/fetch_os_creds.sh "
               "-d %s -i %s -a %s"
               % (rc_file, CI_INSTALLER_TYPE, CI_INSTALLER_IP))
        logger.debug("Executing command: %s" % cmd)
        p = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)
        output = p.communicate()[0]
        logger.debug("\n%s" % output)
        if p.returncode != 0:
            logger.error("Failed to fetch credentials from installer.")
            sys.exit(1)
    else:
        logger.info("RC file provided in %s." % rc_file)
        if os.path.getsize(rc_file) == 0:
            logger.error("The file %s is empty." % rc_file)
            sys.exit(1)

    logger.info("Sourcing the OpenStack RC file...")
    creds = os_utils.source_credentials(rc_file)
    str = ""
    for key, value in creds.iteritems():
        if re.search("OS_", key):
            str += "\n\t\t\t\t\t\t   " + key + "=" + value
    logger.debug("Used credentials: %s" % str)


def verify_deployment():
    print_separator()
    logger.info("Verifying OpenStack services...")
    cmd = ("%s/ci/check_os.sh" % FUNCTEST_REPO)

    logger.debug("Executing command: %s" % cmd)
    p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)

    while p.poll() is None:
        line = p.stdout.readline().rstrip()
        if "ERROR" in line:
            logger.error(line)
            sys.exit("Problem while running 'check_os.sh'.")
        logger.info(line)


def install_rally():
    print_separator()
    logger.info("Creating Rally environment...")

    cmd = "rally deployment destroy opnfv-rally"
    ft_utils.execute_command(cmd, logger=logger, exit_on_error=False,
                             error_msg=("Deployment %s does not exist."
                                        % DEPLOYMENT_MAME), verbose=False)

    cmd = "rally deployment create --fromenv --name=" + DEPLOYMENT_MAME
    ft_utils.execute_command(cmd, logger,
                             error_msg="Problem creating Rally deployment")

    logger.info("Installing tempest from existing repo...")
    cmd = ("rally verify install --source " + TEMPEST_REPO_DIR +
           " --system-wide")
    ft_utils.execute_command(cmd, logger,
                             error_msg="Problem installing Tempest.")

    cmd = "rally deployment check"
    ft_utils.execute_command(cmd, logger,
                             error_msg=("OpenStack not responding or "
                                        "faulty Rally deployment."))

    cmd = "rally show images"
    ft_utils.execute_command(cmd, logger,
                             error_msg=("Problem while listing "
                                        "OpenStack images."))

    cmd = "rally show flavors"
    ft_utils.execute_command(cmd, logger,
                             error_msg=("Problem while showing "
                                        "OpenStack flavors."))


def generate_os_defaults():
    print_separator()
    logger.info("Generating OpenStack defaults...")
    gen_def.main()


def check_environment():
    msg_not_active = "The Functest environment is not installed."
    if not os.path.isfile(ENV_FILE):
        logger.error(msg_not_active)
        sys.exit(1)

    with open(ENV_FILE, "r") as env_file:
        s = env_file.read()
        if not re.search("1", s):
            logger.error(msg_not_active)
            sys.exit(1)

    logger.info("Functest environment installed.")


def main():
    if not (args.action in actions):
        logger.error('Argument not valid.')
        sys.exit()

    if args.action == "start":
        logger.info("######### Preparing Functest environment #########\n")
        check_env_variables()
        create_directories()
        source_rc_file()
        verify_deployment()
        install_rally()
        generate_os_defaults()

        with open(ENV_FILE, "w") as env_file:
            env_file.write("1")

        check_environment()

    if args.action == "check":
        check_environment()

    exit(0)

if __name__ == '__main__':
    main()