2 # Copyright (C) 2019 Bell Canada.
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
16 from builtins import Exception, open, dict
17 from subprocess import CalledProcessError, PIPE
18 from google.protobuf.json_format import MessageToJson
27 import proto.CommandExecutor_pb2 as CommandExecutor_pb2
29 REQUIREMENTS_TXT = "requirements.txt"
32 class CommandExecutorHandler():
34 def __init__(self, request):
35 self.request = request
36 self.logger = logging.getLogger(self.__class__.__name__)
37 self.blueprint_id = utils.get_blueprint_id(request)
38 self.venv_home = '/opt/app/onap/blueprints/deploy/' + self.blueprint_id
39 self.installed = self.venv_home + '/.installed'
41 def is_installed(self):
42 return os.path.exists(self.installed)
44 def prepare_env(self, request, results):
45 if not self.is_installed():
47 if not self.activate_venv():
50 f = open(self.installed, "w+")
51 if not self.install_packages(request, CommandExecutor_pb2.pip, f, results):
55 if not self.install_packages(request, CommandExecutor_pb2.ansible_galaxy, f, results):
59 f = open(self.installed, "r")
60 results.append(f.read())
63 # deactivate_venv(blueprint_id)
66 def execute_command(self, request, results):
68 if not self.activate_venv():
71 cmd = "cd " + self.venv_home
73 if "ansible-playbook" in request.command:
74 cmd = cmd + "; " + request.command + " -e 'ansible_python_interpreter=" + self.venv_home + "/bin/python'"
76 cmd = cmd + "; " + request.command + " " + re.escape(MessageToJson(request.properties))
79 with subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
80 shell=True, bufsize=1, universal_newlines=True) as newProcess:
82 output = newProcess.stdout.readline()
83 if output == '' and newProcess.poll() is not None:
86 self.logger.info(output.strip())
87 results.append(output.strip())
88 rc = newProcess.poll()
89 except Exception as e:
90 self.logger.info("{} - Failed to execute command. Error: {}".format(self.blueprint_id, e))
94 # deactivate_venv(blueprint_id)
97 def install_packages(self, request, type, f, results):
98 for package in request.packages:
99 if package.type == type:
100 f.write("Installed %s packages:\r\n" % CommandExecutor_pb2.PackageType.Name(type))
101 for p in package.package:
102 f.write(" %s\r\n" % p)
103 if package.type == CommandExecutor_pb2.pip:
104 success = self.install_python_packages(p, results)
106 success = self.install_ansible_packages(p, results)
109 os.remove(self.installed)
113 def install_python_packages(self, package, results):
115 "{} - Install Python package({}) in Python Virtual Environment".format(self.blueprint_id, package))
117 if REQUIREMENTS_TXT == package:
118 command = ["pip", "install", "-r", self.venv_home + "/Environments/" + REQUIREMENTS_TXT]
120 command = ["pip", "install", package]
122 env = dict(os.environ)
123 if "https_proxy" in os.environ:
124 env['https_proxy'] = os.environ['https_proxy']
127 results.append(subprocess.run(command, check=True, stdout=PIPE, stderr=PIPE, env=env).stdout.decode())
130 except CalledProcessError as e:
131 results.append(e.stderr.decode())
134 def install_ansible_packages(self, package, results):
136 "{} - Install Ansible Role package({}) in Python Virtual Environment".format(self.blueprint_id, package))
137 command = ["ansible-galaxy", "install", package, "-p", self.venv_home + "/Scripts/ansible/roles"]
139 env = dict(os.environ)
140 if "http_proxy" in os.environ:
141 # ansible galaxy uses https_proxy environment variable, but requires it to be set with http proxy value.
142 env['https_proxy'] = os.environ['http_proxy']
145 results.append(subprocess.run(command, check=True, stdout=PIPE, stderr=PIPE, env=env).stdout.decode())
148 except CalledProcessError as e:
149 results.append(e.stderr.decode())
152 def create_venv(self):
153 self.logger.info("{} - Create Python Virtual Environment".format(self.blueprint_id))
155 bin_dir = self.venv_home + "/bin"
156 # venv doesn't populate the activate_this.py script, hence we use from virtualenv
157 venv.create(self.venv_home, with_pip=True, system_site_packages=True)
158 virtualenv.writefile(os.path.join(bin_dir, "activate_this.py"), virtualenv.ACTIVATE_THIS)
159 except Exception as err:
161 "{} - Failed to provision Python Virtual Environment. Error: {}".format(self.blueprint_id, err))
163 def activate_venv(self):
164 self.logger.info("{} - Activate Python Virtual Environment".format(self.blueprint_id))
166 # Fix: The python generated activate_this.py script concatenates the env bin dir to PATH on every call
167 # eventually this process PATH variable was so big (128Kb) that no child process could be spawn
168 # This script will remove all duplicates; while keeping the order of the PATH folders
169 fixpathenvvar = "os.environ['PATH']=os.pathsep.join(list(dict.fromkeys(os.environ['PATH'].split(':'))))"
171 path = "%s/bin/activate_this.py" % self.venv_home
173 exec (open(path).read(), {'__file__': path})
175 self.logger.info("Running with PATH : {}".format(os.environ['PATH']))
177 except Exception as err:
179 "{} - Failed to activate Python Virtual Environment. Error: {}".format(self.blueprint_id, err))
182 def deactivate_venv(self):
183 self.logger.info("{} - Deactivate Python Virtual Environment".format(self.blueprint_id))
184 command = ["deactivate"]
186 subprocess.run(command, check=True)
187 except Exception as err:
189 "{} - Failed to deactivate Python Virtual Environment. Error: {}".format(self.blueprint_id, err))