cli/info: better output of connection parameters

before:

    $ slapos service info slapos-sr-testing
    Software Release URL: /srv/slapgrid/slappart15/srv/project/slapos/software/slapos-sr-testing/software.cfg
    Instance state: busy
    Instance parameters:
    {}
    Connection parameters:
    ("<?xml version='1.0' encoding='utf-8'?>\n"
     '<instance>\n'
     '  <parameter '
     'id="environment-script">/srv/slapgrid/slappart15/srv/runner/instance/slappart7/etc/slapos-local-development-environment.sh</parameter>\n'

after:

    $ slapos service info slapos-sr-testing
    Software Release URL: /srv/slapgrid/slappart15/srv/project/slapos/software/slapos-sr-testing/software.cfg
    Instance state: busy
    Instance parameters:
    {}
    Connection parameters:
    {'environment-script': '/srv/slapgrid/slappart15/srv/runner/instance/slappart7/etc/slapos-local-development-environment.sh'}

slapos/cli/info.py

@@ -27,6 +27,7 @@
 #
 ##############################################################################
 
+import json
 import pprint
 import sys
 
@@ -35,6 +36,14 @@ from slapos.cli.config import ClientConfigCommand
 from slapos.client import init, ClientConfig
 from slapos.slap import ResourceNotReady, NotFoundError
 
+from slapos.util import (
+  SoftwareReleaseSchema,
+  SoftwareReleaseSerialisation,
+  StrPrettyPrinter,
+  UndefinedSerializationError,
+  xml2dict,
+)
+
 
 class InfoCommand(ClientConfigCommand):
     """get status, software_release and parameters of an instance"""
@@ -70,10 +79,21 @@ def do_info(logger, conf, local):
         logger.warning('Instance %s does not exist.', conf.reference)
         return(2)
 
+    software_schema = SoftwareReleaseSchema(
+        instance._software_release_url,
+        getattr(instance, '_software_type', None))
+    connection_parameter_dict = xml2dict(instance._connection_dict)
+    try:
+        software_serialisation = software_schema.getSerialisation()
+    except UndefinedSerializationError:
+        software_serialisation = SoftwareReleaseSerialisation.JsonInXml
+    if software_serialisation == SoftwareReleaseSerialisation.JsonInXml:
+        if '_' in connection_parameter_dict:
+            connection_parameter_dict = json.loads(connection_parameter_dict['_'])
+
     logger.info('Software Release URL: %s', instance._software_release_url)
     logger.info('Instance state: %s', instance._requested_state)
     logger.info('Instance parameters:')
-    logger.info(pprint.pformat(instance._parameter_dict))
+    logger.info(StrPrettyPrinter().pformat(instance._parameter_dict))
     logger.info('Connection parameters:')
-    logger.info(pprint.pformat(instance._connection_dict))
-
+    logger.info(StrPrettyPrinter().pformat(connection_parameter_dict))

slapos/cli/request.py

@@ -41,7 +41,7 @@ from slapos.client import (ClientConfig, _getSoftwareReleaseFromSoftwareString,
                            init)
 from slapos.slap import ResourceNotReady
 from slapos.util import (SoftwareReleaseSchema, SoftwareReleaseSerialisation,
-                         UndefinedSerializationError)
+                         UndefinedSerializationError, StrPrettyPrinter)
 
 try:
     from typing import IO, Dict
@@ -138,16 +138,6 @@ class RequestCommand(ClientConfigCommand):
         do_request(self.app.log, conf, local)
 
 
-# BBB on python3 we can use pprint.pformat
-class StrPrettyPrinter(pprint.PrettyPrinter):
-  """A PrettyPrinter which produces consistent output on python 2 and 3
-  """
-  def format(self, object, context, maxlevels, level):
-    if six.PY2 and isinstance(object, six.text_type):
-      object = object.encode('utf-8')
-    return pprint.PrettyPrinter.format(self, object, context, maxlevels, level)
-
-
 def do_request(logger, conf, local):
     logger.info('Requesting %s as instance of %s...',
                 conf.reference, conf.software_url)

slapos/tests/test_cli.py

@@ -615,25 +615,41 @@ class TestCliList(CliMixin):
 
 @patch.object(slapos.slap.slap, 'registerOpenOrder', return_value=slapos.slap.OpenOrder())
 class TestCliInfo(CliMixin):
-  def test_info(self, _):
+
+  def test_info_xml_serialisation(self, _):
+    self._test_info_output(
+      slapos.slap.SoftwareInstance(
+        _software_release_url='SR1',
+        _requested_state='mystate',
+        _connection_dict=
+        '<?xml version=\'1.0\' encoding=\'utf-8\'?>\n<instance>\n  <parameter id="myconnectionparameter">value1</parameter>\n</instance>\n',
+        _parameter_dict={'myinstanceparameter': 'value2'}))
+
+  def test_info_json_in_serialisation(self, _):
+    self._test_info_output(
+      slapos.slap.SoftwareInstance(
+        _software_release_url='SR1',
+        _requested_state='mystate',
+        _connection_dict=
+        '<?xml version=\'1.0\' encoding=\'utf-8\'?>\n<instance>\n  <parameter id="_">{"myconnectionparameter": "value1"}</parameter>\n</instance>\n',
+        _parameter_dict={'myinstanceparameter': 'value2'}))
+
+  def _test_info_output(self, instance):
     """
     Test "slapos service info" command output.
     """
     setattr(self.conf, 'reference', 'instance1')
-    instance = slapos.slap.SoftwareInstance(
-        _software_release_url='SR1',
-        _requested_state = 'mystate',
-        _connection_dict = {'myconnectionparameter': 'value1'},
-        _parameter_dict = {'myinstanceparameter': 'value2'}
-    )
-    with patch.object(slapos.slap.OpenOrder, 'getInformation', return_value=instance):
+    with patch.object(slapos.slap.OpenOrder, 'getInformation',
+                      return_value=instance):
       slapos.cli.info.do_info(self.logger, self.conf, self.local)
 
     self.logger.info.assert_any_call(pprint.pformat(instance._parameter_dict))
-    self.logger.info.assert_any_call('Software Release URL: %s', instance._software_release_url)
-    self.logger.info.assert_any_call('Instance state: %s', instance._requested_state)
-    self.logger.info.assert_any_call(pprint.pformat(instance._parameter_dict))
-    self.logger.info.assert_any_call(pprint.pformat(instance._connection_dict))
+    self.logger.info.assert_any_call(
+      'Software Release URL: %s', instance._software_release_url)
+    self.logger.info.assert_any_call(
+      'Instance state: %s', instance._requested_state)
+    self.logger.info.assert_any_call("{'myinstanceparameter': 'value2'}", )
+    self.logger.info.assert_any_call("{'myconnectionparameter': 'value1'}")
 
   def test_unknownReference(self, _):
     """

slapos/tests/test_slapproxy.py

@@ -1305,7 +1305,7 @@ class TestCliInformation(CliMasterMixin):
         'Instance parameters:',
         '{}',
         'Connection parameters:',
-        'None'
+        '{}'
       ],
     )
     output1 = self.cliDoSlapos(('service', 'info', 'MyInstance1'), stderr=subprocess.DEVNULL)
@@ -1317,7 +1317,7 @@ class TestCliInformation(CliMasterMixin):
         'Instance parameters:',
         "{'couscous': 'hello'}",
         'Connection parameters:',
-        'None'
+        '{}'
       ],
     )
     try:

slapos/util.py

@@ -32,6 +32,7 @@ import errno
 import hashlib
 import json
 import os
+import pprint
 import shutil
 import socket
 import sqlite3
@@ -474,3 +475,13 @@ class SoftwareReleaseSchema(object):
           instance=instance,
           schema=self.getInstanceRequestParameterSchema(),
       )
+
+
+# BBB on python3 we can use pprint.pformat
+class StrPrettyPrinter(pprint.PrettyPrinter):
+  """A PrettyPrinter which produces consistent output on python 2 and 3
+  """
+  def format(self, object, context, maxlevels, level):
+    if six.PY2 and isinstance(object, six.text_type):
+      object = object.encode('utf-8')
+    return pprint.PrettyPrinter.format(self, object, context, maxlevels, level)

[Xavier Thompson]

@jerome, slapos node info <reference> crashes on this line for me with slapos.core 1.8.5:

root@ors-sr:~$ slapos service info ors19-nr
/opt/slapos/eggs/urllib3-1.26.9-py3.8.egg/urllib3/connectionpool.py:1043: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.vifib.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
/opt/slapos/eggs/urllib3-1.26.9-py3.8.egg/urllib3/connectionpool.py:1043: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.vifib.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
/opt/slapos/eggs/urllib3-1.26.9-py3.8.egg/urllib3/connectionpool.py:1043: InsecureRequestWarning: Unverified HTTPS request is being made to host 'api.vifib.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
  warnings.warn(
'list' object has no attribute 'encode'
Traceback (most recent call last):
  File "/root/slapos.core/slapos/cli/entry.py", line 305, in run_subcommand
    result = cmd.run(parsed_args)
  File "/root/slapos.core/slapos/cli/command.py", line 56, in run
    return self.take_action(parsed_args)
  File "/root/slapos.core/slapos/cli/info.py", line 64, in take_action
    exit_code = do_info(self.app.log, conf, local)
  File "/root/slapos.core/slapos/cli/info.py", line 85, in do_info
    connection_parameter_dict = xml2dict(instance._connection_dict)
  File "/root/slapos.core/slapos/util.py", line 252, in xml2dict
    tree = etree.fromstring(str2bytes(xml))
  File "/root/slapos.core/slapos/util.py", line 227, in str2bytes
    return s.encode()
AttributeError: 'list' object has no attribute 'encode'

@Just1 experienced the same issue I think.

[Jérome Perrin]

We started to discuss this on https://www.erp5.com/project_section/vifib/forum/slapos-service-info-not-working-with-slapos-master-01gH0x2Teh , let's continue the discussion there.

I'll be happy to fix the code once we agree on what is the expected format.