compare metadata fields as python dict in package tests (#695)

cli/tests/integrations/common.py

@@ -1,3 +1,4 @@
+import base64
 import collections
 import contextlib
 import json
@@ -549,3 +550,13 @@ def config_unset(key, env=None):
 
     assert returncode == 0
     assert stdout == b''
+
+
+def base64_to_dict(byte_string):
+    """
+    :param byte_string: base64 encoded string
+    :type byte_string: str
+    :return: python dictionary decoding of byte_string
+    :rtype dict
+    """
+    return json.loads(base64.b64decode(byte_string).decode('utf-8'))

cli/tests/integrations/test_package.py

@@ -8,10 +8,12 @@ from dcos import subcommand
 
 import pytest
 
-from .common import (assert_command, assert_lines, delete_zk_node,
-                     delete_zk_nodes, exec_command, file_bytes, file_json,
-                     get_services, package_install, package_uninstall,
-                     service_shutdown, wait_for_service, watch_all_deployments)
+from .common import (assert_command, assert_lines, base64_to_dict,
+                     delete_zk_node, delete_zk_nodes, exec_command,
+                     file_bytes, file_json,
+                     get_services, package_install,
+                     package_uninstall, service_shutdown,
+                     wait_for_service, watch_all_deployments)
 
 
 def setup_module(module):
@@ -191,7 +193,13 @@ def test_describe_render():
     actual_labels = stdout_.pop("labels", None)
 
     for label, value in expected_labels.items():
-        assert value == actual_labels.get(label)
+        if label == "DCOS_PACKAGE_METADATA":
+            # We covert the metadata into a dictionary
+            # so that failures in equality are more descriptive
+            assert base64_to_dict(value) == \
+                   base64_to_dict(actual_labels.get(label))
+        else:
+            assert value == actual_labels.get(label)
 
     assert stdout == stdout_
     assert stderr == b''
@@ -252,7 +260,13 @@ def test_describe_options():
     actual_labels = stdout_.pop("labels", None)
 
     for label, value in expected_labels.items():
-        assert value == actual_labels.get(label)
+        if label == "DCOS_PACKAGE_METADATA":
+            # We covert the metadata into a dictionary
+            # so that failures in equality are more descriptive
+            assert base64_to_dict(value) == \
+                   base64_to_dict(actual_labels.get(label))
+        else:
+            assert value == actual_labels.get(label)
 
     assert stdout == stdout_
     assert stderr == b''
@@ -384,21 +398,27 @@ def test_package_metadata():
     _install_helloworld()
 
     # test marathon labels
-    expected_metadata = (b'eyJ3ZWJzaXRlIjoiaHR0cHM6Ly9naXRodWIuY29tL21lc29zcG'
-                         b'hlcmUvZGNvcy1oZWxsb3dvcmxkIiwibmFtZSI6ImhlbGxvd29y'
-                         b'bGQiLCJwb3N0SW5zdGFsbE5vdGVzIjoiQSBzYW1wbGUgcG9zdC'
-                         b'1pbnN0YWxsYXRpb24gbWVzc2FnZSIsImRlc2NyaXB0aW9uIjoi'
-                         b'RXhhbXBsZSBEQ09TIGFwcGxpY2F0aW9uIHBhY2thZ2UiLCJwYW'
-                         b'NrYWdpbmdWZXJzaW9uIjoiMi4wIiwidGFncyI6WyJtZXNvc3Bo'
-                         b'ZXJlIiwiZXhhbXBsZSIsInN1YmNvbW1hbmQiXSwibWFpbnRhaW'
-                         b'5lciI6InN1cHBvcnRAbWVzb3NwaGVyZS5pbyIsInNlbGVjdGVk'
-                         b'IjpmYWxzZSwiZnJhbWV3b3JrIjpmYWxzZSwidmVyc2lvbiI6Ij'
-                         b'AuMS4wIiwicHJlSW5zdGFsbE5vdGVzIjoiQSBzYW1wbGUgcHJl'
-                         b'LWluc3RhbGxhdGlvbiBtZXNzYWdlIn0=')
+    expected_metadata = {
+        'maintainer': 'support@mesosphere.io',
+        'framework': False,
+        'name': 'helloworld',
+        'version': '0.1.0',
+        'packagingVersion': '2.0',
+        'preInstallNotes': 'A sample pre-installation message',
+        'selected': False,
+        'website': 'https://github.com/mesosphere/dcos-helloworld',
+        'description': 'Example DCOS application package',
+        'tags': ['mesosphere', 'example', 'subcommand'],
+        'postInstallNotes': 'A sample post-installation message'
+    }
 
-    expected_command = b"""eyJwaXAiOlsiZGNvczwxLjAiLCJnaXQraHR0cHM6Ly9naXRodWI\
-uY29tL21lc29zcGhlcmUvZGNvcy1oZWxsb3dvcmxkLmdpdCNkY29zLWhlbGxvd29ybGQ9MC4xLjAiX\
-X0="""
+    expected_command = {
+        'pip': [
+            'dcos<1.0',
+            'git+https://github.com/mesosphere/' +
+            'dcos-helloworld.git#dcos-helloworld=0.1.0'
+        ]
+    }
 
     expected_source = b"""https://github.com/mesosphere/universe/archive/\
 cli-test-4.zip"""
@@ -417,10 +437,10 @@ cli-test-4.zip"""
 
     # these labels are different for cosmos b/c of null problem
     # we have cosmos tests for test, and will fix in issue 431
-    assert expected_metadata == six.b(
-        app_labels.get('DCOS_PACKAGE_METADATA'))
-    assert expected_command == six.b(
-        app_labels.get('DCOS_PACKAGE_COMMAND'))
+    assert expected_metadata == base64_to_dict(six.b(
+        app_labels.get('DCOS_PACKAGE_METADATA')))
+    assert expected_command == base64_to_dict(six.b(
+        app_labels.get('DCOS_PACKAGE_COMMAND')))
 
     # test local package.json
     package = {