scm: suppress default properties when pretty printing

jkloetzke · jkloetzke · commit 293f2902e04f · 2025-03-31T20:45:42.000+02:00
When doing a pretty-print of the SCM properties, the user is not
interested in default values. We can safely suppress them to reduce the
output clutter.
diff --git a/pym/bob/scm/cvs.py b/pym/bob/scm/cvs.py
@@ -31,6 +31,10 @@ class CvsScm(Scm):
     # Layers have no "dir" and no "if"
     LAYERS_SCHEMA = schema.Schema({ **__SCHEMA })
 
+    DEFAULT_VALUES = {
+        "dir" : ".",
+    }
+
     # Checkout using CVS
     # - mandatory parameters: cvsroot, module
     # - optional parameters: rev, dir (dir is required if there are multiple checkouts)
@@ -42,14 +46,19 @@ def __init__(self, spec, overrides=[]):
         self.__dir = spec.get("dir", ".")
 
     def getProperties(self, isJenkins, pretty=False):
-        ret = super().getProperties(isJenkins)
+        ret = super().getProperties(isJenkins, pretty)
         ret.update({
             'scm' : 'cvs',
             'cvsroot' : self.__cvsroot,
             'module' : self.__module,
             'rev' : self.__rev,
             'dir' : self.__dir
         })
+
+        if pretty:
+            ret = { k : v for k, v in ret.items()
+                    if v is not None and v != self.DEFAULT_VALUES.get(k) }
+
         return ret
 
     async def invoke(self, invoker):
diff --git a/pym/bob/scm/git.py b/pym/bob/scm/git.py
@@ -104,6 +104,17 @@ class GitScm(Scm):
 
     REMOTE_PREFIX = "remote-"
 
+    DEFAULT_VALUES = {
+        'dir' : ".",
+        'retries' : 0,
+        'sslVerify' : True,
+        'submodules' : False,
+        'recurseSubmodules' : False,
+        'shallowSubmodules' : True,
+        'dissociate' : False,
+        'rebase' : False,
+    }
+
     def __init__(self, spec, overrides=[], stripUser=None, useBranchAndCommit=False):
         super().__init__(spec, overrides)
         self.__url = spec["url"]
@@ -149,7 +160,7 @@ def __resolveReferences(self, alt):
                 self.__references]]
 
     def getProperties(self, isJenkins, pretty=False):
-        properties = super().getProperties(isJenkins)
+        properties = super().getProperties(isJenkins, pretty)
 
         if self.__commit:
             rev = self.__commit
@@ -182,6 +193,11 @@ def getProperties(self, isJenkins, pretty=False):
         })
         for key, val in self.__remotes.items():
             properties.update({GitScm.REMOTE_PREFIX+key : val})
+
+        if pretty:
+            properties = { k : v for k, v in properties.items()
+                           if v is not None and v != self.DEFAULT_VALUES.get(k) }
+
         return properties
 
     def _getGitConfigOptions(self):
diff --git a/pym/bob/scm/imp.py b/pym/bob/scm/imp.py
@@ -127,6 +127,11 @@ class ImportScm(Scm):
 
     SCHEMA = schema.Schema({**__SCHEMA, **DEFAULTS})
 
+    DEFAULT_VALUES = {
+        "dir" : ".",
+        "recipeRelative" : False,
+    }
+
     def __init__(self, spec, overrides=[], pruneDefault=None, fixDigestBug=False, projectRoot=""):
         super().__init__(spec, overrides)
         self.__url = spec["url"]
@@ -142,7 +147,7 @@ def _getSrcDir(self):
         return os.path.join(rootDir, self.__url)
 
     def getProperties(self, isJenkins, pretty=False):
-        ret = super().getProperties(isJenkins)
+        ret = super().getProperties(isJenkins, pretty)
         ret.update({
             'scm' : 'import',
             'url' : self.__url,
@@ -152,8 +157,13 @@ def getProperties(self, isJenkins, pretty=False):
         })
         if isJenkins:
             ret['__data'] = packTree(self._getSrcDir())
-        else:
+        elif not pretty:
             ret['__projectRoot'] = self.__projectRoot
+
+        if pretty:
+            ret = { k : v for k, v in ret.items()
+                    if v is not None and v != self.DEFAULT_VALUES.get(k) }
+
         return ret
 
     async def invoke(self, invoker):
diff --git a/pym/bob/scm/scm.py b/pym/bob/scm/scm.py
@@ -237,13 +237,15 @@ def _getRecipe(self):
     def getSource(self):
         return self.__source
 
-    def getProperties(self, isJenkins):
+    def getProperties(self, isJenkins, pretty):
         # XXX: keep in sync with SYNTHETIC_SCM_PROPS
-        return {
-            "__source" : self.__source,
+        ret = {
             "recipe" : self.__recipe,
             "overridden" : bool(self.__overrides),
         }
+        if not pretty:
+            ret["__source"] = self.__source
+        return ret
 
     @abstractmethod
     async def invoke(self, invoker):
diff --git a/pym/bob/scm/svn.py b/pym/bob/scm/svn.py
@@ -43,6 +43,11 @@ class SvnScm(Scm):
         **__DEFAULTS,
     })
 
+    DEFAULT_VALUES = {
+        "dir" : ".",
+        "sslVerify" : True,
+    }
+
     def __init__(self, spec, overrides=[]):
         super().__init__(spec, overrides)
         self.__url = spec["url"]
@@ -51,7 +56,7 @@ def __init__(self, spec, overrides=[]):
         self.__sslVerify = spec.get('sslVerify', True)
 
     def getProperties(self, isJenkins, pretty=False):
-        ret = super().getProperties(isJenkins)
+        ret = super().getProperties(isJenkins, pretty)
         ret.update({
             'scm' : 'svn',
             "url" : self.__url,
@@ -60,6 +65,11 @@ def getProperties(self, isJenkins, pretty=False):
         })
         if self.__revision:
             ret["revision"] = self.__revision
+
+        if pretty:
+            ret = { k : v for k, v in ret.items()
+                    if v is not None and v != self.DEFAULT_VALUES.get(k) }
+
         return ret
 
     async def invoke(self, invoker):
diff --git a/pym/bob/scm/url.py b/pym/bob/scm/url.py
@@ -351,6 +351,13 @@ class UrlScm(Scm):
         "zip"  : ZipExtractor,
     }
 
+    DEFAULT_VALUES = {
+        "dir" : ".",
+        "extract" : "auto",
+        "stripComponents" : 0,
+        "sslVerify" : True,
+    }
+
     def __init__(self, spec, overrides=[], stripUser=None,
                  preMirrors=[], fallbackMirrors=[], defaultFileMode=None,
                  separateDownload=False):
@@ -395,7 +402,7 @@ def __init__(self, spec, overrides=[], stripUser=None,
         self.__separateDownload = spec.get("__separateDownload", separateDownload)
 
     def getProperties(self, isJenkins, pretty=False):
-        ret = super().getProperties(isJenkins)
+        ret = super().getProperties(isJenkins, pretty)
         ret.update({
             'scm' : 'url',
             'url' : self.__url,
@@ -409,12 +416,20 @@ def getProperties(self, isJenkins, pretty=False):
             'sslVerify' : self.__sslVerify,
             'retries' : self.__retries,
             'preMirrors' : self.__getPreMirrorsUrls(),
-            '__preMirrorsUpload' : self.__getPreMirrorsUpload(),
             'fallbackMirrors' : self.__getFallbackMirrorsUrls(),
-            '__fallbackMirrorsUpload' : self.__getFallbackMirrorsUpload(),
             'fileMode' : dumpMode(self.__fileMode) if pretty else self.__fileMode,
-            '__separateDownload': self.__separateDownload,
         })
+        if not pretty:
+            ret.update({
+                '__preMirrorsUpload' : self.__getPreMirrorsUpload(),
+                '__fallbackMirrorsUpload' : self.__getFallbackMirrorsUpload(),
+                '__separateDownload': self.__separateDownload,
+            })
+
+        if pretty:
+            ret = { k : v for k, v in ret.items()
+                    if v is not None and v != self.DEFAULT_VALUES.get(k) }
+
         return ret
 
     def __applyMirrors(self, mirrors):
