dcae-cli/dcae_cli/util/config.py

   1 # ============LICENSE_START=======================================================
   2 # org.onap.dcae
   3 # ================================================================================
   4 # Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
   5 # ================================================================================
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #      http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17 # ============LICENSE_END=========================================================
  18 #
  19 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
  20
  21 # -*- coding: utf-8 -*-
  22 """
  23 Provides dcae cli config utilities
  24 """
  25 import os, re
  26
  27 import click
  28 import six
  29
  30 from dcae_cli import util
  31 from dcae_cli import _version
  32 from dcae_cli.util import get_app_dir, get_pref, update_pref, write_pref, pref_exists
  33
  34
  35 class ConfigurationInitError(RuntimeError):
  36     pass
  37
  38 def get_config_path():
  39     '''Returns the absolute configuration file path'''
  40     return os.path.join(get_app_dir(), 'config.json')
  41
  42
  43 def _init_config_user():
  44     while True:
  45         user = click.prompt('Please enter your user id', type=str).strip()
  46
  47         # There should be no special characters
  48         if re.match("(?:\w*)\Z", user):
  49             return user
  50         else:
  51             click.echo("Invalid user id. Please try again.")
  52
  53 def _init_config_server_url():
  54     return click.prompt('Please enter the remote server url', type=str).strip()
  55
  56 def _init_config():
  57     '''Returns an initial dict for populating the config'''
  58     # Grab the remote config and merge it in
  59     try:
  60         server_url = _init_config_server_url()
  61         new_config = util.fetch_file_from_web(server_url, "/dcae-cli/config.json")
  62         new_config["server_url"] = server_url
  63     except:
  64         # REVIEW: Should we allow users to manually setup their config if not
  65         # able to pull from remote server?
  66         raise ConfigurationInitError("Could not download configuration from remote server")
  67
  68     new_config["user"] = _init_config_user()
  69     new_config["cli_version"] = _version.__version__
  70
  71     if "db_url" not in new_config or not new_config["db_url"]:
  72         # Really you should never get to this point because the remote config
  73         # should have a postgres db url.
  74         fallback = ''.join(('sqlite:///', os.path.join(get_app_dir(), 'dcae_cli.db')))
  75         new_config["db_url"] = fallback
  76
  77     return new_config
  78
  79
  80 def should_force_reinit(config):
  81     """Configs older than 2.0.0 should be replaced"""
  82     ver = config.get("cli_version", "0.0.0")
  83     return int(ver.split(".")[0]) < 2
  84
  85 def get_config():
  86     '''Returns the configuration dictionary'''
  87     return get_pref(get_config_path(), _init_config)
  88
  89 def get_server_url():
  90     """Returns the remote server url
  91
  92     The remote server holds the artifacts that the dcae-cli requires like the
  93     seed config json and seed profiles json, and json schemas.
  94     """
  95     return get_config().get("server_url")
  96
  97 # These functions are used to fetch the configurable path to the various json
  98 # schema files used in validation.
  99
 100 def get_path_component_spec():
 101     return get_config().get("path_component_spec",
 102             "/schemas/component-specification/dcae-cli-v1/component-spec-schema.json")
 103
 104 def get_path_data_format():
 105     return get_config().get("path_data_format",
 106             "/schemas/data-format/dcae-cli-v1/data-format-schema.json")
 107
 108 def get_active_profile():
 109     return get_config().get("active_profile", None)
 110
 111
 112 def update_config(**kwargs):
 113     '''Updates and returns the configuration dictionary'''
 114     return update_pref(path=get_config_path(), init_func=get_config, **kwargs)
 115
 116
 117 def _reinit_config(init_func):
 118     new_config = init_func()
 119     config_path = get_config_path()
 120
 121     if  pref_exists(config_path):
 122         existing_config = get_config()
 123         # Make sure to clobber existing values and not other way
 124         existing_config.update(new_config)
 125         new_config = existing_config
 126
 127     write_pref(new_config, config_path)
 128     return new_config
 129
 130 def reinit_config():
 131     return _reinit_config(_init_config)