Seth Hillbrand
5a9d351400
The CLI BOM export requires generated field names like ${QUANTITY}
and ${DNP} to be wrapped in ${} delimiters. When users pass these
on the command line inside double quotes, the shell expands ${VAR}
to an empty string, silently dropping the field from the output.
Normalize field names in the job handler so that bare tokens like
QUANTITY, DNP, ITEM_NUMBER, EXCLUDE_FROM_BOM, EXCLUDE_FROM_BOARD,
and EXCLUDE_FROM_SIM are accepted alongside the canonical ${} form.
Update the default --fields value and help text to use the shell-safe
bare form.
Fixes https://gitlab.com/kicad/code/kicad/-/issues/22613
359 lines
16 KiB
Python
359 lines
16 KiB
Python
#
|
|
# This program source code file is part of KiCad, a free EDA CAD application.
|
|
#
|
|
# Copyright (C) 2023 Mark Roszko <[email protected]>
|
|
# 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
|
|
import cairosvg
|
|
import re
|
|
from pathlib import Path
|
|
import pytest
|
|
from typing import List
|
|
|
|
from conftest import KiTestFixture
|
|
|
|
|
|
@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.svg", []),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test_nobg_bnw_nods", "cli/basic_test/basic_test_nobg_bnw_nods.svg", ["--no-background-color", "--exclude-drawing-sheet", "--black-and-white"])
|
|
])
|
|
def test_sch_export_svg( kitest: KiTestFixture,
|
|
test_file: str,
|
|
output_dir: str,
|
|
compare_fn: str,
|
|
cli_args: List[str] ):
|
|
input_file = kitest.get_data_file_path( test_file )
|
|
|
|
output_path = kitest.get_output_path( "cli/{}/".format( output_dir ) )
|
|
|
|
command = [utils.kicad_cli(), "sch", "export", "svg"]
|
|
command.extend( cli_args )
|
|
command.append( "-o" )
|
|
command.append( str( output_path ) )
|
|
command.append( str(input_file) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == 0
|
|
assert stderr == ''
|
|
assert stdout is not None
|
|
|
|
stdout_regex = re.search("Plotted to '(.+)'", stdout)
|
|
assert stdout_regex
|
|
|
|
# now try and manipulate the extracted path
|
|
output_svg_path = Path( stdout_regex.group(1) )
|
|
assert output_svg_path.exists()
|
|
|
|
kitest.add_attachment( output_svg_path )
|
|
|
|
png_converted_from_svg_path = output_svg_path.with_suffix( '.png' )
|
|
|
|
cairosvg.svg2png( url=str( output_svg_path ), write_to=str( png_converted_from_svg_path ), dpi=1200 )
|
|
|
|
compare_file_path = kitest.get_data_file_path( compare_fn )
|
|
compare_stem = f"orig_{output_dir}"
|
|
compare_png_converted_from_svg_path = output_svg_path.with_suffix( '.png' ).with_stem(compare_stem)
|
|
cairosvg.svg2png( url=str( compare_file_path ), write_to=str( compare_png_converted_from_svg_path ), dpi=1200 )
|
|
|
|
assert utils.images_are_equal( png_converted_from_svg_path, compare_png_converted_from_svg_path,
|
|
diff_handler=kitest.add_attachment )
|
|
|
|
|
|
@pytest.mark.parametrize("test_file,output_fn,line_skip_count,skip_compare,cli_args",
|
|
[("cli/basic_test/basic_test.kicad_sch", "basic_test.netlist.kicadsexpr", 5, True, []),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.netlist.kicadsexpr", 5, True,["--format=kicadsexpr"]),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.netlist.kicadxml", 6, True,["--format=kicadxml"]),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.netlist.cadstar", 3, False, ["--format=cadstar"]),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.netlist.orcadpcb2", 1, False, ["--format=orcadpcb2"]),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.netlist.pads", 0, False, ["--format=pads"]),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.netlist.allegro", 3, False, ["--format=allegro"]),
|
|
])
|
|
def test_sch_export_netlist( kitest,
|
|
test_file: str,
|
|
output_fn: str,
|
|
line_skip_count: int,
|
|
skip_compare: bool,
|
|
cli_args: List[str] ):
|
|
input_file = kitest.get_data_file_path( test_file )
|
|
compare_filepath = kitest.get_data_file_path( "cli/basic_test/{}".format( output_fn ) )
|
|
|
|
output_filepath = kitest.get_output_path( "cli/" ).joinpath( output_fn )
|
|
|
|
command = [utils.kicad_cli(), "sch", "export", "netlist"]
|
|
command.extend( cli_args )
|
|
command.append( "-o" )
|
|
command.append( str( output_filepath ) )
|
|
command.append( str(input_file) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == 0
|
|
assert stderr == ''
|
|
|
|
# some of our netlist formats are not cross platform so skip for now
|
|
if not skip_compare:
|
|
assert utils.textdiff_files( compare_filepath, output_filepath, line_skip_count )
|
|
|
|
kitest.add_attachment( output_filepath )
|
|
|
|
|
|
@pytest.mark.parametrize("test_file,output_fn,cli_args",
|
|
[("cli/basic_test/basic_test.kicad_sch", "basic_test.pdf", []),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.bnw.nods.nobg.pdf", ["--black-and-white","--exclude-drawing-sheet","--no-background-color"]),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.pone.pdf", ["--pages", "1"])
|
|
])
|
|
def test_sch_export_pdf( kitest,
|
|
test_file: str,
|
|
output_fn: str,
|
|
cli_args: List[str] ):
|
|
input_file = kitest.get_data_file_path( test_file )
|
|
|
|
output_filepath = kitest.get_output_path( "cli/" ).joinpath( output_fn )
|
|
|
|
command = [utils.kicad_cli(), "sch", "export", "pdf"]
|
|
command.extend( cli_args )
|
|
command.append( "-o" )
|
|
command.append( str( output_filepath ) )
|
|
command.append( str( input_file ) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == 0
|
|
assert stderr == ''
|
|
|
|
kitest.add_attachment( output_filepath )
|
|
|
|
|
|
@pytest.mark.parametrize("test_file,output_fn,compare_fn,line_skip_count,cli_args",
|
|
[("cli/variants/variants.kicad_sch", "variants_default.bom.csv", "cli/variants/variants_default.bom.csv", 0,
|
|
["--exclude-dnp", "--fields", "Reference,Value", "--labels", "Refs,Value"]),
|
|
("cli/variants/variants.kicad_sch", "variants_v1.bom.csv", "cli/variants/variants_v1.bom.csv", 0,
|
|
["--variant", "Variant 1", "--exclude-dnp", "--fields", "Reference,Value", "--labels", "Refs,Value"]),
|
|
("cli/variants/variants.kicad_sch", "variants_v2.bom.csv", "cli/variants/variants_v2.bom.csv", 0,
|
|
["--variant", "Variant2", "--exclude-dnp", "--fields", "Reference,Value", "--labels", "Refs,Value"]),
|
|
])
|
|
def test_sch_export_bom_variants( kitest: KiTestFixture,
|
|
test_file: str,
|
|
output_fn: str,
|
|
compare_fn: str,
|
|
line_skip_count: int,
|
|
cli_args: List[str] ):
|
|
"""Test BOM export with variant support and DNP exclusion"""
|
|
input_file = kitest.get_data_file_path( test_file )
|
|
compare_filepath = kitest.get_data_file_path( compare_fn )
|
|
|
|
output_filepath = kitest.get_output_path( "cli/" ).joinpath( output_fn )
|
|
|
|
command = [utils.kicad_cli(), "sch", "export", "bom"]
|
|
command.extend( cli_args )
|
|
command.append( "-o" )
|
|
command.append( str( output_filepath ) )
|
|
command.append( str( input_file ) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == 0
|
|
assert stderr == ''
|
|
|
|
assert utils.textdiff_files( compare_filepath, output_filepath, line_skip_count )
|
|
|
|
kitest.add_attachment( output_filepath )
|
|
|
|
|
|
def test_sch_export_bom_multi_variant_requires_placeholder( kitest: KiTestFixture ):
|
|
"""Test that multiple variants require ${VARIANT} in output path"""
|
|
input_file = kitest.get_data_file_path( "cli/variants/variants.kicad_sch" )
|
|
|
|
output_filepath = kitest.get_output_path( "cli/" ).joinpath( "multi_variant_fail.csv" )
|
|
|
|
command = [utils.kicad_cli(), "sch", "export", "bom"]
|
|
command.extend( ["--variant", "Variant 1", "--variant", "Variant2"] )
|
|
command.extend( ["--exclude-dnp", "--fields", "Reference,Value", "--labels", "Refs,Value"] )
|
|
command.append( "-o" )
|
|
command.append( str( output_filepath ) )
|
|
command.append( str( input_file ) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == 1
|
|
assert "VARIANT" in stderr
|
|
|
|
|
|
def test_sch_export_bom_multi_variant_with_placeholder( kitest: KiTestFixture ):
|
|
"""Test BOM export with multiple variants using ${VARIANT} placeholder"""
|
|
input_file = kitest.get_data_file_path( "cli/variants/variants.kicad_sch" )
|
|
|
|
output_dir = kitest.get_output_path( "cli/" )
|
|
output_pattern = str( output_dir.joinpath( "bom_${VARIANT}.csv" ) )
|
|
|
|
command = [utils.kicad_cli(), "sch", "export", "bom"]
|
|
command.extend( ["--variant", "Variant 1", "--variant", "Variant2"] )
|
|
command.extend( ["--exclude-dnp", "--fields", "Reference,Value", "--labels", "Refs,Value"] )
|
|
command.append( "-o" )
|
|
command.append( output_pattern )
|
|
command.append( str(input_file) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == 0
|
|
assert stderr == ''
|
|
|
|
v1_path = output_dir.joinpath( "bom_Variant 1.csv" )
|
|
v2_path = output_dir.joinpath( "bom_Variant2.csv" )
|
|
|
|
assert v1_path.exists(), f"Expected output file {v1_path} not found"
|
|
assert v2_path.exists(), f"Expected output file {v2_path} not found"
|
|
|
|
v1_compare = kitest.get_data_file_path( "cli/variants/variants_v1.bom.csv" )
|
|
v2_compare = kitest.get_data_file_path( "cli/variants/variants_v2.bom.csv" )
|
|
|
|
assert utils.textdiff_files( v1_compare, v1_path, 0 )
|
|
assert utils.textdiff_files( v2_compare, v2_path, 0 )
|
|
|
|
kitest.add_attachment( v1_path )
|
|
kitest.add_attachment( v2_path )
|
|
|
|
|
|
@pytest.mark.parametrize("test_file,output_fn,line_skip_count,cli_args",
|
|
[("cli/basic_test/basic_test.kicad_sch", "basic_test.pythonbom", 6, [])
|
|
])
|
|
def test_sch_export_pythonbom( kitest: KiTestFixture,
|
|
test_file: str,
|
|
output_fn: str,
|
|
line_skip_count: int,
|
|
cli_args: List[str] ):
|
|
input_file = kitest.get_data_file_path( test_file )
|
|
compare_filepath = kitest.get_data_file_path( "cli/basic_test/{}".format( output_fn ) )
|
|
|
|
output_filepath = kitest.get_output_path( "cli/" ).joinpath( output_fn )
|
|
|
|
command = [utils.kicad_cli(), "sch", "export", "python-bom"]
|
|
command.extend( cli_args )
|
|
command.append( "-o" )
|
|
command.append( str( output_filepath ) )
|
|
command.append( str( input_file ) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == 0
|
|
assert stderr == ''
|
|
|
|
# pythonbom is not currently crossplatform (platform specific paths) to enable diffs
|
|
|
|
kitest.add_attachment( output_filepath )
|
|
|
|
|
|
|
|
@pytest.mark.parametrize("test_file,output_fn,line_skip_count,skip_compare,expected_exit_code,cli_args",
|
|
[("cli/basic_test/basic_test.kicad_sch", "basic_test.erc.rpt", 1, False, 0, []),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.erc.rpt", 1, False, 0, ["--format=report"]),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.erc.json", 5, False,0, ["--format=json"]),
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.erc.unitsin.rpt", 1, False, 0, ["--format=report", "--units=in"]),
|
|
])
|
|
def test_sch_export_erc( kitest: KiTestFixture,
|
|
test_file: str,
|
|
output_fn: str,
|
|
line_skip_count: int,
|
|
skip_compare: bool,
|
|
expected_exit_code: int,
|
|
cli_args: List[str] ):
|
|
input_file = kitest.get_data_file_path( test_file )
|
|
compare_filepath = kitest.get_data_file_path( "cli/basic_test/{}".format( output_fn ) )
|
|
|
|
output_filepath = kitest.get_output_path( "cli/" ).joinpath( output_fn )
|
|
|
|
command = [utils.kicad_cli(), "sch", "erc"]
|
|
command.extend( cli_args )
|
|
command.append( "-o" )
|
|
command.append( str( output_filepath ) )
|
|
command.append( str( input_file ) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == expected_exit_code
|
|
|
|
# some of our netlist formats are not cross platform so skip for now
|
|
if not skip_compare:
|
|
assert utils.textdiff_files( compare_filepath, output_filepath, line_skip_count )
|
|
|
|
kitest.add_attachment( output_filepath )
|
|
|
|
|
|
@pytest.mark.parametrize("test_file,output_fn,expected_headers,cli_args",
|
|
[
|
|
# Default fields include QUANTITY and DNP
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.bom_default.csv",
|
|
["Refs", "Value", "Footprint", "Qty", "DNP"], []),
|
|
# Explicit fields with ${QUANTITY} (canonical form)
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.bom_quantity.csv",
|
|
["Refs", "Value", "Qty"],
|
|
["--fields", "${QUANTITY},Reference,Value", "--labels", "Qty,Refs,Value"]),
|
|
# Explicit fields with ${ITEM_NUMBER} (canonical form)
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.bom_item_number.csv",
|
|
["#", "Refs", "Value"],
|
|
["--fields", "${ITEM_NUMBER},Reference,Value", "--labels", "#,Refs,Value"]),
|
|
# Bare field names without ${} delimiters (shell-safe form)
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.bom_bare_names.csv",
|
|
["Refs", "Value", "Qty", "DNP"],
|
|
["--fields", "Reference,Value,QUANTITY,DNP", "--labels", "Refs,Value,Qty,DNP"]),
|
|
# Bare ITEM_NUMBER without ${} delimiters
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.bom_bare_item.csv",
|
|
["#", "Refs", "Value"],
|
|
["--fields", "ITEM_NUMBER,Reference,Value", "--labels", "#,Refs,Value"]),
|
|
# Bare EXCLUDE_FROM_BOM
|
|
("cli/basic_test/basic_test.kicad_sch", "basic_test.bom_bare_excl.csv",
|
|
["Refs", "Value", "Excl BOM"],
|
|
["--fields", "Reference,Value,EXCLUDE_FROM_BOM",
|
|
"--labels", "Refs,Value,Excl BOM"]),
|
|
])
|
|
def test_sch_export_bom( kitest,
|
|
test_file: str,
|
|
output_fn: str,
|
|
expected_headers: List[str],
|
|
cli_args: List[str] ):
|
|
"""Test BOM export with various field configurations, including virtual fields like QUANTITY."""
|
|
input_file = kitest.get_data_file_path( test_file )
|
|
|
|
output_filepath = kitest.get_output_path( "cli/" ).joinpath( output_fn )
|
|
|
|
command = [utils.kicad_cli(), "sch", "export", "bom"]
|
|
command.extend( cli_args )
|
|
command.append( "-o" )
|
|
command.append( str( output_filepath ) )
|
|
command.append( str( input_file ) )
|
|
|
|
stdout, stderr, exitcode = utils.run_and_capture( command )
|
|
|
|
assert exitcode == 0, f"BOM export failed with exit code {exitcode}: {stderr}"
|
|
assert output_filepath.exists(), f"Output file not created: {output_filepath}"
|
|
|
|
# Read the BOM file and verify headers
|
|
with open( output_filepath, 'r' ) as f:
|
|
first_line = f.readline().strip()
|
|
|
|
# Parse the CSV header (removing quotes)
|
|
actual_headers = [h.strip().strip('"') for h in first_line.split(',')]
|
|
|
|
for expected in expected_headers:
|
|
assert expected in actual_headers, f"Expected header '{expected}' not found in BOM output. Got: {actual_headers}"
|
|
|
|
kitest.add_attachment( output_filepath )
|