Add qa test for legacy (< v5) zone fills

Disable tests for .brd (legacy file format) fill for now.

qa/tests/cli/test_pcb.py

@@ -0,0 +1,73 @@
+#
+# This program source code file is part of KiCad, a free EDA CAD application.
+#
+# Copyright (C) 2023 Mark Roszko <mark.roszko@gmail.com>
+# Copyright (C) 2023 Roberto Fernandez Bautista <roberto.fer.bau@gmail.com>
+# Copyright (C) 2023 KiCad Developers
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+#  MA 02110-1301, USA.
+#
+
+import utils
+from pathlib import Path
+import pytest
+import re
+from typing import List
+from conftest import KiTestFixture
+
+
+@pytest.mark.parametrize("test_file,output_dir,layers_to_test",
+                          [
+                            ("cli/artwork_generation_regressions/ZoneFill-4.0.7.kicad_pcb",  "artwork_generation_regressions/ZoneFill-4.0.7",  ["F.Cu","B.Cu"]),
+                            #("cli/artwork_generation_regressions/ZoneFill-Legacy.kicad_pcb", "artwork_generation_regressions/ZoneFill-Legacy", ["F.Cu","B.Cu"])
+                          ])
+def test_pcb_export_svg( kitest: KiTestFixture,
+                         test_file: str,
+                         output_dir: str,
+                         layers_to_test: List[str] ):
+    
+    input_file = kitest.get_data_file_path( test_file )
+    
+    for layername in layers_to_test:
+        layerNameFixed = "-" + layername.replace( ".", "_" ) 
+        generated_svg_dir = str( kitest.get_output_path( "cli/{}/".format( output_dir ) ) )
+        generated_svg_name = Path( input_file ).stem + layerNameFixed + "-generated.svg"
+        generated_svg_path = Path( generated_svg_dir + "/" + generated_svg_name )
+
+        command = ["kicad-cli", "pcb", "export", "svg", "--page-size-mode", "1",#Current page size
+                   "--exclude-drawing-sheet", "--black-and-white", "--layers", layername]
+        command.append( "-o" )
+        command.append( str( generated_svg_path ) )
+        command.append( input_file )
+
+        if generated_svg_path.exists():
+            generated_svg_path.unlink()
+
+        assert not generated_svg_path.exists()
+
+        stdout, stderr, exitcode = utils.run_and_capture( command )
+
+        assert exitcode == 0
+        #don't assert stderr (legacy fills will have errors)
+        assert stdout is not None
+        assert generated_svg_path.exists()
+
+        kitest.add_attachment( generated_svg_path )
+
+        svg_source_path = str( Path( input_file ).with_suffix( "" ) )
+        svg_source_path += layerNameFixed + ".svg"
+
+        assert utils.svgs_are_equivalent( str( generated_svg_path ), svg_source_path, 1200 )

qa/tests/cli/test_sch.py

@@ -23,51 +23,10 @@
 import utils
 import cairosvg
 import re
-import os
 from pathlib import Path
 import pytest
 from typing import List
-import platform
-from PIL import Image, ImageChops, ImageFilter
-import numpy as np
 
-def images_are_equal( image1: str, image2: str ):
-    image1 = Image.open( image1 )
-    image2 = Image.open( image2 )
-
-    if image1.size != image2.size:
-        return False
-
-    if image1.mode != image2.mode:
-        return False
-
-    sum = np.sum( ( np.asarray ( image1 ).astype( np.float32 ) - np.asarray( image2 ).astype( np.float32 ) ) ** 2.0 )
-    retval = True
-
-    if sum != 0.0:
-        # images are not identical - lets allow 1 pixel error difference (for curved edges)
-
-        diff = ImageChops.difference( image1, image2 )
-        diffgray=diff.convert("L")
-        diffThresholded=diffgray.point(lambda x: 255 if x > 1 else 0)
-        diffBinary=diffThresholded.convert("1")
-
-        # erode binary image by 1 pixel
-        diffEroded = diffBinary.filter(ImageFilter.MinFilter(3))
-        
-        erodedSum = np.sum( np.asarray ( diffEroded ).astype( np.float32 ) )
-
-        retval = erodedSum == 0
-
-        if not retval:
-            diff_name = image1.filename + ".diff1.png"
-            diff.save( diff_name )
-            diffEroded_name = image1.filename + ".diffEroded_erodedsum" + str(erodedSum)+ ".png"
-            diffEroded.convert("RGB")
-            diffEroded.save( diffEroded_name )
-
-
-    return retval
 
 @pytest.mark.parametrize("test_file,output_dir,compare_fn,cli_args",
                             [("cli/basic_test/basic_test.kicad_sch", "basic_test", "cli/basic_test/basic_test.png", []),
@@ -109,7 +68,7 @@ def test_sch_export_svg( kitest,
 
     cairosvg.svg2png( url=str( output_svg_path ), write_to=str( png_converted_from_svg_path ), dpi=1200 )
 
-    assert images_are_equal( png_converted_from_svg_path, compare_file_path  )
+    assert utils.images_are_equal( png_converted_from_svg_path, compare_file_path  )
 
 
 @pytest.mark.parametrize("test_file,output_fn,line_skip_count,skip_compare,cli_args",

qa/tests/cli/utils.py

@@ -21,10 +21,13 @@
 #
 
 import difflib
+import cairosvg
 import logging
 import subprocess
-import os
 from typing import Tuple
+from pathlib import Path
+from PIL import Image, ImageChops, ImageFilter
+import numpy as np
 
 logger = logging.getLogger("cli_util")
 
@@ -57,4 +60,65 @@ def textdiff_files( golden_filepath: str, new_filepath: str, skip: int = 0 ) ->
         logger.info( "Text diff found:" )
         logger.info( diff_text )
 
-    return diff_text == ""
+    return diff_text == ""
+
+
+def images_are_equal( image1: str, image2: str ) -> bool:
+    # Increase limit to ~500MB uncompressed
+    Image.MAX_IMAGE_PIXELS=2 * 1024 * 1024 * 1024 // 4 // 3
+
+    image1 = Image.open( image1 )
+    image2 = Image.open( image2 )
+
+    if image1.size != image2.size:
+        return False
+
+    if image1.mode != image2.mode:
+        return False
+
+    sum = np.sum( ( np.asarray ( image1 ).astype( np.float32 ) - np.asarray( image2 ).astype( np.float32 ) ) ** 2.0 )
+    retval = True
+
+    if sum != 0.0:
+        # images are not identical - lets allow 1 pixel error difference (for curved edges)
+
+        diff = ImageChops.difference( image1, image2 )
+        diffThresholded = diff.point( lambda x: 255 if x > 1 else 0 )
+
+        # erode binary image by 1 pixel
+        diffEroded = diffThresholded.filter(ImageFilter.MinFilter(3))
+        
+        erodedSum = np.sum( np.asarray( diffEroded ).astype( np.float32 ) )
+
+        retval = erodedSum == 0
+
+        # Save images
+        diff_name = image1.filename + ".diff1.png"
+        diff.save( diff_name )
+        diff_name = image1.filename + ".diffthresholded.png"
+        diffThresholded.save( diff_name )
+        diffEroded_name = image1.filename + ".diffEroded_erodedsum" + str(erodedSum)+ ".png"
+        diffEroded.save( diffEroded_name )
+
+
+    return retval
+
+
+def svgs_are_equivalent( svg_generated_path : str, svg_source_path : str, comparison_dpi : int ) -> bool:
+    
+    png_generated_path = Path( svg_generated_path ).with_suffix( ".png" )
+
+    # store source png in same folder as generated, easier to compare
+    source_stem = Path( svg_source_path ).stem
+    png_source_path = Path( svg_generated_path ).with_stem( source_stem + "-source").with_suffix( ".png" )
+
+    cairosvg.svg2png( url=svg_generated_path,
+                      write_to=str( png_generated_path ),
+                      dpi=comparison_dpi )
+    
+    cairosvg.svg2png( url=svg_source_path,
+                     write_to=str( png_source_path ),
+                      dpi=comparison_dpi )
+
+    return images_are_equal( str( png_generated_path ), str( png_source_path ) )
+