Merge bootstack-ops:juju-select-largest-model into bootstack-ops:master

[David O Neill]

Switches the largest juju model prior to other juju commands

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Giuseppe Petralia (peppepetra)]

Comments inline

[Giuseppe Petralia (peppepetra)]

review: Needs Fixing

[Drew Freiberger (afreiberger)]

comments inline

[Drew Freiberger (afreiberger)]

merge conflict in the code

review: Needs Fixing

[Zachary Zehring (zzehring)]

inline comments. have some more but will save when merge conflict is resolved.

review: Needs Fixing

[Andrea Ieri (aieri)]

I agree with Paul, we have to take into account clouds that have multiple models.
Aside from CDK clusters (which may or may not need to be billed), we also have clouds that use separate models for ceph backup clusters.
We should perhaps think about {white,black}listing models instead.
See also https://bugs.launchpad.net/bootstack-ops/+bug/1842356

[Giuseppe Petralia (peppepetra)]

Thi MP appears to be already merged in the master.

https://git.launchpad.net/bootstack-ops/commit/?id=127965c3f4ae270f67bb97e6cdce9d6648ab7aef

Comments to this MP are addressed here:

https://code.launchpad.net/~canonical-bootstack/bootstack-ops/+git/bootstack-ops/+merge/373037

review: Disapprove

Unmerged commits

2b622cd... by David O Neill on 2019-04-16

Switches the largest juju model prior to other juju commands

diff --git a/bootstack-ops/cloud_report.py b/bootstack-ops/cloud_report.py
index f13a5d3..d278db5 100644
--- a/bootstack-ops/cloud_report.py
+++ b/bootstack-ops/cloud_report.py
@@ -43,6 +43,8 @@ import json
 import click
 import subprocess
 import yaml
+import re
+
 
 from maas.client import login, connect
 from flask import Flask, jsonify
@@ -382,22 +384,38 @@ class Juju(object):
     def disconnect(self):
         pass
 
-    def _list_machines(self):
+    def run_juju_command(self, command, **kwargs):
+        """
+        Run a juju command with args and specify the output format
+
+        :param command: Juju command
+        :param format: the output format, tabulaur (None), json, yaml
+        :param commandargs: argument for the specific command
+        :return: string or None
+        """
         if not JUJU_DATA:
             print("Please export JUJU_DATA env variable before running the script")
             sys.exit(1)
 
-        machines = []
         env = os.environ.copy()
         env["JUJU_DATA"] = JUJU_DATA
 
+        format = "--format=" + kwargs['format'] if "format" in kwargs else None
+
         if os.path.isfile('/snap/bin/juju'):
-            cmd = ['/snap/bin/juju', 'status', '--format=yaml']
+            cmd = ['/snap/bin/juju', command]
         elif os.path.isfile("/usr/bin/juju"):
-            cmd = ['/usr/bin/juju', 'status', '--format=yaml']
+            cmd = ['/usr/bin/juju', command]
         else:
-            cmd = ['snap run juju', 'status', '--format=yaml']
+            cmd = ['snap run juju', command]
 
+        if "commandargs" in kwargs:
+            cmd.append(kwargs['commandargs'])
+
+        if format is not None:
+            cmd.append(format)
+
+<<<<<<< bootstack-ops/cloud_report.py
         for i in range(0, RETRY):
             try:
                 output = subprocess.check_output(cmd, timeout=30, env=env)
@@ -409,6 +427,114 @@ class Juju(object):
                 time.sleep(SLEEP * i)
     
         return machines
+=======
+        try:
+            return subprocess.check_output(cmd, env=env)
+        except subprocess.CalledProcessError as e:
+            print("Exception calling juju status command. {}".format(e))
+            # implicit, but lets do it anyway
+            return None
+
+
+    def _list_machines(self):
+        res = self.run_juju_command("status", format="yaml")
+
+        if res is None:
+            print("Failed to get machine list, @see run_juju_command")
+            return None
+
+        return yaml.safe_load(res)
+
+
+    def switch_model(self, model):
+        """
+        Switches to a given model
+        :param model: the model to switch to      
+        """
+
+        res = self.run_juju_command("switch", commandargs=model)
+
+        if res is None:
+            print("Exception calling juju switch, @see run_juju_command")
+            return None
+
+    def list_models(self):
+        """
+        Gets the output of juju list-models
+        :returns models: string of the command output
+        """
+
+        models = self.run_juju_command("list-models")
+
+        if models is None:
+            print("Exception calling juju list-models command, @see run_juju_command")
+            return None
+
+        return models
+
+    def get_model_and_sizes(self):
+        """
+        From the output of juju list-models we create a dict of the format
+        {
+          'model-name': machine-count
+          'model-name': machine-count
+          'model-name': machine-count
+        }
+        :returns dict: the above format       
+        """
+        models = self.list_models().decode('utf8').split('\n')
+        modelsdict = {}
+        machinescolnum = 0
+
+        for line in models:
+            if line.strip() == "":
+                continue
+
+            if line.startswith('Controller') and machinescolnum == 0:
+                continue
+
+            line = line.replace('\n', ' ').replace('\r', '')
+            cols = re.split('\s{2,100}', line)
+
+            if machinescolnum == 0:
+                for col in cols:
+                    if col == "Machines":
+                        break
+                    machinescolnum += 1
+            else:
+                modelsdict[cols[0]] = int(cols[machinescolnum])
+
+        return modelsdict
+
+    def switch_to_largest_model(self):
+        """
+        Looks through a dict of models in format 
+        {
+          'model-name': machine-count
+          'model-name': machine-count
+          'model-name': machine-count
+        }
+        Determiens the largest model from the machine count
+        Then calls switch_model        
+        """
+        largest = -1
+        largestModel = None
+        models = self.get_model_and_sizes()
+
+        if len(models) == 0:
+            print("No models found ?????")
+            return
+
+        for k, v in models.items():
+            if v > largest:
+                largest = v
+                largestModel = k
+
+        if "*" not in largestModel:
+            self.switch_model(largestModel)
+        else:
+            print("Largest model already selected: " + largestModel)
+>>>>>>> bootstack-ops/cloud_report.py
 
     def connect(self):
         return True
@@ -478,6 +604,108 @@ class Juju(object):
 
         return m_json
 
+    def switch_model(self, model):
+        """
+        Switches to a given model
+        :param model: the model to switch to      
+        """
+
+        if os.path.isfile('/snap/bin/juju'):
+            cmd = ['/snap/bin/juju', 'switch', model]
+        elif os.path.isfile("/usr/bin/juju"):
+            cmd = ['/usr/bin/juju', 'switch', model]
+        else:
+            cmd = ['snap run juju', 'switch', model]
+
+        try:
+            subprocess.check_output(cmd)
+        except subprocess.CalledProcessError as e:
+            print("Exception calling juju status command. {}".format(e))
+
+    def list_models(self):
+        """
+        Gets the output of juju list-models
+        :returns dict: the above format       
+        """
+        models = None
+
+        if os.path.isfile('/snap/bin/juju'):
+            cmd = ['/snap/bin/juju', 'list-models']
+        elif os.path.isfile("/usr/bin/juju"):
+            cmd = ['/usr/bin/juju', 'list-models']
+        else:
+            cmd = ['snap run juju', 'list-models']
+
+        try:
+            models = subprocess.check_output(cmd).decode("utf-8")
+        except subprocess.CalledProcessError as e:
+            print("Exception calling juju status command. {}".format(e))
+
+        return models
+
+    def get_model_and_sizes(self):
+        """
+        From the output of juju list-models we create a dict of the format
+        {
+          'model-name': machine-count
+          'model-name': machine-count
+          'model-name': machine-count
+        }
+        :returns dict: the above format       
+        """
+        models = self.list_models().split('\n')
+        modelsDict = {}
+        machinesColnum = 0
+
+        for line in models:
+            if line.strip() == "":
+                continue
+
+            if line.startswith('Controller') and machinesColnum == 0:
+                continue
+
+            line  = line.replace('\n', ' ').replace('\r', '')
+            cols = re.split('\s{2,100}', line)
+
+            if machinesColnum == 0:
+                for col in cols:
+                    if col == "Machines":
+                        break 
+                    machinesColnum += 1
+            else:
+                modelsDict[cols[0]] = int(cols[machinesColnum])
+
+        return modelsDict
+
+    def switch_to_largest_model(self):
+        """
+        Looks through a dict of models in format 
+        {
+          'model-name': machine-count
+          'model-name': machine-count
+          'model-name': machine-count
+        }
+        Determiens the largest model from the machine count
+        Then calls switch_model        
+        """
+        largest = -1
+        largestModel = None
+        models = self.get_model_and_sizes()
+
+        if len(models) == 0:
+            print("No models found ?????")
+            return
+
+        for k,v in models.items():
+            if v > largest:
+                largest = v
+                largestModel = k
+
+        if "*" not in largestModel:
+            self.switch_model(largestModel)
+        else:
+            print("Largest model already selected: " + largestModel)
+
     def get_report(self, running=False):
         """
         Get the json report for running machines retrieved using Juju cli.
@@ -485,7 +713,7 @@ class Juju(object):
         :param running: If it is set to true only machines with status 'running' will be added to the report
         :return: json report
         """
-
+        self.switch_to_largest_model()
         machines = self._list_machines()
         juju_machines = []
         for m in machines: