[Diff] Added two mechanisms to compare PCB variants in one output

- Taking pairs
- Using a reference

Related to #278

README.md

@@ -1520,17 +1520,21 @@ Notes:
                             Note that using it you could potentially lose modified files. For more information
                             read https://stackoverflow.com/questions/1248029/git-pull-error-entry-foo-not-uptodate-cannot-merge.
         - `fuzz`: [number=5] [0,100] Color tolerance (fuzzyness) for the `stats` mode.
-        - `new`: [string=''] The file you want to compare. Leave it blank for the current PCB/SCH.
+        - `new`: [string|list(string)] The file you want to compare. Leave it blank for the current PCB/SCH.
-        - `new_type`: [string='file'] [git,file,output] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
+                 A list is accepted only for the `multivar` type.
+        - `new_type`: [string='file'] [git,file,output,multivar] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
                       Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output.
+                      Use `multivar` to compare a set of variants, in this mode `new` is the list of variants.
+                      If `old` is also `multivar` then it becomes the reference, otherwise we compare using pairs of variants.
         - `old`: [string='HEAD'] Reference file. When using git use `HEAD` to refer to the last commit.
                  Use `HEAD~` to refer the previous to the last commit.
                  As `HEAD` is for the whole repo you can use `KIBOT_LAST-n` to make
                  reference to the changes in the PCB/SCH. The `n` value is how many
                  changes in the history you want to go back. A 0 is the same as `HEAD`,
                  a 1 means the last time the PCB/SCH was changed, etc.
-        - `old_type`: [string='git'] [git,file,output] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
+        - `old_type`: [string='git'] [git,file,output,multivar] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
                       Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output.
+                      Use `multivar` to specify a reference file when `new_type` is also `multivar`.
         - `pcb`: [boolean=true] Compare the PCB, otherwise compare the schematic.
         - `threshold`: [number=0] [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a
                        difference bigger than the indicated value will make the diff fail.

docs/samples/generic_plot.kibot.yaml

@@ -437,10 +437,13 @@ outputs:
       force_checkout: false
       # [number=5] [0,100] Color tolerance (fuzzyness) for the `stats` mode
       fuzz: 5
-      # [string=''] The file you want to compare. Leave it blank for the current PCB/SCH
+      # [string|list(string)] The file you want to compare. Leave it blank for the current PCB/SCH.
+      # A list is accepted only for the `multivar` type
       new: ''
-      # [string='file'] [git,file,output] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
+      # [string='file'] [git,file,output,multivar] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
-      # Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output
+      # Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output.
+      # Use `multivar` to compare a set of variants, in this mode `new` is the list of variants.
+      # If `old` is also `multivar` then it becomes the reference, otherwise we compare using pairs of variants
       new_type: 'file'
       # [string='HEAD'] Reference file. When using git use `HEAD` to refer to the last commit.
       # Use `HEAD~` to refer the previous to the last commit.
@@ -449,8 +452,9 @@ outputs:
       # changes in the history you want to go back. A 0 is the same as `HEAD`,
       # a 1 means the last time the PCB/SCH was changed, etc
       old: 'HEAD'
-      # [string='git'] [git,file,output] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
+      # [string='git'] [git,file,output,multivar] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
-      # Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output
+      # Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output.
+      # Use `multivar` to specify a reference file when `new_type` is also `multivar`
       old_type: 'git'
       # [string='%f-%i%I%v.%x'] Filename for the output (%i=diff_pcb/diff_sch, %x=pdf). Affected by global options
       output: '%f-%i%I%v.%x'

kibot/out_diff.py

@@ -20,6 +20,7 @@ Dependencies:
     version: 2.0.0
 """
 from hashlib import sha1
+from itertools import combinations
 import os
 import re
 from shutil import rmtree, copy2
@@ -53,13 +54,17 @@ class DiffOptions(BaseOptions):
                 changes in the history you want to go back. A 0 is the same as `HEAD`,
                 a 1 means the last time the PCB/SCH was changed, etc """
             self.old_type = 'git'
-            """ [git,file,output] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
+            """ [git,file,output,multivar] How to interpret the `old` name. Use `git` for a git hash, branch, etc.
-                Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output """
+                Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output.
+                Use `multivar` to specify a reference file when `new_type` is also `multivar` """
             self.new = ''
-            """ The file you want to compare. Leave it blank for the current PCB/SCH """
+            """ [string|list(string)] The file you want to compare. Leave it blank for the current PCB/SCH.
+                A list is accepted only for the `multivar` type """
             self.new_type = 'file'
-            """ [git,file,output] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
+            """ [git,file,output,multivar] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
-                Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output """
+                Use `file` for a file name. Use `output` to specify the name of a `pcb_variant` output.
+                Use `multivar` to compare a set of variants, in this mode `new` is the list of variants.
+                If `old` is also `multivar` then it becomes the reference, otherwise we compare using pairs of variants """
             self.cache_dir = ''
             """ Directory to cache the intermediate files. Leave it blank to disable the cache """
             self.diff_mode = 'red_green'
@@ -91,6 +96,16 @@ class DiffOptions(BaseOptions):
     def config(self, parent):
         super().config(parent)
         self._expand_id = 'diff'+('_pcb' if self.pcb else '_sch')
+        if self.new_type == 'multivar':
+            if isinstance(self.new, str):
+                raise KiPlotConfigurationError('`new` must be a list when using the `multivar` type')
+            if len(self.new) < 2:
+                raise KiPlotConfigurationError('`new` must contain at least two variants when using the `multivar` type')
+        else:
+            if isinstance(self.new, list):
+                raise KiPlotConfigurationError('`new` must be a single string for `{}` type'.format(self.new_type))
+        if self.old_type == 'multivar' and self.new_type != 'multivar':
+            raise KiPlotConfigurationError("`old_type` can't be `multivar` when `new_type` isn't (`{}`)".format(self.new_type))
 
     def get_targets(self, out_dir):
         return [self._parent.expand_filename(out_dir, self.output)]
@@ -330,6 +345,36 @@ class DiffOptions(BaseOptions):
                     f.write(str(la.id)+'\n')
         return incl_file
 
+    def do_compare(self, old, old_type, new, new_type, name):
+        dir_name = os.path.dirname(name)
+        file_name = os.path.basename(name)
+        # Populate the cache
+        old_hash = self.cache_obj(old, old_type)
+        gh1 = self.git_hash
+        new_hash = self.cache_obj(new, new_type)
+        gh2 = self.git_hash
+        # Compute the diff using the cache
+        cmd = [self.command, '--no_reader', '--new_file_hash', new_hash, '--old_file_hash', old_hash,
+               '--cache_dir', self.cache_dir, '--output_dir', dir_name, '--output_name', file_name,
+               '--diff_mode', self.diff_mode, '--fuzz', str(self.fuzz)]
+        if self.incl_file:
+            cmd.extend(['--layers', self.incl_file])
+        if self.threshold:
+            cmd.extend(['--threshold', str(self.threshold)])
+        cmd.extend([self.file_exist, self.file_exist])
+        if GS.debug_enabled:
+            cmd.insert(1, '-'+'v'*GS.debug_level)
+        run_command(cmd)
+        if self.add_link_id:
+            name_comps = os.path.splitext(name)
+            target = name_comps[0]+'_'+gh1+'-'+gh2+name_comps[1]
+            if self.copy_instead_of_link:
+                copy2(name, target)
+            else:
+                if os.path.isfile(target):
+                    os.remove(target)
+                os.symlink(os.path.basename(name), target)
+
     def run(self, name):
         self.command = self.ensure_tool('KiDiff')
         if self.old_type == 'git' or self.new_type == 'git':
@@ -345,42 +390,36 @@ class DiffOptions(BaseOptions):
         # A valid name, not really used
         if self.pcb:
             GS.check_pcb()
-            file = GS.pcb_file
+            self.file_exist = GS.pcb_file
         else:
             GS.check_sch()
-            file = GS.sch_file
+            self.file_exist = GS.sch_file
-        dir_name = os.path.dirname(name)
-        file_name = os.path.basename(name)
         self.incl_file = None
         try:
             # List of layers
             self.incl_file = self.create_layers_incl(self.layers)
-            # Populate the cache
+            if self.new_type == 'multivar' and self.old_type != 'multivar':
-            old_hash = self.cache_obj(self.old, self.old_type)
+                # Special case, we generate various files
-            gh1 = self.git_hash
+                base_id = self._expand_id
-            new_hash = self.cache_obj(self.new, self.new_type)
+                for pair in combinations(self.new, 2):
-            gh2 = self.git_hash
+                    logger.debug('Using variants '+str(pair))
-            # Compute the diff using the cache
+                    logger.info(' - {} vs {}'.format(pair[0], pair[1]))
-            cmd = [self.command, '--no_reader', '--new_file_hash', new_hash, '--old_file_hash', old_hash,
+                    self._expand_id = '{}_variants_{}_VS_{}'.format(base_id, pair[0], pair[1])
-                   '--cache_dir', self.cache_dir, '--output_dir', dir_name, '--output_name', file_name,
+                    name = self._parent.expand_filename(self._parent.output_dir, self.output)
-                   '--diff_mode', self.diff_mode, '--fuzz', str(self.fuzz)]
+                    self.do_compare(pair[0], 'output', pair[1], 'output', name)
-            if self.incl_file:
+                self._expand_id = base_id
-                cmd.extend(['--layers', self.incl_file])
+            elif self.new_type == 'multivar' and self.old_type == 'multivar':
-            if self.threshold:
+                # Special case, we generate various files
-                cmd.extend(['--threshold', str(self.threshold)])
+                base_id = self._expand_id
-            cmd.extend([file, file])
+                for new_variant in self.new:
-            if GS.debug_enabled:
+                    ref_name = self.old if self.old else 'current'
-                cmd.insert(1, '-'+'v'*GS.debug_level)
+                    logger.info(' - {} vs {}'.format(ref_name, new_variant))
-            run_command(cmd)
+                    self._expand_id = '{}_variant_{}'.format(base_id, new_variant)
-            if self.add_link_id:
+                    name = self._parent.expand_filename(self._parent.output_dir, self.output)
-                name_comps = os.path.splitext(name)
+                    self.do_compare(self.old, 'file', new_variant, 'output', name)
-                target = name_comps[0]+'_'+gh1+'-'+gh2+name_comps[1]
+                self._expand_id = base_id
-                if self.copy_instead_of_link:
+            else:
-                    copy2(name, target)
+                self.do_compare(self.old, self.old_type, self.new, self.new_type, name)
-                else:
-                    if os.path.isfile(target):
-                        os.remove(target)
-                    os.symlink(os.path.basename(name), target)
         finally:
             # Clean-up
             if remove_cache:

tests/yaml_samples/pcb_variant_1.kibot.yaml

@@ -3,6 +3,18 @@ kibot:
   version: 1
 
 variants:
+  - name: 'production'
+    comment: 'Production variant'
+    type: ibom
+    file_id: '_(production)'
+    variants_blacklist: T2
+
+  - name: 'test'
+    comment: 'Test variant'
+    type: ibom
+    file_id: '_(test)'
+    variants_blacklist: T1
+
   - name: 'default'
     comment: 'Default variant'
     type: ibom
@@ -10,18 +22,36 @@ variants:
 
 outputs:
   - name: 'pcb_default'
-    comment: "PCB w/variant"
+    comment: "PCB w/default variant"
     type: pcb_variant
     options:
       variant: default
       title: 'Hello %V'
 
+  - name: 'pcb_production'
+    comment: "PCB w/production variant"
+    type: pcb_variant
+    options:
+      variant: production
+      title: 'Hello %V'
+
+  - name: 'pcb_test'
+    comment: "PCB w/test variant"
+    type: pcb_variant
+    options:
+      variant: test
+      title: 'Hello %V'
+
   - name: 'diff_pcb'
     comment: "PCB difference with variant"
     type: diff
     layers: ['F.Cu', 'F.Fab']
     options:
-      old: pcb_default
+      # old: pcb_default
-      old_type: output
+      # old_type: output
+      old: ''
+      old_type: multivar
+      new: [pcb_default, pcb_production, pcb_test]
+      new_type: multivar
       cache_dir: .cache
-      add_link_id: true
+      # add_link_id: true