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
|
"""Tower plugin for integration tests."""
from __future__ import absolute_import, print_function
import os
import time
from lib.util import (
display,
ApplicationError,
is_shippable,
run_command,
SubprocessError,
ConfigParser,
)
from lib.cloud import (
CloudProvider,
CloudEnvironment,
)
from lib.core_ci import (
AnsibleCoreCI,
)
class TowerCloudProvider(CloudProvider):
"""Tower cloud provider plugin. Sets up cloud resources before delegation."""
def __init__(self, args):
"""
:type args: TestConfig
"""
super(TowerCloudProvider, self).__init__(args, config_extension='.cfg')
self.aci = None
self.version = ''
def filter(self, targets, exclude):
"""Filter out the cloud tests when the necessary config and resources are not available.
:type targets: tuple[TestTarget]
:type exclude: list[str]
"""
if os.path.isfile(self.config_static_path):
return
aci = get_tower_aci(self.args)
if os.path.isfile(aci.ci_key):
return
if is_shippable():
return
super(TowerCloudProvider, self).filter(targets, exclude)
def setup(self):
"""Setup the cloud resource before delegation and register a cleanup callback."""
super(TowerCloudProvider, self).setup()
if self._use_static_config():
self._setup_static()
else:
self._setup_dynamic()
def check_tower_version(self, fallback=None):
"""Check the Tower version being tested and determine the correct CLI version to use.
:type fallback: str | None
"""
tower_cli_version_map = {
'3.1.5': '3.1.8',
'3.2.3': '3.3.0',
}
cli_version = tower_cli_version_map.get(self.version, fallback)
if not cli_version:
raise ApplicationError('Mapping to ansible-tower-cli version required for Tower version: %s' % self.version)
self._set_cloud_config('tower_cli_version', cli_version)
def cleanup(self):
"""Clean up the cloud resource and any temporary configuration files after tests complete."""
# cleanup on success or failure is not yet supported due to how cleanup is called
if self.aci and self.args.remote_terminate == 'always':
self.aci.stop()
super(TowerCloudProvider, self).cleanup()
def _setup_static(self):
config = TowerConfig.parse(self.config_static_path)
self.version = config.version
self.check_tower_version()
def _setup_dynamic(self):
"""Request Tower credentials through the Ansible Core CI service."""
display.info('Provisioning %s cloud environment.' % self.platform, verbosity=1)
# temporary solution to allow version selection
self.version = os.environ.get('TOWER_VERSION', '3.2.3')
self.check_tower_version(os.environ.get('TOWER_CLI_VERSION'))
aci = get_tower_aci(self.args, self.version)
aci.start()
aci.wait()
connection = aci.get()
config = self._read_config_template()
if not self.args.explain:
self.aci = aci
values = dict(
VERSION=self.version,
HOST=connection.hostname,
USERNAME=connection.username,
PASSWORD=connection.password,
)
config = self._populate_config_template(config, values)
self._write_config(config)
class TowerCloudEnvironment(CloudEnvironment):
"""Tower cloud environment plugin. Updates integration test environment after delegation."""
def setup(self):
"""Setup which should be done once per environment instead of once per test target."""
self.setup_cli()
self.disable_pendo()
def setup_cli(self):
"""Install the correct Tower CLI for the version of Tower being tested."""
tower_cli_version = self._get_cloud_config('tower_cli_version')
display.info('Installing Tower CLI version: %s' % tower_cli_version)
cmd = self.args.pip_command + ['install', '--disable-pip-version-check', 'ansible-tower-cli==%s' % tower_cli_version]
run_command(self.args, cmd)
def disable_pendo(self):
"""Disable Pendo tracking."""
display.info('Disable Pendo tracking')
config = TowerConfig.parse(self.config_path)
# tower-cli does not recognize TOWER_ environment variables
cmd = ['tower-cli', 'setting', 'modify', 'PENDO_TRACKING_STATE', 'off',
'-h', config.host, '-u', config.username, '-p', config.password]
attempts = 60
while True:
attempts -= 1
try:
run_command(self.args, cmd, capture=True)
return
except SubprocessError as ex:
if not attempts:
raise ApplicationError('Timed out trying to disable Pendo tracking:\n%s' % ex)
time.sleep(5)
def configure_environment(self, env, cmd):
"""Configuration which should be done once for each test target.
:type env: dict[str, str]
:type cmd: list[str]
"""
config = TowerConfig.parse(self.config_path)
env.update(config.environment)
class TowerConfig(object):
"""Tower settings."""
def __init__(self, values):
self.version = values.get('version')
self.host = values.get('host')
self.username = values.get('username')
self.password = values.get('password')
if self.password:
display.sensitive.add(self.password)
@property
def environment(self):
"""Tower settings as environment variables.
:rtype: dict[str, str]
"""
env = dict(
TOWER_VERSION=self.version,
TOWER_HOST=self.host,
TOWER_USERNAME=self.username,
TOWER_PASSWORD=self.password,
)
return env
@staticmethod
def parse(path):
"""
:type path: str
:rtype: TowerConfig
"""
parser = ConfigParser()
parser.read(path)
keys = (
'version',
'host',
'username',
'password',
)
values = dict((k, parser.get('general', k)) for k in keys)
config = TowerConfig(values)
missing = [k for k in keys if not values.get(k)]
if missing:
raise ApplicationError('Missing or empty Tower configuration value(s): %s' % ', '.join(missing))
return config
def get_tower_aci(args, version=None):
"""
:type args: EnvironmentConfig
:type version: str | None
:rtype: AnsibleCoreCI
"""
if version:
persist = True
else:
version = ''
persist = False
return AnsibleCoreCI(args, 'tower', version, persist=persist, stage=args.remote_stage, provider=args.remote_provider)
|
