From ade8c2e0266b020089145075e8236b95c000a3cb Mon Sep 17 00:00:00 2001
From: Scott Moser <smoser@brickies.net>
Date: Tue, 28 Feb 2017 17:14:45 -0500
Subject: Move warning functionality to cloudinit/warnings.py

This moves the warning code that was added specifically for
EC2 into a generic path at cloudinit/warnings.py.

It also adds support for writing warning files into the
warnings directory to be shown by Z99-cloudinit-warnings.sh.
---
 cloudinit/warnings.py | 115 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 115 insertions(+)
 create mode 100644 cloudinit/warnings.py

(limited to 'cloudinit/warnings.py')

diff --git a/cloudinit/warnings.py b/cloudinit/warnings.py
new file mode 100644
index 00000000..77c092f9
--- /dev/null
+++ b/cloudinit/warnings.py
@@ -0,0 +1,115 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+from cloudinit import helpers
+from cloudinit import log as logging
+from cloudinit import util
+
+import os
+import time
+
+LOG = logging.getLogger()
+
+WARNINGS = {
+    'non_ec2_md': """
+This system is using the EC2 Metadata Service, but does not appear to
+be running on Amazon EC2 or one of cloud-init's known platforms that
+provide a EC2 Metadata service. In the future, cloud-init may stop
+reading metadata from the EC2 Metadata Service unless the platform can
+be identified.
+
+If you are seeing this message, please file a bug against
+cloud-init at
+   https://bugs.launchpad.net/cloud-init/+filebug?field.tags=dsid
+Make sure to include the cloud provider your instance is
+running on.
+
+For more information see
+  https://bugs.launchpad.net/bugs/1660385
+
+After you have filed a bug, you can disable this warning by
+launching your instance with the cloud-config below, or
+putting that content into
+   /etc/cloud/cloud.cfg.d/99-ec2-datasource.cfg
+
+#cloud-config
+datasource:
+ Ec2:
+  strict_id: false""",
+}
+
+
+def _get_warn_dir(cfg):
+    paths = helpers.Paths(
+        path_cfgs=cfg.get('system_info', {}).get('paths', {}))
+    return paths.get_ipath_cur('warnings')
+
+
+def _load_warn_cfg(cfg, name, mode=True, sleep=None):
+    # parse cfg['warnings']['name'] returning boolean, sleep
+    # expected value is form of:
+    #   (on|off|true|false|sleep)[,sleeptime]
+    # boolean True == on, False == off
+    default = (mode, sleep)
+    if not cfg or not isinstance(cfg, dict):
+        return default
+
+    ncfg = util.get_cfg_by_path(cfg, ('warnings', name))
+    if ncfg is None:
+        return default
+
+    if ncfg in ("on", "true", True):
+        return True, None
+
+    if ncfg in ("off", "false", False):
+        return False, None
+
+    mode, _, csleep = ncfg.partition(",")
+    if mode != "sleep":
+        return default
+
+    if csleep:
+        try:
+            sleep = int(csleep)
+        except ValueError:
+            return default
+
+    return True, sleep
+
+
+def show_warning(name, cfg=None, sleep=None, mode=True, **kwargs):
+    # kwargs are used for .format of the message.
+    # sleep and mode are default values used if
+    #   cfg['warnings']['name'] is not present.
+    if cfg is None:
+        cfg = {}
+
+    mode, sleep = _load_warn_cfg(cfg, name, mode=mode, sleep=sleep)
+    if not mode:
+        return
+
+    msg = WARNINGS[name].format(**kwargs)
+    msgwidth = 70
+    linewidth = msgwidth + 4
+
+    fmt = "# %%-%ds #" % msgwidth
+    topline = "*" * linewidth + "\n"
+    fmtlines = []
+    for line in msg.strip("\n").splitlines():
+        fmtlines.append(fmt % line)
+
+    closeline = topline
+    if sleep:
+        sleepmsg = "  [sleeping for %d seconds]  " % sleep
+        closeline = sleepmsg.center(linewidth, "*") + "\n"
+
+    util.write_file(
+        os.path.join(_get_warn_dir(cfg), name),
+        topline + "\n".join(fmtlines) + "\n" + topline)
+
+    LOG.warn(topline + "\n".join(fmtlines) + "\n" + closeline)
+
+    if sleep:
+        LOG.debug("sleeping %d seconds for warning '%s'" % (sleep, name))
+        time.sleep(sleep)
+
+# vi: ts=4 expandtab
-- 
cgit v1.2.3


From 79db2e2436d91510aceb8c036c4a945362c85a52 Mon Sep 17 00:00:00 2001
From: Scott Moser <smoser@brickies.net>
Date: Wed, 1 Mar 2017 15:50:40 -0500
Subject: Support warning if the used datasource is not in ds-identify's list.

If ds-identify is in report mode, and the datasource that is found
is not in the list, then warn the user of this situation.
---
 cloudinit/cmd/main.py | 39 +++++++++++++++++++++++++++++++++++++++
 cloudinit/warnings.py | 24 ++++++++++++++++++++++++
 2 files changed, 63 insertions(+)

(limited to 'cloudinit/warnings.py')

diff --git a/cloudinit/cmd/main.py b/cloudinit/cmd/main.py
index 7c652574..6ff4e1c0 100644
--- a/cloudinit/cmd/main.py
+++ b/cloudinit/cmd/main.py
@@ -29,6 +29,7 @@ from cloudinit import templater
 from cloudinit import url_helper
 from cloudinit import util
 from cloudinit import version
+from cloudinit import warnings
 
 from cloudinit import reporting
 from cloudinit.reporting import events
@@ -413,10 +414,48 @@ def main_init(name, args):
     # give the activated datasource a chance to adjust
     init.activate_datasource()
 
+    di_report_warn(datasource=init.datasource, cfg=init.cfg)
+
     # Stage 10
     return (init.datasource, run_module_section(mods, name, name))
 
 
+def di_report_warn(datasource, cfg):
+    if 'di_report' not in cfg:
+        LOG.debug("no di_report found in config.")
+        return
+
+    dicfg = cfg.get('di_report', {})
+    if not isinstance(dicfg, dict):
+        LOG.warn("di_report config not a dictionary: %s", dicfg)
+        return
+
+    dslist = dicfg.get('datasource_list')
+    if dslist is None:
+        LOG.warn("no 'datasource_list' found in di_report.")
+        return
+    elif not isinstance(dslist, list):
+        LOG.warn("di_report/datasource_list not a list: %s", dslist)
+        return
+
+    # ds.__module__ is like cloudinit.sources.DataSourceName
+    # where Name is the thing that shows up in datasource_list.
+    modname = datasource.__module__.rpartition(".")[2]
+    if modname.startswith(sources.DS_PREFIX):
+        modname = modname[len(sources.DS_PREFIX):]
+    else:
+        LOG.warn("Datasource '%s' came from unexpected module '%s'.",
+                 datasource, modname)
+
+    if modname in dslist:
+        LOG.debug("used datasource '%s' from '%s' was in di_report's list: %s",
+                  datasource, modname, dslist)
+        return
+
+    warnings.show_warning('dsid_missing_source', cfg,
+                          source=modname, dslist=str(dslist))
+
+
 def main_modules(action_name, args):
     name = args.mode
     # Cloud-init 'modules' stages are broken up into the following sub-stages
diff --git a/cloudinit/warnings.py b/cloudinit/warnings.py
index 77c092f9..3206d4e9 100644
--- a/cloudinit/warnings.py
+++ b/cloudinit/warnings.py
@@ -35,6 +35,30 @@ putting that content into
 datasource:
  Ec2:
   strict_id: false""",
+    'dsid_missing_source': """
+A new feature in cloud-init identified possible datasources for
+this system as:
+  {dslist}
+However, the datasource used was: {source}
+
+In the future, cloud-init will only attempt to use datasources that
+are identified or specifically configured.
+For more information see
+  https://bugs.launchpad.net/bugs/1669675
+
+If you are seeing this message, please file a bug against
+cloud-init at
+   https://bugs.launchpad.net/cloud-init/+filebug?field.tags=dsid
+Make sure to include the cloud provider your instance is
+running on.
+
+After you have filed a bug, you can disable this warning by launching
+your instance with the cloud-config below, or putting that content
+into /etc/cloud/cloud.cfg.d/99-warnings.cfg
+
+#cloud-config
+warnings:
+  dsid_missing_source: off""",
 }
 
 
-- 
cgit v1.2.3