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
|
# ============LICENSE_START=======================================================
# org.onap.dcae
# ================================================================================
# Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# 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=========================================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
# -*- coding: utf-8 -*-
"""
Provides dcae cli config utilities
"""
import os, re
import click
import six
from dcae_cli import util
from dcae_cli import _version
from dcae_cli.util import get_app_dir, get_pref, update_pref, write_pref, pref_exists
class ConfigurationInitError(RuntimeError):
pass
def get_config_path():
'''Returns the absolute configuration file path'''
return os.path.join(get_app_dir(), 'config.json')
def _init_config_user():
while True:
user = click.prompt('Please enter your user id', type=str).strip()
# There should be no special characters
if re.match("(?:\w*)\Z", user):
return user
else:
click.echo("Invalid user id. Please try again.")
def _init_config_server_url():
return click.prompt("Please enter the remote server url", type=str).strip()
def _init_config_db_url():
click.echo("Now we need to set up access to the onboarding catalog")
hostname = click.prompt("Please enter the onboarding catalog hostname").strip()
user = click.prompt("Please enter the onboarding catalog user").strip()
password = click.prompt("Please enter the onboarding catalog password").strip()
return "postgresql://{user}:{password}@{hostname}:5432/dcae_onboarding_db".format(
hostname=hostname, user=user, password=password)
def _init_config():
'''Returns an initial dict for populating the config'''
# Grab the remote config and merge it in
new_config = {}
try:
server_url = _init_config_server_url()
new_config = util.fetch_file_from_web(server_url, "/dcae-cli/config.json")
except:
# Failing to pull seed configuration from remote server is not considered
# a problem. Just continue and give user the option to set it up
# themselves.
if not click.confirm("Could not download initial configuration from remote server. Attempt manually setting up?"):
raise ConfigurationInitError("Could not setup dcae-cli configuration")
# UPDATE: Keeping the server url even though the config was not found there.
new_config["server_url"] = server_url
new_config["user"] = _init_config_user()
new_config["cli_version"] = _version.__version__
if "db_url" not in new_config or not new_config["db_url"]:
# The seed configuration was not provided so manually set up the db
# connection
new_config["db_url"] = _init_config_db_url()
if "active_profile" not in new_config:
# The seed configuration was not provided which means the profiles will
# be the same. The profile will be hardcoded to a an empty default.
new_config["active_profile"] = "default"
return new_config
def should_force_reinit(config):
"""Configs older than 2.0.0 should be replaced"""
ver = config.get("cli_version", "0.0.0")
return int(ver.split(".")[0]) < 2
def get_config():
'''Returns the configuration dictionary'''
return get_pref(get_config_path(), _init_config)
def get_server_url():
"""Returns the remote server url
The remote server holds the artifacts that the dcae-cli requires like the
seed config json and seed profiles json, and json schemas.
"""
return get_config().get("server_url")
def get_docker_logins_key():
"""Returns the Consul key that Docker logins are stored under
Default is "docker_plugin/docker_logins" which matches up with the docker
plugin default.
"""
return get_config().get("docker_logins_key", "docker_plugin/docker_logins")
# These functions are used to fetch the configurable path to the various json
# schema files used in validation.
def get_path_component_spec():
return get_config().get("path_component_spec",
"/component-json-schemas/component-specification/dcae-cli-v1/component-spec-schema.json")
def get_path_data_format():
return get_config().get("path_data_format",
"/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json")
def get_active_profile():
return get_config().get("active_profile", None)
def update_config(**kwargs):
'''Updates and returns the configuration dictionary'''
return update_pref(path=get_config_path(), init_func=get_config, **kwargs)
def _reinit_config(init_func):
new_config = init_func()
config_path = get_config_path()
if pref_exists(config_path):
existing_config = get_config()
# Make sure to clobber existing values and not other way
existing_config.update(new_config)
new_config = existing_config
write_pref(new_config, config_path)
return new_config
def reinit_config():
return _reinit_config(_init_config)
|
