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
|
# Copyright (c) 2017 Cisco and/or its affiliates.
# 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.
"""Environment
Setting of the environment according to the specification specified in the
specification YAML file.
"""
import os
import shutil
import logging
from errors import PresentationError
class Environment(object):
"""Setting of the environment:
- set environment variables,
- create directories.
"""
def __init__(self, env, force=False):
"""Initialization.
:param env: Environment specification.
:param force: If True, remove old build(s) if present.
:type env: dict
:type force: bool
"""
self._env = env
self._force = force
@property
def environment(self):
"""Getter.
:returns: Environment settings.
:rtype: dict
"""
return self._env
def _set_environment_variables(self):
"""Set environment variables.
"""
logging.info("Setting the environment variables ...")
# logging.debug("Environment variables before:\n{}".format(os.environ))
count = 1
for var, value in self._env["configuration"].items():
logging.debug(" {:3d} Setting the variable {} = {}".
format(count, var, value))
os.environ[var] = str(value)
count += 1
for var, value in self._env["paths"].items():
logging.debug(" {:3d} Setting the variable {} = {}".
format(count, var, value))
os.environ[var] = str(value)
count += 1
for var, value in self._env["urls"].items():
logging.debug(" {:3d} Setting the variable {} = {}".
format(count, var, value))
os.environ[var] = str(value)
count += 1
# logging.debug("Environment variables after:\n{}".format(os.environ))
logging.info("Done.")
def _make_dirs(self):
"""Create the directories specified in the 'make-dirs' part of
'environment' section in the specification file.
:raises: PresentationError if it is not possible to remove or create a
directory.
"""
if self._force:
logging.info("Removing old build(s) ...")
for directory in self._env["build-dirs"]:
dir_to_remove = self._env["paths"][directory]
if os.path.isdir(dir_to_remove):
try:
shutil.rmtree(dir_to_remove)
logging.info(" Removed: {}".format(dir_to_remove))
except OSError:
raise PresentationError("Cannot remove the directory "
"'{}'".format(dir_to_remove))
logging.info("Done.")
logging.info("Making directories ...")
for directory in self._env["make-dirs"]:
dir_to_make = self._env["paths"][directory]
try:
if os.path.isdir(dir_to_make):
logging.warning("The directory '{}' exists, skipping.".
format(dir_to_make))
else:
os.makedirs(dir_to_make)
logging.info(" Created: {}".format(dir_to_make))
except OSError:
raise PresentationError("Cannot make the directory '{}'".
format(dir_to_make))
logging.info("Done.")
def set_environment(self):
"""Set the environment.
"""
self._set_environment_variables()
self._make_dirs()
def clean_environment(env):
"""Clean the environment.
:param env: Environment specification.
:type env: dict
:raises: PresentationError if it is not possible to remove a directory.
"""
logging.info("Cleaning the environment ...")
if not env["remove-dirs"]: # None or empty
logging.info(" No directories to remove.")
return
for directory in env["remove-dirs"]:
dir_to_remove = env["paths"][directory]
logging.info(" Removing the working directory {} ...".
format(dir_to_remove))
if os.path.isdir(dir_to_remove):
try:
shutil.rmtree(dir_to_remove)
except OSError:
raise PresentationError("Cannot remove the directory '{}'".
format(dir_to_remove))
else:
logging.warning("The directory '{}' does not exist.".
format(dir_to_remove))
logging.info("Done.")
|
